fix conf callback (align with v3/master), RT#25239 weirdness?
[freeside.git] / FS / FS / svc_phone.pm
index b61a93d..7e5e26f 100644 (file)
@@ -2,9 +2,12 @@ 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 $phone_name_max );
+use vars qw( $DEBUG $me @pw_set $conf $phone_name_max
+             $passwordmin $passwordmax
+           );
 use Data::Dumper;
 use Scalar::Util qw( blessed );
+use List::Util qw( min );
 use FS::Conf;
 use FS::Record qw( qsearch qsearchs dbh );
 use FS::Msgcat qw(gettext);
@@ -22,10 +25,13 @@ $DEBUG = 0;
 @pw_set = ( 'a'..'k', 'm','n', 'p-z', 'A'..'N', 'P'..'Z' , '2'..'9' );
 
 #ask FS::UID to run this stuff for us later
-$FS::UID::callback{'FS::svc_acct'} = sub { 
+FS::UID->install_callback( sub { 
   $conf = new FS::Conf;
   $phone_name_max = $conf->config('svc_phone-phone_name-max_length');
-};
+  $passwordmin = $conf->config('sip_passwordmin') || 0;
+  $passwordmax = $conf->config('sip_passwordmax') || 80;
+}
+);
 
 =head1 NAME
 
@@ -79,6 +85,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
@@ -136,10 +177,20 @@ 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, 
@@ -353,6 +404,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;
@@ -414,26 +476,59 @@ 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'])
+    || $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) ) {
+  unless ( length($self->pin) ) {
+    my $random_pin = $conf->config('svc_phone-random_pin');
+    if ( $random_pin =~ /^\d+$/ ) {
+      $self->pin(
+        join('', map int(rand(10)), 0..($random_pin-1))
+      );
+    }
+  }
+
+  if ( length($self->sip_password) ) {
+
+    return "SIP password must be longer than $passwordmin characters"
+      if length($self->sip_password) < $passwordmin;
+    return "SIP password must be shorter than $passwordmax characters"
+      if length($self->sip_password) > $passwordmax;
+
+  } else { # option for this?
 
     $self->sip_password(
-      join('', map $pw_set[ int(rand $#pw_set) ], (0..16) )
+      join('', map $pw_set[ int(rand $#pw_set) ], (1..min($passwordmax,16)) )
     );
 
   }
@@ -577,7 +672,7 @@ 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 status => "" (or "processing-tiered", "done"): Return only CDRs with that processing status.
 
 =item inbound => 1: Return CDRs for inbound calls.  With "status", will filter 
 on inbound processing status.
@@ -585,45 +680,54 @@ on inbound processing status.
 =item default_prefix => "XXX": Also accept the phone number of the service prepended 
 with the chosen prefix.
 
+=item begin, end: Start and end of a date range, as unix timestamp.
+
+=item cdrtypenum: Only return CDRs with this type number.
+
 =item disable_src => 1: Only match on "charged_party", not "src".
 
+=item nonzero: Only return CDRs where duration > 0.
+
 =item by_svcnum: not supported for svc_phone
 
 =back
 
 =cut
 
-sub get_cdrs {
+sub _search_cdrs { # transitional; replaced with psearch_cdrs in 3.0
   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";
+      my $status = $options{'status'};
+      if ( $status ) {
+        push @where, 'EXISTS ( SELECT 1 FROM cdr_termination '.
+          'WHERE cdr.acctid = cdr_termination.acctid '.
+          "AND cdr_termination.status = '$status' ". #quoting kludge
+          'AND cdr_termination.termpart = 1 )';
+      } else {
+        push @where, 'NOT EXISTS ( SELECT 1 FROM cdr_termination '.
+          'WHERE cdr.acctid = cdr_termination.acctid '.
+          'AND cdr_termination.termpart = 1 )';
       }
     }
-  }
-  else {
+
+  } else {
+
     @fields = ( 'charged_party' );
     push @fields, 'src' if !$options{'disable_src'};
     $hash{'freesidestatus'} = $options{'status'}
       if exists($options{'status'});
   }
+
+  if ($options{'cdrtypenum'}) {
+    $hash{'cdrtypenum'} = $options{'cdrtypenum'};
+  }
   
   my $for_update = $options{'for_update'} ? 'FOR UPDATE' : '';
 
@@ -633,8 +737,8 @@ sub get_cdrs {
 
   my @orwhere =  map " $_ = '$number'        ", @fields;
   push @orwhere, map " $_ = '$prefix$number' ", @fields
-    if length($prefix);
-  if ( $prefix =~ /^\+(\d+)$/ ) {
+    if defined($prefix) && length($prefix);
+  if ( $prefix && $prefix =~ /^\+(\d+)$/ ) {
     push @orwhere, map " $_ = '$1$number' ", @fields
   }
 
@@ -646,18 +750,48 @@ sub get_cdrs {
   if ( $options{'end'} ) {
     push @where, 'startdate < '.  $options{'end'};
   }
+  if ( $options{'nonzero'} ) {
+    push @where, 'duration > 0';
+  }
 
   my $extra_sql = ( keys(%hash) ? ' AND ' : ' WHERE ' ). join(' AND ', @where );
 
-  my @cdrs =
-    qsearch( {
+
+  return {
       'table'      => 'cdr',
       'hashref'    => \%hash,
       'extra_sql'  => $extra_sql,
-      'order_by'   => "ORDER BY startdate $for_update",
-    } );
+      'order_by'   => $options{'billsec_sum'} ? '' : "ORDER BY startdate $for_update",
+      'select'     => $options{'billsec_sum'} ? 'sum(billsec) as billsec_sum' : '*',
+  };
+}
+
+sub get_cdrs {
+  qsearch(_search_cdrs(@_));
+}
+
+=item sum_cdrs
+
+Takes the same options as psearch_cdrs, but returns a single row containing
+"count" (the number of CDRs) and the sums of the following fields: duration,
+billsec, rated_price, rated_seconds, rated_minutes.
+
+Note that if any calls are not rated, their rated_* fields will be null.
+If you want to use those fields, pass the 'status' option to limit to 
+calls that have been rated.  This is intentional; please don't "fix" it.
 
-  @cdrs;
+=cut
+
+sub sum_cdrs {
+  my $self = shift;
+  my $search = $self->_search_cdrs(@_);
+  $search->{'select'} = join(',',
+    'COUNT(*) AS count',
+    map { "SUM($_) AS $_" }
+      qw(duration billsec rated_price rated_seconds rated_minutes)
+  );
+  $search->{'order_by'} = '';
+  qsearchs ( $search );
 }
 
 =back