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,
78 'manual_require' => 1,
80 'svcnum' => { label => 'Service' },
81 'typenum' => { label => 'Device type',
82 type => 'select-hardware',
86 disable_inventory => 1,
89 'serial' => { label => 'Serial number', %opts },
90 'hw_addr' => { label => 'Hardware address', %opts },
91 'ip_addr' => { label => 'IP address', %opts },
92 'smartcard' => { label => 'Smartcard #', %opts },
93 'statusnum' => { label => 'Service status',
95 select_table => 'hardware_status',
96 select_key => 'statusnum',
97 select_label => 'label',
98 disable_inventory => 1,
100 'note' => { label => 'Installation notes', %opts },
106 my ($class, $string) = @_;
109 if ( $string =~ /^[\d\.:]+$/ ) {
110 # if the string isn't an IP address, this will waste several seconds
111 # attempting a DNS lookup. so try to filter those out.
112 my $ip = NetAddr::IP->new($string);
114 push @where, $class->search_sql_field('ip_addr', $ip->addr);
118 if ( $string =~ /^(\w+)$/ ) {
119 push @where, 'LOWER(svc_hardware.serial) LIKE \'%'.lc($string).'%\'';
122 if ( $string =~ /^([0-9A-Fa-f]|\W)+$/ ) {
123 my $hex = uc($string);
125 push @where, 'svc_hardware.hw_addr LIKE \'%'.$hex.'%\'';
129 '(' . join(' OR ', @where) . ')';
137 my $part_svc = $self->cust_svc->part_svc;
139 if (my $type = $self->hardware_type) {
140 my $typenum_label = $part_svc->part_svc_column('typenum');
141 push @label, ( $typenum_label && $typenum_label->columnlabel || 'Type:' ).
144 if (my $ser = $self->serial) {
145 my $serial_label = $part_svc->part_svc_column('serial');
146 push @label, ( $serial_label && $serial_label->columnlabel || 'Serial#' ).
149 if (my $mac = $self->display_hw_addr) {
150 my $hw_addr_label = $part_svc->part_svc_column('hw_addr');
151 push @label, ( $hw_addr_label && $hw_addr_label->columnlabel || 'MAC:').
154 return join(', ', @label);
159 Adds this record to the database. If there is an error, returns the error,
160 otherwise returns false.
164 Delete this record from the database.
166 =item replace OLD_RECORD
168 Replaces the OLD_RECORD with this one in the database. If there is an error,
169 returns the error, otherwise returns false.
171 # the replace method can be inherited from FS::Record
175 Checks all fields to make sure this is a valid service. If there is
176 an error, returns the error, otherwise returns false. Called by the insert
183 my $conf = FS::Conf->new;
185 my $x = $self->setfixed;
186 return $x unless ref $x;
188 my $hw_addr = $self->getfield('hw_addr');
189 $hw_addr = join('', split(/[_\W]/, $hw_addr));
190 if ( $conf->exists('svc_hardware-check_mac_addr') ) {
191 $hw_addr = uc($hw_addr);
192 $hw_addr =~ /^[0-9A-F]{12}$/
193 or return "Illegal (MAC address) '".$self->getfield('hw_addr')."'";
195 $self->setfield('hw_addr', $hw_addr);
198 $self->ut_numbern('svcnum')
199 || $self->ut_foreign_key('typenum', 'hardware_type', 'typenum')
200 || $self->ut_ip46n('ip_addr')
201 || $self->ut_alphan('hw_addr')
202 || $self->ut_alphan('serial')
203 || $self->ut_alphan('smartcard')
204 || $self->ut_foreign_keyn('statusnum', 'hardware_status', 'statusnum')
205 || $self->ut_anything('note')
207 return $error if $error;
209 if ( !length($self->getfield('hw_addr'))
210 and !length($self->getfield('serial')) ) {
211 return 'Serial number or hardware address required';
217 #false laziness w/svc_cable
218 sub _check_duplicate {
221 # Not reliable checks because the table isn't locked, but that's why we have
222 # unique indices. These are just to give friendlier error messages.
224 if ( $self->hw_addr ) {
226 @dup_mac = $self->find_duplicates('global', 'hw_addr');
228 return "Hardware address in use (svcnum ".$dup_mac[0]->svcnum.")";
232 if ( $self->ip_addr ) {
234 @dup_ip = $self->find_duplicates('global', 'ip_addr');
236 return "IP address in use (svcnum ".$dup_ip[0]->svcnum.")";
240 if ( $self->serial ) {
242 @dup_serial = $self->find_duplicates('global', 'typenum', 'serial');
244 return "Serial number in use (svcnum ".$dup_serial[0]->svcnum.")";
253 Returns the L<FS::hardware_type> object associated with this installation.
257 Returns the 'label' field of the L<FS::hardware_status> object associated
258 with this installation.
264 my $status = qsearchs('hardware_status', { 'statusnum' => $self->statusnum })
269 =item display_hw_addr
271 Returns the 'hw_addr' field, formatted as a MAC address if the
272 'svc_hardware-check_mac_addr' option is enabled.
276 sub display_hw_addr {
278 ($conf->exists('svc_hardware-check_mac_addr') ?
279 join(':', $self->hw_addr =~ /../g) : $self->hw_addr)
284 require FS::Misc::FixIPFormat;
285 FS::Misc::FixIPFormat::fix_bad_addresses_in_table(
286 'svc_hardware', 'svcnum', 'ip_addr',
297 L<FS::Record>, L<FS::svc_Common>, schema.html from the base documentation.