File: ScanSet.pm

package info (click to toggle)
ndiff 0.05beta4-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 300 kB
  • ctags: 254
  • sloc: perl: 1,806; makefile: 56
file content (217 lines) | stat: -rw-r--r-- 4,773 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
#!/usr/bin/perl
#
# $Id: ScanSet.pm,v 1.10 2001/11/24 22:28:15 levine Exp $
#
# Copyright (C) 2000  James D. Levine (jdl@vinecorp.com)
#
#
#   This program is free software; you can redistribute it and/or
#   modify it under the terms of the GNU General Public License
#   as published by the Free Software Foundation; either version 2
#   of the License, or (at your option) any later version.
# 
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
# 
#   You should have received a copy of the GNU General Public License
#   along with this program; if not, write to the Free Software
#   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 
#   02111-1307, USA.
#
####################################################################

use strict;

use PortScan::ScannedHost;

package PortScan::ScanSet;

sub new
{
    my ($type, $tag, $hosts, $properties, $ports) = @_;

    $hosts = {} if !defined $hosts; 
    $properties = {} if !defined $properties;
    $ports = {} if !defined $ports;

    my $self = 
    {
	tag => $tag,		# identifying tag for the scanset used by DataStore
	properties => $properties, # hash of key to value mappings
	hosts => $hosts,  # hash of IP (dotted-quad text) to ScannedHost mappings
	all_scanned_ports => $ports,  # hash of PortSpec::key_for() to PortSpec mappings
                                      # dummy PortSpecs for all ports scanned
    };

    bless $self, $type;

    return $self;
}

# private util to output a hash
sub hash_to_text
  {
    my $h = shift;
    my $t;
    while (my ($k, $v) = each %$h)
      {
	$t .= "`${k}' -> `${v}'\n";
      }
    $t;
  }

# outputs a ScanSet in human readable form
sub to_text
  {
    my $self = shift;

    return
      "tag: " . $self->{tag} . "\n" 
    . "properties:\n" 
    . hash_to_text($self->{properties}) 
    . "hosts:\n"  
    . hash_to_text($self->{hosts})
      ;
  }

# generic accessor
sub set_or_get
{
    my $field = shift;
    my $self = shift;
    my $val = shift;

    $self->{$field} = $val if defined $val;

    return $self->{$field};
}

# set/get the tag associated with the set
sub tag
{
    return set_or_get('tag', @_);
}

# clones this instance
sub clone_deep
{
    my( $self, $from, $when, $tag1, $tag2 ) = @_;

    my $hosts = {};
    my $properties = {};

    my ($k, $v);
    my $h = $self->hosts();

    while ( ($k, $v) = each %$h )
    {
	$hosts->{$k} = $v->clone();
    }

    my $p = $self->{properties};
    while ( ($k, $v) = each %$p)
    {
	$properties->{$k} = $v;
    }

    return new ScanSet($from, $when, $tag1, $tag2, $hosts, $properties);
}

# set an arbitrary piece of metadata
sub set_property
{
    my( $self, $k, $v ) = @_;
    $self->{properties}->{$k} = $v;
}

# retrieve a piece of metadata by name
sub get_property
{
    my( $self, $k ) = @_;
    $self->{$k};
}

# set/get the hash of hosts in the set
sub hosts { return set_or_get('hosts', @_); }

# set/get the hash of metadata
sub properties { return set_or_get('properties', @_); }

# set/get the hash of all ports scanned
sub all_scanned_ports { return set_or_get('all_scanned_ports', @_); }

# TODO: where is this used??
sub prune
{
    my( $self ) = shift;

    my $hosts = $self->hosts;

    while( my( $name, $host ) = each %$hosts )
    {
	print "------------> prune: processing $name \n";
	    my $portspecs = $host->port_specs();
	    my @ports = keys %$portspecs;
	print "default_state is " . $host->default_state . " \n";
	print "number of ports is $#ports \n";

		if( ( $host->default_state eq "unknown" )  &&
		    ( $#ports == -1 )
		    )
		{
		    print "prune: removing $name \n";
		    $self->remove_host( $name )
	    }
    
    }
}

# adds a PortScan::PortSpec instance to the master set of scanned ports 
sub add_scanned_port 
{
    my( $self, $spec ) = @_;

    $self->all_scanned_ports()->{$spec->key_for()} = $spec;
}

# returns the list of hosts (PortScan::ScannedHost) sorted in IP address order
sub hosts_sorted_list
{
    my $self = shift;
    return PortScan::ScannedHost::sorted_list values %{$self->hosts()};
}


# add a ScannedHost instance 

sub add_host
{
    my( $self, $scanned_host ) = @_;
    $self->hosts()->{ $scanned_host->addr() } = $scanned_host;
    $scanned_host->scan_set($self);
}

# remove a ScannedHost instance identified by its IP address in dotted-quad
# text rep
sub remove_host
{
    my( $self, $addr ) = @_;
    delete $self->hosts()->{$addr};
}


# retrieve a ScannedHost instance identified by its IP address in dotted-quad
# text rep
sub get_host
{
    my( $self, $addr ) = @_;
    $self->hosts()->{$addr};
}

1;