X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fsvc_phone.pm;h=3cc1adc66769ac901d1ebb63c7bfad568f159a9b;hb=f6d64a9f735b666e876cf1a42e5ca16169ba7870;hp=a0a2c3effae10115db7bfed61ceaf2df7c880907;hpb=624b2d44625f69d71175c3348cae635d580c890b;p=freeside.git diff --git a/FS/FS/svc_phone.pm b/FS/FS/svc_phone.pm index a0a2c3eff..3cc1adc66 100644 --- a/FS/FS/svc_phone.pm +++ b/FS/FS/svc_phone.pm @@ -7,12 +7,14 @@ use Data::Dumper; use Scalar::Util qw( blessed ); 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; @@ -21,10 +23,11 @@ $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'); -}; +} +); =head1 NAME @@ -66,6 +69,10 @@ primary key =item phonenum +=item sim_imsi + +SIM IMSI (http://en.wikipedia.org/wiki/International_mobile_subscriber_identity) + =item sip_password =item pin @@ -78,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 @@ -96,19 +138,22 @@ points to. You can ask the object for a copy with the I 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', + '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, @@ -133,6 +178,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 + }, }, }; } @@ -150,13 +225,14 @@ Class method which returns an SQL fragment to search for the given string. 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') ) @@ -262,6 +338,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; @@ -320,6 +406,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; @@ -375,22 +472,60 @@ sub check { $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('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 ( $random_pin =~ /^\d+$/ ) { + $self->pin( + join('', map int(rand(10)), 0..($random_pin-1)) + ); + } + } + + unless ( length($self->sip_password) ) { # option for this? $self->sip_password( join('', map $pw_set[ int(rand $#pw_set) ], (0..16) ) @@ -525,11 +660,13 @@ sub cust_location_or_main { $cust_pkg ? $cust_pkg->cust_location_or_main : ''; } -=item get_cdrs +=item psearch_cdrs OPTIONS -Returns a set of Call Detail Records (see L) 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) 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 @@ -537,7 +674,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. @@ -545,43 +682,64 @@ 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 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' : ''; @@ -591,8 +749,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 } @@ -604,18 +762,58 @@ 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( { + 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 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. - @cdrs; +=cut + +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