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->SUPER::delete; # usergroup here
852 $dbh->rollback if $oldAutoCommit;
856 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
860 =item replace OLD_RECORD
862 Replaces OLD_RECORD with this one in the database. If there is an error,
863 returns the error, otherwise returns false.
865 The additional field I<usergroup> can optionally be defined; if so it should
866 contain an arrayref of group names. See L<FS::radius_usergroup>.
874 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
878 warn "$me replacing $old with $new\n" if $DEBUG;
882 return "can't modify system account" if $old->_check_system;
885 #no warnings 'numeric'; #alas, a 5.006-ism
888 foreach my $xid (qw( uid gid )) {
890 return "Can't change $xid!"
891 if ! $conf->exists("svc_acct-edit_$xid")
892 && $old->$xid() != $new->$xid()
893 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
898 return "can't change username"
899 if $old->username ne $new->username
900 && $conf->exists('svc_acct-no_edit_username');
902 #change homdir when we change username
903 $new->setfield('dir', '') if $old->username ne $new->username;
905 local $SIG{HUP} = 'IGNORE';
906 local $SIG{INT} = 'IGNORE';
907 local $SIG{QUIT} = 'IGNORE';
908 local $SIG{TERM} = 'IGNORE';
909 local $SIG{TSTP} = 'IGNORE';
910 local $SIG{PIPE} = 'IGNORE';
912 my $oldAutoCommit = $FS::UID::AutoCommit;
913 local $FS::UID::AutoCommit = 0;
916 $error = $new->SUPER::replace($old, @_); # usergroup here
918 # don't need to record this unless the password was changed
919 if ( $old->_password ne $new->_password ) {
920 $error ||= $new->insert_password_history;
924 $dbh->rollback if $oldAutoCommit;
925 return $error if $error;
928 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
929 $error = $new->queue_fuzzyfiles_update;
931 $dbh->rollback if $oldAutoCommit;
932 return "updating fuzzy search cache: $error";
936 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
940 =item queue_fuzzyfiles_update
942 Used by insert & replace to update the fuzzy search cache
946 sub queue_fuzzyfiles_update {
949 local $SIG{HUP} = 'IGNORE';
950 local $SIG{INT} = 'IGNORE';
951 local $SIG{QUIT} = 'IGNORE';
952 local $SIG{TERM} = 'IGNORE';
953 local $SIG{TSTP} = 'IGNORE';
954 local $SIG{PIPE} = 'IGNORE';
956 my $oldAutoCommit = $FS::UID::AutoCommit;
957 local $FS::UID::AutoCommit = 0;
960 my $queue = new FS::queue {
961 'svcnum' => $self->svcnum,
962 'job' => 'FS::svc_acct::append_fuzzyfiles'
964 my $error = $queue->insert($self->username);
966 $dbh->rollback if $oldAutoCommit;
967 return "queueing job (transaction rolled back): $error";
970 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
978 Suspends this account by calling export-specific suspend hooks. If there is
979 an error, returns the error, otherwise returns false.
981 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
987 return "can't suspend system account" if $self->_check_system;
988 $self->SUPER::suspend(@_);
993 Unsuspends this account by by calling export-specific suspend hooks. If there
994 is an error, returns the error, otherwise returns false.
996 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1002 my %hash = $self->hash;
1003 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1004 $hash{_password} = $1;
1005 my $new = new FS::svc_acct ( \%hash );
1006 my $error = $new->replace($self);
1007 return $error if $error;
1010 $self->SUPER::unsuspend(@_);
1015 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1017 If the B<auto_unset_catchall> configuration option is set, this method will
1018 automatically remove any references to the canceled service in the catchall
1019 field of svc_domain. This allows packages that contain both a svc_domain and
1020 its catchall svc_acct to be canceled in one step.
1025 # Only one thing to do at this level
1027 foreach my $svc_domain (
1028 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1029 if($conf->exists('auto_unset_catchall')) {
1030 my %hash = $svc_domain->hash;
1031 $hash{catchall} = '';
1032 my $new = new FS::svc_domain ( \%hash );
1033 my $error = $new->replace($svc_domain);
1034 return $error if $error;
1036 return "cannot unprovision svc_acct #".$self->svcnum.
1037 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1041 $self->SUPER::cancel(@_);
1047 Checks all fields to make sure this is a valid service. If there is an error,
1048 returns the error, otherwise returns false. Called by the insert and replace
1051 Sets any fixed values; see L<FS::part_svc>.
1058 my($recref) = $self->hashref;
1060 my $x = $self->setfixed;
1061 return $x unless ref($x);
1064 my $error = $self->ut_numbern('svcnum')
1065 #|| $self->ut_number('domsvc')
1066 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1067 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1068 || $self->ut_foreign_keyn('sectornum','tower_sector','sectornum')
1069 || $self->ut_foreign_keyn('routernum','router','routernum')
1070 || $self->ut_foreign_keyn('blocknum','addr_block','blocknum')
1071 || $self->ut_textn('sec_phrase')
1072 || $self->ut_snumbern('seconds')
1073 || $self->ut_snumbern('upbytes')
1074 || $self->ut_snumbern('downbytes')
1075 || $self->ut_snumbern('totalbytes')
1076 || $self->ut_snumbern('seconds_threshold')
1077 || $self->ut_snumbern('upbytes_threshold')
1078 || $self->ut_snumbern('downbytes_threshold')
1079 || $self->ut_snumbern('totalbytes_threshold')
1080 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1081 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1082 || $self->ut_enum('password_recover', [ '', 'Y' ])
1084 || $self->ut_anything('cf_privatekey')
1086 || $self->ut_textn('cgp_accessmodes')
1087 || $self->ut_alphan('cgp_type')
1088 || $self->ut_textn('cgp_aliases' ) #well
1090 || $self->ut_alphasn('cgp_rulesallowed')
1091 || $self->ut_enum('cgp_rpopallowed', [ '', 'Y' ])
1092 || $self->ut_enum('cgp_mailtoall', [ '', 'Y' ])
1093 || $self->ut_enum('cgp_addmailtrailer', [ '', 'Y' ])
1094 || $self->ut_snumbern('cgp_archiveafter')
1096 || $self->ut_alphasn('cgp_deletemode')
1097 || $self->ut_enum('cgp_emptytrash', $self->cgp_emptytrash_values)
1098 || $self->ut_alphan('cgp_language')
1099 || $self->ut_textn('cgp_timezone')
1100 || $self->ut_textn('cgp_skinname')
1101 || $self->ut_textn('cgp_prontoskinname')
1102 || $self->ut_alphan('cgp_sendmdnmode')
1104 return $error if $error;
1106 # assign IP address, etc.
1107 if ( $conf->exists('svc_acct-ip_addr') ) {
1108 my $error = $self->svc_ip_check;
1109 return $error if $error;
1110 } else { # I think this is correct
1111 $self->routernum('');
1112 $self->blocknum('');
1116 local $username_letter = $username_letter;
1117 local $username_uppercase = $username_uppercase;
1118 if ($self->svcnum) {
1119 my $cust_svc = $self->cust_svc
1120 or return "no cust_svc record found for svcnum ". $self->svcnum;
1121 my $cust_pkg = $cust_svc->cust_pkg;
1123 if ($self->pkgnum) {
1124 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1128 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1129 $username_uppercase =
1130 $conf->exists('username-uppercase', $cust_pkg->cust_main->agentnum);
1133 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1135 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:\/\=\#\!]{$usernamemin,$ulen})$/i
1136 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1137 $recref->{username} = $1;
1139 my $uerror = gettext('illegal_username'). ': '. $recref->{username};
1141 unless ( $username_uppercase ) {
1142 $recref->{username} =~ /[A-Z]/ and return $uerror;
1144 if ( $username_letterfirst ) {
1145 $recref->{username} =~ /^[a-z]/ or return $uerror;
1146 } elsif ( $username_letter ) {
1147 $recref->{username} =~ /[a-z]/ or return $uerror;
1149 if ( $username_noperiod ) {
1150 $recref->{username} =~ /\./ and return $uerror;
1152 if ( $username_nounderscore ) {
1153 $recref->{username} =~ /_/ and return $uerror;
1155 if ( $username_nodash ) {
1156 $recref->{username} =~ /\-/ and return $uerror;
1158 unless ( $username_ampersand ) {
1159 $recref->{username} =~ /\&/ and return $uerror;
1161 unless ( $username_percent ) {
1162 $recref->{username} =~ /\%/ and return $uerror;
1164 unless ( $username_colon ) {
1165 $recref->{username} =~ /\:/ and return $uerror;
1167 unless ( $username_slash ) {
1168 $recref->{username} =~ /\// and return $uerror;
1170 unless ( $username_equals ) {
1171 $recref->{username} =~ /\=/ and return $uerror;
1173 unless ( $username_pound ) {
1174 $recref->{username} =~ /\#/ and return $uerror;
1176 unless ( $username_exclamation ) {
1177 $recref->{username} =~ /\!/ and return $uerror;
1181 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1182 $recref->{popnum} = $1;
1183 return "Unknown popnum" unless
1184 ! $recref->{popnum} ||
1185 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1187 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1189 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1190 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1192 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1193 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1194 #not all systems use gid=uid
1195 #you can set a fixed gid in part_svc
1197 return "Only root can have uid 0"
1198 if $recref->{uid} == 0
1199 && $recref->{username} !~ /^(root|toor|smtp)$/;
1201 unless ( $recref->{username} eq 'sync' ) {
1202 if ( grep $_ eq $recref->{shell}, @shells ) {
1203 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1205 return "Illegal shell \`". $self->shell. "\'; ".
1206 "shells configuration value contains: @shells";
1209 $recref->{shell} = '/bin/sync';
1213 $recref->{gid} ne '' ?
1214 return "Can't have gid without uid" : ( $recref->{gid}='' );
1215 #$recref->{dir} ne '' ?
1216 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1217 $recref->{shell} ne '' ?
1218 return "Can't have shell without uid" : ( $recref->{shell}='' );
1221 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1223 $recref->{dir} =~ /^([\/\w\-\.\&\:\#]*)$/
1224 or return "Illegal directory: ". $recref->{dir};
1225 $recref->{dir} = $1;
1226 return "Illegal directory"
1227 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1228 return "Illegal directory"
1229 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1230 unless ( $recref->{dir} ) {
1231 $recref->{dir} = $dir_prefix . '/';
1232 if ( $dirhash > 0 ) {
1233 for my $h ( 1 .. $dirhash ) {
1234 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1236 } elsif ( $dirhash < 0 ) {
1237 for my $h ( reverse $dirhash .. -1 ) {
1238 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1241 $recref->{dir} .= $recref->{username};
1247 if ( $self->getfield('finger') eq '' ) {
1248 my $cust_pkg = $self->svcnum
1249 ? $self->cust_svc->cust_pkg
1250 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1252 my $cust_main = $cust_pkg->cust_main;
1253 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1256 # $error = $self->ut_textn('finger');
1257 # return $error if $error;
1258 $self->getfield('finger') =~ /^([\w \,\.\-\'\&\t\!\@\#\$\%\(\)\+\;\"\?\/\*\<\>]*)$/
1259 or return "Illegal finger: ". $self->getfield('finger');
1260 $self->setfield('finger', $1);
1262 for (qw( quota file_quota file_maxsize )) {
1263 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1266 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1267 $recref->{file_maxnum} = $1;
1269 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1270 if ( $recref->{slipip} eq '' ) {
1271 $recref->{slipip} = ''; # eh?
1272 } elsif ( $recref->{slipip} eq '0e0' ) {
1273 $recref->{slipip} = '0e0';
1275 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1276 or return "Illegal slipip: ". $self->slipip;
1277 $recref->{slipip} = $1;
1281 #arbitrary RADIUS stuff; allow ut_textn for now
1282 foreach ( grep /^radius_/, fields('svc_acct') ) {
1283 $self->ut_textn($_);
1286 # First, if _password is blank, generate one and set default encoding.
1287 if ( ! $recref->{_password} ) {
1288 $error = $self->set_password('');
1290 # But if there's a _password but no encoding, assume it's plaintext and
1291 # set it to default encoding.
1292 elsif ( ! $recref->{_password_encoding} ) {
1293 $error = $self->set_password($recref->{_password});
1295 return $error if $error;
1297 # Next, check _password to ensure compliance with the encoding.
1298 if ( $recref->{_password_encoding} eq 'ldap' ) {
1300 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1301 $recref->{_password} = uc($1).$2;
1303 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1306 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1308 if ( $recref->{_password} =~
1309 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1310 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1313 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1316 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1319 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1320 # Password randomization is now in set_password.
1321 # Strip whitespace characters, check length requirements, etc.
1322 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1323 $recref->{_password} = $1;
1325 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1326 FS::Msgcat::_gettext('illegal_password_characters').
1327 ": ". $recref->{_password};
1330 if ( $password_noampersand ) {
1331 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1333 if ( $password_noexclamation ) {
1334 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1338 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1341 $self->SUPER::check;
1346 sub _password_encryption {
1348 my $encoding = lc($self->_password_encoding);
1349 return if !$encoding;
1350 return 'plain' if $encoding eq 'plain';
1351 if($encoding eq 'crypt') {
1352 my $pass = $self->_password;
1353 $pass =~ s/^\*SUSPENDED\* //;
1355 return 'md5' if $pass =~ /^\$1\$/;
1356 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1357 return 'des' if length($pass) == 13;
1360 if($encoding eq 'ldap') {
1361 uc($self->_password) =~ /^\{([\w-]+)\}/;
1362 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1363 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1364 return 'md5' if $1 eq 'MD5';
1365 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1372 sub get_cleartext_password {
1374 if($self->_password_encryption eq 'plain') {
1375 if($self->_password_encoding eq 'ldap') {
1376 $self->_password =~ /\{\w+\}(.*)$/;
1380 return $self->_password;
1389 Set the cleartext password for the account. If _password_encoding is set, the
1390 new password will be encoded according to the existing method (including
1391 encryption mode, if it can be determined). Otherwise,
1392 config('default-password-encoding') is used.
1394 If no password is supplied (or a zero-length password when minimum password length
1395 is >0), one will be generated randomly.
1400 my( $self, $pass ) = ( shift, shift );
1402 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1405 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1406 FS::Msgcat::_gettext('illegal_password_characters').
1409 my( $encoding, $encryption ) = ('', '');
1411 if ( $self->_password_encoding ) {
1412 $encoding = $self->_password_encoding;
1413 # identify existing encryption method, try to use it.
1414 $encryption = $self->_password_encryption;
1416 # use the system default
1422 # set encoding to system default
1423 ($encoding, $encryption) =
1424 split(/-/, lc($conf->config('default-password-encoding') || ''));
1425 $encoding ||= 'legacy';
1426 $self->_password_encoding($encoding);
1429 if ( $encoding eq 'legacy' ) {
1431 # The legacy behavior from check():
1432 # If the password is blank, randomize it and set encoding to 'plain'.
1433 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1434 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1435 $self->_password_encoding('plain');
1437 # Prefix + valid-length password
1438 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1440 $self->_password_encoding('plain');
1441 # Prefix + crypt string
1442 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1444 $self->_password_encoding('crypt');
1445 # Various disabled crypt passwords
1446 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1447 $self->_password_encoding('crypt');
1453 $self->_password($pass);
1459 if $passwordmin && length($pass) < $passwordmin
1460 or $passwordmax && length($pass) > $passwordmax;
1462 if ( $encoding eq 'crypt' ) {
1463 if ($encryption eq 'md5') {
1464 $pass = unix_md5_crypt($pass);
1465 } elsif ($encryption eq 'des') {
1466 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1469 } elsif ( $encoding eq 'ldap' ) {
1470 if ($encryption eq 'md5') {
1471 $pass = md5_base64($pass);
1472 } elsif ($encryption eq 'sha1') {
1473 $pass = sha1_base64($pass);
1474 } elsif ($encryption eq 'crypt') {
1475 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1477 # else $encryption eq 'plain', do nothing
1478 $pass .= '=' x (4 - length($pass) % 4) #properly padded base64
1479 if $encryption eq 'md5' || $encryption eq 'sha1';
1480 $pass = '{'.uc($encryption).'}'.$pass;
1482 # else encoding eq 'plain'
1484 $self->_password($pass);
1490 Internal function to check the username against the list of system usernames
1491 from the I<system_usernames> configuration value. Returns true if the username
1492 is listed on the system username list.
1498 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1499 $conf->config('system_usernames')
1503 =item _check_duplicate
1505 Internal method to check for duplicates usernames, username@domain pairs and
1508 If the I<global_unique-username> configuration value is set to B<username> or
1509 B<username@domain>, enforces global username or username@domain uniqueness.
1511 In all cases, check for duplicate uids and usernames or username@domain pairs
1512 per export and with identical I<svcpart> values.
1516 sub _check_duplicate {
1519 my $global_unique = $conf->config('global_unique-username') || 'none';
1520 return '' if $global_unique eq 'disabled';
1524 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1525 unless ( $part_svc ) {
1526 return 'unknown svcpart '. $self->svcpart;
1529 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1530 qsearch( 'svc_acct', { 'username' => $self->username } );
1531 return gettext('username_in_use')
1532 if $global_unique eq 'username' && @dup_user;
1534 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1535 qsearch( 'svc_acct', { 'username' => $self->username,
1536 'domsvc' => $self->domsvc } );
1537 return gettext('username_in_use')
1538 if $global_unique eq 'username@domain' && @dup_userdomain;
1541 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1542 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1543 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1544 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1549 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1550 my $exports = FS::part_export::export_info('svc_acct');
1551 my %conflict_user_svcpart;
1552 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1554 foreach my $part_export ( $part_svc->part_export ) {
1556 #this will catch to the same exact export
1557 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1559 #this will catch to exports w/same exporthost+type ???
1560 #my @other_part_export = qsearch('part_export', {
1561 # 'machine' => $part_export->machine,
1562 # 'exporttype' => $part_export->exporttype,
1564 #foreach my $other_part_export ( @other_part_export ) {
1565 # push @svcparts, map { $_->svcpart }
1566 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1569 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1570 #silly kludge to avoid uninitialized value errors
1571 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1572 ? $exports->{$part_export->exporttype}{'nodomain'}
1574 if ( $nodomain =~ /^Y/i ) {
1575 $conflict_user_svcpart{$_} = $part_export->exportnum
1578 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1583 foreach my $dup_user ( @dup_user ) {
1584 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1585 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1586 return "duplicate username ". $self->username.
1587 ": conflicts with svcnum ". $dup_user->svcnum.
1588 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1592 foreach my $dup_userdomain ( @dup_userdomain ) {
1593 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1594 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1595 return "duplicate username\@domain ". $self->email.
1596 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1597 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1601 foreach my $dup_uid ( @dup_uid ) {
1602 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1603 if ( exists($conflict_user_svcpart{$dup_svcpart})
1604 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1605 return "duplicate uid ". $self->uid.
1606 ": conflicts with svcnum ". $dup_uid->svcnum.
1608 ( $conflict_user_svcpart{$dup_svcpart}
1609 || $conflict_userdomain_svcpart{$dup_svcpart} );
1621 Depriciated, use radius_reply instead.
1626 carp "FS::svc_acct::radius depriciated, use radius_reply";
1627 $_[0]->radius_reply;
1632 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1633 reply attributes of this record.
1635 Note that this is now the preferred method for reading RADIUS attributes -
1636 accessing the columns directly is discouraged, as the column names are
1637 expected to change in the future.
1644 return %{ $self->{'radius_reply'} }
1645 if exists $self->{'radius_reply'};
1650 my($column, $attrib) = ($1, $2);
1651 #$attrib =~ s/_/\-/g;
1652 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1653 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1655 if ( $self->slipip && $self->slipip ne '0e0' ) {
1656 $reply{$radius_ip} = $self->slipip;
1659 if ( $self->seconds !~ /^$/ ) {
1660 $reply{'Session-Timeout'} = $self->seconds;
1663 if ( $conf->exists('radius-chillispot-max') ) {
1664 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1666 #hmm. just because sqlradius.pm says so?
1673 foreach my $what (qw( input output total )) {
1674 my $is = $whatis{$what}.'bytes';
1675 if ( $self->$is() =~ /\d/ ) {
1676 my $big = new Math::BigInt $self->$is();
1677 $big = new Math::BigInt '0' if $big->is_neg();
1678 my $att = "Chillispot-Max-\u$what";
1679 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1680 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1691 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1692 check attributes of this record.
1694 Note that this is now the preferred method for reading RADIUS attributes -
1695 accessing the columns directly is discouraged, as the column names are
1696 expected to change in the future.
1703 return %{ $self->{'radius_check'} }
1704 if exists $self->{'radius_check'};
1709 my($column, $attrib) = ($1, $2);
1710 #$attrib =~ s/_/\-/g;
1711 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1712 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1715 my($pw_attrib, $password) = $self->radius_password;
1716 $check{$pw_attrib} = $password;
1718 my $cust_svc = $self->cust_svc;
1720 my $cust_pkg = $cust_svc->cust_pkg;
1721 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1722 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1725 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1726 "; can't set Expiration\n"
1734 =item radius_password
1736 Returns a key/value pair containing the RADIUS attribute name and value
1741 sub radius_password {
1745 if ( $self->_password_encoding eq 'ldap' ) {
1746 $pw_attrib = 'Password-With-Header';
1747 } elsif ( $self->_password_encoding eq 'crypt' ) {
1748 $pw_attrib = 'Crypt-Password';
1749 } elsif ( $self->_password_encoding eq 'plain' ) {
1750 $pw_attrib = $radius_password;
1752 $pw_attrib = length($self->_password) <= 12
1757 ($pw_attrib, $self->_password);
1763 This method instructs the object to "snapshot" or freeze RADIUS check and
1764 reply attributes to the current values.
1768 #bah, my english is too broken this morning
1769 #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
1770 #the FS::cust_pkg's replace method to trigger the correct export updates when
1771 #package dates change)
1776 $self->{$_} = { $self->$_() }
1777 foreach qw( radius_reply radius_check );
1781 =item forget_snapshot
1783 This methos instructs the object to forget any previously snapshotted
1784 RADIUS check and reply attributes.
1788 sub forget_snapshot {
1792 foreach qw( radius_reply radius_check );
1796 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1798 Returns the domain associated with this account.
1800 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1807 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1808 my $svc_domain = $self->svc_domain(@_)
1809 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1810 $svc_domain->domain;
1815 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1819 #inherited from svc_Common
1821 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1823 Returns an email address associated with the account.
1825 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1832 $self->username. '@'. $self->domain(@_);
1838 Returns an array of FS::acct_snarf records associated with the account.
1842 # unused as originally intended, but now by Communigate Pro "RPOP"
1844 =item cgp_rpop_hashref
1846 Returns an arrayref of RPOP data suitable for Communigate Pro API commands.
1850 sub cgp_rpop_hashref {
1852 { map { $_->snarfname => $_->cgp_hashref } $self->acct_snarf };
1855 =item decrement_upbytes OCTETS
1857 Decrements the I<upbytes> field of this record by the given amount. If there
1858 is an error, returns the error, otherwise returns false.
1862 sub decrement_upbytes {
1863 shift->_op_usage('-', 'upbytes', @_);
1866 =item increment_upbytes OCTETS
1868 Increments the I<upbytes> field of this record by the given amount. If there
1869 is an error, returns the error, otherwise returns false.
1873 sub increment_upbytes {
1874 shift->_op_usage('+', 'upbytes', @_);
1877 =item decrement_downbytes OCTETS
1879 Decrements the I<downbytes> field of this record by the given amount. If there
1880 is an error, returns the error, otherwise returns false.
1884 sub decrement_downbytes {
1885 shift->_op_usage('-', 'downbytes', @_);
1888 =item increment_downbytes OCTETS
1890 Increments the I<downbytes> field of this record by the given amount. If there
1891 is an error, returns the error, otherwise returns false.
1895 sub increment_downbytes {
1896 shift->_op_usage('+', 'downbytes', @_);
1899 =item decrement_totalbytes OCTETS
1901 Decrements the I<totalbytes> field of this record by the given amount. If there
1902 is an error, returns the error, otherwise returns false.
1906 sub decrement_totalbytes {
1907 shift->_op_usage('-', 'totalbytes', @_);
1910 =item increment_totalbytes OCTETS
1912 Increments the I<totalbytes> field of this record by the given amount. If there
1913 is an error, returns the error, otherwise returns false.
1917 sub increment_totalbytes {
1918 shift->_op_usage('+', 'totalbytes', @_);
1921 =item decrement_seconds SECONDS
1923 Decrements the I<seconds> field of this record by the given amount. If there
1924 is an error, returns the error, otherwise returns false.
1928 sub decrement_seconds {
1929 shift->_op_usage('-', 'seconds', @_);
1932 =item increment_seconds SECONDS
1934 Increments the I<seconds> field of this record by the given amount. If there
1935 is an error, returns the error, otherwise returns false.
1939 sub increment_seconds {
1940 shift->_op_usage('+', 'seconds', @_);
1948 my %op2condition = (
1949 '-' => sub { my($self, $column, $amount) = @_;
1950 $self->$column - $amount <= 0;
1952 '+' => sub { my($self, $column, $amount) = @_;
1953 ($self->$column || 0) + $amount > 0;
1956 my %op2warncondition = (
1957 '-' => sub { my($self, $column, $amount) = @_;
1958 my $threshold = $column . '_threshold';
1959 $self->$column - $amount <= $self->$threshold + 0;
1961 '+' => sub { my($self, $column, $amount) = @_;
1962 ($self->$column || 0) + $amount > 0;
1967 my( $self, $op, $column, $amount ) = @_;
1969 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
1970 ' ('. $self->email. "): $op $amount\n"
1973 return '' unless $amount;
1975 local $SIG{HUP} = 'IGNORE';
1976 local $SIG{INT} = 'IGNORE';
1977 local $SIG{QUIT} = 'IGNORE';
1978 local $SIG{TERM} = 'IGNORE';
1979 local $SIG{TSTP} = 'IGNORE';
1980 local $SIG{PIPE} = 'IGNORE';
1982 my $oldAutoCommit = $FS::UID::AutoCommit;
1983 local $FS::UID::AutoCommit = 0;
1986 my $sql = "UPDATE svc_acct SET $column = ".
1987 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
1988 " $op ? WHERE svcnum = ?";
1992 my $sth = $dbh->prepare( $sql )
1993 or die "Error preparing $sql: ". $dbh->errstr;
1994 my $rv = $sth->execute($amount, $self->svcnum);
1995 die "Error executing $sql: ". $sth->errstr
1996 unless defined($rv);
1997 die "Can't update $column for svcnum". $self->svcnum
2000 #$self->snapshot; #not necessary, we retain the old values
2001 #create an object with the updated usage values
2002 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2004 my $error = $new->replace($self);
2006 $dbh->rollback if $oldAutoCommit;
2007 return "Error replacing: $error";
2010 #overlimit_action eq 'cancel' handling
2011 my $cust_pkg = $self->cust_svc->cust_pkg;
2013 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2014 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2018 my $error = $cust_pkg->cancel; #XXX should have a reason
2020 $dbh->rollback if $oldAutoCommit;
2021 return "Error cancelling: $error";
2024 #nothing else is relevant if we're cancelling, so commit & return success
2025 warn "$me update successful; committing\n"
2027 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2032 my $action = $op2action{$op};
2034 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2035 ( $action eq 'suspend' && !$self->overlimit
2036 || $action eq 'unsuspend' && $self->overlimit )
2039 my $error = $self->_op_overlimit($action);
2041 $dbh->rollback if $oldAutoCommit;
2047 if ( $conf->exists("svc_acct-usage_$action")
2048 && &{$op2condition{$op}}($self, $column, $amount) ) {
2049 #my $error = $self->$action();
2050 my $error = $self->cust_svc->cust_pkg->$action();
2051 # $error ||= $self->overlimit($action);
2053 $dbh->rollback if $oldAutoCommit;
2054 return "Error ${action}ing: $error";
2058 if ($warning_msgnum && &{$op2warncondition{$op}}($self, $column, $amount)) {
2059 my $wqueue = new FS::queue {
2060 'svcnum' => $self->svcnum,
2061 'job' => 'FS::svc_acct::reached_threshold',
2065 my $error = $wqueue->insert(
2066 'svcnum' => $self->svcnum,
2071 $dbh->rollback if $oldAutoCommit;
2072 return "Error queuing threshold activity: $error";
2076 warn "$me update successful; committing\n"
2078 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2084 my( $self, $action ) = @_;
2086 local $SIG{HUP} = 'IGNORE';
2087 local $SIG{INT} = 'IGNORE';
2088 local $SIG{QUIT} = 'IGNORE';
2089 local $SIG{TERM} = 'IGNORE';
2090 local $SIG{TSTP} = 'IGNORE';
2091 local $SIG{PIPE} = 'IGNORE';
2093 my $oldAutoCommit = $FS::UID::AutoCommit;
2094 local $FS::UID::AutoCommit = 0;
2097 my $cust_pkg = $self->cust_svc->cust_pkg;
2099 my @conf_overlimit =
2101 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2102 : $conf->config('overlimit_groups');
2104 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2106 my @groups = scalar(@conf_overlimit) ? @conf_overlimit
2107 : split(' ',$part_export->option('overlimit_groups'));
2108 next unless scalar(@groups);
2110 my $other = new FS::svc_acct $self->hashref;
2111 $other->usergroup(\@groups);
2114 if ($action eq 'suspend') {
2117 } else { # $action eq 'unsuspend'
2122 my $error = $part_export->export_replace($new, $old)
2123 || $self->overlimit($action);
2126 $dbh->rollback if $oldAutoCommit;
2127 return "Error replacing radius groups: $error";
2132 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2138 my( $self, $valueref, %options ) = @_;
2140 warn "$me set_usage called for svcnum ". $self->svcnum.
2141 ' ('. $self->email. "): ".
2142 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2145 local $SIG{HUP} = 'IGNORE';
2146 local $SIG{INT} = 'IGNORE';
2147 local $SIG{QUIT} = 'IGNORE';
2148 local $SIG{TERM} = 'IGNORE';
2149 local $SIG{TSTP} = 'IGNORE';
2150 local $SIG{PIPE} = 'IGNORE';
2152 local $FS::svc_Common::noexport_hack = 1;
2153 my $oldAutoCommit = $FS::UID::AutoCommit;
2154 local $FS::UID::AutoCommit = 0;
2159 if ( $options{null} ) {
2160 %handyhash = ( map { ( $_ => undef, $_."_threshold" => undef ) }
2161 qw( seconds upbytes downbytes totalbytes )
2164 foreach my $field (keys %$valueref){
2165 $reset = 1 if $valueref->{$field};
2166 $self->setfield($field, $valueref->{$field});
2167 $self->setfield( $field.'_threshold',
2168 int($self->getfield($field)
2169 * ( $conf->exists('svc_acct-usage_threshold')
2170 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2175 $handyhash{$field} = $self->getfield($field);
2176 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2178 #my $error = $self->replace; #NO! we avoid the call to ->check for
2179 #die $error if $error; #services not explicity changed via the UI
2181 my $sql = "UPDATE svc_acct SET " .
2182 join (',', map { "$_ = ?" } (keys %handyhash) ).
2183 " WHERE svcnum = ". $self->svcnum;
2188 if (scalar(keys %handyhash)) {
2189 my $sth = $dbh->prepare( $sql )
2190 or die "Error preparing $sql: ". $dbh->errstr;
2191 my $rv = $sth->execute(values %handyhash);
2192 die "Error executing $sql: ". $sth->errstr
2193 unless defined($rv);
2194 die "Can't update usage for svcnum ". $self->svcnum
2198 #$self->snapshot; #not necessary, we retain the old values
2199 #create an object with the updated usage values
2200 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2201 local($FS::Record::nowarn_identical) = 1;
2202 my $error = $new->replace($self); #call exports
2204 $dbh->rollback if $oldAutoCommit;
2205 return "Error replacing: $error";
2212 $error = $self->_op_overlimit('unsuspend')
2213 if $self->overlimit;;
2215 $error ||= $self->cust_svc->cust_pkg->unsuspend
2216 if $conf->exists("svc_acct-usage_unsuspend");
2219 $dbh->rollback if $oldAutoCommit;
2220 return "Error unsuspending: $error";
2225 warn "$me update successful; committing\n"
2227 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2233 =item recharge HASHREF
2235 Increments usage columns by the amount specified in HASHREF as
2236 column=>amount pairs.
2241 my ($self, $vhash) = @_;
2244 warn "[$me] recharge called on $self: ". Dumper($self).
2245 "\nwith vhash: ". Dumper($vhash);
2248 my $oldAutoCommit = $FS::UID::AutoCommit;
2249 local $FS::UID::AutoCommit = 0;
2253 foreach my $column (keys %$vhash){
2254 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2258 $dbh->rollback if $oldAutoCommit;
2260 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2265 =item is_rechargeable
2267 Returns true if this svc_account can be "recharged" and false otherwise.
2271 sub is_rechargable {
2273 $self->seconds ne ''
2274 || $self->upbytes ne ''
2275 || $self->downbytes ne ''
2276 || $self->totalbytes ne '';
2279 =item seconds_since TIMESTAMP
2281 Returns the number of seconds this account has been online since TIMESTAMP,
2282 according to the session monitor (see L<FS::Session>).
2284 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2285 L<Time::Local> and L<Date::Parse> for conversion functions.
2289 #note: POD here, implementation in FS::cust_svc
2292 $self->cust_svc->seconds_since(@_);
2295 =item last_login_text
2297 Returns text describing the time of last login.
2301 sub last_login_text {
2303 $self->last_login ? ctime($self->last_login) : 'unknown';
2306 =item psearch_cdrs OPTIONS
2308 Returns a paged search (L<FS::PagedSearch>) for Call Detail Records
2309 associated with this service. For svc_acct, "associated with" means that
2310 either the "src" or the "charged_party" field of the CDR matches the
2311 "username" field of the service.
2316 my($self, %options) = @_;
2321 my $did = dbh->quote($self->username);
2323 my $prefix = $options{'default_prefix'} || ''; #convergent.au '+61'
2324 my $prefixdid = dbh->quote($prefix . $self->username);
2326 my $for_update = $options{'for_update'} ? 'FOR UPDATE' : '';
2328 if ( $options{inbound} ) {
2329 # these will be selected under their DIDs
2330 push @where, "FALSE";
2334 if (!$options{'disable_charged_party'}) {
2336 "charged_party = $did",
2337 "charged_party = $prefixdid";
2339 if (!$options{'disable_src'}) {
2341 "src = $did AND charged_party IS NULL",
2342 "src = $prefixdid AND charged_party IS NULL";
2344 push @where, '(' . join(' OR ', @orwhere) . ')';
2346 # $options{'status'} = '' is meaningful; for the rest of them it's not
2347 if ( exists $options{'status'} ) {
2348 $hash{'freesidestatus'} = $options{'status'};
2350 if ( $options{'cdrtypenum'} ) {
2351 $hash{'cdrtypenum'} = $options{'cdrtypenum'};
2353 if ( $options{'calltypenum'} ) {
2354 $hash{'calltypenum'} = $options{'calltypenum'};
2356 if ( $options{'begin'} ) {
2357 push @where, 'startdate >= '. $options{'begin'};
2359 if ( $options{'end'} ) {
2360 push @where, 'startdate < '. $options{'end'};
2362 if ( $options{'nonzero'} ) {
2363 push @where, 'duration > 0';
2366 my $extra_sql = join(' AND ', @where);
2369 $extra_sql = " AND ".$extra_sql;
2371 $extra_sql = " WHERE ".$extra_sql;
2377 'hashref' => \%hash,
2378 'extra_sql' => $extra_sql,
2379 'order_by' => "ORDER BY startdate $for_update",
2383 =item get_cdrs (DEPRECATED)
2385 Like psearch_cdrs, but returns all the L<FS::cdr> objects at once, in a
2386 single list. Arguments are the same as for psearch_cdrs.
2392 my $psearch = $self->psearch_cdrs(@_);
2393 qsearch ( $psearch->{query} )
2396 # sub radius_groups has moved to svc_Radius_Mixin
2398 =item clone_suspended
2400 Constructor used by FS::part_export::_export_suspend fallback. Document
2405 sub clone_suspended {
2407 my %hash = $self->hash;
2408 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2409 new FS::svc_acct \%hash;
2412 =item clone_kludge_unsuspend
2414 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2419 sub clone_kludge_unsuspend {
2421 my %hash = $self->hash;
2422 $hash{_password} = '';
2423 new FS::svc_acct \%hash;
2426 =item check_password
2428 Checks the supplied password against the (possibly encrypted) password in the
2429 database. Returns true for a successful authentication, false for no match.
2431 Currently supported encryptions are: classic DES crypt() and MD5
2435 sub check_password {
2436 my($self, $check_password) = @_;
2438 #remove old-style SUSPENDED kludge, they should be allowed to login to
2439 #self-service and pay up
2440 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2442 if ( $self->_password_encoding eq 'ldap' ) {
2444 $password =~ s/^{PLAIN}/{CLEARTEXT}/;
2445 my $auth = from_rfc2307 Authen::Passphrase $password;
2446 return $auth->match($check_password);
2448 } elsif ( $self->_password_encoding eq 'crypt' ) {
2450 my $auth = from_crypt Authen::Passphrase $self->_password;
2451 return $auth->match($check_password);
2453 } elsif ( $self->_password_encoding eq 'plain' ) {
2455 return $check_password eq $password;
2459 #XXX this could be replaced with Authen::Passphrase stuff
2461 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2463 } elsif ( length($password) < 13 ) { #plaintext
2464 $check_password eq $password;
2465 } elsif ( length($password) == 13 ) { #traditional DES crypt
2466 crypt($check_password, $password) eq $password;
2467 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2468 unix_md5_crypt($check_password, $password) eq $password;
2469 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2470 warn "Can't check password: Blowfish encryption not yet supported, ".
2471 "svcnum ". $self->svcnum. "\n";
2474 warn "Can't check password: Unrecognized encryption for svcnum ".
2475 $self->svcnum. "\n";
2483 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2485 Returns an encrypted password, either by passing through an encrypted password
2486 in the database or by encrypting a plaintext password from the database.
2488 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2489 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2490 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2491 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2492 encryption type is only used if the password is not already encrypted in the
2497 sub crypt_password {
2500 if ( $self->_password_encoding eq 'ldap' ) {
2502 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2505 #XXX this could be replaced with Authen::Passphrase stuff
2507 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2508 if ( $encryption eq 'crypt' ) {
2511 $saltset[int(rand(64))].$saltset[int(rand(64))]
2513 } elsif ( $encryption eq 'md5' ) {
2514 return unix_md5_crypt( $self->_password );
2515 } elsif ( $encryption eq 'blowfish' ) {
2516 croak "unknown encryption method $encryption";
2518 croak "unknown encryption method $encryption";
2521 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2525 } elsif ( $self->_password_encoding eq 'crypt' ) {
2527 return $self->_password;
2529 } elsif ( $self->_password_encoding eq 'plain' ) {
2531 #XXX this could be replaced with Authen::Passphrase stuff
2533 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2534 if ( $encryption eq 'crypt' ) {
2537 $saltset[int(rand(64))].$saltset[int(rand(64))]
2539 } elsif ( $encryption eq 'md5' ) {
2540 return unix_md5_crypt( $self->_password );
2541 } elsif ( $encryption eq 'sha1_base64' ) { #for acct_sql
2542 my $pass = sha1_base64( $self->_password );
2543 $pass .= '=' x (4 - length($pass) % 4); #properly padded base64
2545 } elsif ( $encryption eq 'blowfish' ) {
2546 croak "unknown encryption method $encryption";
2548 croak "unknown encryption method $encryption";
2553 if ( length($self->_password) == 13
2554 || $self->_password =~ /^\$(1|2a?)\$/
2555 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2561 #XXX this could be replaced with Authen::Passphrase stuff
2563 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2564 if ( $encryption eq 'crypt' ) {
2567 $saltset[int(rand(64))].$saltset[int(rand(64))]
2569 } elsif ( $encryption eq 'md5' ) {
2570 return unix_md5_crypt( $self->_password );
2571 } elsif ( $encryption eq 'blowfish' ) {
2572 croak "unknown encryption method $encryption";
2574 croak "unknown encryption method $encryption";
2583 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2585 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2586 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2587 "{MD5}5426824942db4253f87a1009fd5d2d4".
2589 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2590 to work the same as the B</crypt_password> method.
2596 #eventually should check a "password-encoding" field
2598 if ( $self->_password_encoding eq 'ldap' ) {
2600 return $self->_password;
2602 } elsif ( $self->_password_encoding eq 'crypt' ) {
2604 if ( length($self->_password) == 13 ) { #crypt
2605 return '{CRYPT}'. $self->_password;
2606 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2608 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2609 # die "Blowfish encryption not supported in this context, svcnum ".
2610 # $self->svcnum. "\n";
2612 warn "encryption method not (yet?) supported in LDAP context";
2613 return '{CRYPT}*'; #unsupported, should not auth
2616 } elsif ( $self->_password_encoding eq 'plain' ) {
2618 return '{PLAIN}'. $self->_password;
2620 #return '{CLEARTEXT}'. $self->_password; #?
2624 if ( length($self->_password) == 13 ) { #crypt
2625 return '{CRYPT}'. $self->_password;
2626 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2628 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2629 warn "Blowfish encryption not supported in this context, svcnum ".
2630 $self->svcnum. "\n";
2633 #are these two necessary anymore?
2634 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2635 return '{SSHA}'. $1;
2636 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2637 return '{NS-MTA-MD5}'. $1;
2640 return '{PLAIN}'. $self->_password;
2642 #return '{CLEARTEXT}'. $self->_password; #?
2644 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2645 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2646 #if ( $encryption eq 'crypt' ) {
2647 # return '{CRYPT}'. crypt(
2649 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2651 #} elsif ( $encryption eq 'md5' ) {
2652 # unix_md5_crypt( $self->_password );
2653 #} elsif ( $encryption eq 'blowfish' ) {
2654 # croak "unknown encryption method $encryption";
2656 # croak "unknown encryption method $encryption";
2664 =item domain_slash_username
2666 Returns $domain/$username/
2670 sub domain_slash_username {
2672 $self->domain. '/'. $self->username. '/';
2675 =item virtual_maildir
2677 Returns $domain/maildirs/$username/
2681 sub virtual_maildir {
2683 $self->domain. '/maildirs/'. $self->username. '/';
2686 =item password_svc_check
2688 Override, for L<FS::Password_Mixin>. Not really intended for other use.
2692 sub password_svc_check {
2693 my ($self, $password) = @_;
2694 foreach my $field ( qw(username finger) ) {
2695 foreach my $word (split(/\W+/,$self->get($field))) {
2696 next unless length($word) > 2;
2697 if ($password =~ /$word/i) {
2698 return qq(Password contains account information '$word');
2707 =head1 CLASS METHODS
2711 =item search HASHREF
2713 Class method which returns a qsearch hash expression to search for parameters
2714 specified in HASHREF. Valid parameters are
2728 Arrayref of pkgparts
2734 Arrayref of additional WHERE clauses, will be ANDed together.
2745 my( $class, $params, $from, $where ) = @_;
2747 #these two should probably move to svc_Domain_Mixin ?
2750 if ( $params->{'domain'} ) {
2751 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2752 #preserve previous behavior & bubble up an error if $svc_domain not found?
2753 push @$where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2757 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2758 push @$where, "domsvc = $1";
2763 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2764 push @$where, "popnum = $1";
2768 #and these in svc_Tower_Mixin, or maybe we never should have done svc_acct
2769 # towers (or, as mark thought, never should have done svc_broadband)
2772 my @where_sector = $class->tower_sector_sql($params);
2773 if ( @where_sector ) {
2774 push @$where, @where_sector;
2775 push @$from, ' LEFT JOIN tower_sector USING ( sectornum )';
2786 =item check_and_rebuild_fuzzyfiles
2790 sub check_and_rebuild_fuzzyfiles {
2791 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2792 -e "$dir/svc_acct.username"
2793 or &rebuild_fuzzyfiles;
2796 =item rebuild_fuzzyfiles
2800 sub rebuild_fuzzyfiles {
2802 use Fcntl qw(:flock);
2804 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2808 open(USERNAMELOCK,">>$dir/svc_acct.username")
2809 or die "can't open $dir/svc_acct.username: $!";
2810 flock(USERNAMELOCK,LOCK_EX)
2811 or die "can't lock $dir/svc_acct.username: $!";
2813 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2815 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2816 or die "can't open $dir/svc_acct.username.tmp: $!";
2817 print USERNAMECACHE join("\n", @all_username), "\n";
2818 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2820 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2830 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2831 open(USERNAMECACHE,"<$dir/svc_acct.username")
2832 or die "can't open $dir/svc_acct.username: $!";
2833 my @array = map { chomp; $_; } <USERNAMECACHE>;
2834 close USERNAMECACHE;
2838 =item append_fuzzyfiles USERNAME
2842 sub append_fuzzyfiles {
2843 my $username = shift;
2845 &check_and_rebuild_fuzzyfiles;
2847 use Fcntl qw(:flock);
2849 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2851 open(USERNAME,">>$dir/svc_acct.username")
2852 or die "can't open $dir/svc_acct.username: $!";
2853 flock(USERNAME,LOCK_EX)
2854 or die "can't lock $dir/svc_acct.username: $!";
2856 print USERNAME "$username\n";
2858 flock(USERNAME,LOCK_UN)
2859 or die "can't unlock $dir/svc_acct.username: $!";
2866 =item reached_threshold
2868 Performs some activities when svc_acct thresholds (such as number of seconds
2869 remaining) are reached.
2873 sub reached_threshold {
2876 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
2877 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
2879 if ( $opt{'op'} eq '+' ){
2880 $svc_acct->setfield( $opt{'column'}.'_threshold',
2881 int($svc_acct->getfield($opt{'column'})
2882 * ( $conf->exists('svc_acct-usage_threshold')
2883 ? $conf->config('svc_acct-usage_threshold')/100
2888 my $error = $svc_acct->replace;
2889 die $error if $error;
2890 }elsif ( $opt{'op'} eq '-' ){
2892 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
2893 return '' if ($threshold eq '' );
2895 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
2896 my $error = $svc_acct->replace;
2897 die $error if $error; # email next time, i guess
2899 if ( $warning_msgnum ) {
2901 my $msg_template = qsearchs('msg_template',{ msgnum => $warning_msgnum });
2902 die "Could not load template for threshold_warning_msgnum ($warning_msgnum)" unless $msg_template;
2904 my $cust_main = $svc_acct->cust_svc->cust_pkg->cust_main;
2906 my $to = join(', ', $cust_main->invoicing_list_emailonly );
2908 my $error = $msg_template->send(
2909 cust_main => $cust_main,
2910 object => $svc_acct,
2913 # have to override these, because we changed threshold above
2914 'column' => $opt{'column'},
2915 'amount' => $opt{'column'} =~/bytes/
2916 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
2917 : $svc_acct->getfield($opt{'column'}),
2918 'threshold' => $opt{'column'} =~/bytes/
2919 ? FS::UI::bytecount::display_bytecount($threshold)
2924 die "Error sending threshold warning email: $error" if $error;
2928 die "unknown op: " . $opt{'op'};
2936 The $recref stuff in sub check should be cleaned up.
2938 The suspend, unsuspend and cancel methods update the database, but not the
2939 current object. This is probably a bug as it's unexpected and
2942 insertion of RADIUS group stuff in insert could be done with child_objects now
2943 (would probably clean up export of them too)
2945 _op_usage and set_usage bypass the history... maybe they shouldn't
2949 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
2950 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
2951 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
2952 L<freeside-queued>), L<FS::svc_acct_pop>,
2953 schema.html from the base documentation.