From: ivan <ivan>
Date: Tue, 23 Dec 2003 01:49:32 +0000 (+0000)
Subject: add svc_external
X-Git-Tag: NET_WHOIS_RAW_0_31~213
X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=commitdiff_plain;h=d20581bcbf2809d5c2969d773b16a0c8714a6dec;hp=869a43742a9bcba4d2dd117b76e759ff6c81d371;ds=sidebyside

add svc_external
---

diff --git a/FS/FS.pm b/FS/FS.pm
index a299e659d..36c3a1777 100644
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -66,6 +66,10 @@ L<FS::svc_forward> - Mail forwarding class
 
 L<FS::svc_www> - Web virtual host class.
 
+L<FS::svc_broadband> - DSL, wireless and other broadband class.
+
+L<FS::svc_external> - Externally tracked service class.
+
 L<FS::part_svc> - Service definition class
 
 L<FS::part_svc_column> - Column constraint class
diff --git a/FS/FS/cust_svc.pm b/FS/FS/cust_svc.pm
index af0abf7f1..ce2b969f9 100644
--- a/FS/FS/cust_svc.pm
+++ b/FS/FS/cust_svc.pm
@@ -296,6 +296,8 @@ sub label {
     $tag = $domain->zone;
   } elsif ( $svcdb eq 'svc_broadband' ) {
     $tag = $svc_x->ip_addr;
+  } elsif ( $svcdb eq 'svc_external' ) {
+    $tag = $svc_x->id. ': '. $svc_x->title;
   } else {
     cluck "warning: asked for label of unsupported svcdb; using svcnum";
     $tag = $svc_x->getfield('svcnum');
diff --git a/FS/FS/svc_external.pm b/FS/FS/svc_external.pm
new file mode 100644
index 000000000..fe4ea1d67
--- /dev/null
+++ b/FS/FS/svc_external.pm
@@ -0,0 +1,174 @@
+package FS::svc_external;
+
+use strict;
+use vars qw(@ISA); # $conf
+use FS::UID;
+#use FS::Record qw( qsearch qsearchs dbh);
+use FS::svc_Common;
+
+@ISA = qw( FS::svc_Common );
+
+#FS::UID::install_callback( sub {
+#  $conf = new FS::Conf;
+#};
+
+=head1 NAME
+
+FS::svc_external - Object methods for svc_external records
+
+=head1 SYNOPSIS
+
+  use FS::svc_external;
+
+  $record = new FS::svc_external \%hash;
+  $record = new FS::svc_external { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+  $error = $record->suspend;
+
+  $error = $record->unsuspend;
+
+  $error = $record->cancel;
+
+=head1 DESCRIPTION
+
+An FS::svc_external object represents a externally tracked service.
+FS::svc_external inherits from FS::svc_Common.  The following fields are
+currently supported:
+
+=over 4
+
+=item svcnum - primary key
+
+=item id - unique number of external record
+
+=item title - for invoice line items
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new external service.  To add the external service 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_external'; }
+
+=item insert
+
+Adds this external service to the database.  If there is an error, returns the
+error, otherwise returns false.
+
+The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be 
+defined.  An FS::cust_svc record will be created and inserted.
+
+=cut
+
+sub insert {
+  my $self = shift;
+  my $error;
+
+  $error = $self->SUPER::insert;
+  return $error if $error;
+
+  '';
+}
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+sub delete {
+  my $self = shift;
+  my $error;
+
+  $error = $self->SUPER::delete;
+  return $error if $error;
+
+  '';
+}
+
+
+=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.
+
+=cut
+
+sub replace {
+  my ( $new, $old ) = ( shift, shift );
+  my $error;
+
+  $error = $new->SUPER::replace($old);
+  return $error if $error;
+
+  '';
+}
+
+=item suspend
+
+Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
+
+=item unsuspend
+
+Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
+
+=item cancel
+
+Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
+
+=item check
+
+Checks all fields to make sure this is a valid external service.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and repalce methods.
+
+=cut
+
+sub check {
+  my $self = shift;
+
+  my $x = $self->setfixed;
+  return $x unless ref($x);
+  my $part_svc = $x;
+
+  my $error = 
+    $self->ut_numbern('svcnum')
+    || $self->ut_number('id')
+    || $self->ut_textn('title')
+  ;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::svc_Common>, L<FS::Record>, L<FS::cust_svc>, L<FS::part_svc>,
+L<FS::cust_pkg>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/bin/freeside-setup b/FS/bin/freeside-setup
index 4e3a09aad..fce8bc750 100755
--- a/FS/bin/freeside-setup
+++ b/FS/bin/freeside-setup
@@ -1120,6 +1120,17 @@ sub tables_hash_hack {
       'index'  => [ [ 'svcnum' ] ],
     },
 
+    'svc_external' => {
+      'columns' => [
+        'svcnum', 'int', '', '',
+        'id',     'int', '', '',
+        'title',  'varchar', 'NULL', $char_d,
+      ],
+      'primary_key' => 'svcnum',
+      'unique'      => [],
+      'index'       => [],
+    },
+
   );
 
   %tables;
diff --git a/httemplate/docs/upgrade10.html b/httemplate/docs/upgrade10.html
index 3c6519a61..275b821a3 100644
--- a/httemplate/docs/upgrade10.html
+++ b/httemplate/docs/upgrade10.html
@@ -73,6 +73,13 @@ CREATE TABLE acct_snarf (
 );
 CREATE INDEX acct_snarf1 ON acct_snarf ( svcnum );
 
+CREATE TABLE svc_external (
+  svcnum int NOT NULL,
+  id int NOT NULL,
+  title varchar(80),
+  PRIMARY KEY (svcnum)
+);
+
 CREATE TABLE part_pkg_temp (
     pkgpart serial NOT NULL,
     pkg varchar(80) NOT NULL,
@@ -175,7 +182,7 @@ optionally:
 mandatory again:
 
 dbdef-create username
-create-history-tables username cust_bill_pkg_detail router part_svc_router addr_block svc_broadband acct_snarf
+create-history-tables username cust_bill_pkg_detail router part_svc_router addr_block svc_broadband acct_snarf svc_external
 dbdef-create username
 
 apache - fix <Files> sections to include .html also