199 lines
		
	
	
		
			5.0 KiB
		
	
	
	
		
			Perl
		
	
	
	
	
	
			
		
		
	
	
			199 lines
		
	
	
		
			5.0 KiB
		
	
	
	
		
			Perl
		
	
	
	
	
	
use utf8;
 | 
						|
package App::Netdisco::DB::Result::Node;
 | 
						|
 | 
						|
 | 
						|
use strict;
 | 
						|
use warnings;
 | 
						|
 | 
						|
use NetAddr::MAC;
 | 
						|
 | 
						|
use base 'App::Netdisco::DB::Result';
 | 
						|
__PACKAGE__->table("node");
 | 
						|
__PACKAGE__->add_columns(
 | 
						|
  "mac",
 | 
						|
  { data_type => "macaddr", is_nullable => 0 },
 | 
						|
  "switch",
 | 
						|
  { data_type => "inet", is_nullable => 0 },
 | 
						|
  "port",
 | 
						|
  { data_type => "text", is_nullable => 0 },
 | 
						|
  "active",
 | 
						|
  { data_type => "boolean", is_nullable => 1 },
 | 
						|
  "oui",
 | 
						|
  { data_type => "varchar", is_nullable => 1, is_serializable => 0, size => 8 },
 | 
						|
  "time_first",
 | 
						|
  {
 | 
						|
    data_type     => "timestamp",
 | 
						|
    default_value => \"current_timestamp",
 | 
						|
    is_nullable   => 1,
 | 
						|
    original      => { default_value => \"now()" },
 | 
						|
  },
 | 
						|
  "time_recent",
 | 
						|
  {
 | 
						|
    data_type     => "timestamp",
 | 
						|
    default_value => \"current_timestamp",
 | 
						|
    is_nullable   => 1,
 | 
						|
    original      => { default_value => \"now()" },
 | 
						|
  },
 | 
						|
  "time_last",
 | 
						|
  {
 | 
						|
    data_type     => "timestamp",
 | 
						|
    default_value => \"current_timestamp",
 | 
						|
    is_nullable   => 1,
 | 
						|
    original      => { default_value => \"now()" },
 | 
						|
  },
 | 
						|
  "vlan",
 | 
						|
  { data_type => "text", is_nullable => 0, default_value => '0' },
 | 
						|
);
 | 
						|
__PACKAGE__->set_primary_key("mac", "switch", "port", "vlan");
 | 
						|
 | 
						|
 | 
						|
 | 
						|
=head1 RELATIONSHIPS
 | 
						|
 | 
						|
=head2 device
 | 
						|
 | 
						|
Returns the single C<device> to which this Node entry was associated at the
 | 
						|
time of discovery.
 | 
						|
 | 
						|
The JOIN is of type LEFT, in case the C<device> is no longer present in the
 | 
						|
database but the relation is being used in C<search()>.
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
__PACKAGE__->belongs_to( device => 'App::Netdisco::DB::Result::Device',
 | 
						|
  { 'foreign.ip' => 'self.switch' }, { join_type => 'LEFT' } );
 | 
						|
 | 
						|
=head2 device_port
 | 
						|
 | 
						|
Returns the single C<device_port> to which this Node entry was associated at
 | 
						|
the time of discovery.
 | 
						|
 | 
						|
The JOIN is of type LEFT, in case the C<device> is no longer present in the
 | 
						|
database but the relation is being used in C<search()>.
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
# device port may have been deleted (reconfigured modules?) but node remains
 | 
						|
__PACKAGE__->belongs_to( device_port => 'App::Netdisco::DB::Result::DevicePort',
 | 
						|
  { 'foreign.ip' => 'self.switch', 'foreign.port' => 'self.port' },
 | 
						|
  { join_type => 'LEFT' }
 | 
						|
);
 | 
						|
 | 
						|
=head2 wireless_port
 | 
						|
 | 
						|
Returns the single C<wireless_port> to which this Node entry was associated at
 | 
						|
the time of discovery.
 | 
						|
 | 
						|
The JOIN is of type LEFT, in case the C<device> is no longer present in the
 | 
						|
