svc_hardware uniqueness checks, RT#81534
[freeside.git] / FS / FS / svc_cable.pm
index f588f43..daaf680 100644 (file)
@@ -1,9 +1,10 @@
 package FS::svc_cable;
-use base qw( FS::device_Common FS::svc_Common );
+use base qw( FS::MAC_Mixin
+             FS::svc_Common
+           ); #FS::device_Common
 
 use strict;
-use base qw( FS::Record );
-use FS::Record; # qw( qsearch qsearchs );
+use Tie::IxHash;
 
 =head1 NAME
 
@@ -35,6 +36,26 @@ from FS::Record.  The following fields are currently supported:
 
 primary key
 
+=item providernum
+
+Provider (see L<FS::cable_provider>)
+
+=item ordernum
+
+Provider order number
+
+=item modelnum
+
+Cable device model (see L<FS::cable_model>)
+
+=item serialnum
+
+Cable device serial number
+
+=item mac_addr
+
+Cable device MAC address
+
 =back
 
 =head1 METHODS
@@ -52,21 +73,88 @@ points to.  You can ask the object for a copy with the I<hash> method.
 
 sub table { 'svc_cable'; }
 
+sub table_dupcheck_fields { ( 'serialnum', 'mac_addr' ); }
+
+sub search_sql {
+  my( $class, $string ) = @_;
+  if ( $string =~ /^([A-F0-9]{12})$/i ) {
+    $class->search_sql_field('mac_addr', uc($string));
+  } elsif ( $string =~ /^(([A-F0-9]{2}:){5}([A-F0-9]{2}))$/i ) {
+    $string =~ s/://g;
+    $class->search_sql_field('mac_addr', uc($string) );
+  } elsif ( $string =~ /^(\w+)$/ ) {
+    $class->search_sql_field('serialnum', $1);
+  } else {
+    '1 = 0'; #false
+  }
+}
+
 sub table_info {
+
+  tie my %fields, 'Tie::IxHash',
+    'svcnum'      => 'Service',
+    'providernum' => { label             => 'Provider',
+                       type              => 'select-cable_provider',
+                       disable_inventory => 1,
+                       disable_select    => 1,
+                       value_callback    => sub {
+                                              my $svc = shift;
+                                              my $p = $svc->cable_provider;
+                                              $p ? $p->provider : '';
+                                            },
+                     },
+    'ordernum'    => 'Order number', #XXX "Circuit ID/Order number"
+    'modelnum'    => { label             => 'Model',
+                       type              => 'select-cable_model',
+                       disable_inventory => 1,
+                       disable_select    => 1,
+                       value_callback    => sub {
+                                              my $svc = shift;
+                                              $svc->cable_model->model_name;
+                                            },
+                     },
+    'serialnum'   => 'Serial number',
+    'mac_addr'    => { label          => 'MAC address',
+                       type           => 'input-mac_addr',
+                       value_callback => sub {
+                                           my $svc = shift;
+                                           $svc->mac_addr_formatted('U',':');
+                                         },
+                     },
+  ;
+
   {
-    'name' => 'Cable Subscriber',
-    #'name_plural' => '', #optional,
+    'name'            => 'Cable Subscriber',
+    #'name_plural'     => '', #optional,
     #'longname_plural' => '', #optional
-    'sorts' => [ 'svcnum', ], #, 'serviceid' ], # optional sort field (or arrayref of sort fields, main first)
-    'display_weight' => 54,
-    'cancel_weight'  => 70, #?  no deps, so
-    'fields' => {
-      'svcnum'     => 'Service',
-      'identifier' => 'Identifier',
-    },
+    'fields'          => \%fields,
+    'sorts'           => [ 'svcnum', 'serialnum', 'mac_addr', ],
+    'display_weight'  => 54,
+    'cancel_weight'   => 70, #?  no deps, so
   };
 }
 
+=item label
+
+Returns the MAC address and serial number.
+
+=cut
+
+sub label {
+  my $self = shift;
+  my $part_svc = $self->cust_svc->part_svc;
+  my @label = ();
+  push @label, 'MAC:'. $self->mac_addr_pretty
+    if $self->mac_addr;
+  if ( $self->serialnum ) {
+    my $serialnum_label = $part_svc->part_svc_column('serialnum');
+    push @label,
+      ($serialnum_label && $serialnum_label->columnlabel || 'Serial#').
+      $self->serialnum;
+  }
+  return join(', ', @label);
+}
+
 =item insert
 
 Adds this record to the database.  If there is an error, returns the error,
@@ -93,13 +181,51 @@ sub check {
   my $self = shift;
 
   my $error = 
-    $self->ut_numbern('svcnum')
+       $self->ut_numbern('svcnum')
+    || $self->ut_foreign_keyn('providernum', 'cable_provider', 'providernum')
+    || $self->ut_alphan('ordernum')
+    || $self->ut_foreign_key('modelnum', 'cable_model', 'modelnum')
+    || $self->ut_alphan('serialnum')
+    || $self->ut_mac_addrn('mac_addr')
   ;
   return $error if $error;
 
   $self->SUPER::check;
 }
 
+sub _check_duplicate {
+  my $self = shift;
+
+  # Not reliable checks because the table isn't locked, but that's why we have
+  # unique indices.  These are just to give friendlier error messages.
+
+  if ( $self->mac_addr ) {
+    my @dup_mac;
+    @dup_mac = $self->find_duplicates('global', 'mac_addr');
+    if ( @dup_mac ) {
+      return "MAC address in use (svcnum ".$dup_mac[0]->svcnum.")";
+    }
+  }
+
+  if ( $self->serialnum ) {
+    my @dup_serial;
+    @dup_serial = $self->find_duplicates('global', 'modelnum', 'serialnum');
+    if ( @dup_serial ) {
+      return "Serial number in use (svcnum ".$dup_serial[0]->svcnum.")";
+    }
+  }
+
+  '';
+}
+
+=item cable_provider
+
+Returns the cable_provider object for this record.
+
+=item cable_model
+
+Returns the cable_model object for this record.
+
 =back
 
 =head1 BUGS