invoice DID summary performance enhancement, RT10886
[freeside.git] / FS / FS / svc_phone.pm
index 5d102ce..19bef94 100644 (file)
@@ -2,7 +2,7 @@ package FS::svc_phone;
 
 use strict;
 use base qw( FS::svc_Domain_Mixin FS::location_Mixin FS::svc_Common );
-use vars qw( $DEBUG $me @pw_set $conf );
+use vars qw( $DEBUG $me @pw_set $conf $phone_name_max );
 use Data::Dumper;
 use Scalar::Util qw( blessed );
 use FS::Conf;
@@ -13,6 +13,7 @@ use FS::phone_device;
 use FS::svc_pbx;
 use FS::svc_domain;
 use FS::cust_location;
+use FS::phone_avail;
 
 $me = '[' . __PACKAGE__ . ']';
 $DEBUG = 0;
@@ -23,6 +24,7 @@ $DEBUG = 0;
 #ask FS::UID to run this stuff for us later
 $FS::UID::callback{'FS::svc_acct'} = sub { 
   $conf = new FS::Conf;
+  $phone_name_max = $conf->config('svc_phone-phone_name-max_length');
 };
 
 =head1 NAME
@@ -77,6 +79,41 @@ Voicemail PIN
 
 Optional svcnum from svc_pbx
 
+=item forwarddst
+
+Forwarding destination
+
+=item email
+
+Email address for virtual fax (fax-to-email) services
+
+=item lnp_status
+
+LNP Status (can be null, native, portedin, portingin, portin-reject,
+portingout, portout-reject)
+
+=item portable
+
+=item lrn
+
+=item lnp_desired_due_date
+
+=item lnp_due_date
+
+=item lnp_other_provider
+
+If porting the number in or out, name of the losing or winning provider, 
+respectively.
+
+=item lnp_other_provider_account
+
+Account number of other provider. See lnp_other_provider.
+
+=item lnp_reject_reason
+
+See lnp_status. If lnp_status is portin-reject or portout-reject, this is an
+optional reject reason.
+
 =back
 
 =head1 METHODS
