X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fsvc_phone.pm;h=30572ecc04ead09fe0572af5176d3b089add2fa5;hp=00ccc1958485f4e5c2b696c90a8d4499ba7bcbf9;hb=ad7f49821d40ffd099a45acc32ba91e0e211aede;hpb=c648976f0b7975f2328ebd7ba8c711fad0ca4195 diff --git a/FS/FS/svc_phone.pm b/FS/FS/svc_phone.pm index 00ccc1958..30572ecc0 100644 --- a/FS/FS/svc_phone.pm +++ b/FS/FS/svc_phone.pm @@ -1,11 +1,30 @@ 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; + +$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 @@ -39,13 +58,25 @@ from FS::Record. The following fields are currently supported: =over 4 -=item svcnum - primary key +=item svcnum + +primary key + +=item countrycode + +=item phonenum + +=item sip_password + +=item pin -=item countrycode - +Voicemail PIN -=item phonenum - +=item phone_name -=item pin - +=item pbxsvc + +Optional svcnum from svc_pbx =back @@ -71,16 +102,36 @@ sub table_info { 'display_weight' => 60, 'cancel_weight' => 80, 'fields' => { - 'countrycode' => { label => 'Country code', - type => 'text', - disable_inventory => 1, - disable_select => 1, - }, - 'phonenum' => 'Phone number', - 'pin' => { label => 'Personal Identification Number', - type => 'text', + 'countrycode' => { label => 'Country code', + type => 'text', + disable_inventory => 1, + disable_select => 1, + }, + 'phonenum' => 'Phone number', + 'pin' => { label => '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, + disable_select => 1, }, }, }; @@ -88,6 +139,8 @@ sub table_info { 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. @@ -96,6 +149,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 ); } @@ -107,17 +176,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 @@ -125,6 +240,39 @@ 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 $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 @@ -134,7 +282,53 @@ 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? + + 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 @@ -162,19 +356,175 @@ and replace methods. sub check { my $self = shift; + my $conf = new FS::Conf; + + my $phonenum = $self->phonenum; + 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') ; return $error if $error; + 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) ) { + + $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 +sucessful authentication, false if no match. + +=cut + +sub check_pin { + my($self, $check_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 : ''; +} + =back =head1 BUGS