package FS::svc_phone;
+use base qw( FS::svc_Domain_Mixin FS::svc_PBX_Mixin
+ FS::location_Mixin
+ FS::svc_Common
+ );
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::PagedSearch qw( psearch );
use FS::Msgcat qw(gettext);
use FS::part_svc;
-use FS::phone_device;
use FS::svc_pbx;
use FS::svc_domain;
use FS::cust_location;
+use FS::phone_avail;
$me = '[' . __PACKAGE__ . ']';
$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
=item phonenum
+=item sim_imsi
+
+SIM IMSI (http://en.wikipedia.org/wiki/International_mobile_subscriber_identity)
+
=item sip_password
=item 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
# 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',
+ 'sim_imsi' => 'IMSI', #http://en.wikipedia.org/wiki/International_mobile_subscriber_identity
+ 'pin' => { label => 'Voicemail PIN', #'Personal Identification Number',
type => 'text',
disable_inventory => 1,
disable_select => 1,
select_label => 'domain',
disable_inventory => 1,
},
+ 'sms_carrierid' => { label => 'SMS Carrier',
+ type => 'select',
+ select_table => 'cdr_carrier',
+ select_key => 'carrierid',
+ select_label => 'carriername',
+ disable_inventory => 1,
+ },
+ 'sms_account' => { label => 'SMS Carrier Account', },
+ 'max_simultaneous' => { label=>'Maximum number of simultaneous users' },
'locationnum' => {
label => 'E911 location',
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
+ },
},
};
}
sub search_sql {
my( $class, $string ) = @_;
+ #my $conf = new FS::Conf;
+
if ( $conf->exists('svc_phone-allow_alpha_phonenum') ) {
$string =~ s/\W//g;
} else {
$string =~ s/\D//g;
}
- my $conf = new FS::Conf;
my $ccode = ( $conf->exists('default_phone_countrycode')
&& $conf->config('default_phone_countrycode')
)
#false laziness w/cust_pkg.pm... move this to location_Mixin? that would
#make it more of a base class than a mixin... :)
- if ( $options{'cust_location'}
- && ( ! $self->locationnum || $self->locationnum == -1 ) ) {
- my $error = $options{'cust_location'}->insert;
+ if ( $options{'cust_location'} ) {
+ my $error = $options{'cust_location'}->find_or_insert;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return "inserting cust_location (transaction rolled back): $error";
}
}
+ 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;
}
-# the delete method can be inherited from FS::Record
-
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
}
#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;
sub check {
my $self = shift;
- my $conf = new FS::Conf;
+ #my $conf = new FS::Conf;
+
+ my $x = $self->setfixed;
+ return $x unless ref($x);
+ my $part_svc = $x;
my $phonenum = $self->phonenum;
my $phonenum_check_method;
$self->ut_numbern('svcnum')
|| $self->ut_numbern('countrycode')
|| $self->$phonenum_check_method('phonenum')
+ || $self->ut_numbern('sim_imsi')
|| $self->ut_anything('sip_password')
|| $self->ut_numbern('pin')
|| $self->ut_textn('phone_name')
|| $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
|| $self->ut_foreign_keyn('domsvc', 'svc_domain', 'svcnum' )
+ || $self->ut_foreign_keyn('sms_carrierid', 'cdr_carrier', 'carrierid' )
+ || $self->ut_alphan('sms_account')
+ || $self->ut_numbern('max_simultaneous')
|| $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;
+ return 'Illegal IMSI (not 14-15 digits)' #shorter?
+ if length($self->sim_imsi)
+ && ( length($self->sim_imsi) < 14 || length($self->sim_imsi) > 15 );
+
+ # 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 ( defined($random_pin) && $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;
+
+ } elsif ( $part_svc->part_svc_column('sip_password')->columnflag ne 'F' ) {
+ # 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)) )
);
}
my $self = shift;
my %check = ();
- my $conf = new FS::Conf;
+ #my $conf = new FS::Conf;
- $check{'User-Password'} = $conf->config('svc_phone-radius-default_password');
+ my $password;
+ if ( $conf->config('svc_phone-radius-password') eq 'countrycode_phonenum' ) {
+ $password = $self->countrycode. $self->phonenum;
+ } else {
+ $password = $conf->config('svc_phone-radius-default_password');
+ }
+ $check{'User-Password'} = $password;
%check;
}
();
}
-=item phone_device
+=item sms_cdr_carrier
-Returns any FS::phone_device records associated with this service.
+=cut
+
+sub sms_cdr_carrier {
+ my $self = shift;
+ return '' unless $self->sms_carrierid;
+ qsearchs('cdr_carrier', { 'carrierid' => $self->sms_carrierid } );
+}
+
+=item sms_carriername
=cut
-sub phone_device {
+sub sms_carriername {
my $self = shift;
- qsearch('phone_device', { 'svcnum' => $self->svcnum } );
+ my $cdr_carrier = $self->sms_cdr_carrier or return '';
+ $cdr_carrier->carriername;
}
+=item phone_device
+
+Returns any FS::phone_device records associated with this service.
+
+=cut
+
#override location_Mixin version cause we want to try the cust_pkg location
#in between us and cust_main
# XXX what to do in the unlinked case??? return a pseudo-object that returns
$cust_pkg ? $cust_pkg->cust_location_or_main : '';
}
-=item get_cdrs
+=item psearch_cdrs OPTIONS
-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.
+Returns a paged search (L<FS::PagedSearch>) for Call Detail Records
+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. To access the CDRs themselves, call
+"->fetch" on the resulting object.
=over 2
=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.
=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.
+
+=item calltypenum: Only return CDRs with this call type.
+
=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
+=item billsec_sum: Instead of returning all of the CDRs, return a single
+record (as an L<FS::cdr> object) with the sum of the 'billsec' field over
+the entire result set.
+
=back
=cut
-sub get_cdrs {
+sub psearch_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";
+ 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'};
+ }
+ if ($options{'calltypenum'}) {
+ $hash{'calltypenum'} = $options{'calltypenum'};
+ }
my $for_update = $options{'for_update'} ? 'FOR UPDATE' : '';
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
}
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( {
+ psearch( {
'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' : '*',
+ } );
+}
+
+=item get_cdrs (DEPRECATED)
+
+Like psearch_cdrs, but returns all the L<FS::cdr> objects at once, in a
+single list. Arguments are the same as for psearch_cdrs. This can take
+an unreasonably large amount of memory and is best avoided.
+
+=cut
- @cdrs;
+sub get_cdrs {
+ my $self = shift;
+ my $psearch = $self->psearch_cdrs(@_);
+ qsearch ( $psearch->{query} )
+}
+
+=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.
+
+=cut
+
+sub sum_cdrs {
+ my $self = shift;
+ my $psearch = $self->psearch_cdrs(@_);
+ $psearch->{query}->{'select'} = join(',',
+ 'COUNT(*) AS count',
+ map { "SUM($_) AS $_" }
+ qw(duration billsec rated_price rated_seconds rated_minutes)
+ );
+ # hack
+ $psearch->{query}->{'extra_sql'} =~ s/ ORDER BY.*$//;
+ qsearchs ( $psearch->{query} );
}
=back
projects / freeside.git / blobdiff