X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fsvc_phone.pm;h=118748ea20926528aa4fe01924e415d6780dcbf3;hp=04d5960b72d943c6b8edbd5aba6190b8adca21fa;hb=1e14c5a832bbedde3dafa13fe9bd984b75a424db;hpb=3b268aa232236ad064c7b3f47a6a0a242e395bdf diff --git a/FS/FS/svc_phone.pm b/FS/FS/svc_phone.pm index 04d5960b7..118748ea2 100644 --- a/FS/FS/svc_phone.pm +++ b/FS/FS/svc_phone.pm @@ -1,11 +1,31 @@ package FS::svc_phone; use strict; -use vars qw( @ISA ); -#use FS::Record qw( qsearch qsearchs ); -use FS::svc_Common; - -@ISA = qw( FS::svc_Common ); +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 Data::Dumper; +use Scalar::Util qw( blessed ); +use FS::Conf; +use FS::Record qw( qsearch qsearchs dbh ); +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; + +#avoid l 1 and o O 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 { + $conf = new FS::Conf; + $phone_name_max = $conf->config('svc_phone-phone_name-max_length'); +}; =head1 NAME @@ -53,6 +73,47 @@ primary key Voicemail PIN +=item phone_name + +=item pbxsvc + +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 @@ -71,30 +132,83 @@ 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', + 'pin' => { label => 'Voicemail PIN', #'Personal Identification Number', type => 'text', disable_inventory => 1, disable_select => 1, }, 'sip_password' => 'SIP password', + 'phone_name' => 'Name', + 'pbxsvc' => { label => 'PBX', + type => 'select-svc_pbx.html', + disable_inventory => 1, + disable_select => 1, #UI wonky, pry works otherwise + }, + 'domsvc' => { + label => 'Domain', + type => 'select', + select_table => 'svc_domain', + select_key => 'svcnum', + select_label => 'domain', + disable_inventory => 1, + }, + '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 table { 'svc_phone'; } +sub table_dupcheck_fields { ( 'countrycode', 'phonenum' ); } + =item search_sql STRING Class method which returns an SQL fragment to search for the given string. @@ -103,6 +217,22 @@ Class method which returns an SQL fragment to search for the given string. sub search_sql { my( $class, $string ) = @_; + + 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') + ) + ? $conf->config('default_phone_countrycode') + : '1'; + + $string =~ s/^$ccode//; + $class->search_sql_field('phonenum', $string ); } @@ -114,17 +244,63 @@ Returns the phone number. sub label { my $self = shift; - $self->phonenum; #XXX format it better + my $phonenum = $self->phonenum; #XXX format it better + my $label = $phonenum; + $label .= '@'.$self->domain if $self->domsvc; + $label .= ' ('.$self->phone_name.')' if $self->phone_name; + $label; } =item insert -Adds this record to the database. If there is an error, returns the error, -otherwise returns false. +Adds this phone number to the database. If there is an error, returns the +error, otherwise returns false. =cut -# the insert method can be inherited from FS::Record +sub insert { + my $self = shift; + my %options = @_; + + if ( $DEBUG ) { + warn "[$me] insert called on $self: ". Dumper($self). + "\nwith options: ". Dumper(%options); + } + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + #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 ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "inserting cust_location (transaction rolled back): $error"; + } + $self->locationnum( $options{'cust_location'}->locationnum ); + } + #what about on-the-fly edits? if the ui supports it? + + my $error = $self->SUPER::insert(%options); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + ''; + +} =item delete @@ -132,6 +308,49 @@ Delete this record from the database. =cut +sub delete { + my $self = shift; + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + foreach my $phone_device ( $self->phone_device ) { + my $error = $phone_device->delete; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $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; + return $error; + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + ''; + +} + # the delete method can be inherited from FS::Record =item replace OLD_RECORD @@ -141,7 +360,64 @@ returns the error, otherwise returns false. =cut -# the replace method can be inherited from FS::Record +sub replace { + my $new = shift; + + my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') ) + ? shift + : $new->replace_old; + + my %options = @_; + + if ( $DEBUG ) { + warn "[$me] replacing $old with $new\n". + "\nwith options: ". Dumper(%options); + } + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + #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'} + && ( ! $new->locationnum || $new->locationnum == -1 ) ) { + my $error = $options{'cust_location'}->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "inserting cust_location (transaction rolled back): $error"; + } + $new->locationnum( $options{'cust_location'}->locationnum ); + } + #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; + return $error if $error; + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + ''; #no error +} =item suspend @@ -169,24 +445,145 @@ and replace methods. sub check { my $self = shift; + my $conf = new FS::Conf; + my $phonenum = $self->phonenum; - $phonenum =~ s/\D//g; + my $phonenum_check_method; + if ( $conf->exists('svc_phone-allow_alpha_phonenum') ) { + $phonenum =~ s/\W//g; + $phonenum_check_method = 'ut_alpha'; + } else { + $phonenum =~ s/\D//g; + $phonenum_check_method = 'ut_number'; + } $self->phonenum($phonenum); + $self->locationnum('') if !$self->locationnum || $self->locationnum == -1; + my $error = $self->ut_numbern('svcnum') || $self->ut_numbern('countrycode') - || $self->ut_number('phonenum') + || $self->$phonenum_check_method('phonenum') || $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; + # 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->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) ) + ); + + } + $self->SUPER::check; } +=item _check duplicate + +Internal method to check for duplicate phone numers. + +=cut + +#false laziness w/svc_acct.pm's _check_duplicate. +sub _check_duplicate { + my $self = shift; + + my $global_unique = $conf->config('global_unique-phonenum') || 'none'; + return '' if $global_unique eq 'disabled'; + + $self->lock_table; + + my @dup_ccphonenum = + grep { !$self->svcnum || $_->svcnum != $self->svcnum } + qsearch( 'svc_phone', { + 'countrycode' => $self->countrycode, + 'phonenum' => $self->phonenum, + }); + + return gettext('phonenum_in_use') + if $global_unique eq 'countrycode+phonenum' && @dup_ccphonenum; + + my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } ); + unless ( $part_svc ) { + return 'unknown svcpart '. $self->svcpart; + } + + if ( @dup_ccphonenum ) { + + my $exports = FS::part_export::export_info('svc_phone'); + my %conflict_ccphonenum_svcpart = ( $self->svcpart => 'SELF', ); + + foreach my $part_export ( $part_svc->part_export ) { + + #this will catch to the same exact export + my @svcparts = map { $_->svcpart } $part_export->export_svc; + + $conflict_ccphonenum_svcpart{$_} = $part_export->exportnum + foreach @svcparts; + + } + + foreach my $dup_ccphonenum ( @dup_ccphonenum ) { + my $dup_svcpart = $dup_ccphonenum->cust_svc->svcpart; + if ( exists($conflict_ccphonenum_svcpart{$dup_svcpart}) ) { + return "duplicate phone number ". + $self->countrycode. ' '. $self->phonenum. + ": conflicts with svcnum ". $dup_ccphonenum->svcnum. + " via exportnum ". $conflict_ccphonenum_svcpart{$dup_svcpart}; + } + } + + } + + return ''; + +} + =item check_pin Checks the supplied PIN against the PIN in the database. Returns true for a @@ -196,7 +593,161 @@ sucessful authentication, false if no match. sub check_pin { my($self, $check_pin) = @_; - $check_pin eq $self->pin; + length($self->pin) && $check_pin eq $self->pin; +} + +=item radius_reply + +=cut + +sub radius_reply { + my $self = shift; + #XXX Session-Timeout! holy shit, need rlm_perl to ask for this in realtime + (); +} + +=item radius_check + +=cut + +sub radius_check { + my $self = shift; + my %check = (); + + my $conf = new FS::Conf; + + $check{'User-Password'} = $conf->config('svc_phone-radius-default_password'); + + %check; +} + +sub radius_groups { + (); +} + +=item phone_device + +Returns any FS::phone_device records associated with this service. + +=cut + +sub phone_device { + my $self = shift; + qsearch('phone_device', { 'svcnum' => $self->svcnum } ); +} + +#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 +# empty fields? +sub cust_location_or_main { + my $self = shift; + return $self->cust_location if $self->locationnum; + my $cust_pkg = $self->cust_svc->cust_pkg; + $cust_pkg ? $cust_pkg->cust_location_or_main : ''; +} + +=item get_cdrs + +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. + +=over 2 + +Accepts the following options: + +=item for_update => 1: SELECT the CDRs "FOR UPDATE". + +=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 number. + +=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'}) ) { + 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 { + + @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' : ''; + + my $number = $self->phonenum; + + my $prefix = $options{'default_prefix'}; + + my @orwhere = map " $_ = '$number' ", @fields; + push @orwhere, map " $_ = '$prefix$number' ", @fields + if defined($prefix) && length($prefix); + if ( $prefix && $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