svc_cable, RT#22009

9 files changed, 372 insertions, 0 deletions

diff --git a/FS/FS/AccessRight.pm b/FS/FS/AccessRight.pm
index 373617e..4753d31 100644
--- a/FS/FS/AccessRight.pm
+++ b/FS/FS/AccessRight.pm
@@ -293,6 +293,7 @@ tie my %rights, 'Tie::IxHash',
     'Services: Wireless broadband services',
     'Services: Wireless broadband services: Advanced search',
     'Services: DSLs',
+    'Services: Cable subscribers',
     'Services: Dish services',
     'Services: Hardware',
     'Services: Hardware: Advanced search',
diff --git a/FS/FS/Schema.pm b/FS/FS/Schema.pm
index 28c7fc4..ed23d31 100644
--- a/FS/FS/Schema.pm
+++ b/FS/FS/Schema.pm
@@ -4129,6 +4129,30 @@ sub tables_hashref {
       'index' => [],
     },
 
+    'svc_cable' => {
+      'columns' => [
+        'svcnum',         'int',     '',      '', '', '', 
+        #nothing so far...  there should be _something_ uniquely identifying
+        # each subscriber besides the device info...?
+      ],
+      'primary_key' => 'svcnum',
+      'unique' => [],
+      'index'  => [],
+    },
+
+    'cable_device' => {
+      'columns' => [
+        'devicenum', 'serial',     '',      '', '', '',
+        'devicepart',   'int',     '',      '', '', '',
+        'svcnum',       'int',     '',      '', '', '', 
+        'mac_addr', 'varchar', 'NULL',      12, '', '', 
+        'serial',   'varchar', 'NULL', $char_d, '', '',
+      ],
+      'primary_key' => 'devicenum',
+      'unique' => [ [ 'mac_addr' ], ],
+      'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
+    },
+
     %{ tables_hashref_torrus() },
 
     # tables of ours for doing torrus virtual port combining
diff --git a/FS/FS/access_right.pm b/FS/FS/access_right.pm
index 5bcf922..a42d7f2 100644
--- a/FS/FS/access_right.pm
+++ b/FS/FS/access_right.pm
@@ -233,6 +233,7 @@ sub _upgrade_data { # class method
                              'Employees: Audit Report',
                            ],
     'Change customer package' => 'Detach customer package',