database but the relation is being used in C<search()>.
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
__PACKAGE__->belongs_to(
 | 
						|
    wireless_port => 'App::Netdisco::DB::Result::DevicePortWireless',
 | 
						|
    { 'foreign.ip' => 'self.switch', 'foreign.port' => 'self.port' },
 | 
						|
    { join_type    => 'LEFT' }
 | 
						|
);
 | 
						|
 | 
						|
=head2 ips
 | 
						|
 | 
						|
Returns the set of C<node_ip> entries associated with this Node. That is, the
 | 
						|
IP addresses which this MAC address was hosting at the time of discovery.
 | 
						|
 | 
						|
Note that the Active status of the returned IP entries will all be the same as
 | 
						|
the current Node's.
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
__PACKAGE__->has_many( ips => 'App::Netdisco::DB::Result::NodeIp',
 | 
						|
  { 'foreign.mac' => 'self.mac', 'foreign.active' => 'self.active' } );
 | 
						|
 | 
						|
=head2 ip4s
 | 
						|
 | 
						|
Same as C<ips> but for IPv4 only.
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
__PACKAGE__->has_many( ip4s => 'App::Netdisco::DB::Result::Virtual::NodeIp4',
 | 
						|
  { 'foreign.mac' => 'self.mac', 'foreign.active' => 'self.active' } );
 | 
						|
 | 
						|
=head2 ip6s
 | 
						|
 | 
						|
Same as C<ips> but for IPv6 only.
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
__PACKAGE__->has_many( ip6s => 'App::Netdisco::DB::Result::Virtual::NodeIp6',
 | 
						|
  { 'foreign.mac' => 'self.mac', 'foreign.active' => 'self.active' } );
 | 
						|
 | 
						|
=head2 netbios
 | 
						|
 | 
						|
Returns the C<node_nbt> entry associated with this Node if one exists. That
 | 
						|
is, the NetBIOS information of this MAC address at the time of discovery.
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
__PACKAGE__->might_have( netbios => 'App::Netdisco::DB::Result::NodeNbt',
 | 
						|
  { 'foreign.mac' => 'self.mac' } );
 | 
						|
 | 
						|
=head2 wireless
 | 
						|
 | 
						|
Returns the set of C<node_wireless> entries associated with this Node. That
 | 
						|
is, the SSIDs and wireless statistics associated with this MAC address
 | 
						|
at the time of discovery.
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
__PACKAGE__->has_many( wireless => 'App::Netdisco::DB::Result::NodeWireless',
 | 
						|
  { 'foreign.mac' => 'self.mac' } );
 | 
						|
 | 
						|
=head2 oui
 | 
						|
 | 
						|
Returns the C<oui> table entry matching this Node. You can then join on this
 | 
						|
relation and retrieve the Company name from the related table.
 | 
						|
 | 
						|
The JOIN is of type LEFT, in case the OUI table has not been populated.
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
__PACKAGE__->belongs_to( oui => 'App::Netdisco::DB::Result::Oui', 'oui',
 | 
						|
  { join_type => 'LEFT' } );
 | 
						|
 | 
						|
=head1 ADDITIONAL COLUMNS
 | 
						|
 | 
						|
=head2 time_first_stamp
 | 
						|
 | 
						|
Formatted version of the C<time_first> field, accurate to the minute.
 | 
						|
 | 
						|
The format is somewhat like ISO 8601 or RFC3339 but without the middle C<T>
 | 
						|
between the date stamp and time stamp. That is:
 | 
						|
 | 
						|
 2012-02-06 12:49
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
sub time_first_stamp { return (shift)->get_column('time_first_stamp') }
 | 
						|
 | 
						|
=head2 time_last_stamp
 | 
						|
 | 
						|
Formatted version of the C<time_last> field, accurate to the minute.
 | 
						|
 | 
						|
The format is somewhat like ISO 8601 or RFC3339 but without the middle C<T>
 | 
						|
between the date stamp and time stamp. That is:
 | 
						|
 | 
						|
 2012-02-06 12:49
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
sub time_last_stamp  { return (shift)->get_column('time_last_stamp')  }
 | 
						|
 | 
						|
=head2 net_mac
 | 
						|
 | 
						|
Returns the C<mac> column instantiated into a L<NetAddr::MAC> object.
 | 
						|
 | 
						|
=cut
 | 
						|
 | 
						|
sub net_mac { return NetAddr::MAC->new(mac => ((shift)->mac || '')) }
 | 
						|
 | 
						|
1;
 |