2 use base qw( FS::svc_Domain_Mixin FS::svc_PBX_Mixin
3 FS::svc_CGP_Mixin FS::svc_CGPRule_Mixin
12 use vars qw( $DEBUG $me $conf $skip_fuzzyfiles
13 $dir_prefix @shells $usernamemin
14 $usernamemax $passwordmin $passwordmax
15 $username_ampersand $username_letter $username_letterfirst
16 $username_noperiod $username_nounderscore $username_nodash
17 $username_uppercase $username_percent $username_colon
18 $username_slash $username_equals $username_pound
20 $password_noampersand $password_noexclamation
23 $radius_password $radius_ip
26 use Scalar::Util qw( blessed );
31 use Crypt::PasswdMD5 1.2;
32 use Digest::SHA 'sha1_base64';
33 use Digest::MD5 'md5_base64';
36 use Authen::Passphrase;
37 use FS::UID qw( datasrc driver_name );
39 use FS::Record qw( qsearch qsearchs fields dbh dbdef );
40 use FS::Msgcat qw(gettext);
41 use FS::UI::bytecount;
43 use FS::PagedSearch qw( psearch ); # XXX in v4, replace with FS::Cursor
51 use FS::radius_usergroup;
61 $me = '[FS::svc_acct]';
63 #ask FS::UID to run this stuff for us later
64 FS::UID->install_callback( sub {
66 $dir_prefix = $conf->config('home');
67 @shells = $conf->config('shells');
68 $usernamemin = $conf->config('usernamemin') || 2;
69 $usernamemax = $conf->config('usernamemax');
70 $passwordmin = $conf->config('passwordmin'); # || 6;
72 $passwordmin = ( defined($passwordmin) && $passwordmin =~ /\d+/ )
75 $passwordmax = $conf->config('passwordmax') || 12;
76 $username_letter = $conf->exists('username-letter');
77 $username_letterfirst = $conf->exists('username-letterfirst');
78 $username_noperiod = $conf->exists('username-noperiod');
79 $username_nounderscore = $conf->exists('username-nounderscore');
80 $username_nodash = $conf->exists('username-nodash');
81 $username_uppercase = $conf->exists('username-uppercase');
82 $username_ampersand = $conf->exists('username-ampersand');
83 $username_percent = $conf->exists('username-percent');
84 $username_colon = $conf->exists('username-colon');
85 $username_slash = $conf->exists('username-slash');
86 $username_equals = $conf->exists('username-equals');
87 $username_pound = $conf->exists('username-pound');
88 $username_exclamation = $conf->exists('username-exclamation');
89 $password_noampersand = $conf->exists('password-noexclamation');
90 $password_noexclamation = $conf->exists('password-noexclamation');
91 $dirhash = $conf->config('dirhash') || 0;
92 $warning_msgnum = $conf->config('threshold_warning_msgnum');
93 $smtpmachine = $conf->config('smtpmachine');
94 $radius_password = $conf->config('radius-password') || 'Password';
95 $radius_ip = $conf->config('radius-ip') || 'Framed-IP-Address';
96 @pw_set = ( 'A'..'Z' ) if $conf->exists('password-generated-allcaps');
100 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
101 @pw_set = ( 'a'..'z', 'A'..'Z', '0'..'9', '(', ')', '#', '.', ',' );
105 my ( $hashref, $cache ) = @_;
106 if ( $hashref->{'svc_acct_svcnum'} ) {
107 $self->{'_domsvc'} = FS::svc_domain->new( {
108 'svcnum' => $hashref->{'domsvc'},
109 'domain' => $hashref->{'svc_acct_domain'},
110 'catchall' => $hashref->{'svc_acct_catchall'},
117 FS::svc_acct - Object methods for svc_acct records
123 $record = new FS::svc_acct \%hash;
124 $record = new FS::svc_acct { 'column' => 'value' };
126 $error = $record->insert;
128 $error = $new_record->replace($old_record);
130 $error = $record->delete;
132 $error = $record->check;
134 $error = $record->suspend;
136 $error = $record->unsuspend;
138 $error = $record->cancel;
140 %hash = $record->radius;
142 %hash = $record->radius_reply;
144 %hash = $record->radius_check;
146 $domain = $record->domain;
148 $svc_domain = $record->svc_domain;
150 $email = $record->email;
152 $seconds_since = $record->seconds_since($timestamp);
156 An FS::svc_acct object represents an account. FS::svc_acct inherits from
157 FS::svc_Common. The following fields are currently supported:
163 Primary key (assigned automatcially for new accounts)
171 =item _password_encoding
173 plain, crypt, ldap (or empty for autodetection)
181 Point of presence (see L<FS::svc_acct_pop>)
193 set automatically if blank (and uid is not)
213 svcnum from svc_domain
217 Optional svcnum from svc_pbx
219 =item radius_I<Radius_Attribute>
221 I<Radius-Attribute> (reply)
223 =item rc_I<Radius_Attribute>
225 I<Radius-Attribute> (check)
235 Creates a new account. To add the account to the database, see L<"insert">.
242 'longname_plural' => 'Access accounts and mailboxes',
243 'sorts' => [ 'username', 'uid', 'seconds', 'last_login' ],
244 'display_weight' => 10,
245 'cancel_weight' => 50,
246 'ip_field' => 'slipip',
247 'manual_require' => 1,
249 'dir' => 'Home directory',
252 def_info => 'set to fixed and blank for no UIDs',
255 'slipip' => 'IP address',
256 # 'popnum' => qq!<A HREF="$p/browse/svc_acct_pop.cgi/">POP number</A>!,
258 label => 'Access number',
260 select_table => 'svc_acct_pop',
261 select_key => 'popnum',
262 select_label => 'city',
268 disable_default => 1,
273 'password_selfchange' => { label => 'Password modification',
276 'password_recover' => { label => 'Password recovery',
280 label => 'Quota', #Mail storage limit
282 disable_inventory => 1,
285 label => 'File storage limit',
287 disable_inventory => 1,
290 label => 'Number of files limit',
292 disable_inventory => 1,
295 label => 'File size limit',
297 disable_inventory => 1,
299 '_password' => { label => 'Password',
304 def_info => 'when blank, defaults to UID',
309 def_info => 'set to blank for no shell tracking',
311 #select_list => [ $conf->config('shells') ],
312 select_list => [ $conf ? $conf->config('shells') : () ],
313 disable_inventory => 1,
316 'finger' => 'Real name', # (GECOS)',
320 select_table => 'svc_domain',
321 select_key => 'svcnum',
322 select_label => 'domain',
323 disable_inventory => 1,
326 'pbxsvc' => { label => 'PBX',
327 type => 'select-svc_pbx.html',
328 disable_inventory => 1,
329 disable_select => 1, #UI wonky, pry works otherwise
331 'sectornum' => 'Tower sector',
333 label => 'RADIUS groups',
334 type => 'select-radius_group.html',
335 disable_inventory => 1,
339 'seconds' => { label => 'Seconds',
340 label_sort => 'with Time Remaining',
342 disable_inventory => 1,
344 disable_part_svc_column => 1,
346 'upbytes' => { label => 'Upload',
348 disable_inventory => 1,
350 'format' => \&FS::UI::bytecount::display_bytecount,
351 'parse' => \&FS::UI::bytecount::parse_bytecount,
352 disable_part_svc_column => 1,
354 'downbytes' => { label => 'Download',
356 disable_inventory => 1,
358 'format' => \&FS::UI::bytecount::display_bytecount,
359 'parse' => \&FS::UI::bytecount::parse_bytecount,
360 disable_part_svc_column => 1,
362 'totalbytes'=> { label => 'Total up and download',
364 disable_inventory => 1,
366 'format' => \&FS::UI::bytecount::display_bytecount,
367 'parse' => \&FS::UI::bytecount::parse_bytecount,
368 disable_part_svc_column => 1,
370 'seconds_threshold' => { label => 'Seconds threshold',
372 disable_inventory => 1,
374 disable_part_svc_column => 1,
376 'upbytes_threshold' => { label => 'Upload threshold',
378 disable_inventory => 1,
380 'format' => \&FS::UI::bytecount::display_bytecount,
381 'parse' => \&FS::UI::bytecount::parse_bytecount,
382 disable_part_svc_column => 1,
384 'downbytes_threshold' => { label => 'Download threshold',
386 disable_inventory => 1,
388 'format' => \&FS::UI::bytecount::display_bytecount,
389 'parse' => \&FS::UI::bytecount::parse_bytecount,
390 disable_part_svc_column => 1,
392 'totalbytes_threshold'=> { label => 'Total up and download threshold',
394 disable_inventory => 1,
396 'format' => \&FS::UI::bytecount::display_bytecount,
397 'parse' => \&FS::UI::bytecount::parse_bytecount,
398 disable_part_svc_column => 1,
401 label => 'Last login',
405 label => 'Last logout',
410 label => 'Communigate aliases',
412 disable_inventory => 1,
417 label => 'Communigate account type',
419 select_list => [qw( MultiMailbox TextMailbox MailDirMailbox AGrade BGrade CGrade )],
420 disable_inventory => 1,
423 'cgp_accessmodes' => {
424 label => 'Communigate enabled services',
425 type => 'communigate_pro-accessmodes',
426 disable_inventory => 1,
429 'cgp_rulesallowed' => {
430 label => 'Allowed mail rules',
432 select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ],
433 disable_inventory => 1,
436 'cgp_rpopallowed' => { label => 'RPOP modifications',
439 'cgp_mailtoall' => { label => 'Accepts mail to "all"',
442 'cgp_addmailtrailer' => { label => 'Add trailer to sent mail',
445 'cgp_archiveafter' => {
446 label => 'Archive messages after',
449 -2 => 'default(730 days)',
456 1209600 => '2 weeks',
457 2592000 => '30 days',
458 7776000 => '90 days',
459 15552000 => '180 days',
460 31536000 => '365 days',
461 63072000 => '730 days',
463 disable_inventory => 1,
469 'cgp_deletemode' => {
470 label => 'Communigate message delete method',
472 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
473 disable_inventory => 1,
476 'cgp_emptytrash' => {
477 label => 'Communigate on logout remove trash',
479 select_list => __PACKAGE__->cgp_emptytrash_values,
480 disable_inventory => 1,
484 label => 'Communigate language',
486 select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ],
487 disable_inventory => 1,
491 label => 'Communigate time zone',
493 select_list => __PACKAGE__->cgp_timezone_values,
494 disable_inventory => 1,
498 label => 'Communigate layout',
500 select_list => [ '', '***', 'GoldFleece', 'Skin2' ],
501 disable_inventory => 1,
504 'cgp_prontoskinname' => {
505 label => 'Communigate Pronto style',
507 select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ],
508 disable_inventory => 1,
511 'cgp_sendmdnmode' => {
512 label => 'Communigate send read receipts',
514 select_list => [ '', 'Never', 'Manually', 'Automatically' ],
515 disable_inventory => 1,
526 sub table { 'svc_acct'; }
528 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
531 shift->_lastlog('in', @_);
535 shift->_lastlog('out', @_);
539 my( $self, $op, $time ) = @_;
541 if ( defined($time) ) {
542 warn "$me last_log$op called on svcnum ". $self->svcnum.
543 ' ('. $self->email. "): $time\n"
548 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
552 my $sth = $dbh->prepare( $sql )
553 or die "Error preparing $sql: ". $dbh->errstr;
554 my $rv = $sth->execute($time, $self->svcnum);
555 die "Error executing $sql: ". $sth->errstr
557 die "Can't update last_log$op for svcnum". $self->svcnum
560 $self->{'Hash'}->{"last_log$op"} = $time;
562 $self->getfield("last_log$op");
566 =item search_sql STRING
568 Class method which returns an SQL fragment to search for the given string.
573 my( $class, $string ) = @_;
574 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
575 my( $username, $domain ) = ( $1, $2 );
576 my $q_username = dbh->quote($username);
577 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
579 "svc_acct.username = $q_username AND ( ".
580 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
585 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
587 $class->search_sql_field('slipip', $string ).
589 $class->search_sql_field('username', $string ).
592 $class->search_sql_field('username', $string);
596 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
598 Returns the "username@domain" string for this account.
600 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
610 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
612 Returns a longer string label for this acccount ("Real Name <username@domain>"
613 if available, or "username@domain").
615 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
622 my $label = $self->label(@_);
623 my $finger = $self->finger;
624 return $label unless $finger =~ /\S/;
625 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
626 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
630 =item insert [ , OPTION => VALUE ... ]
632 Adds this account to the database. If there is an error, returns the error,
633 otherwise returns false.
635 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
636 defined. An FS::cust_svc record will be created and inserted.
638 The additional field I<usergroup> can optionally be defined; if so it should
639 contain an arrayref of group names. See L<FS::radius_usergroup>.
641 The additional field I<child_objects> can optionally be defined; if so it
642 should contain an arrayref of FS::tablename objects. They will have their
643 svcnum fields set and will be inserted after this record, but before any
644 exports are run. Each element of the array can also optionally be a
645 two-element array reference containing the child object and the name of an
646 alternate field to be filled in with the newly-inserted svcnum, for example
647 C<[ $svc_forward, 'srcsvc' ]>
649 Currently available options are: I<depend_jobnum>
651 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
652 jobnums), all provisioning jobs will have a dependancy on the supplied
653 jobnum(s) (they will not run until the specific job(s) complete(s)).
655 (TODOC: L<FS::queue> and L<freeside-queued>)
657 (TODOC: new exports!)
666 warn "[$me] insert called on $self: ". Dumper($self).
667 "\nwith options: ". Dumper(%options);
670 local $SIG{HUP} = 'IGNORE';
671 local $SIG{INT} = 'IGNORE';
672 local $SIG{QUIT} = 'IGNORE';
673 local $SIG{TERM} = 'IGNORE';
674 local $SIG{TSTP} = 'IGNORE';
675 local $SIG{PIPE} = 'IGNORE';
677 my $oldAutoCommit = $FS::UID::AutoCommit;
678 local $FS::UID::AutoCommit = 0;
682 my $error = $self->SUPER::insert( # usergroup is here
683 'jobnums' => \@jobnums,
684 'child_objects' => $self->child_objects,
688 $error ||= $self->insert_password_history;
691 $dbh->rollback if $oldAutoCommit;
695 unless ( $skip_fuzzyfiles ) {
696 $error = $self->queue_fuzzyfiles_update;
698 $dbh->rollback if $oldAutoCommit;
699 return "updating fuzzy search cache: $error";
703 my $cust_pkg = $self->cust_svc->cust_pkg;
706 my $cust_main = $cust_pkg->cust_main;
707 my $agentnum = $cust_main->agentnum;
709 if ( $conf->exists('emailinvoiceautoalways')
710 || $conf->exists('emailinvoiceauto')
711 && ! $cust_main->invoicing_list_emailonly
714 # slight false laziness w/ edit/process/cust_main.cgi...
715 # and also slightly arbitrary behavior.
717 # this will never happen but check it anyway
718 my ($contact) = map { $_->contact }
719 qsearch('contact_email', { emailaddress => $self->email });
722 # if the "real name" of this account matches the first + last name
723 # of a contact, attach the email address to that person.
724 my @contacts = map { $_->contact } $cust_main->cust_contact;
725 my $myname = $self->get('finger');
727 grep { $_->get('first') . ' ' . $_->get('last') eq $myname } @contacts;
728 # otherwise just pick the first one
729 $contact = $contacts[0];
732 $contact ||= FS::contact->new({
733 'custnum' => $cust_main->get('custnum'),
734 'locationnum' => $cust_main->get('bill_locationnum'),
735 'last' => $cust_main->get('last'),
736 'first' => $cust_main->get('first'),
738 $contact->set('emailaddress', $self->email);
739 $contact->set('invoice_dest', 'Y');
741 if ( $contact->get('contactnum') ) {
742 $error = $contact->replace;
744 $error = $contact->insert;
748 $dbh->rollback if $oldAutoCommit;
749 return "creating invoice destination contact: $error";
754 my @welcome_exclude_svcparts = $conf->config('svc_acct_welcome_exclude');
755 unless ( grep { $_ eq $self->svcpart } @welcome_exclude_svcparts ) {
757 my $msgnum = $conf->config('welcome_msgnum', $agentnum);
759 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
760 $error = $msg_template->send('cust_main' => $cust_main,
762 #should this do something on error?
767 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
771 # set usage fields and thresholds if unset but set in a package def
772 # AND the package already has a last bill date (otherwise they get double added)
773 sub preinsert_hook_first {
776 return '' unless $self->pkgnum;
778 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
779 return '' unless $cust_pkg && $cust_pkg->last_bill;
781 my $part_pkg = $cust_pkg->part_pkg;
782 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
784 my %values = $part_pkg->usage_valuehash;
785 my $multiplier = $conf->exists('svc_acct-usage_threshold')
786 ? 1 - $conf->config('svc_acct-usage_threshold')/100
787 : 0.20; #doesn't matter
789 foreach ( keys %values ) {
790 next if $self->getfield($_);
791 $self->setfield( $_, $values{$_} );
792 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
793 if $conf->exists('svc_acct-usage_threshold');
801 Deletes this account from the database. If there is an error, returns the
802 error, otherwise returns false.
804 The corresponding FS::cust_svc record will be deleted as well.
806 (TODOC: new exports!)
813 return "can't delete system account" if $self->_check_system;
815 return "Can't delete an account which is a (svc_forward) source!"
816 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
818 return "Can't delete an account which is a (svc_forward) destination!"
819 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
821 return "Can't delete an account with (svc_www) web service!"
822 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
824 # what about records in session ? (they should refer to history table)
826 local $SIG{HUP} = 'IGNORE';
827 local $SIG{INT} = 'IGNORE';
828 local $SIG{QUIT} = 'IGNORE';
829 local $SIG{TERM} = 'IGNORE';
830 local $SIG{TSTP} = 'IGNORE';
831 local $SIG{PIPE} = 'IGNORE';
833 my $oldAutoCommit = $FS::UID::AutoCommit;
834 local $FS::UID::AutoCommit = 0;
837 foreach my $svc_domain (
838 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
840 my %hash = new FS::svc_domain->hash;
841 $hash{'catchall'} = '';
842 my $new = new FS::svc_domain \%hash;
843 my $error = $new->replace($svc_domain);
845 $dbh->rollback if $oldAutoCommit;
850 my $error = $self->delete_password_history
851 || $self->SUPER::delete; # usergroup here
853 $dbh->rollback if $oldAutoCommit;
857 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
861 =item replace OLD_RECORD
863 Replaces OLD_RECORD with this one in the database. If there is an error,
864 returns the error, otherwise returns false.
866 The additional field I<usergroup> can optionally be defined; if so it should
867 contain an arrayref of group names. See L<FS::radius_usergroup>.
875 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
879 warn "$me replacing $old with $new\n" if $DEBUG;
883 return "can't modify system account" if $old->_check_system;
886 #no warnings 'numeric'; #alas, a 5.006-ism
889 foreach my $xid (qw( uid gid )) {
891 return "Can't change $xid!"
892 if ! $conf->exists("svc_acct-edit_$xid")
893 && $old->$xid() != $new->$xid()
894 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
899 return "can't change username"
900 if $old->username ne $new->username
901 && $conf->exists('svc_acct-no_edit_username');
903 #change homdir when we change username
904 $new->setfield('dir', '') if $old->username ne $new->username;
906 local $SIG{HUP} = 'IGNORE';
907 local $SIG{INT} = 'IGNORE';
908 local $SIG{QUIT} = 'IGNORE';
909 local $SIG{TERM} = 'IGNORE';
910 local $SIG{TSTP} = 'IGNORE';
911 local $SIG{PIPE} = 'IGNORE';
913 my $oldAutoCommit = $FS::UID::AutoCommit;
914 local $FS::UID::AutoCommit = 0;
917 $error = $new->SUPER::replace($old, @_); # usergroup here
919 # don't need to record this unless the password was changed
920 if ( $old->_password ne $new->_password ) {
921 $error ||= $new->insert_password_history;
925 $dbh->rollback if $oldAutoCommit;
926 return $error if $error;
929 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
930 $error = $new->queue_fuzzyfiles_update;
932 $dbh->rollback if $oldAutoCommit;
933 return "updating fuzzy search cache: $error";
937 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
941 =item queue_fuzzyfiles_update
943 Used by insert & replace to update the fuzzy search cache
947 sub queue_fuzzyfiles_update {
950 local $SIG{HUP} = 'IGNORE';
951 local $SIG{INT} = 'IGNORE';
952 local $SIG{QUIT} = 'IGNORE';
953 local $SIG{TERM} = 'IGNORE';
954 local $SIG{TSTP} = 'IGNORE';
955 local $SIG{PIPE} = 'IGNORE';
957 my $oldAutoCommit = $FS::UID::AutoCommit;
958 local $FS::UID::AutoCommit = 0;
961 my $queue = new FS::queue {
962 'svcnum' => $self->svcnum,
963 'job' => 'FS::svc_acct::append_fuzzyfiles'
965 my $error = $queue->insert($self->username);
967 $dbh->rollback if $oldAutoCommit;
968 return "queueing job (transaction rolled back): $error";
971 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
979 Suspends this account by calling export-specific suspend hooks. If there is
980 an error, returns the error, otherwise returns false.
982 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
988 return "can't suspend system account" if $self->_check_system;
989 $self->SUPER::suspend(@_);
994 Unsuspends this account by by calling export-specific suspend hooks. If there
995 is an error, returns the error, otherwise returns false.
997 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1003 my %hash = $self->hash;
1004 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1005 $hash{_password} = $1;
1006 my $new = new FS::svc_acct ( \%hash );
1007 my $error = $new->replace($self);
1008 return $error if $error;
1011 $self->SUPER::unsuspend(@_);
1016 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1018 If the B<auto_unset_catchall> configuration option is set, this method will
1019 automatically remove any references to the canceled service in the catchall
1020 field of svc_domain. This allows packages that contain both a svc_domain and
1021 its catchall svc_acct to be canceled in one step.
1026 # Only one thing to do at this level
1028 foreach my $svc_domain (
1029 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1030 if($conf->exists('auto_unset_catchall')) {
1031 my %hash = $svc_domain->hash;
1032 $hash{catchall} = '';
1033 my $new = new FS::svc_domain ( \%hash );
1034 my $error = $new->replace($svc_domain);
1035 return $error if $error;
1037 return "cannot unprovision svc_acct #".$self->svcnum.
1038 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1042 $self->SUPER::cancel(@_);
1048 Checks all fields to make sure this is a valid service. If there is an error,
1049 returns the error, otherwise returns false. Called by the insert and replace
1052 Sets any fixed values; see L<FS::part_svc>.
1059 my($recref) = $self->hashref;
1061 my $x = $self->setfixed;
1062 return $x unless ref($x);
1065 my $error = $self->ut_numbern('svcnum')
1066 #|| $self->ut_number('domsvc')
1067 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1068 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1069 || $self->ut_foreign_keyn('sectornum','tower_sector','sectornum')
1070 || $self->ut_foreign_keyn('routernum','router','routernum')
1071 || $self->ut_foreign_keyn('blocknum','addr_block','blocknum')
1072 || $self->ut_textn('sec_phrase')
1073 || $self->ut_snumbern('seconds')
1074 || $self->ut_snumbern('upbytes')
1075 || $self->ut_snumbern('downbytes')
1076 || $self->ut_snumbern('totalbytes')
1077 || $self->ut_snumbern('seconds_threshold')
1078 || $self->ut_snumbern('upbytes_threshold')
1079 || $self->ut_snumbern('downbytes_threshold')
1080 || $self->ut_snumbern('totalbytes_threshold')
1081 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1082 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1083 || $self->ut_enum('password_recover', [ '', 'Y' ])
1085 || $self->ut_anything('cf_privatekey')
1087 || $self->ut_textn('cgp_accessmodes')
1088 || $self->ut_alphan('cgp_type')
1089 || $self->ut_textn('cgp_aliases' ) #well
1091 || $self->ut_alphasn('cgp_rulesallowed')
1092 || $self->ut_enum('cgp_rpopallowed', [ '', 'Y' ])
1093 || $self->ut_enum('cgp_mailtoall', [ '', 'Y' ])
1094 || $self->ut_enum('cgp_addmailtrailer', [ '', 'Y' ])
1095 || $self->ut_snumbern('cgp_archiveafter')
1097 || $self->ut_alphasn('cgp_deletemode')
1098 || $self->ut_enum('cgp_emptytrash', $self->cgp_emptytrash_values)
1099 || $self->ut_alphan('cgp_language')
1100 || $self->ut_textn('cgp_timezone')
1101 || $self->ut_textn('cgp_skinname')
1102 || $self->ut_textn('cgp_prontoskinname')
1103 || $self->ut_alphan('cgp_sendmdnmode')
1105 return $error if $error;
1107 # assign IP address, etc.
1108 if ( $conf->exists('svc_acct-ip_addr') ) {
1109 my $error = $self->svc_ip_check;
1110 return $error if $error;
1111 } else { # I think this is correct
1112 $self->routernum('');
1113 $self->blocknum('');
1117 local $username_letter = $username_letter;
1118 local $username_uppercase = $username_uppercase;
1119 if ($self->svcnum) {
1120 my $cust_svc = $self->cust_svc
1121 or return "no cust_svc record found for svcnum ". $self->svcnum;
1122 my $cust_pkg = $cust_svc->cust_pkg;
1124 if ($self->pkgnum) {
1125 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1129 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1130 $username_uppercase =
1131 $conf->exists('username-uppercase', $cust_pkg->cust_main->agentnum);
1134 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1136 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:\/\=\#\!]{$usernamemin,$ulen})$/i
1137 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1138 $recref->{username} = $1;
1140 my $uerror = gettext('illegal_username'). ': '. $recref->{username};
1142 unless ( $username_uppercase ) {
1143 $recref->{username} =~ /[A-Z]/ and return $uerror;
1145 if ( $username_letterfirst ) {
1146 $recref->{username} =~ /^[a-z]/ or return $uerror;
1147 } elsif ( $username_letter ) {
1148 $recref->{username} =~ /[a-z]/ or return $uerror;
1150 if ( $username_noperiod ) {
1151 $recref->{username} =~ /\./ and return $uerror;
1153 if ( $username_nounderscore ) {
1154 $recref->{username} =~ /_/ and return $uerror;
1156 if ( $username_nodash ) {
1157 $recref->{username} =~ /\-/ and return $uerror;
1159 unless ( $username_ampersand ) {
1160 $recref->{username} =~ /\&/ and return $uerror;
1162 unless ( $username_percent ) {
1163 $recref->{username} =~ /\%/ and return $uerror;
1165 unless ( $username_colon ) {
1166 $recref->{username} =~ /\:/ and return $uerror;
1168 unless ( $username_slash ) {
1169 $recref->{username} =~ /\// and return $uerror;
1171 unless ( $username_equals ) {
1172 $recref->{username} =~ /\=/ and return $uerror;
1174 unless ( $username_pound ) {
1175 $recref->{username} =~ /\#/ and return $uerror;
1177 unless ( $username_exclamation ) {
1178 $recref->{username} =~ /\!/ and return $uerror;
1182 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1183 $recref->{popnum} = $1;
1184 return "Unknown popnum" unless
1185 ! $recref->{popnum} ||
1186 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1188 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1190 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1191 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1193 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1194 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1195 #not all systems use gid=uid
1196 #you can set a fixed gid in part_svc
1198 return "Only root can have uid 0"
1199 if $recref->{uid} == 0
1200 && $recref->{username} !~ /^(root|toor|smtp)$/;
1202 unless ( $recref->{username} eq 'sync' ) {
1203 if ( grep $_ eq $recref->{shell}, @shells ) {
1204 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1206 return "Illegal shell \`". $self->shell. "\'; ".
1207 "shells configuration value contains: @shells";
1210 $recref->{shell} = '/bin/sync';
1214 $recref->{gid} ne '' ?
1215 return "Can't have gid without uid" : ( $recref->{gid}='' );
1216 #$recref->{dir} ne '' ?
1217 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1218 $recref->{shell} ne '' ?
1219 return "Can't have shell without uid" : ( $recref->{shell}='' );
1222 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1224 $recref->{dir} =~ /^([\/\w\-\.\&\:\#]*)$/
1225 or return "Illegal directory: ". $recref->{dir};
1226 $recref->{dir} = $1;
1227 return "Illegal directory"
1228 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1229 return "Illegal directory"
1230 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1231 unless ( $recref->{dir} ) {
1232 $recref->{dir} = $dir_prefix . '/';
1233 if ( $dirhash > 0 ) {
1234 for my $h ( 1 .. $dirhash ) {
1235 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1237 } elsif ( $dirhash < 0 ) {
1238 for my $h ( reverse $dirhash .. -1 ) {
1239 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1242 $recref->{dir} .= $recref->{username};
1248 if ( $self->getfield('finger') eq '' ) {
1249 my $cust_pkg = $self->svcnum
1250 ? $self->cust_svc->cust_pkg
1251 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1253 my $cust_main = $cust_pkg->cust_main;
1254 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1257 # $error = $self->ut_textn('finger');
1258 # return $error if $error;
1259 $self->getfield('finger') =~ /^([\w \,\.\-\'\&\t\!\@\#\$\%\(\)\+\;\"\?\/\*\<\>]*)$/
1260 or return "Illegal finger: ". $self->getfield('finger');
1261 $self->setfield('finger', $1);
1263 for (qw( quota file_quota file_maxsize )) {
1264 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1267 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1268 $recref->{file_maxnum} = $1;
1270 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1271 if ( $recref->{slipip} eq '' ) {
1272 $recref->{slipip} = ''; # eh?
1273 } elsif ( $recref->{slipip} eq '0e0' ) {
1274 $recref->{slipip} = '0e0';
1276 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1277 or return "Illegal slipip: ". $self->slipip;
1278 $recref->{slipip} = $1;
1282 #arbitrary RADIUS stuff; allow ut_textn for now
1283 foreach ( grep /^radius_/, fields('svc_acct') ) {
1284 $self->ut_textn($_);
1287 # First, if _password is blank, generate one and set default encoding.
1288 if ( ! $recref->{_password} ) {
1289 $error = $self->set_password('');
1291 # But if there's a _password but no encoding, assume it's plaintext and
1292 # set it to default encoding.
1293 elsif ( ! $recref->{_password_encoding} ) {
1294 $error = $self->set_password($recref->{_password});
1296 return $error if $error;
1298 # Next, check _password to ensure compliance with the encoding.
1299 if ( $recref->{_password_encoding} eq 'ldap' ) {
1301 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1302 $recref->{_password} = uc($1).$2;
1304 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1307 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1309 if ( $recref->{_password} =~
1310 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1311 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1314 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1317 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1320 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1321 # Password randomization is now in set_password.
1322 # Strip whitespace characters, check length requirements, etc.
1323 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1324 $recref->{_password} = $1;
1326 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1327 FS::Msgcat::_gettext('illegal_password_characters').
1328 ": ". $recref->{_password};
1331 if ( $password_noampersand ) {
1332 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1334 if ( $password_noexclamation ) {
1335 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1339 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1342 $self->SUPER::check;
1347 sub _password_encryption {
1349 my $encoding = lc($self->_password_encoding);
1350 return if !$encoding;
1351 return 'plain' if $encoding eq 'plain';
1352 if($encoding eq 'crypt') {
1353 my $pass = $self->_password;
1354 $pass =~ s/^\*SUSPENDED\* //;
1356 return 'md5' if $pass =~ /^\$1\$/;
1357 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1358 return 'des' if length($pass) == 13;
1361 if($encoding eq 'ldap') {
1362 uc($self->_password) =~ /^\{([\w-]+)\}/;
1363 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1364 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1365 return 'md5' if $1 eq 'MD5';
1366 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1373 sub get_cleartext_password {
1375 if($self->_password_encryption eq 'plain') {
1376 if($self->_password_encoding eq 'ldap') {
1377 $self->_password =~ /\{\w+\}(.*)$/;
1381 return $self->_password;
1390 Set the cleartext password for the account. If _password_encoding is set, the
1391 new password will be encoded according to the existing method (including
1392 encryption mode, if it can be determined). Otherwise,
1393 config('default-password-encoding') is used.
1395 If no password is supplied (or a zero-length password when minimum password length
1396 is >0), one will be generated randomly.
1401 my( $self, $pass ) = ( shift, shift );
1403 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1406 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1407 FS::Msgcat::_gettext('illegal_password_characters').
1410 my( $encoding, $encryption ) = ('', '');
1412 if ( $self->_password_encoding ) {
1413 $encoding = $self->_password_encoding;
1414 # identify existing encryption method, try to use it.
1415 $encryption = $self->_password_encryption;
1417 # use the system default
1423 # set encoding to system default
1424 ($encoding, $encryption) =
1425 split(/-/, lc($conf->config('default-password-encoding') || ''));
1426 $encoding ||= 'legacy';
1427 $self->_password_encoding($encoding);
1430 if ( $encoding eq 'legacy' ) {
1432 # The legacy behavior from check():
1433 # If the password is blank, randomize it and set encoding to 'plain'.
1434 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1435 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1436 $self->_password_encoding('plain');
1438 # Prefix + valid-length password
1439 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1441 $self->_password_encoding('plain');
1442 # Prefix + crypt string
1443 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1445 $self->_password_encoding('crypt');
1446 # Various disabled crypt passwords
1447 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1448 $self->_password_encoding('crypt');
1454 $self->_password($pass);
1460 if $passwordmin && length($pass) < $passwordmin
1461 or $passwordmax && length($pass) > $passwordmax;
1463 if ( $encoding eq 'crypt' ) {
1464 if ($encryption eq 'md5') {
1465 $pass = unix_md5_crypt($pass);
1466 } elsif ($encryption eq 'des') {
1467 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1470 } elsif ( $encoding eq 'ldap' ) {
1471 if ($encryption eq 'md5') {
1472 $pass = md5_base64($pass);
1473 } elsif ($encryption eq 'sha1') {
1474 $pass = sha1_base64($pass);
1475 } elsif ($encryption eq 'crypt') {
1476 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1478 # else $encryption eq 'plain', do nothing
1479 $pass .= '=' x (4 - length($pass) % 4) #properly padded base64
1480 if $encryption eq 'md5' || $encryption eq 'sha1';
1481 $pass = '{'.uc($encryption).'}'.$pass;
1483 # else encoding eq 'plain'
1485 $self->_password($pass);
1491 Internal function to check the username against the list of system usernames
1492 from the I<system_usernames> configuration value. Returns true if the username
1493 is listed on the system username list.
1499 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1500 $conf->config('system_usernames')
1504 =item _check_duplicate
1506 Internal method to check for duplicates usernames, username@domain pairs and
1509 If the I<global_unique-username> configuration value is set to B<username> or
1510 B<username@domain>, enforces global username or username@domain uniqueness.
1512 In all cases, check for duplicate uids and usernames or username@domain pairs
1513 per export and with identical I<svcpart> values.
1517 sub _check_duplicate {
1520 my $global_unique = $conf->config('global_unique-username') || 'none';
1521 return '' if $global_unique eq 'disabled';
1525 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1526 unless ( $part_svc ) {
1527 return 'unknown svcpart '. $self->svcpart;
1530 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1531 qsearch( 'svc_acct', { 'username' => $self->username } );
1532 return gettext('username_in_use')
1533 if $global_unique eq 'username' && @dup_user;
1535 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1536 qsearch( 'svc_acct', { 'username' => $self->username,
1537 'domsvc' => $self->domsvc } );
1538 return gettext('username_in_use')
1539 if $global_unique eq 'username@domain' && @dup_userdomain;
1542 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1543 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1544 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1545 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1550 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1551 my $exports = FS::part_export::export_info('svc_acct');
1552 my %conflict_user_svcpart;
1553 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1555 foreach my $part_export ( $part_svc->part_export ) {
1557 #this will catch to the same exact export
1558 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1560 #this will catch to exports w/same exporthost+type ???
1561 #my @other_part_export = qsearch('part_export', {
1562 # 'machine' => $part_export->machine,
1563 # 'exporttype' => $part_export->exporttype,
1565 #foreach my $other_part_export ( @other_part_export ) {
1566 # push @svcparts, map { $_->svcpart }
1567 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1570 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1571 #silly kludge to avoid uninitialized value errors
1572 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1573 ? $exports->{$part_export->exporttype}{'nodomain'}
1575 if ( $nodomain =~ /^Y/i ) {
1576 $conflict_user_svcpart{$_} = $part_export->exportnum
1579 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1584 foreach my $dup_user ( @dup_user ) {
1585 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1586 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1587 return "duplicate username ". $self->username.
1588 ": conflicts with svcnum ". $dup_user->svcnum.
1589 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1593 foreach my $dup_userdomain ( @dup_userdomain ) {
1594 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1595 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1596 return "duplicate username\@domain ". $self->email.
1597 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1598 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1602 foreach my $dup_uid ( @dup_uid ) {
1603 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1604 if ( exists($conflict_user_svcpart{$dup_svcpart})
1605 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1606 return "duplicate uid ". $self->uid.
1607 ": conflicts with svcnum ". $dup_uid->svcnum.
1609 ( $conflict_user_svcpart{$dup_svcpart}
1610 || $conflict_userdomain_svcpart{$dup_svcpart} );
1622 Depriciated, use radius_reply instead.
1627 carp "FS::svc_acct::radius depriciated, use radius_reply";
1628 $_[0]->radius_reply;
1633 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1634 reply attributes of this record.
1636 Note that this is now the preferred method for reading RADIUS attributes -
1637 accessing the columns directly is discouraged, as the column names are
1638 expected to change in the future.
1645 return %{ $self->{'radius_reply'} }
1646 if exists $self->{'radius_reply'};
1651 my($column, $attrib) = ($1, $2);
1652 #$attrib =~ s/_/\-/g;
1653 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1654 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1656 if ( $self->slipip && $self->slipip ne '0e0' ) {
1657 $reply{$radius_ip} = $self->slipip;
1660 if ( $self->seconds !~ /^$/ ) {
1661 $reply{'Session-Timeout'} = $self->seconds;
1664 if ( $conf->exists('radius-chillispot-max') ) {
1665 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1667 #hmm. just because sqlradius.pm says so?
1674 foreach my $what (qw( input output total )) {
1675 my $is = $whatis{$what}.'bytes';
1676 if ( $self->$is() =~ /\d/ ) {
1677 my $big = new Math::BigInt $self->$is();
1678 $big = new Math::BigInt '0' if $big->is_neg();
1679 my $att = "Chillispot-Max-\u$what";
1680 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1681 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1692 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1693 check attributes of this record.
1695 Note that this is now the preferred method for reading RADIUS attributes -
1696 accessing the columns directly is discouraged, as the column names are
1697 expected to change in the future.
1704 return %{ $self->{'radius_check'} }
1705 if exists $self->{'radius_check'};
1710 my($column, $attrib) = ($1, $2);
1711 #$attrib =~ s/_/\-/g;
1712 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1713 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1716 my($pw_attrib, $password) = $self->radius_password;
1717 $check{$pw_attrib} = $password;
1719 my $cust_svc = $self->cust_svc;
1721 my $cust_pkg = $cust_svc->cust_pkg;
1722 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1723 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1726 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1727 "; can't set Expiration\n"
1735 =item radius_password
1737 Returns a key/value pair containing the RADIUS attribute name and value
1742 sub radius_password {
1746 if ( $self->_password_encoding eq 'ldap' ) {
1747 $pw_attrib = 'Password-With-Header';
1748 } elsif ( $self->_password_encoding eq 'crypt' ) {
1749 $pw_attrib = 'Crypt-Password';
1750 } elsif ( $self->_password_encoding eq 'plain' ) {
1751 $pw_attrib = $radius_password;
1753 $pw_attrib = length($self->_password) <= 12
1758 ($pw_attrib, $self->_password);
1764 This method instructs the object to "snapshot" or freeze RADIUS check and
1765 reply attributes to the current values.
1769 #bah, my english is too broken this morning
1770 #Of note is the "Expiration" attribute, which, for accounts in prepaid packages, is typically defined on-the-fly as the associated packages cust_pkg.bill. (This is used by
1771 #the FS::cust_pkg's replace method to trigger the correct export updates when
1772 #package dates change)
1777 $self->{$_} = { $self->$_() }
1778 foreach qw( radius_reply radius_check );
1782 =item forget_snapshot
1784 This methos instructs the object to forget any previously snapshotted
1785 RADIUS check and reply attributes.
1789 sub forget_snapshot {
1793 foreach qw( radius_reply radius_check );
1797 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1799 Returns the domain associated with this account.
1801 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1808 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1809 my $svc_domain = $self->svc_domain(@_)
1810 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1811 $svc_domain->domain;
1816 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1820 #inherited from svc_Common
1822 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1824 Returns an email address associated with the account.
1826 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1833 $self->username. '@'. $self->domain(@_);
1839 Returns an array of FS::acct_snarf records associated with the account.
1843 # unused as originally intended, but now by Communigate Pro "RPOP"
1845 =item cgp_rpop_hashref
1847 Returns an arrayref of RPOP data suitable for Communigate Pro API commands.
1851 sub cgp_rpop_hashref {
1853 { map { $_->snarfname => $_->cgp_hashref } $self->acct_snarf };
1856 =item decrement_upbytes OCTETS
1858 Decrements the I<upbytes> field of this record by the given amount. If there
1859 is an error, returns the error, otherwise returns false.
1863 sub decrement_upbytes {
1864 shift->_op_usage('-', 'upbytes', @_);
1867 =item increment_upbytes OCTETS
1869 Increments the I<upbytes> field of this record by the given amount. If there
1870 is an error, returns the error, otherwise returns false.
1874 sub increment_upbytes {
1875 shift->_op_usage('+', 'upbytes', @_);
1878 =item decrement_downbytes OCTETS
1880 Decrements the I<downbytes> field of this record by the given amount. If there
1881 is an error, returns the error, otherwise returns false.
1885 sub decrement_downbytes {
1886 shift->_op_usage('-', 'downbytes', @_);
1889 =item increment_downbytes OCTETS
1891 Increments the I<downbytes> field of this record by the given amount. If there
1892 is an error, returns the error, otherwise returns false.
1896 sub increment_downbytes {
1897 shift->_op_usage('+', 'downbytes', @_);
1900 =item decrement_totalbytes OCTETS
1902 Decrements the I<totalbytes> field of this record by the given amount. If there
1903 is an error, returns the error, otherwise returns false.
1907 sub decrement_totalbytes {
1908 shift->_op_usage('-', 'totalbytes', @_);
1911 =item increment_totalbytes OCTETS
1913 Increments the I<totalbytes> field of this record by the given amount. If there
1914 is an error, returns the error, otherwise returns false.
1918 sub increment_totalbytes {
1919 shift->_op_usage('+', 'totalbytes', @_);
1922 =item decrement_seconds SECONDS
1924 Decrements the I<seconds> field of this record by the given amount. If there
1925 is an error, returns the error, otherwise returns false.
1929 sub decrement_seconds {
1930 shift->_op_usage('-', 'seconds', @_);
1933 =item increment_seconds SECONDS
1935 Increments the I<seconds> field of this record by the given amount. If there
1936 is an error, returns the error, otherwise returns false.
1940 sub increment_seconds {
1941 shift->_op_usage('+', 'seconds', @_);
1949 my %op2condition = (
1950 '-' => sub { my($self, $column, $amount) = @_;
1951 $self->$column - $amount <= 0;
1953 '+' => sub { my($self, $column, $amount) = @_;
1954 ($self->$column || 0) + $amount > 0;
1957 my %op2warncondition = (
1958 '-' => sub { my($self, $column, $amount) = @_;
1959 my $threshold = $column . '_threshold';
1960 $self->$column - $amount <= $self->$threshold + 0;
1962 '+' => sub { my($self, $column, $amount) = @_;
1963 ($self->$column || 0) + $amount > 0;
1968 my( $self, $op, $column, $amount ) = @_;
1970 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
1971 ' ('. $self->email. "): $op $amount\n"
1974 return '' unless $amount;
1976 local $SIG{HUP} = 'IGNORE';
1977 local $SIG{INT} = 'IGNORE';
1978 local $SIG{QUIT} = 'IGNORE';
1979 local $SIG{TERM} = 'IGNORE';
1980 local $SIG{TSTP} = 'IGNORE';
1981 local $SIG{PIPE} = 'IGNORE';
1983 my $oldAutoCommit = $FS::UID::AutoCommit;
1984 local $FS::UID::AutoCommit = 0;
1987 my $sql = "UPDATE svc_acct SET $column = ".
1988 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
1989 " $op ? WHERE svcnum = ?";
1993 my $sth = $dbh->prepare( $sql )
1994 or die "Error preparing $sql: ". $dbh->errstr;
1995 my $rv = $sth->execute($amount, $self->svcnum);
1996 die "Error executing $sql: ". $sth->errstr
1997 unless defined($rv);
1998 die "Can't update $column for svcnum". $self->svcnum
2001 #$self->snapshot; #not necessary, we retain the old values
2002 #create an object with the updated usage values
2003 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2005 my $error = $new->replace($self);
2007 $dbh->rollback if $oldAutoCommit;
2008 return "Error replacing: $error";
2011 #overlimit_action eq 'cancel' handling
2012 my $cust_pkg = $self->cust_svc->cust_pkg;
2014 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2015 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2019 my $error = $cust_pkg->cancel; #XXX should have a reason
2021 $dbh->rollback if $oldAutoCommit;
2022 return "Error cancelling: $error";
2025 #nothing else is relevant if we're cancelling, so commit & return success
2026 warn "$me update successful; committing\n"
2028 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2033 my $action = $op2action{$op};
2035 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2036 ( $action eq 'suspend' && !$self->overlimit
2037 || $action eq 'unsuspend' && $self->overlimit )
2040 my $error = $self->_op_overlimit($action);
2042 $dbh->rollback if $oldAutoCommit;
2048 if ( $conf->exists("svc_acct-usage_$action")
2049 && &{$op2condition{$op}}($self, $column, $amount) ) {
2050 #my $error = $self->$action();
2051 my $error = $self->cust_svc->cust_pkg->$action();
2052 # $error ||= $self->overlimit($action);
2054 $dbh->rollback if $oldAutoCommit;
2055 return "Error ${action}ing: $error";
2059 if ($warning_msgnum && &{$op2warncondition{$op}}($self, $column, $amount)) {
2060 my $wqueue = new FS::queue {
2061 'svcnum' => $self->svcnum,
2062 'job' => 'FS::svc_acct::reached_threshold',
2066 my $error = $wqueue->insert(
2067 'svcnum' => $self->svcnum,
2072 $dbh->rollback if $oldAutoCommit;
2073 return "Error queuing threshold activity: $error";
2077 warn "$me update successful; committing\n"
2079 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2085 my( $self, $action ) = @_;
2087 local $SIG{HUP} = 'IGNORE';
2088 local $SIG{INT} = 'IGNORE';
2089 local $SIG{QUIT} = 'IGNORE';
2090 local $SIG{TERM} = 'IGNORE';
2091 local $SIG{TSTP} = 'IGNORE';
2092 local $SIG{PIPE} = 'IGNORE';
2094 my $oldAutoCommit = $FS::UID::AutoCommit;
2095 local $FS::UID::AutoCommit = 0;
2098 my $cust_pkg = $self->cust_svc->cust_pkg;
2100 my @conf_overlimit =
2102 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2103 : $conf->config('overlimit_groups');
2105 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2107 my @groups = scalar(@conf_overlimit) ? @conf_overlimit
2108 : split(' ',$part_export->option('overlimit_groups'));
2109 next unless scalar(@groups);
2111 my $other = new FS::svc_acct $self->hashref;
2112 $other->usergroup(\@groups);
2115 if ($action eq 'suspend') {
2118 } else { # $action eq 'unsuspend'
2123 my $error = $part_export->export_replace($new, $old)
2124 || $self->overlimit($action);
2127 $dbh->rollback if $oldAutoCommit;
2128 return "Error replacing radius groups: $error";
2133 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2139 my( $self, $valueref, %options ) = @_;
2141 warn "$me set_usage called for svcnum ". $self->svcnum.
2142 ' ('. $self->email. "): ".
2143 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2146 local $SIG{HUP} = 'IGNORE';
2147 local $SIG{INT} = 'IGNORE';
2148 local $SIG{QUIT} = 'IGNORE';
2149 local $SIG{TERM} = 'IGNORE';
2150 local $SIG{TSTP} = 'IGNORE';
2151 local $SIG{PIPE} = 'IGNORE';
2153 local $FS::svc_Common::noexport_hack = 1;
2154 my $oldAutoCommit = $FS::UID::AutoCommit;
2155 local $FS::UID::AutoCommit = 0;
2160 if ( $options{null} ) {
2161 %handyhash = ( map { ( $_ => undef, $_."_threshold" => undef ) }
2162 qw( seconds upbytes downbytes totalbytes )
2165 foreach my $field (keys %$valueref){
2166 $reset = 1 if $valueref->{$field};
2167 $self->setfield($field, $valueref->{$field});
2168 $self->setfield( $field.'_threshold',
2169 int($self->getfield($field)
2170 * ( $conf->exists('svc_acct-usage_threshold')
2171 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2176 $handyhash{$field} = $self->getfield($field);
2177 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2179 #my $error = $self->replace; #NO! we avoid the call to ->check for
2180 #die $error if $error; #services not explicity changed via the UI
2182 my $sql = "UPDATE svc_acct SET " .
2183 join (',', map { "$_ = ?" } (keys %handyhash) ).
2184 " WHERE svcnum = ". $self->svcnum;
2189 if (scalar(keys %handyhash)) {
2190 my $sth = $dbh->prepare( $sql )
2191 or die "Error preparing $sql: ". $dbh->errstr;
2192 my $rv = $sth->execute(values %handyhash);
2193 die "Error executing $sql: ". $sth->errstr
2194 unless defined($rv);
2195 die "Can't update usage for svcnum ". $self->svcnum
2199 #$self->snapshot; #not necessary, we retain the old values
2200 #create an object with the updated usage values
2201 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2202 local($FS::Record::nowarn_identical) = 1;
2203 my $error = $new->replace($self); #call exports
2205 $dbh->rollback if $oldAutoCommit;
2206 return "Error replacing: $error";
2213 $error = $self->_op_overlimit('unsuspend')
2214 if $self->overlimit;;
2216 $error ||= $self->cust_svc->cust_pkg->unsuspend
2217 if $conf->exists("svc_acct-usage_unsuspend");
2220 $dbh->rollback if $oldAutoCommit;
2221 return "Error unsuspending: $error";
2226 warn "$me update successful; committing\n"
2228 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2234 =item recharge HASHREF
2236 Increments usage columns by the amount specified in HASHREF as
2237 column=>amount pairs.
2242 my ($self, $vhash) = @_;
2245 warn "[$me] recharge called on $self: ". Dumper($self).
2246 "\nwith vhash: ". Dumper($vhash);
2249 my $oldAutoCommit = $FS::UID::AutoCommit;
2250 local $FS::UID::AutoCommit = 0;
2254 foreach my $column (keys %$vhash){
2255 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2259 $dbh->rollback if $oldAutoCommit;
2261 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2266 =item is_rechargeable
2268 Returns true if this svc_account can be "recharged" and false otherwise.
2272 sub is_rechargable {
2274 $self->seconds ne ''
2275 || $self->upbytes ne ''
2276 || $self->downbytes ne ''
2277 || $self->totalbytes ne '';
2280 =item seconds_since TIMESTAMP
2282 Returns the number of seconds this account has been online since TIMESTAMP,
2283 according to the session monitor (see L<FS::Session>).
2285 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2286 L<Time::Local> and L<Date::Parse> for conversion functions.
2290 #note: POD here, implementation in FS::cust_svc
2293 $self->cust_svc->seconds_since(@_);
2296 =item last_login_text
2298 Returns text describing the time of last login.
2302 sub last_login_text {
2304 $self->last_login ? ctime($self->last_login) : 'unknown';
2307 =item psearch_cdrs OPTIONS
2309 Returns a paged search (L<FS::PagedSearch>) for Call Detail Records
2310 associated with this service. For svc_acct, "associated with" means that
2311 either the "src" or the "charged_party" field of the CDR matches the
2312 "username" field of the service.
2317 my($self, %options) = @_;
2322 my $did = dbh->quote($self->username);
2324 my $prefix = $options{'default_prefix'} || ''; #convergent.au '+61'
2325 my $prefixdid = dbh->quote($prefix . $self->username);
2327 my $for_update = $options{'for_update'} ? 'FOR UPDATE' : '';
2329 if ( $options{inbound} ) {
2330 # these will be selected under their DIDs
2331 push @where, "FALSE";
2335 if (!$options{'disable_charged_party'}) {
2337 "charged_party = $did",
2338 "charged_party = $prefixdid";
2340 if (!$options{'disable_src'}) {
2342 "src = $did AND charged_party IS NULL",
2343 "src = $prefixdid AND charged_party IS NULL";
2345 push @where, '(' . join(' OR ', @orwhere) . ')';
2347 # $options{'status'} = '' is meaningful; for the rest of them it's not
2348 if ( exists $options{'status'} ) {
2349 $hash{'freesidestatus'} = $options{'status'};
2351 if ( $options{'cdrtypenum'} ) {
2352 $hash{'cdrtypenum'} = $options{'cdrtypenum'};
2354 if ( $options{'calltypenum'} ) {
2355 $hash{'calltypenum'} = $options{'calltypenum'};
2357 if ( $options{'begin'} ) {
2358 push @where, 'startdate >= '. $options{'begin'};
2360 if ( $options{'end'} ) {
2361 push @where, 'startdate < '. $options{'end'};
2363 if ( $options{'nonzero'} ) {
2364 push @where, 'duration > 0';
2367 my $extra_sql = join(' AND ', @where);
2370 $extra_sql = " AND ".$extra_sql;
2372 $extra_sql = " WHERE ".$extra_sql;
2378 'hashref' => \%hash,
2379 'extra_sql' => $extra_sql,
2380 'order_by' => "ORDER BY startdate $for_update",
2384 =item get_cdrs (DEPRECATED)
2386 Like psearch_cdrs, but returns all the L<FS::cdr> objects at once, in a
2387 single list. Arguments are the same as for psearch_cdrs.
2393 my $psearch = $self->psearch_cdrs(@_);
2394 qsearch ( $psearch->{query} )
2397 # sub radius_groups has moved to svc_Radius_Mixin
2399 =item clone_suspended
2401 Constructor used by FS::part_export::_export_suspend fallback. Document
2406 sub clone_suspended {
2408 my %hash = $self->hash;
2409 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2410 new FS::svc_acct \%hash;
2413 =item clone_kludge_unsuspend
2415 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2420 sub clone_kludge_unsuspend {
2422 my %hash = $self->hash;
2423 $hash{_password} = '';
2424 new FS::svc_acct \%hash;
2427 =item check_password
2429 Checks the supplied password against the (possibly encrypted) password in the
2430 database. Returns true for a successful authentication, false for no match.
2432 Currently supported encryptions are: classic DES crypt() and MD5
2436 sub check_password {
2437 my($self, $check_password) = @_;
2439 #remove old-style SUSPENDED kludge, they should be allowed to login to
2440 #self-service and pay up
2441 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2443 if ( $self->_password_encoding eq 'ldap' ) {
2445 $password =~ s/^{PLAIN}/{CLEARTEXT}/;
2446 my $auth = from_rfc2307 Authen::Passphrase $password;
2447 return $auth->match($check_password);
2449 } elsif ( $self->_password_encoding eq 'crypt' ) {
2451 my $auth = from_crypt Authen::Passphrase $self->_password;
2452 return $auth->match($check_password);
2454 } elsif ( $self->_password_encoding eq 'plain' ) {
2456 return $check_password eq $password;
2460 #XXX this could be replaced with Authen::Passphrase stuff
2462 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2464 } elsif ( length($password) < 13 ) { #plaintext
2465 $check_password eq $password;
2466 } elsif ( length($password) == 13 ) { #traditional DES crypt
2467 crypt($check_password, $password) eq $password;
2468 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2469 unix_md5_crypt($check_password, $password) eq $password;
2470 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2471 warn "Can't check password: Blowfish encryption not yet supported, ".
2472 "svcnum ". $self->svcnum. "\n";
2475 warn "Can't check password: Unrecognized encryption for svcnum ".
2476 $self->svcnum. "\n";
2484 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2486 Returns an encrypted password, either by passing through an encrypted password
2487 in the database or by encrypting a plaintext password from the database.
2489 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2490 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2491 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2492 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2493 encryption type is only used if the password is not already encrypted in the
2498 sub crypt_password {
2501 if ( $self->_password_encoding eq 'ldap' ) {
2503 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2506 #XXX this could be replaced with Authen::Passphrase stuff
2508 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2509 if ( $encryption eq 'crypt' ) {
2512 $saltset[int(rand(64))].$saltset[int(rand(64))]
2514 } elsif ( $encryption eq 'md5' ) {
2515 return unix_md5_crypt( $self->_password );
2516 } elsif ( $encryption eq 'blowfish' ) {
2517 croak "unknown encryption method $encryption";
2519 croak "unknown encryption method $encryption";
2522 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2526 } elsif ( $self->_password_encoding eq 'crypt' ) {
2528 return $self->_password;
2530 } elsif ( $self->_password_encoding eq 'plain' ) {
2532 #XXX this could be replaced with Authen::Passphrase stuff
2534 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2535 if ( $encryption eq 'crypt' ) {
2538 $saltset[int(rand(64))].$saltset[int(rand(64))]
2540 } elsif ( $encryption eq 'md5' ) {
2541 return unix_md5_crypt( $self->_password );
2542 } elsif ( $encryption eq 'sha1_base64' ) { #for acct_sql
2543 my $pass = sha1_base64( $self->_password );
2544 $pass .= '=' x (4 - length($pass) % 4); #properly padded base64
2546 } elsif ( $encryption eq 'blowfish' ) {
2547 croak "unknown encryption method $encryption";
2549 croak "unknown encryption method $encryption";
2554 if ( length($self->_password) == 13
2555 || $self->_password =~ /^\$(1|2a?)\$/
2556 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2562 #XXX this could be replaced with Authen::Passphrase stuff
2564 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2565 if ( $encryption eq 'crypt' ) {
2568 $saltset[int(rand(64))].$saltset[int(rand(64))]
2570 } elsif ( $encryption eq 'md5' ) {
2571 return unix_md5_crypt( $self->_password );
2572 } elsif ( $encryption eq 'blowfish' ) {
2573 croak "unknown encryption method $encryption";
2575 croak "unknown encryption method $encryption";
2584 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2586 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2587 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2588 "{MD5}5426824942db4253f87a1009fd5d2d4".
2590 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2591 to work the same as the B</crypt_password> method.
2597 #eventually should check a "password-encoding" field
2599 if ( $self->_password_encoding eq 'ldap' ) {
2601 return $self->_password;
2603 } elsif ( $self->_password_encoding eq 'crypt' ) {
2605 if ( length($self->_password) == 13 ) { #crypt
2606 return '{CRYPT}'. $self->_password;
2607 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2609 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2610 # die "Blowfish encryption not supported in this context, svcnum ".
2611 # $self->svcnum. "\n";
2613 warn "encryption method not (yet?) supported in LDAP context";
2614 return '{CRYPT}*'; #unsupported, should not auth
2617 } elsif ( $self->_password_encoding eq 'plain' ) {
2619 return '{PLAIN}'. $self->_password;
2621 #return '{CLEARTEXT}'. $self->_password; #?
2625 if ( length($self->_password) == 13 ) { #crypt
2626 return '{CRYPT}'. $self->_password;
2627 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2629 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2630 warn "Blowfish encryption not supported in this context, svcnum ".
2631 $self->svcnum. "\n";
2634 #are these two necessary anymore?
2635 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2636 return '{SSHA}'. $1;
2637 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2638 return '{NS-MTA-MD5}'. $1;
2641 return '{PLAIN}'. $self->_password;
2643 #return '{CLEARTEXT}'. $self->_password; #?
2645 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2646 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2647 #if ( $encryption eq 'crypt' ) {
2648 # return '{CRYPT}'. crypt(
2650 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2652 #} elsif ( $encryption eq 'md5' ) {
2653 # unix_md5_crypt( $self->_password );
2654 #} elsif ( $encryption eq 'blowfish' ) {
2655 # croak "unknown encryption method $encryption";
2657 # croak "unknown encryption method $encryption";
2665 =item domain_slash_username
2667 Returns $domain/$username/
2671 sub domain_slash_username {
2673 $self->domain. '/'. $self->username. '/';
2676 =item virtual_maildir
2678 Returns $domain/maildirs/$username/
2682 sub virtual_maildir {
2684 $self->domain. '/maildirs/'. $self->username. '/';
2687 =item password_svc_check
2689 Override, for L<FS::Password_Mixin>. Not really intended for other use.
2693 sub password_svc_check {
2694 my ($self, $password) = @_;
2695 foreach my $field ( qw(username finger) ) {
2696 foreach my $word (split(/\W+/,$self->get($field))) {
2697 next unless length($word) > 2;
2698 if ($password =~ /$word/i) {
2699 return qq(Password contains account information '$word');
2708 =head1 CLASS METHODS
2712 =item search HASHREF
2714 Class method which returns a qsearch hash expression to search for parameters
2715 specified in HASHREF. Valid parameters are
2729 Arrayref of pkgparts
2735 Arrayref of additional WHERE clauses, will be ANDed together.
2746 my( $class, $params, $from, $where ) = @_;
2748 #these two should probably move to svc_Domain_Mixin ?
2751 if ( $params->{'domain'} ) {
2752 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2753 #preserve previous behavior & bubble up an error if $svc_domain not found?
2754 push @$where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2758 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2759 push @$where, "domsvc = $1";
2764 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2765 push @$where, "popnum = $1";
2769 #and these in svc_Tower_Mixin, or maybe we never should have done svc_acct
2770 # towers (or, as mark thought, never should have done svc_broadband)
2773 my @where_sector = $class->tower_sector_sql($params);
2774 if ( @where_sector ) {
2775 push @$where, @where_sector;
2776 push @$from, ' LEFT JOIN tower_sector USING ( sectornum )';
2787 =item check_and_rebuild_fuzzyfiles
2791 sub check_and_rebuild_fuzzyfiles {
2792 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2793 -e "$dir/svc_acct.username"
2794 or &rebuild_fuzzyfiles;
2797 =item rebuild_fuzzyfiles
2801 sub rebuild_fuzzyfiles {
2803 use Fcntl qw(:flock);
2805 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2809 open(USERNAMELOCK,">>$dir/svc_acct.username")
2810 or die "can't open $dir/svc_acct.username: $!";
2811 flock(USERNAMELOCK,LOCK_EX)
2812 or die "can't lock $dir/svc_acct.username: $!";
2814 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2816 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2817 or die "can't open $dir/svc_acct.username.tmp: $!";
2818 print USERNAMECACHE join("\n", @all_username), "\n";
2819 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2821 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2831 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2832 open(USERNAMECACHE,"<$dir/svc_acct.username")
2833 or die "can't open $dir/svc_acct.username: $!";
2834 my @array = map { chomp; $_; } <USERNAMECACHE>;
2835 close USERNAMECACHE;
2839 =item append_fuzzyfiles USERNAME
2843 sub append_fuzzyfiles {
2844 my $username = shift;
2846 &check_and_rebuild_fuzzyfiles;
2848 use Fcntl qw(:flock);
2850 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2852 open(USERNAME,">>$dir/svc_acct.username")
2853 or die "can't open $dir/svc_acct.username: $!";
2854 flock(USERNAME,LOCK_EX)
2855 or die "can't lock $dir/svc_acct.username: $!";
2857 print USERNAME "$username\n";
2859 flock(USERNAME,LOCK_UN)
2860 or die "can't unlock $dir/svc_acct.username: $!";
2867 =item reached_threshold
2869 Performs some activities when svc_acct thresholds (such as number of seconds
2870 remaining) are reached.
2874 sub reached_threshold {
2877 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
2878 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
2880 if ( $opt{'op'} eq '+' ){
2881 $svc_acct->setfield( $opt{'column'}.'_threshold',
2882 int($svc_acct->getfield($opt{'column'})
2883 * ( $conf->exists('svc_acct-usage_threshold')
2884 ? $conf->config('svc_acct-usage_threshold')/100
2889 my $error = $svc_acct->replace;
2890 die $error if $error;
2891 }elsif ( $opt{'op'} eq '-' ){
2893 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
2894 return '' if ($threshold eq '' );
2896 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
2897 my $error = $svc_acct->replace;
2898 die $error if $error; # email next time, i guess
2900 if ( $warning_msgnum ) {
2902 my $msg_template = qsearchs('msg_template',{ msgnum => $warning_msgnum });
2903 die "Could not load template for threshold_warning_msgnum ($warning_msgnum)" unless $msg_template;
2905 my $cust_main = $svc_acct->cust_svc->cust_pkg->cust_main;
2907 my $to = join(', ', $cust_main->invoicing_list_emailonly );
2909 my $error = $msg_template->send(
2910 cust_main => $cust_main,
2911 object => $svc_acct,
2914 # have to override these, because we changed threshold above
2915 'column' => $opt{'column'},
2916 'amount' => $opt{'column'} =~/bytes/
2917 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
2918 : $svc_acct->getfield($opt{'column'}),
2919 'threshold' => $opt{'column'} =~/bytes/
2920 ? FS::UI::bytecount::display_bytecount($threshold)
2925 die "Error sending threshold warning email: $error" if $error;
2929 die "unknown op: " . $opt{'op'};
2937 The $recref stuff in sub check should be cleaned up.
2939 The suspend, unsuspend and cancel methods update the database, but not the
2940 current object. This is probably a bug as it's unexpected and
2943 insertion of RADIUS group stuff in insert could be done with child_objects now
2944 (would probably clean up export of them too)
2946 _op_usage and set_usage bypass the history... maybe they shouldn't
2950 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
2951 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
2952 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
2953 L<freeside-queued>), L<FS::svc_acct_pop>,
2954 schema.html from the base documentation.