+    'Services: Accounts' => 'Services: Cable Subscribers',
 ;
 
   foreach my $old_acl ( keys %onetime ) {
diff --git a/FS/FS/cable_device.pm b/FS/FS/cable_device.pm
new file mode 100644
index 0000000..1a0f1b9
--- /dev/null
+++ b/FS/FS/cable_device.pm
@@ -0,0 +1,140 @@
+package FS::cable_device;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearchs ); # qsearch );
+use FS::part_device;
+use FS::svc_cable;
+
+=head1 NAME
+
+FS::cable_device - Object methods for cable_device records
+
+=head1 SYNOPSIS
+
+  use FS::cable_device;
+
+  $record = new FS::cable_device \%hash;
+  $record = new FS::cable_device { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::cable_device object represents a specific customer cable modem.
+FS::cable_device inherits from FS::Record.  The following fields are currently
+supported:
+
+=over 4
+
+=item devicenum
+
+primary key
+
+=item devicepart
+
+devicepart
+
+=item svcnum
+
+svcnum
+
+=item mac_addr
+
+mac_addr
+
+=item serial
+
+serial
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new record.  To add the record to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to.  You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+sub table { 'cable_device'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=item delete
+
+Delete this record from the database.
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=item check
+
+Checks all fields to make sure this is a valid record.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+sub check {
+  my $self = shift;
+
+  my $mac = $self->mac_addr;
+  $mac =~ s/\s+//g;
+  $mac =~ s/://g;
+  $self->mac_addr($mac);
+
+  my $error = 
+    $self->ut_numbern('devicenum')
+    || $self->ut_number('devicepart')
+    || $self->ut_foreign_key('devicepart', 'part_device', 'devicepart')
+    || $self->ut_foreign_key('svcnum', 'svc_cable', 'svcnum' ) #cust_svc?
+    || $self->ut_hexn('mac_addr')
+    || $self->ut_textn('serial')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=item part_device
+
+Returns the device type record (see L<FS::part_device>) associated with this
+customer device.
+
+=cut
+
+sub part_device {
+  my $self = shift;
+  qsearchs( 'part_device', { 'devicepart' => $self->devicepart } );
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::Record>
+
+=cut
+
+1;
+
diff --git a/FS/FS/device_Common.pm b/FS/FS/device_Common.pm
new file mode 100644
index 0000000..ac00b76
--- /dev/null
+++ b/FS/FS/device_Common.pm
@@ -0,0 +1,78 @@
+package FS::device_Common;
+
+use strict;
+use NEXT;
+use FS::Record qw( qsearch dbh ); # qsearchs );
+
+=head1 NAME
+
+FS::device_Common - Base class for svc_X classes which have associated X_devices
+
+=head1 SYNOPSIS
+
+  package FS::svc_newservice
+  use base qw( FS::device_Common FS::svc_Common );
+
+=head1 DESCRIPTION
+
+=cut
+
+sub _device_table {
+  my $self = shift;
+  ( my $device_table = $self->table ) =~ s/^svc_//;
+  $device_table.'_device';
+}
+
+sub device_table {
+  my $self = shift;
+  my $device_table = $self->_device_table;
+  eval "use FS::$device_table;";
+  die $@ if $@;
+  $device_table;
+}
+
+sub device_objects {
+  my $self = shift;
+  qsearch($self->device_table, { 'svcnum' => $self->svcnum } );
+}
+
+sub delete {
+  my $self = shift;
+
+  local $SIG{HUP} = 'IGNORE';
+  local $SIG{INT} = 'IGNORE';
+  local $SIG{QUIT} = 'IGNORE';
+  local $SIG{TERM} = 'IGNORE';
+  local $SIG{TSTP} = 'IGNORE';
+  local $SIG{PIPE} = 'IGNORE';
+
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  foreach my $device ( $self->device_objects ) {
+    my $error = $device->delete;
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return $error;
+    }
+  }
+
+  my $error = $self->NEXT::delete;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+  '';
+
+}
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+=cut
+
+1;
diff --git a/FS/FS/svc_cable.pm b/FS/FS/svc_cable.pm
new file mode 100644
index 0000000..f588f43
--- /dev/null
+++ b/FS/FS/svc_cable.pm
@@ -0,0 +1,114 @@
+package FS::svc_cable;
+use base qw( FS::device_Common FS::svc_Common );
+
+use strict;
+use base qw( FS::Record );
+use FS::Record; # qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::svc_cable - Object methods for svc_cable records
+
+=head1 SYNOPSIS
+
+  use FS::svc_cable;
+
+  $record = new FS::svc_cable \%hash;
+  $record = new FS::svc_cable { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::svc_cable object represents a cable subscriber.  FS::svc_cable inherits
+from FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item svcnum
+
+primary key
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new record.  To add the record to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to.  You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+sub table { 'svc_cable'; }
+
+sub table_info {
+  {
+    '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',
+    },
+  };
+}
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=item delete
+
+Delete this record from the database.
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=item check
+
+Checks all fields to make sure this is a valid record.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('svcnum')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/MANIFEST b/FS/MANIFEST
index ee18407..3a58c8e 100644
--- a/FS/MANIFEST
+++ b/FS/MANIFEST
@@ -696,3 +696,7 @@ FS/part_pkg_msgcat.pm
 t/part_pkg_msgcat.t
 FS/access_user_session.pm
 t/access_user_session.t
+FS/svc_cable.pm
+t/svc_cable.t
+FS/cable_device.pm
+t/cable_device.t
diff --git a/FS/t/cable_device.t b/FS/t/cable_device.t
new file mode 100644
index 0000000..016d2c5
--- /dev/null
+++ b/FS/t/cable_device.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::cable_device;
+$loaded=1;
+print "ok 1\n";
diff --git a/FS/t/svc_cable.t b/FS/t/svc_cable.t
new file mode 100644
index 0000000..5057659
--- /dev/null
+++ b/FS/t/svc_cable.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::svc_cable;
+$loaded=1;
+print "ok 1\n";