1 package FS::svc_hardware;
2 use base qw( FS::svc_Common );
6 use FS::Record qw( qsearchs ); #qsearch qsearchs );
7 use FS::hardware_status;
10 FS::UID->install_callback(sub { $conf = FS::Conf->new; });
14 FS::svc_hardware - Object methods for svc_hardware records
20 $record = new FS::svc_hardware \%hash;
21 $record = new FS::svc_hardware { 'column' => 'value' };
23 $error = $record->insert;
25 $error = $new_record->replace($old_record);
27 $error = $record->delete;
29 $error = $record->check;
33 An FS::svc_hardware object represents an equipment installation, such as
34 a wireless broadband receiver, satellite antenna, or DVR. FS::svc_hardware
35 inherits from FS::svc_Common.
37 The following fields are currently supported:
41 =item svcnum - Primary key
43 =item typenum - Device type number (see L<FS::hardware_type>)
45 =item ip_addr - IP address
47 =item hw_addr - Hardware address
49 =item serial - Serial number
51 =item smartcard - Smartcard number, for devices that use a smartcard
53 =item statusnum - Service status (see L<FS::hardware_status>)
55 =item note - Installation notes: location on property, physical access, etc.
65 Creates a new svc_hardware object.
69 sub table { 'svc_hardware'; }
72 my %opts = ( 'type' => 'text', 'disable_select' => 1 );
74 'name' => 'Hardware', #?
75 'name_plural' => 'Hardware',
76 'display_weight' => 59,
77 'cancel_weight' => 86,
79 'svcnum' => { label => 'Service' },
80 'typenum' => { label => 'Device type',
81 type => 'select-hardware',
85 disable_inventory => 1,
87 'serial' => { label => 'Serial number', %opts },
88 'hw_addr' => { label => 'Hardware address', %opts },
89 'ip_addr' => { label => 'IP address', %opts },
90 'smartcard' => { label => 'Smartcard #', %opts },
91 'statusnum' => { label => 'Service status',
93 select_table => 'hardware_status',
94 select_key => 'statusnum',
95 select_label => 'label',
96 disable_inventory => 1,
98 'note' => { label => 'Installation notes', %opts },
104 my ($class, $string) = @_;
107 if ( $string =~ /^[\d\.:]+$/ ) {
108 # if the string isn't an IP address, this will waste several seconds
109 # attempting a DNS lookup. so try to filter those out.
110 my $ip = NetAddr::IP->new($string);
112 push @where, $class->search_sql_field('ip_addr', $ip->addr);
116 if ( $string =~ /^(\w+)$/ ) {
117 push @where, 'LOWER(svc_hardware.serial) LIKE \'%'.lc($string).'%\'';
120 if ( $string =~ /^([0-9A-Fa-f]|\W)+$/ ) {
121 my $hex = uc($string);
123 push @where, 'svc_hardware.hw_addr LIKE \'%'.$hex.'%\'';
127 '(' . join(' OR ', @where) . ')';
136 if (my $type = $self->hardware_type) {
137 push @label, 'Type:' . $type->description;
139 if (my $ser = $self->serial) {
140 push @label, 'Serial#' . $ser;
142 if (my $mac = $self->display_hw_addr) {
143 push @label, 'MAC:'. $mac;
145 return join(', ', @label);
150 Adds this record to the database. If there is an error, returns the error,
151 otherwise returns false.
155 Delete this record from the database.
157 =item replace OLD_RECORD
159 Replaces the OLD_RECORD with this one in the database. If there is an error,
160 returns the error, otherwise returns false.
162 # the replace method can be inherited from FS::Record
166 Checks all fields to make sure this is a valid service. If there is
167 an error, returns the error, otherwise returns false. Called by the insert
174 my $conf = FS::Conf->new;
176 my $x = $self->setfixed;
177 return $x unless ref $x;
179 my $hw_addr = $self->getfield('hw_addr');
180 $hw_addr = join('', split(/[_\W]/, $hw_addr));
181 if ( $conf->exists('svc_hardware-check_mac_addr') ) {
182 $hw_addr = uc($hw_addr);
183 $hw_addr =~ /^[0-9A-F]{12}$/
184 or return "Illegal (MAC address) '".$self->getfield('hw_addr')."'";
186 $self->setfield('hw_addr', $hw_addr);
189 $self->ut_numbern('svcnum')
190 || $self->ut_foreign_key('typenum', 'hardware_type', 'typenum')
191 || $self->ut_ip46n('ip_addr')
192 || $self->ut_alphan('hw_addr')
193 || $self->ut_alphan('serial')
194 || $self->ut_alphan('smartcard')
195 || $self->ut_foreign_keyn('statusnum', 'hardware_status', 'statusnum')
196 || $self->ut_anything('note')
198 return $error if $error;
200 if ( !length($self->getfield('hw_addr'))
201 and !length($self->getfield('serial')) ) {
202 return 'Serial number or hardware address required';
210 Returns the L<FS::hardware_type> object associated with this installation.
214 Returns the 'label' field of the L<FS::hardware_status> object associated
215 with this installation.
221 my $status = qsearchs('hardware_status', { 'statusnum' => $self->statusnum })
226 =item display_hw_addr
228 Returns the 'hw_addr' field, formatted as a MAC address if the
229 'svc_hardware-check_mac_addr' option is enabled.
233 sub display_hw_addr {
235 ($conf->exists('svc_hardware-check_mac_addr') ?
236 join(':', $self->hw_addr =~ /../g) : $self->hw_addr)
243 L<FS::Record>, L<FS::svc_Common>, schema.html from the base documentation.