1 package FS::svc_hardware;
4 use base qw( FS::svc_Common );
6 use FS::Record qw( qsearch qsearchs );
8 use FS::hardware_status;
11 FS::UID->install_callback(sub { $conf = FS::Conf->new; });
15 FS::svc_hardware - Object methods for svc_hardware records
21 $record = new FS::svc_hardware \%hash;
22 $record = new FS::svc_hardware { 'column' => 'value' };
24 $error = $record->insert;
26 $error = $new_record->replace($old_record);
28 $error = $record->delete;
30 $error = $record->check;
34 An FS::svc_hardware object represents an equipment installation, such as
35 a wireless broadband receiver, satellite antenna, or DVR. FS::svc_hardware
36 inherits from FS::svc_Common.
38 The following fields are currently supported:
42 =item svcnum - Primary key
44 =item typenum - Device type number (see L<FS::hardware_type>)
46 =item ip_addr - IP address
48 =item hw_addr - Hardware address
50 =item serial - Serial number
52 =item smartcard - Smartcard number, for devices that use a smartcard
54 =item statusnum - Service status (see L<FS::hardware_status>)
56 =item note - Installation notes: location on property, physical access, etc.
66 Creates a new svc_hardware object.
70 sub table { 'svc_hardware'; }
73 my %opts = ( 'type' => 'text', 'disable_select' => 1 );
75 'name' => 'Hardware', #?
76 'name_plural' => 'Hardware',
77 'display_weight' => 59,
78 'cancel_weight' => 86,
79 'manual_require' => 1,
81 'svcnum' => { label => 'Service' },
82 'typenum' => { label => 'Device type',
83 type => 'select-hardware',
87 disable_inventory => 1,
90 'serial' => { label => 'Serial number', %opts },
91 'hw_addr' => { label => 'Hardware address', %opts },
92 'ip_addr' => { label => 'IP address', %opts },
93 'smartcard' => { label => 'Smartcard #', %opts },
94 'statusnum' => { label => 'Service status',
96 select_table => 'hardware_status',
97 select_key => 'statusnum',
98 select_label => 'label',
99 disable_inventory => 1,
101 'note' => { label => 'Installation notes', %opts },
107 my ($class, $string) = @_;
110 if ( $string =~ /^[\d\.:]+$/ ) {
111 # if the string isn't an IP address, this will waste several seconds
112 # attempting a DNS lookup. so try to filter those out.
113 my $ip = NetAddr::IP->new($string);
115 push @where, $class->search_sql_field('ip_addr', $ip->addr);
119 if ( $string =~ /^(\w+)$/ ) {
120 push @where, 'LOWER(svc_hardware.serial) LIKE \'%'.lc($string).'%\'';
123 if ( $string =~ /^([0-9A-Fa-f]|\W)+$/ ) {
124 my $hex = uc($string);
126 push @where, 'svc_hardware.hw_addr LIKE \'%'.$hex.'%\'';
130 '(' . join(' OR ', @where) . ')';
138 my $part_svc = $self->cust_svc->part_svc;
140 if (my $type = $self->hardware_type) {
141 my $typenum_label = $part_svc->part_svc_column('typenum');
142 push @label, ( $typenum_label && $typenum_label->columnlabel || 'Type:' ).
145 if (my $ser = $self->serial) {
146 my $serial_label = $part_svc->part_svc_column('serial');
147 push @label, ( $serial_label && $serial_label->columnlabel || 'Serial#' ).
150 if (my $mac = $self->display_hw_addr) {
151 my $hw_addr_label = $part_svc->part_svc_column('hw_addr');
152 push @label, ( $hw_addr_label && $hw_addr_label->columnlabel || 'MAC:').
155 return join(', ', @label);
160 Adds this record to the database. If there is an error, returns the error,
161 otherwise returns false.
165 Delete this record from the database.
167 =item replace OLD_RECORD
169 Replaces the OLD_RECORD with this one in the database. If there is an error,
170 returns the error, otherwise returns false.
172 # the replace method can be inherited from FS::Record
176 Checks all fields to make sure this is a valid service. If there is
177 an error, returns the error, otherwise returns false. Called by the insert
184 my $conf = FS::Conf->new;
186 my $x = $self->setfixed;
187 return $x unless ref $x;
189 my $hw_addr = $self->getfield('hw_addr');
190 $hw_addr = join('', split(/[_\W]/, $hw_addr));
191 if ( $conf->exists('svc_hardware-check_mac_addr') ) {
192 $hw_addr = uc($hw_addr);
193 $hw_addr =~ /^[0-9A-F]{12}$/
194 or return "Illegal (MAC address) '".$self->getfield('hw_addr')."'";
196 $self->setfield('hw_addr', $hw_addr);
199 $self->ut_numbern('svcnum')
200 || $self->ut_foreign_key('typenum', 'hardware_type', 'typenum')
201 || $self->ut_ip46n('ip_addr')
202 || $self->ut_alphan('hw_addr')
203 || $self->ut_alphan('serial')
204 || $self->ut_alphan('smartcard')
205 || $self->ut_foreign_keyn('statusnum', 'hardware_status', 'statusnum')
206 || $self->ut_anything('note')
208 return $error if $error;
210 if ( !length($self->getfield('hw_addr'))
211 and !length($self->getfield('serial')) ) {
212 return 'Serial number or hardware address required';
220 Returns the L<FS::hardware_type> object associated with this installation.
226 return qsearchs('hardware_type', { 'typenum' => $self->typenum });
231 Returns the 'label' field of the L<FS::hardware_status> object associated
232 with this installation.
238 my $status = qsearchs('hardware_status', { 'statusnum' => $self->statusnum })
243 =item display_hw_addr
245 Returns the 'hw_addr' field, formatted as a MAC address if the
246 'svc_hardware-check_mac_addr' option is enabled.
250 sub display_hw_addr {
252 ($conf->exists('svc_hardware-check_mac_addr') ?
253 join(':', $self->hw_addr =~ /../g) : $self->hw_addr)
260 L<FS::Record>, L<FS::svc_Common>, schema.html from the base documentation.