@@ -95,19 +132,21 @@ points to.  You can ask the object for a copy with the I<hash> method.
 # the new method can be inherited from FS::Record, if a table method is defined
 #
 sub table_info {
+ my %dis2 = ( disable_inventory=>1, disable_select=>1 );
   {
     'name' => 'Phone number',
     'sorts' => 'phonenum',
     'display_weight' => 60,
     'cancel_weight'  => 80,
     'fields' => {
+        'svcnum'       => 'Service',
         'countrycode'  => { label => 'Country code',
                             type  => 'text',
                             disable_inventory => 1,
                             disable_select => 1,
                           },
         'phonenum'     => 'Phone number',
-        'pin'          => { label => 'Personal Identification Number',
+        'pin'          => { label => 'Voicemail PIN', #'Personal Identification Number',
                             type  => 'text',
                             disable_inventory => 1,
                             disable_select => 1,
@@ -132,6 +171,36 @@ sub table_info {
                            disable_inventory => 1,
                            disable_select    => 1,
                          },
+       'forwarddst' => {       label => 'Forward Destination', 
+                               %dis2,
+                       },
+       'email' => {            label => 'Email',
+                               %dis2,
+                   },
+       'lnp_status' => {       label => 'LNP Status',
+                               type => 'select-lnp_status.html',
+                               %dis2,
+                       },
+       'lnp_reject_reason' => { 
+                               label => 'LNP Reject Reason',
+                               %dis2,
+                       },
+       'portable' =>   {       label => 'Portable?', %dis2, },
+       'lrn'   =>      {       label => 'LRN', 
+                               disable_inventory => 1, 
+                       },
+       'lnp_desired_due_date' =>
+                       { label => 'LNP Desired Due Date', %dis2 },
+       'lnp_due_date' =>
+                       { label => 'LNP Due Date', %dis2 },
+       'lnp_other_provider' =>
+                       {       label => 'LNP Other Provider', 
+                               disable_inventory => 1, 
+                       },
+       'lnp_other_provider_account' =>
+                       {       label => 'LNP Other Provider Account #', 
+                               %dis2 
+                       },
     },
   };
 }
@@ -261,6 +330,16 @@ sub delete {
     }
   }
 
+  my @phone_avail = qsearch('phone_avail', { 'svcnum' => $self->svcnum } );
+  foreach my $phone_avail ( @phone_avail ) {
+    $phone_avail->svcnum('');
+    my $error = $phone_avail->replace;
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return $error;
+    }
+  }
+
   my $error = $self->SUPER::delete;
   if ( $error ) {
     $dbh->rollback if $oldAutoCommit;
@@ -319,6 +398,17 @@ sub replace {
   }
   #what about on-the-fly edits?  if the ui supports it?
 
+  # LNP data validation
+ return 'Invalid LNP status' # if someone does really stupid stuff
+    if (  ($old->lnp_status eq 'portingout' && $new->lnp_status eq 'portingin')
+       || ($old->lnp_status eq 'portout-reject' && $new->lnp_status eq 'portingin')
+       || ($old->lnp_status eq 'portin-reject' && $new->lnp_status eq 'portingout')
+       || ($old->lnp_status eq 'portingin' && $new->lnp_status eq 'native')
+       || ($old->lnp_status eq 'portin-reject' && $new->lnp_status eq 'native')
+       || ($old->lnp_status eq 'portingin' && $new->lnp_status eq 'portingout')
+       || ($old->lnp_status eq 'portingout' && $new->lnp_status eq 'portin-reject')
+       );
+
   my $error = $new->SUPER::replace($old, %options);
   if ( $error ) {
     $dbh->rollback if $oldAutoCommit;
@@ -380,9 +470,37 @@ sub check {
     || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx',    'svcnum' )
     || $self->ut_foreign_keyn('domsvc', 'svc_domain', 'svcnum' )
     || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
+    || $self->ut_numbern('forwarddst')
+    || $self->ut_textn('email')
+    || $self->ut_numbern('lrn')
+    || $self->ut_numbern('lnp_desired_due_date')
+    || $self->ut_numbern('lnp_due_date')
+    || $self->ut_textn('lnp_other_provider')
+    || $self->ut_textn('lnp_other_provider_account')
+    || $self->ut_enumn('lnp_status', ['','portingin','portingout','portedin',
+                               'native', 'portin-reject', 'portout-reject'])
+    || $self->ut_enumn('portable', ['','Y'])
+    || $self->ut_textn('lnp_reject_reason')
   ;
   return $error if $error;
 
+    # LNP data validation
+    return 'Cannot set LNP fields: no LNP in progress'
+       if ( ($self->lnp_desired_due_date || $self->lnp_due_date 
+           || $self->lnp_other_provider || $self->lnp_other_provider_account
+           || $self->lnp_reject_reason) 
+           && (!$self->lnp_status || $self->lnp_status eq 'native') );
+    return 'Cannot set LNP reject reason: no LNP in progress or status is not reject'
+       if ($self->lnp_reject_reason && (!$self->lnp_status 
+                           || $self->lnp_status !~ /^port(in|out)-reject$/) );
+    return 'Cannot port-out a non-portable number' 
+       if (!$self->portable && $self->lnp_status eq 'portingout');
+
+
+  return 'Name ('. $self->phone_name.
+         ") is longer than $phone_name_max characters"
+    if $phone_name_max && length($self->phone_name) > $phone_name_max;
+
   $self->countrycode(1) unless $self->countrycode;
 
   unless ( length($self->sip_password) ) {
@@ -520,6 +638,102 @@ sub cust_location_or_main {
   $cust_pkg ? $cust_pkg->cust_location_or_main : '';
 }
 
+=item get_cdrs
+
+Returns a set of Call Detail Records (see L<FS::cdr>) associated with this 
+service.  By default, "associated with" means that either the "src" or the 
+"charged_party" field of the CDR matches the "phonenum" field of the service.
+
+=over 2
+
+Accepts the following options:
+
+=item for_update => 1: SELECT the CDRs "FOR UPDATE".
+
+=item status => "" (or "done"): Return only CDRs with that processing status.
+
+=item inbound => 1: Return CDRs for inbound calls.  With "status", will filter 
+on inbound processing status.
+
+=item default_prefix => "XXX": Also accept the phone number of the service prepended 
+with the chosen prefix.
+
+=item disable_src => 1: Only match on "charged_party", not "src".
+
+=item by_svcnum: not supported for svc_phone
+
+=back
+
+=cut
+
+sub get_cdrs {
+  my($self, %options) = @_;
+  my @fields;
+  my %hash;
+  my @where;
+
+  if ( $options{'inbound'} ) {
+    @fields = ( 'dst' );
+    if ( exists($options{'status'}) ) {
+      # must be 'done' or ''
+      my $sq = 'EXISTS ( SELECT 1 FROM cdr_termination '.
+        'WHERE cdr.acctid = cdr_termination.acctid '.
+        'AND cdr_termination.status = \'done\' '.
+        'AND cdr_termination.termpart = 1 )';
+      if ( $options{'status'} eq 'done' ) {
+        push @where, $sq;
+      }
+      elsif ($options{'status'} eq '' ) {
+        push @where, "NOT $sq";
+      }
+      else {
+        warn "invalid status: $options{'status'} (ignored)\n";
+      }
+    }
+  }
+  else {
+    @fields = ( 'charged_party' );
+    push @fields, 'src' if !$options{'disable_src'};
+    $hash{'freesidestatus'} = $options{'status'}
+      if exists($options{'status'});
+  }
+  
+  my $for_update = $options{'for_update'} ? 'FOR UPDATE' : '';
+
+  my $number = $self->phonenum;
+
+  my $prefix = $options{'default_prefix'};
+
+  my @orwhere =  map " $_ = '$number'        ", @fields;
+  push @orwhere, map " $_ = '$prefix$number' ", @fields
+    if length($prefix);
+  if ( $prefix =~ /^\+(\d+)$/ ) {
+    push @orwhere, map " $_ = '$1$number' ", @fields
+  }
+
+  push @where, ' ( '. join(' OR ', @orwhere ). ' ) ';
+
+  if ( $options{'begin'} ) {
+    push @where, 'startdate >= '. $options{'begin'};
+  }
+  if ( $options{'end'} ) {
+    push @where, 'startdate < '.  $options{'end'};
+  }
+
+  my $extra_sql = ( keys(%hash) ? ' AND ' : ' WHERE ' ). join(' AND ', @where );
+
+  my @cdrs =
+    qsearch( {
+      'table'      => 'cdr',
+      'hashref'    => \%hash,
+      'extra_sql'  => $extra_sql,
+      'order_by'   => $options{'billsec_sum'} ? '' : "ORDER BY startdate $for_update",
+      'select'     => $options{'billsec_sum'} ? 'sum(billsec) as billsec_sum' : '*',
+    } );
+
+  @cdrs;
+}
+
 =back
 
 =head1 BUGS