4 use vars qw( @ISA $DEBUG $me $conf $skip_fuzzyfiles
5 $dir_prefix @shells $usernamemin
6 $usernamemax $passwordmin $passwordmax
7 $username_ampersand $username_letter $username_letterfirst
8 $username_noperiod $username_nounderscore $username_nodash
9 $username_uppercase $username_percent $username_colon
10 $password_noampersand $password_noexclamation
11 $warning_template $warning_from $warning_subject $warning_mimetype
14 $radius_password $radius_ip
17 use Scalar::Util qw( blessed );
22 use Crypt::PasswdMD5 1.2;
23 use Digest::SHA1 'sha1_base64';
24 use Digest::MD5 'md5_base64';
27 use Authen::Passphrase;
28 use FS::UID qw( datasrc driver_name );
30 use FS::Record qw( qsearch qsearchs fields dbh dbdef );
31 use FS::Msgcat qw(gettext);
32 use FS::UI::bytecount;
39 use FS::cust_main_invoice;
44 use FS::radius_usergroup;
51 @ISA = qw( FS::svc_Common );
54 $me = '[FS::svc_acct]';
56 #ask FS::UID to run this stuff for us later
57 FS::UID->install_callback( sub {
59 $dir_prefix = $conf->config('home');
60 @shells = $conf->config('shells');
61 $usernamemin = $conf->config('usernamemin') || 2;
62 $usernamemax = $conf->config('usernamemax');
63 $passwordmin = $conf->config('passwordmin'); # || 6;
65 $passwordmin = ( defined($passwordmin) && $passwordmin =~ /\d+/ )
68 $passwordmax = $conf->config('passwordmax') || 8;
69 $username_letter = $conf->exists('username-letter');
70 $username_letterfirst = $conf->exists('username-letterfirst');
71 $username_noperiod = $conf->exists('username-noperiod');
72 $username_nounderscore = $conf->exists('username-nounderscore');
73 $username_nodash = $conf->exists('username-nodash');
74 $username_uppercase = $conf->exists('username-uppercase');
75 $username_ampersand = $conf->exists('username-ampersand');
76 $username_percent = $conf->exists('username-percent');
77 $username_colon = $conf->exists('username-colon');
78 $password_noampersand = $conf->exists('password-noexclamation');
79 $password_noexclamation = $conf->exists('password-noexclamation');
80 $dirhash = $conf->config('dirhash') || 0;
81 if ( $conf->exists('warning_email') ) {
82 $warning_template = new Text::Template (
84 SOURCE => [ map "$_\n", $conf->config('warning_email') ]
85 ) or warn "can't create warning email template: $Text::Template::ERROR";
86 $warning_from = $conf->config('warning_email-from'); # || 'your-isp-is-dum'
87 $warning_subject = $conf->config('warning_email-subject') || 'Warning';
88 $warning_mimetype = $conf->config('warning_email-mimetype') || 'text/plain';
89 $warning_cc = $conf->config('warning_email-cc');
91 $warning_template = '';
93 $warning_subject = '';
94 $warning_mimetype = '';
97 $smtpmachine = $conf->config('smtpmachine');
98 $radius_password = $conf->config('radius-password') || 'Password';
99 $radius_ip = $conf->config('radius-ip') || 'Framed-IP-Address';
100 @pw_set = ( 'A'..'Z' ) if $conf->exists('password-generated-allcaps');
104 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
105 @pw_set = ( 'a'..'z', 'A'..'Z', '0'..'9', '(', ')', '#', '!', '.', ',' );
109 my ( $hashref, $cache ) = @_;
110 if ( $hashref->{'svc_acct_svcnum'} ) {
111 $self->{'_domsvc'} = FS::svc_domain->new( {
112 'svcnum' => $hashref->{'domsvc'},
113 'domain' => $hashref->{'svc_acct_domain'},
114 'catchall' => $hashref->{'svc_acct_catchall'},
121 FS::svc_acct - Object methods for svc_acct records
127 $record = new FS::svc_acct \%hash;
128 $record = new FS::svc_acct { 'column' => 'value' };
130 $error = $record->insert;
132 $error = $new_record->replace($old_record);
134 $error = $record->delete;
136 $error = $record->check;
138 $error = $record->suspend;
140 $error = $record->unsuspend;
142 $error = $record->cancel;
144 %hash = $record->radius;
146 %hash = $record->radius_reply;
148 %hash = $record->radius_check;
150 $domain = $record->domain;
152 $svc_domain = $record->svc_domain;
154 $email = $record->email;
156 $seconds_since = $record->seconds_since($timestamp);
160 An FS::svc_acct object represents an account. FS::svc_acct inherits from
161 FS::svc_Common. The following fields are currently supported:
167 Primary key (assigned automatcially for new accounts)
175 =item _password_encoding
177 plain, crypt, ldap (or empty for autodetection)
185 Point of presence (see L<FS::svc_acct_pop>)
197 set automatically if blank (and uid is not)
217 svcnum from svc_domain
221 Optional svcnum from svc_pbx
223 =item radius_I<Radius_Attribute>
225 I<Radius-Attribute> (reply)
227 =item rc_I<Radius_Attribute>
229 I<Radius-Attribute> (check)
239 Creates a new account. To add the account to the database, see L<"insert">.
246 'longname_plural' => 'Access accounts and mailboxes',
247 'sorts' => [ 'username', 'uid', 'seconds', 'last_login' ],
248 'display_weight' => 10,
249 'cancel_weight' => 50,
251 'dir' => 'Home directory',
254 def_info => 'set to fixed and blank for no UIDs',
257 'slipip' => 'IP address',
258 # 'popnum' => qq!<A HREF="$p/browse/svc_acct_pop.cgi/">POP number</A>!,
260 label => 'Access number',
262 select_table => 'svc_acct_pop',
263 select_key => 'popnum',
264 select_label => 'city',
270 disable_default => 1,
275 label => 'Communigate account type',
278 disable_inventory => 1,
281 'cgp_accessmodes' => {
282 label => 'Communigate enabled services',
283 type => 'communigate_pro-accessmodes',
284 disable_inventory => 1,
288 label => 'Quota', #Mail storage limit
290 disable_inventory => 1,
294 label => 'File storage limit',
296 disable_inventory => 1,
300 label => 'Number of files limit',
302 disable_inventory => 1,
306 label => 'File size limit',
308 disable_inventory => 1,
311 '_password' => 'Password',
314 def_info => 'when blank, defaults to UID',
319 def_info => 'set to blank for no shell tracking',
321 #select_list => [ $conf->config('shells') ],
322 select_list => [ $conf ? $conf->config('shells') : () ],
323 disable_inventory => 1,
326 'finger' => 'Real name', # (GECOS)',
330 select_table => 'svc_domain',
331 select_key => 'svcnum',
332 select_label => 'domain',
333 disable_inventory => 1,
339 select_table => 'svc_domain',
340 select_key => 'svcnum',
341 select_label => 'domain',
342 disable_inventory => 1,
345 'pbxsvc' => { label => 'PBX',
346 type => 'select-svc_pbx.html',
347 disable_inventory => 1,
348 disable_select => 1, #UI wonky, pry works otherwise
351 label => 'RADIUS groups',
352 type => 'radius_usergroup_selector',
353 disable_inventory => 1,
356 'seconds' => { label => 'Seconds',
357 label_sort => 'with Time Remaining',
359 disable_inventory => 1,
361 disable_part_svc_column => 1,
363 'upbytes' => { label => 'Upload',
365 disable_inventory => 1,
367 'format' => \&FS::UI::bytecount::display_bytecount,
368 'parse' => \&FS::UI::bytecount::parse_bytecount,
369 disable_part_svc_column => 1,
371 'downbytes' => { label => 'Download',
373 disable_inventory => 1,
375 'format' => \&FS::UI::bytecount::display_bytecount,
376 'parse' => \&FS::UI::bytecount::parse_bytecount,
377 disable_part_svc_column => 1,
379 'totalbytes'=> { label => 'Total up and download',
381 disable_inventory => 1,
383 'format' => \&FS::UI::bytecount::display_bytecount,
384 'parse' => \&FS::UI::bytecount::parse_bytecount,
385 disable_part_svc_column => 1,
387 'seconds_threshold' => { label => 'Seconds threshold',
389 disable_inventory => 1,
391 disable_part_svc_column => 1,
393 'upbytes_threshold' => { label => 'Upload threshold',
395 disable_inventory => 1,
397 'format' => \&FS::UI::bytecount::display_bytecount,
398 'parse' => \&FS::UI::bytecount::parse_bytecount,
399 disable_part_svc_column => 1,
401 'downbytes_threshold' => { label => 'Download threshold',
403 disable_inventory => 1,
405 'format' => \&FS::UI::bytecount::display_bytecount,
406 'parse' => \&FS::UI::bytecount::parse_bytecount,
407 disable_part_svc_column => 1,
409 'totalbytes_threshold'=> { label => 'Total up and download threshold',
411 disable_inventory => 1,
413 'format' => \&FS::UI::bytecount::display_bytecount,
414 'parse' => \&FS::UI::bytecount::parse_bytecount,
415 disable_part_svc_column => 1,
418 label => 'Last login',
422 label => 'Last logout',
429 sub table { 'svc_acct'; }
431 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
435 #false laziness with edit/svc_acct.cgi
437 my( $self, $groups ) = @_;
438 if ( ref($groups) eq 'ARRAY' ) {
440 } elsif ( length($groups) ) {
441 [ split(/\s*,\s*/, $groups) ];
450 shift->_lastlog('in', @_);
454 shift->_lastlog('out', @_);
458 my( $self, $op, $time ) = @_;
460 if ( defined($time) ) {
461 warn "$me last_log$op called on svcnum ". $self->svcnum.
462 ' ('. $self->email. "): $time\n"
467 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
471 my $sth = $dbh->prepare( $sql )
472 or die "Error preparing $sql: ". $dbh->errstr;
473 my $rv = $sth->execute($time, $self->svcnum);
474 die "Error executing $sql: ". $sth->errstr
476 die "Can't update last_log$op for svcnum". $self->svcnum
479 $self->{'Hash'}->{"last_log$op"} = $time;
481 $self->getfield("last_log$op");
485 =item search_sql STRING
487 Class method which returns an SQL fragment to search for the given string.
492 my( $class, $string ) = @_;
493 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
494 my( $username, $domain ) = ( $1, $2 );
495 my $q_username = dbh->quote($username);
496 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
498 "svc_acct.username = $q_username AND ( ".
499 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
504 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
506 $class->search_sql_field('slipip', $string ).
508 $class->search_sql_field('username', $string ).
511 $class->search_sql_field('username', $string);
515 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
517 Returns the "username@domain" string for this account.
519 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
529 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
531 Returns a longer string label for this acccount ("Real Name <username@domain>"
532 if available, or "username@domain").
534 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
541 my $label = $self->label(@_);
542 my $finger = $self->finger;
543 return $label unless $finger =~ /\S/;
544 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
545 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
549 =item insert [ , OPTION => VALUE ... ]
551 Adds this account to the database. If there is an error, returns the error,
552 otherwise returns false.
554 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
555 defined. An FS::cust_svc record will be created and inserted.
557 The additional field I<usergroup> can optionally be defined; if so it should
558 contain an arrayref of group names. See L<FS::radius_usergroup>.
560 The additional field I<child_objects> can optionally be defined; if so it
561 should contain an arrayref of FS::tablename objects. They will have their
562 svcnum fields set and will be inserted after this record, but before any
563 exports are run. Each element of the array can also optionally be a
564 two-element array reference containing the child object and the name of an
565 alternate field to be filled in with the newly-inserted svcnum, for example
566 C<[ $svc_forward, 'srcsvc' ]>
568 Currently available options are: I<depend_jobnum>
570 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
571 jobnums), all provisioning jobs will have a dependancy on the supplied
572 jobnum(s) (they will not run until the specific job(s) complete(s)).
574 (TODOC: L<FS::queue> and L<freeside-queued>)
576 (TODOC: new exports!)
585 warn "[$me] insert called on $self: ". Dumper($self).
586 "\nwith options: ". Dumper(%options);
589 local $SIG{HUP} = 'IGNORE';
590 local $SIG{INT} = 'IGNORE';
591 local $SIG{QUIT} = 'IGNORE';
592 local $SIG{TERM} = 'IGNORE';
593 local $SIG{TSTP} = 'IGNORE';
594 local $SIG{PIPE} = 'IGNORE';
596 my $oldAutoCommit = $FS::UID::AutoCommit;
597 local $FS::UID::AutoCommit = 0;
601 my $error = $self->SUPER::insert(
602 'jobnums' => \@jobnums,
603 'child_objects' => $self->child_objects,
607 $dbh->rollback if $oldAutoCommit;
611 if ( $self->usergroup ) {
612 foreach my $groupname ( @{$self->usergroup} ) {
613 my $radius_usergroup = new FS::radius_usergroup ( {
614 svcnum => $self->svcnum,
615 groupname => $groupname,
617 my $error = $radius_usergroup->insert;
619 $dbh->rollback if $oldAutoCommit;
625 unless ( $skip_fuzzyfiles ) {
626 $error = $self->queue_fuzzyfiles_update;
628 $dbh->rollback if $oldAutoCommit;
629 return "updating fuzzy search cache: $error";
633 my $cust_pkg = $self->cust_svc->cust_pkg;
636 my $cust_main = $cust_pkg->cust_main;
637 my $agentnum = $cust_main->agentnum;
639 if ( $conf->exists('emailinvoiceautoalways')
640 || $conf->exists('emailinvoiceauto')
641 && ! $cust_main->invoicing_list_emailonly
643 my @invoicing_list = $cust_main->invoicing_list;
644 push @invoicing_list, $self->email;
645 $cust_main->invoicing_list(\@invoicing_list);
649 my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
650 = ('','','','','','');
652 if ( $conf->exists('welcome_email', $agentnum) ) {
653 $welcome_template = new Text::Template (
655 SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
656 ) or warn "can't create welcome email template: $Text::Template::ERROR";
657 $welcome_from = $conf->config('welcome_email-from', $agentnum);
658 # || 'your-isp-is-dum'
659 $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
661 $welcome_subject_template = new Text::Template (
663 SOURCE => $welcome_subject,
664 ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
665 $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
668 if ( $welcome_template && $cust_pkg ) {
669 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
673 'custnum' => $self->custnum,
674 'username' => $self->username,
675 'password' => $self->_password,
676 'first' => $cust_main->first,
677 'last' => $cust_main->getfield('last'),
678 'pkg' => $cust_pkg->part_pkg->pkg,
680 my $wqueue = new FS::queue {
681 'svcnum' => $self->svcnum,
682 'job' => 'FS::svc_acct::send_email'
684 my $error = $wqueue->insert(
686 'from' => $welcome_from,
687 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
688 'mimetype' => $welcome_mimetype,
689 'body' => $welcome_template->fill_in( HASH => \%hash, ),
692 $dbh->rollback if $oldAutoCommit;
693 return "error queuing welcome email: $error";
696 if ( $options{'depend_jobnum'} ) {
697 warn "$me depend_jobnum found; adding to welcome email dependancies"
699 if ( ref($options{'depend_jobnum'}) ) {
700 warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
701 "to welcome email dependancies"
703 push @jobnums, @{ $options{'depend_jobnum'} };
705 warn "$me adding job $options{'depend_jobnum'} ".
706 "to welcome email dependancies"
708 push @jobnums, $options{'depend_jobnum'};
712 foreach my $jobnum ( @jobnums ) {
713 my $error = $wqueue->depend_insert($jobnum);
715 $dbh->rollback if $oldAutoCommit;
716 return "error queuing welcome email job dependancy: $error";
726 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
730 # set usage fields and thresholds if unset but set in a package def
731 # AND the package already has a last bill date (otherwise they get double added)
732 sub preinsert_hook_first {
735 return '' unless $self->pkgnum;
737 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
738 return '' unless $cust_pkg && $cust_pkg->last_bill;
740 my $part_pkg = $cust_pkg->part_pkg;
741 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
743 my %values = $part_pkg->usage_valuehash;
744 my $multiplier = $conf->exists('svc_acct-usage_threshold')
745 ? 1 - $conf->config('svc_acct-usage_threshold')/100
746 : 0.20; #doesn't matter
748 foreach ( keys %values ) {
749 next if $self->getfield($_);
750 $self->setfield( $_, $values{$_} );
751 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
752 if $conf->exists('svc_acct-usage_threshold');
760 Deletes this account from the database. If there is an error, returns the
761 error, otherwise returns false.
763 The corresponding FS::cust_svc record will be deleted as well.
765 (TODOC: new exports!)
772 return "can't delete system account" if $self->_check_system;
774 return "Can't delete an account which is a (svc_forward) source!"
775 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
777 return "Can't delete an account which is a (svc_forward) destination!"
778 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
780 return "Can't delete an account with (svc_www) web service!"
781 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
783 # what about records in session ? (they should refer to history table)
785 local $SIG{HUP} = 'IGNORE';
786 local $SIG{INT} = 'IGNORE';
787 local $SIG{QUIT} = 'IGNORE';
788 local $SIG{TERM} = 'IGNORE';
789 local $SIG{TSTP} = 'IGNORE';
790 local $SIG{PIPE} = 'IGNORE';
792 my $oldAutoCommit = $FS::UID::AutoCommit;
793 local $FS::UID::AutoCommit = 0;
796 foreach my $cust_main_invoice (
797 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
799 unless ( defined($cust_main_invoice) ) {
800 warn "WARNING: something's wrong with qsearch";
803 my %hash = $cust_main_invoice->hash;
804 $hash{'dest'} = $self->email;
805 my $new = new FS::cust_main_invoice \%hash;
806 my $error = $new->replace($cust_main_invoice);
808 $dbh->rollback if $oldAutoCommit;
813 foreach my $svc_domain (
814 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
816 my %hash = new FS::svc_domain->hash;
817 $hash{'catchall'} = '';
818 my $new = new FS::svc_domain \%hash;
819 my $error = $new->replace($svc_domain);
821 $dbh->rollback if $oldAutoCommit;
826 my $error = $self->SUPER::delete;
828 $dbh->rollback if $oldAutoCommit;
832 foreach my $radius_usergroup (
833 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } )
835 my $error = $radius_usergroup->delete;
837 $dbh->rollback if $oldAutoCommit;
842 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
846 =item replace OLD_RECORD
848 Replaces OLD_RECORD with this one in the database. If there is an error,
849 returns the error, otherwise returns false.
851 The additional field I<usergroup> can optionally be defined; if so it should
852 contain an arrayref of group names. See L<FS::radius_usergroup>.
860 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
864 warn "$me replacing $old with $new\n" if $DEBUG;
868 return "can't modify system account" if $old->_check_system;
871 #no warnings 'numeric'; #alas, a 5.006-ism
874 foreach my $xid (qw( uid gid )) {
876 return "Can't change $xid!"
877 if ! $conf->exists("svc_acct-edit_$xid")
878 && $old->$xid() != $new->$xid()
879 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
884 #change homdir when we change username
885 $new->setfield('dir', '') if $old->username ne $new->username;
887 local $SIG{HUP} = 'IGNORE';
888 local $SIG{INT} = 'IGNORE';
889 local $SIG{QUIT} = 'IGNORE';
890 local $SIG{TERM} = 'IGNORE';
891 local $SIG{TSTP} = 'IGNORE';
892 local $SIG{PIPE} = 'IGNORE';
894 my $oldAutoCommit = $FS::UID::AutoCommit;
895 local $FS::UID::AutoCommit = 0;
898 # redundant, but so $new->usergroup gets set
899 $error = $new->check;
900 return $error if $error;
902 $old->usergroup( [ $old->radius_groups ] );
904 warn $old->email. " old groups: ". join(' ',@{$old->usergroup}). "\n";
905 warn $new->email. "new groups: ". join(' ',@{$new->usergroup}). "\n";
907 if ( $new->usergroup ) {
908 #(sorta) false laziness with FS::part_export::sqlradius::_export_replace
909 my @newgroups = @{$new->usergroup};
910 foreach my $oldgroup ( @{$old->usergroup} ) {
911 if ( grep { $oldgroup eq $_ } @newgroups ) {
912 @newgroups = grep { $oldgroup ne $_ } @newgroups;
915 my $radius_usergroup = qsearchs('radius_usergroup', {
916 svcnum => $old->svcnum,
917 groupname => $oldgroup,
919 my $error = $radius_usergroup->delete;
921 $dbh->rollback if $oldAutoCommit;
922 return "error deleting radius_usergroup $oldgroup: $error";
926 foreach my $newgroup ( @newgroups ) {
927 my $radius_usergroup = new FS::radius_usergroup ( {
928 svcnum => $new->svcnum,
929 groupname => $newgroup,
931 my $error = $radius_usergroup->insert;
933 $dbh->rollback if $oldAutoCommit;
934 return "error adding radius_usergroup $newgroup: $error";
940 $error = $new->SUPER::replace($old, @_);
942 $dbh->rollback if $oldAutoCommit;
943 return $error if $error;
946 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
947 $error = $new->queue_fuzzyfiles_update;
949 $dbh->rollback if $oldAutoCommit;
950 return "updating fuzzy search cache: $error";
954 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
958 =item queue_fuzzyfiles_update
960 Used by insert & replace to update the fuzzy search cache
964 sub queue_fuzzyfiles_update {
967 local $SIG{HUP} = 'IGNORE';
968 local $SIG{INT} = 'IGNORE';
969 local $SIG{QUIT} = 'IGNORE';
970 local $SIG{TERM} = 'IGNORE';
971 local $SIG{TSTP} = 'IGNORE';
972 local $SIG{PIPE} = 'IGNORE';
974 my $oldAutoCommit = $FS::UID::AutoCommit;
975 local $FS::UID::AutoCommit = 0;
978 my $queue = new FS::queue {
979 'svcnum' => $self->svcnum,
980 'job' => 'FS::svc_acct::append_fuzzyfiles'
982 my $error = $queue->insert($self->username);
984 $dbh->rollback if $oldAutoCommit;
985 return "queueing job (transaction rolled back): $error";
988 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
996 Suspends this account by calling export-specific suspend hooks. If there is
997 an error, returns the error, otherwise returns false.
999 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1005 return "can't suspend system account" if $self->_check_system;
1006 $self->SUPER::suspend(@_);
1011 Unsuspends this account by by calling export-specific suspend hooks. If there
1012 is an error, returns the error, otherwise returns false.
1014 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1020 my %hash = $self->hash;
1021 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1022 $hash{_password} = $1;
1023 my $new = new FS::svc_acct ( \%hash );
1024 my $error = $new->replace($self);
1025 return $error if $error;
1028 $self->SUPER::unsuspend(@_);
1033 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1035 If the B<auto_unset_catchall> configuration option is set, this method will
1036 automatically remove any references to the canceled service in the catchall
1037 field of svc_domain. This allows packages that contain both a svc_domain and
1038 its catchall svc_acct to be canceled in one step.
1043 # Only one thing to do at this level
1045 foreach my $svc_domain (
1046 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1047 if($conf->exists('auto_unset_catchall')) {
1048 my %hash = $svc_domain->hash;
1049 $hash{catchall} = '';
1050 my $new = new FS::svc_domain ( \%hash );
1051 my $error = $new->replace($svc_domain);
1052 return $error if $error;
1054 return "cannot unprovision svc_acct #".$self->svcnum.
1055 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1059 $self->SUPER::cancel(@_);
1065 Checks all fields to make sure this is a valid service. If there is an error,
1066 returns the error, otherwise returns false. Called by the insert and replace
1069 Sets any fixed values; see L<FS::part_svc>.
1076 my($recref) = $self->hashref;
1078 my $x = $self->setfixed( $self->_fieldhandlers );
1079 return $x unless ref($x);
1082 if ( $part_svc->part_svc_column('usergroup')->columnflag eq "F" ) {
1084 [ split(',', $part_svc->part_svc_column('usergroup')->columnvalue) ] );
1087 my $error = $self->ut_numbern('svcnum')
1088 #|| $self->ut_number('domsvc')
1089 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1090 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1091 || $self->ut_textn('sec_phrase')
1092 || $self->ut_snumbern('seconds')
1093 || $self->ut_snumbern('upbytes')
1094 || $self->ut_snumbern('downbytes')
1095 || $self->ut_snumbern('totalbytes')
1096 || $self->ut_enum( '_password_encoding',
1097 [ '', qw( plain crypt ldap ) ]
1099 || $self->ut_enum( 'password_selfchange', [ '', 'Y' ] )
1100 || $self->ut_enum( 'password_recover', [ '', 'Y' ] )
1101 || $self->ut_textn( 'cgp_accessmodes' )
1102 || $self->ut_alphan( 'cgp_type' )
1104 return $error if $error;
1107 local $username_letter = $username_letter;
1108 if ($self->svcnum) {
1109 my $cust_svc = $self->cust_svc
1110 or return "no cust_svc record found for svcnum ". $self->svcnum;
1111 my $cust_pkg = $cust_svc->cust_pkg;
1113 if ($self->pkgnum) {
1114 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1118 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1121 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1122 if ( $username_uppercase ) {
1123 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:]{$usernamemin,$ulen})$/i
1124 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1125 $recref->{username} = $1;
1127 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:]{$usernamemin,$ulen})$/
1128 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1129 $recref->{username} = $1;
1132 if ( $username_letterfirst ) {
1133 $recref->{username} =~ /^[a-z]/ or return gettext('illegal_username');
1134 } elsif ( $username_letter ) {
1135 $recref->{username} =~ /[a-z]/ or return gettext('illegal_username');
1137 if ( $username_noperiod ) {
1138 $recref->{username} =~ /\./ and return gettext('illegal_username');
1140 if ( $username_nounderscore ) {
1141 $recref->{username} =~ /_/ and return gettext('illegal_username');
1143 if ( $username_nodash ) {
1144 $recref->{username} =~ /\-/ and return gettext('illegal_username');
1146 unless ( $username_ampersand ) {
1147 $recref->{username} =~ /\&/ and return gettext('illegal_username');
1149 unless ( $username_percent ) {
1150 $recref->{username} =~ /\%/ and return gettext('illegal_username');
1152 unless ( $username_colon ) {
1153 $recref->{username} =~ /\:/ and return gettext('illegal_username');
1156 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1157 $recref->{popnum} = $1;
1158 return "Unknown popnum" unless
1159 ! $recref->{popnum} ||
1160 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1162 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1164 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1165 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1167 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1168 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1169 #not all systems use gid=uid
1170 #you can set a fixed gid in part_svc
1172 return "Only root can have uid 0"
1173 if $recref->{uid} == 0
1174 && $recref->{username} !~ /^(root|toor|smtp)$/;
1176 unless ( $recref->{username} eq 'sync' ) {
1177 if ( grep $_ eq $recref->{shell}, @shells ) {
1178 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1180 return "Illegal shell \`". $self->shell. "\'; ".
1181 "shells configuration value contains: @shells";
1184 $recref->{shell} = '/bin/sync';
1188 $recref->{gid} ne '' ?
1189 return "Can't have gid without uid" : ( $recref->{gid}='' );
1190 #$recref->{dir} ne '' ?
1191 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1192 $recref->{shell} ne '' ?
1193 return "Can't have shell without uid" : ( $recref->{shell}='' );
1196 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1198 $recref->{dir} =~ /^([\/\w\-\.\&]*)$/
1199 or return "Illegal directory: ". $recref->{dir};
1200 $recref->{dir} = $1;
1201 return "Illegal directory"
1202 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1203 return "Illegal directory"
1204 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1205 unless ( $recref->{dir} ) {
1206 $recref->{dir} = $dir_prefix . '/';
1207 if ( $dirhash > 0 ) {
1208 for my $h ( 1 .. $dirhash ) {
1209 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1211 } elsif ( $dirhash < 0 ) {
1212 for my $h ( reverse $dirhash .. -1 ) {
1213 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1216 $recref->{dir} .= $recref->{username};
1222 # $error = $self->ut_textn('finger');
1223 # return $error if $error;
1224 if ( $self->getfield('finger') eq '' ) {
1225 my $cust_pkg = $self->svcnum
1226 ? $self->cust_svc->cust_pkg
1227 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1229 my $cust_main = $cust_pkg->cust_main;
1230 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1233 $self->getfield('finger') =~
1234 /^([\w \t\!\@\#\$\%\&\(\)\-\+\;\'\"\,\.\?\/\*\<\>]*)$/
1235 or return "Illegal finger: ". $self->getfield('finger');
1236 $self->setfield('finger', $1);
1238 for (qw( quota file_quota file_maxsize )) {
1239 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1242 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1243 $recref->{file_maxnum} = $1;
1245 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1246 if ( $recref->{slipip} eq '' ) {
1247 $recref->{slipip} = '';
1248 } elsif ( $recref->{slipip} eq '0e0' ) {
1249 $recref->{slipip} = '0e0';
1251 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1252 or return "Illegal slipip: ". $self->slipip;
1253 $recref->{slipip} = $1;
1258 #arbitrary RADIUS stuff; allow ut_textn for now
1259 foreach ( grep /^radius_/, fields('svc_acct') ) {
1260 $self->ut_textn($_);
1263 # First, if _password is blank, generate one and set default encoding.
1264 if ( ! $recref->{_password} ) {
1265 $error = $self->set_password('');
1267 # But if there's a _password but no encoding, assume it's plaintext and
1268 # set it to default encoding.
1269 elsif ( ! $recref->{_password_encoding} ) {
1270 $error = $self->set_password($recref->{_password});
1272 return $error if $error;
1274 # Next, check _password to ensure compliance with the encoding.
1275 if ( $recref->{_password_encoding} eq 'ldap' ) {
1277 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1278 $recref->{_password} = uc($1).$2;
1280 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1283 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1285 if ( $recref->{_password} =~
1286 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1287 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1290 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1293 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1296 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1297 # Password randomization is now in set_password.
1298 # Strip whitespace characters, check length requirements, etc.
1299 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1300 $recref->{_password} = $1;
1302 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1303 FS::Msgcat::_gettext('illegal_password_characters').
1304 ": ". $recref->{_password};
1307 if ( $password_noampersand ) {
1308 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1310 if ( $password_noexclamation ) {
1311 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1315 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1317 $self->SUPER::check;
1322 sub _password_encryption {
1324 my $encoding = lc($self->_password_encoding);
1325 return if !$encoding;
1326 return 'plain' if $encoding eq 'plain';
1327 if($encoding eq 'crypt') {
1328 my $pass = $self->_password;
1329 $pass =~ s/^\*SUSPENDED\* //;
1331 return 'md5' if $pass =~ /^\$1\$/;
1332 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1333 return 'des' if length($pass) == 13;
1336 if($encoding eq 'ldap') {
1337 uc($self->_password) =~ /^\{([\w-]+)\}/;
1338 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1339 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1340 return 'md5' if $1 eq 'MD5';
1341 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1348 sub get_cleartext_password {
1350 if($self->_password_encryption eq 'plain') {
1351 if($self->_password_encoding eq 'ldap') {
1352 $self->_password =~ /\{\w+\}(.*)$/;
1356 return $self->_password;
1365 Set the cleartext password for the account. If _password_encoding is set, the
1366 new password will be encoded according to the existing method (including
1367 encryption mode, if it can be determined). Otherwise,
1368 config('default-password-encoding') is used.
1370 If no password is supplied (or a zero-length password when minimum password length
1371 is >0), one will be generated randomly.
1376 my( $self, $pass ) = ( shift, shift );
1378 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1381 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1382 FS::Msgcat::_gettext('illegal_password_characters').
1385 my( $encoding, $encryption ) = ('', '');
1387 if ( $self->_password_encoding ) {
1388 $encoding = $self->_password_encoding;
1389 # identify existing encryption method, try to use it.
1390 $encryption = $self->_password_encryption;
1392 # use the system default
1398 # set encoding to system default
1399 ($encoding, $encryption) =
1400 split(/-/, lc($conf->config('default-password-encoding')));
1401 $encoding ||= 'legacy';
1402 $self->_password_encoding($encoding);
1405 if ( $encoding eq 'legacy' ) {
1407 # The legacy behavior from check():
1408 # If the password is blank, randomize it and set encoding to 'plain'.
1409 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1410 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1411 $self->_password_encoding('plain');
1413 # Prefix + valid-length password
1414 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1416 $self->_password_encoding('plain');
1417 # Prefix + crypt string
1418 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1420 $self->_password_encoding('crypt');
1421 # Various disabled crypt passwords
1422 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1423 $self->_password_encoding('crypt');
1429 $self->_password($pass);
1435 if $passwordmin && length($pass) < $passwordmin
1436 or $passwordmax && length($pass) > $passwordmax;
1438 if ( $encoding eq 'crypt' ) {
1439 if ($encryption eq 'md5') {
1440 $pass = unix_md5_crypt($pass);
1441 } elsif ($encryption eq 'des') {
1442 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1445 } elsif ( $encoding eq 'ldap' ) {
1446 if ($encryption eq 'md5') {
1447 $pass = md5_base64($pass);
1448 } elsif ($encryption eq 'sha1') {
1449 $pass = sha1_base64($pass);
1450 } elsif ($encryption eq 'crypt') {
1451 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1453 # else $encryption eq 'plain', do nothing
1454 $pass = '{'.uc($encryption).'}'.$pass;
1456 # else encoding eq 'plain'
1458 $self->_password($pass);
1464 Internal function to check the username against the list of system usernames
1465 from the I<system_usernames> configuration value. Returns true if the username
1466 is listed on the system username list.
1472 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1473 $conf->config('system_usernames')
1477 =item _check_duplicate
1479 Internal method to check for duplicates usernames, username@domain pairs and
1482 If the I<global_unique-username> configuration value is set to B<username> or
1483 B<username@domain>, enforces global username or username@domain uniqueness.
1485 In all cases, check for duplicate uids and usernames or username@domain pairs
1486 per export and with identical I<svcpart> values.
1490 sub _check_duplicate {
1493 my $global_unique = $conf->config('global_unique-username') || 'none';
1494 return '' if $global_unique eq 'disabled';
1498 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1499 unless ( $part_svc ) {
1500 return 'unknown svcpart '. $self->svcpart;
1503 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1504 qsearch( 'svc_acct', { 'username' => $self->username } );
1505 return gettext('username_in_use')
1506 if $global_unique eq 'username' && @dup_user;
1508 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1509 qsearch( 'svc_acct', { 'username' => $self->username,
1510 'domsvc' => $self->domsvc } );
1511 return gettext('username_in_use')
1512 if $global_unique eq 'username@domain' && @dup_userdomain;
1515 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1516 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1517 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1518 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1523 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1524 my $exports = FS::part_export::export_info('svc_acct');
1525 my %conflict_user_svcpart;
1526 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1528 foreach my $part_export ( $part_svc->part_export ) {
1530 #this will catch to the same exact export
1531 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1533 #this will catch to exports w/same exporthost+type ???
1534 #my @other_part_export = qsearch('part_export', {
1535 # 'machine' => $part_export->machine,
1536 # 'exporttype' => $part_export->exporttype,
1538 #foreach my $other_part_export ( @other_part_export ) {
1539 # push @svcparts, map { $_->svcpart }
1540 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1543 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1544 #silly kludge to avoid uninitialized value errors
1545 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1546 ? $exports->{$part_export->exporttype}{'nodomain'}
1548 if ( $nodomain =~ /^Y/i ) {
1549 $conflict_user_svcpart{$_} = $part_export->exportnum
1552 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1557 foreach my $dup_user ( @dup_user ) {
1558 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1559 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1560 return "duplicate username ". $self->username.
1561 ": conflicts with svcnum ". $dup_user->svcnum.
1562 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1566 foreach my $dup_userdomain ( @dup_userdomain ) {
1567 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1568 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1569 return "duplicate username\@domain ". $self->email.
1570 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1571 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1575 foreach my $dup_uid ( @dup_uid ) {
1576 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1577 if ( exists($conflict_user_svcpart{$dup_svcpart})
1578 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1579 return "duplicate uid ". $self->uid.
1580 ": conflicts with svcnum ". $dup_uid->svcnum.
1582 ( $conflict_user_svcpart{$dup_svcpart}
1583 || $conflict_userdomain_svcpart{$dup_svcpart} );
1595 Depriciated, use radius_reply instead.
1600 carp "FS::svc_acct::radius depriciated, use radius_reply";
1601 $_[0]->radius_reply;
1606 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1607 reply attributes of this record.
1609 Note that this is now the preferred method for reading RADIUS attributes -
1610 accessing the columns directly is discouraged, as the column names are
1611 expected to change in the future.
1618 return %{ $self->{'radius_reply'} }
1619 if exists $self->{'radius_reply'};
1624 my($column, $attrib) = ($1, $2);
1625 #$attrib =~ s/_/\-/g;
1626 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1627 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1629 if ( $self->slipip && $self->slipip ne '0e0' ) {
1630 $reply{$radius_ip} = $self->slipip;
1633 if ( $self->seconds !~ /^$/ ) {
1634 $reply{'Session-Timeout'} = $self->seconds;
1637 if ( $conf->exists('radius-chillispot-max') ) {
1638 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1640 #hmm. just because sqlradius.pm says so?
1647 foreach my $what (qw( input output total )) {
1648 my $is = $whatis{$what}.'bytes';
1649 if ( $self->$is() =~ /\d/ ) {
1650 my $big = new Math::BigInt $self->$is();
1651 $big = new Math::BigInt '0' if $big->is_neg();
1652 my $att = "Chillispot-Max-\u$what";
1653 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1654 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1665 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1666 check attributes of this record.
1668 Note that this is now the preferred method for reading RADIUS attributes -
1669 accessing the columns directly is discouraged, as the column names are
1670 expected to change in the future.
1677 return %{ $self->{'radius_check'} }
1678 if exists $self->{'radius_check'};
1683 my($column, $attrib) = ($1, $2);
1684 #$attrib =~ s/_/\-/g;
1685 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1686 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1689 my($pw_attrib, $password) = $self->radius_password;
1690 $check{$pw_attrib} = $password;
1692 my $cust_svc = $self->cust_svc;
1694 my $cust_pkg = $cust_svc->cust_pkg;
1695 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1696 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1699 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1700 "; can't set Expiration\n"
1708 =item radius_password
1710 Returns a key/value pair containing the RADIUS attribute name and value
1715 sub radius_password {
1719 if ( $self->_password_encoding eq 'ldap' ) {
1720 $pw_attrib = 'Password-With-Header';
1721 } elsif ( $self->_password_encoding eq 'crypt' ) {
1722 $pw_attrib = 'Crypt-Password';
1723 } elsif ( $self->_password_encoding eq 'plain' ) {
1724 $pw_attrib = $radius_password;
1726 $pw_attrib = length($self->_password) <= 12
1731 ($pw_attrib, $self->_password);
1737 This method instructs the object to "snapshot" or freeze RADIUS check and
1738 reply attributes to the current values.
1742 #bah, my english is too broken this morning
1743 #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
1744 #the FS::cust_pkg's replace method to trigger the correct export updates when
1745 #package dates change)
1750 $self->{$_} = { $self->$_() }
1751 foreach qw( radius_reply radius_check );
1755 =item forget_snapshot
1757 This methos instructs the object to forget any previously snapshotted
1758 RADIUS check and reply attributes.
1762 sub forget_snapshot {
1766 foreach qw( radius_reply radius_check );
1770 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1772 Returns the domain associated with this account.
1774 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1781 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1782 my $svc_domain = $self->svc_domain(@_)
1783 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1784 $svc_domain->domain;
1789 Returns the FS::svc_domain record for this account's domain (see
1794 # FS::h_svc_acct has a history-aware svc_domain override
1799 ? $self->{'_domsvc'}
1800 : qsearchs( 'svc_domain', { 'svcnum' => $self->domsvc } );
1805 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1809 #inherited from svc_Common
1811 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1813 Returns an email address associated with the account.
1815 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1822 $self->username. '@'. $self->domain(@_);
1827 Returns an array of FS::acct_snarf records associated with the account.
1828 If the acct_snarf table does not exist or there are no associated records,
1829 an empty list is returned
1835 return () unless dbdef->table('acct_snarf');
1836 eval "use FS::acct_snarf;";
1838 qsearch('acct_snarf', { 'svcnum' => $self->svcnum } );
1841 =item decrement_upbytes OCTETS
1843 Decrements the I<upbytes> field of this record by the given amount. If there
1844 is an error, returns the error, otherwise returns false.
1848 sub decrement_upbytes {
1849 shift->_op_usage('-', 'upbytes', @_);
1852 =item increment_upbytes OCTETS
1854 Increments the I<upbytes> field of this record by the given amount. If there
1855 is an error, returns the error, otherwise returns false.
1859 sub increment_upbytes {
1860 shift->_op_usage('+', 'upbytes', @_);
1863 =item decrement_downbytes OCTETS
1865 Decrements the I<downbytes> field of this record by the given amount. If there
1866 is an error, returns the error, otherwise returns false.
1870 sub decrement_downbytes {
1871 shift->_op_usage('-', 'downbytes', @_);
1874 =item increment_downbytes OCTETS
1876 Increments the I<downbytes> field of this record by the given amount. If there
1877 is an error, returns the error, otherwise returns false.
1881 sub increment_downbytes {
1882 shift->_op_usage('+', 'downbytes', @_);
1885 =item decrement_totalbytes OCTETS
1887 Decrements the I<totalbytes> field of this record by the given amount. If there
1888 is an error, returns the error, otherwise returns false.
1892 sub decrement_totalbytes {
1893 shift->_op_usage('-', 'totalbytes', @_);
1896 =item increment_totalbytes OCTETS
1898 Increments the I<totalbytes> field of this record by the given amount. If there
1899 is an error, returns the error, otherwise returns false.
1903 sub increment_totalbytes {
1904 shift->_op_usage('+', 'totalbytes', @_);
1907 =item decrement_seconds SECONDS
1909 Decrements the I<seconds> field of this record by the given amount. If there
1910 is an error, returns the error, otherwise returns false.
1914 sub decrement_seconds {
1915 shift->_op_usage('-', 'seconds', @_);
1918 =item increment_seconds SECONDS
1920 Increments the I<seconds> field of this record by the given amount. If there
1921 is an error, returns the error, otherwise returns false.
1925 sub increment_seconds {
1926 shift->_op_usage('+', 'seconds', @_);
1934 my %op2condition = (
1935 '-' => sub { my($self, $column, $amount) = @_;
1936 $self->$column - $amount <= 0;
1938 '+' => sub { my($self, $column, $amount) = @_;
1939 ($self->$column || 0) + $amount > 0;
1942 my %op2warncondition = (
1943 '-' => sub { my($self, $column, $amount) = @_;
1944 my $threshold = $column . '_threshold';
1945 $self->$column - $amount <= $self->$threshold + 0;
1947 '+' => sub { my($self, $column, $amount) = @_;
1948 ($self->$column || 0) + $amount > 0;
1953 my( $self, $op, $column, $amount ) = @_;
1955 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
1956 ' ('. $self->email. "): $op $amount\n"
1959 return '' unless $amount;
1961 local $SIG{HUP} = 'IGNORE';
1962 local $SIG{INT} = 'IGNORE';
1963 local $SIG{QUIT} = 'IGNORE';
1964 local $SIG{TERM} = 'IGNORE';
1965 local $SIG{TSTP} = 'IGNORE';
1966 local $SIG{PIPE} = 'IGNORE';
1968 my $oldAutoCommit = $FS::UID::AutoCommit;
1969 local $FS::UID::AutoCommit = 0;
1972 my $sql = "UPDATE svc_acct SET $column = ".
1973 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
1974 " $op ? WHERE svcnum = ?";
1978 my $sth = $dbh->prepare( $sql )
1979 or die "Error preparing $sql: ". $dbh->errstr;
1980 my $rv = $sth->execute($amount, $self->svcnum);
1981 die "Error executing $sql: ". $sth->errstr
1982 unless defined($rv);
1983 die "Can't update $column for svcnum". $self->svcnum
1986 #$self->snapshot; #not necessary, we retain the old values
1987 #create an object with the updated usage values
1988 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
1990 my $error = $new->replace($self);
1992 $dbh->rollback if $oldAutoCommit;
1993 return "Error replacing: $error";
1996 #overlimit_action eq 'cancel' handling
1997 my $cust_pkg = $self->cust_svc->cust_pkg;
1999 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2000 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2004 my $error = $cust_pkg->cancel; #XXX should have a reason
2006 $dbh->rollback if $oldAutoCommit;
2007 return "Error cancelling: $error";
2010 #nothing else is relevant if we're cancelling, so commit & return success
2011 warn "$me update successful; committing\n"
2013 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2018 my $action = $op2action{$op};
2020 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2021 ( $action eq 'suspend' && !$self->overlimit
2022 || $action eq 'unsuspend' && $self->overlimit )
2025 my $error = $self->_op_overlimit($action);
2027 $dbh->rollback if $oldAutoCommit;
2033 if ( $conf->exists("svc_acct-usage_$action")
2034 && &{$op2condition{$op}}($self, $column, $amount) ) {
2035 #my $error = $self->$action();
2036 my $error = $self->cust_svc->cust_pkg->$action();
2037 # $error ||= $self->overlimit($action);
2039 $dbh->rollback if $oldAutoCommit;
2040 return "Error ${action}ing: $error";
2044 if ($warning_template && &{$op2warncondition{$op}}($self, $column, $amount)) {
2045 my $wqueue = new FS::queue {
2046 'svcnum' => $self->svcnum,
2047 'job' => 'FS::svc_acct::reached_threshold',
2052 $to = $warning_cc if &{$op2condition{$op}}($self, $column, $amount);
2056 my $error = $wqueue->insert(
2057 'svcnum' => $self->svcnum,
2059 'column' => $column,
2063 $dbh->rollback if $oldAutoCommit;
2064 return "Error queuing threshold activity: $error";
2068 warn "$me update successful; committing\n"
2070 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2076 my( $self, $action ) = @_;
2078 local $SIG{HUP} = 'IGNORE';
2079 local $SIG{INT} = 'IGNORE';
2080 local $SIG{QUIT} = 'IGNORE';
2081 local $SIG{TERM} = 'IGNORE';
2082 local $SIG{TSTP} = 'IGNORE';
2083 local $SIG{PIPE} = 'IGNORE';
2085 my $oldAutoCommit = $FS::UID::AutoCommit;
2086 local $FS::UID::AutoCommit = 0;
2089 my $cust_pkg = $self->cust_svc->cust_pkg;
2091 my $conf_overlimit =
2093 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2094 : $conf->config('overlimit_groups');
2096 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2098 my $groups = $conf_overlimit || $part_export->option('overlimit_groups');
2099 next unless $groups;
2101 my $gref = &{ $self->_fieldhandlers->{'usergroup'} }( $self, $groups );
2103 my $other = new FS::svc_acct $self->hashref;
2104 $other->usergroup( $gref );
2107 if ($action eq 'suspend') {
2110 } else { # $action eq 'unsuspend'
2115 my $error = $part_export->export_replace($new, $old)
2116 || $self->overlimit($action);
2119 $dbh->rollback if $oldAutoCommit;
2120 return "Error replacing radius groups: $error";
2125 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2131 my( $self, $valueref, %options ) = @_;
2133 warn "$me set_usage called for svcnum ". $self->svcnum.
2134 ' ('. $self->email. "): ".
2135 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2138 local $SIG{HUP} = 'IGNORE';
2139 local $SIG{INT} = 'IGNORE';
2140 local $SIG{QUIT} = 'IGNORE';
2141 local $SIG{TERM} = 'IGNORE';
2142 local $SIG{TSTP} = 'IGNORE';
2143 local $SIG{PIPE} = 'IGNORE';
2145 local $FS::svc_Common::noexport_hack = 1;
2146 my $oldAutoCommit = $FS::UID::AutoCommit;
2147 local $FS::UID::AutoCommit = 0;
2152 if ( $options{null} ) {
2153 %handyhash = ( map { ( $_ => 'NULL', $_."_threshold" => 'NULL' ) }
2154 qw( seconds upbytes downbytes totalbytes )
2157 foreach my $field (keys %$valueref){
2158 $reset = 1 if $valueref->{$field};
2159 $self->setfield($field, $valueref->{$field});
2160 $self->setfield( $field.'_threshold',
2161 int($self->getfield($field)
2162 * ( $conf->exists('svc_acct-usage_threshold')
2163 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2168 $handyhash{$field} = $self->getfield($field);
2169 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2171 #my $error = $self->replace; #NO! we avoid the call to ->check for
2172 #die $error if $error; #services not explicity changed via the UI
2174 my $sql = "UPDATE svc_acct SET " .
2175 join (',', map { "$_ = $handyhash{$_}" } (keys %handyhash) ).
2176 " WHERE svcnum = ". $self->svcnum;
2181 if (scalar(keys %handyhash)) {
2182 my $sth = $dbh->prepare( $sql )
2183 or die "Error preparing $sql: ". $dbh->errstr;
2184 my $rv = $sth->execute();
2185 die "Error executing $sql: ". $sth->errstr
2186 unless defined($rv);
2187 die "Can't update usage for svcnum ". $self->svcnum
2191 #$self->snapshot; #not necessary, we retain the old values
2192 #create an object with the updated usage values
2193 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2194 local($FS::Record::nowarn_identical) = 1;
2195 my $error = $new->replace($self); #call exports
2197 $dbh->rollback if $oldAutoCommit;
2198 return "Error replacing: $error";
2205 $error = $self->_op_overlimit('unsuspend')
2206 if $self->overlimit;;
2208 $error ||= $self->cust_svc->cust_pkg->unsuspend
2209 if $conf->exists("svc_acct-usage_unsuspend");
2212 $dbh->rollback if $oldAutoCommit;
2213 return "Error unsuspending: $error";
2218 warn "$me update successful; committing\n"
2220 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2226 =item recharge HASHREF
2228 Increments usage columns by the amount specified in HASHREF as
2229 column=>amount pairs.
2234 my ($self, $vhash) = @_;
2237 warn "[$me] recharge called on $self: ". Dumper($self).
2238 "\nwith vhash: ". Dumper($vhash);
2241 my $oldAutoCommit = $FS::UID::AutoCommit;
2242 local $FS::UID::AutoCommit = 0;
2246 foreach my $column (keys %$vhash){
2247 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2251 $dbh->rollback if $oldAutoCommit;
2253 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2258 =item is_rechargeable
2260 Returns true if this svc_account can be "recharged" and false otherwise.
2264 sub is_rechargable {
2266 $self->seconds ne ''
2267 || $self->upbytes ne ''
2268 || $self->downbytes ne ''
2269 || $self->totalbytes ne '';
2272 =item seconds_since TIMESTAMP
2274 Returns the number of seconds this account has been online since TIMESTAMP,
2275 according to the session monitor (see L<FS::Session>).
2277 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2278 L<Time::Local> and L<Date::Parse> for conversion functions.
2282 #note: POD here, implementation in FS::cust_svc
2285 $self->cust_svc->seconds_since(@_);
2288 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2290 Returns the numbers of seconds this account has been online between
2291 TIMESTAMP_START (inclusive) and TIMESTAMP_END (exclusive), according to an
2292 external SQL radacct table, specified via sqlradius export. Sessions which
2293 started in the specified range but are still open are counted from session
2294 start to the end of the range (unless they are over 1 day old, in which case
2295 they are presumed missing their stop record and not counted). Also, sessions
2296 which end in the range but started earlier are counted from the start of the
2297 range to session end. Finally, sessions which start before the range but end
2298 after are counted for the entire range.
2300 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2301 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2306 #note: POD here, implementation in FS::cust_svc
2307 sub seconds_since_sqlradacct {
2309 $self->cust_svc->seconds_since_sqlradacct(@_);
2312 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2314 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2315 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2316 TIMESTAMP_END (exclusive).
2318 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2319 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2324 #note: POD here, implementation in FS::cust_svc
2325 sub attribute_since_sqlradacct {
2327 $self->cust_svc->attribute_since_sqlradacct(@_);
2330 =item get_session_history TIMESTAMP_START TIMESTAMP_END
2332 Returns an array of hash references of this customers login history for the
2333 given time range. (document this better)
2337 sub get_session_history {
2339 $self->cust_svc->get_session_history(@_);
2342 =item last_login_text
2344 Returns text describing the time of last login.
2348 sub last_login_text {
2350 $self->last_login ? ctime($self->last_login) : 'unknown';
2353 =item get_cdrs TIMESTAMP_START TIMESTAMP_END [ 'OPTION' => 'VALUE ... ]
2358 my($self, $start, $end, %opt ) = @_;
2360 my $did = $self->username; #yup
2362 my $prefix = $opt{'default_prefix'}; #convergent.au '+61'
2364 my $for_update = $opt{'for_update'} ? 'FOR UPDATE' : '';
2366 #SELECT $for_update * FROM cdr
2367 # WHERE calldate >= $start #need a conversion
2368 # AND calldate < $end #ditto
2369 # AND ( charged_party = "$did"
2370 # OR charged_party = "$prefix$did" #if length($prefix);
2371 # OR ( ( charged_party IS NULL OR charged_party = '' )
2373 # ( src = "$did" OR src = "$prefix$did" ) # if length($prefix)
2376 # AND ( freesidestatus IS NULL OR freesidestatus = '' )
2379 if ( length($prefix) ) {
2381 " AND ( charged_party = '$did'
2382 OR charged_party = '$prefix$did'
2383 OR ( ( charged_party IS NULL OR charged_party = '' )
2385 ( src = '$did' OR src = '$prefix$did' )
2391 " AND ( charged_party = '$did'
2392 OR ( ( charged_party IS NULL OR charged_party = '' )
2402 'select' => "$for_update *",
2405 #( freesidestatus IS NULL OR freesidestatus = '' )
2406 'freesidestatus' => '',
2408 'extra_sql' => $charged_or_src,
2416 Returns all RADIUS groups for this account (see L<FS::radius_usergroup>).
2422 if ( $self->usergroup ) {
2423 confess "explicitly specified usergroup not an arrayref: ". $self->usergroup
2424 unless ref($self->usergroup) eq 'ARRAY';
2425 #when provisioning records, export callback runs in svc_Common.pm before
2426 #radius_usergroup records can be inserted...
2427 @{$self->usergroup};
2429 map { $_->groupname }
2430 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } );
2434 =item clone_suspended
2436 Constructor used by FS::part_export::_export_suspend fallback. Document
2441 sub clone_suspended {
2443 my %hash = $self->hash;
2444 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2445 new FS::svc_acct \%hash;
2448 =item clone_kludge_unsuspend
2450 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2455 sub clone_kludge_unsuspend {
2457 my %hash = $self->hash;
2458 $hash{_password} = '';
2459 new FS::svc_acct \%hash;
2462 =item check_password
2464 Checks the supplied password against the (possibly encrypted) password in the
2465 database. Returns true for a successful authentication, false for no match.
2467 Currently supported encryptions are: classic DES crypt() and MD5
2471 sub check_password {
2472 my($self, $check_password) = @_;
2474 #remove old-style SUSPENDED kludge, they should be allowed to login to
2475 #self-service and pay up
2476 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2478 if ( $self->_password_encoding eq 'ldap' ) {
2480 my $auth = from_rfc2307 Authen::Passphrase $self->_password;
2481 return $auth->match($check_password);
2483 } elsif ( $self->_password_encoding eq 'crypt' ) {
2485 my $auth = from_crypt Authen::Passphrase $self->_password;
2486 return $auth->match($check_password);
2488 } elsif ( $self->_password_encoding eq 'plain' ) {
2490 return $check_password eq $password;
2494 #XXX this could be replaced with Authen::Passphrase stuff
2496 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2498 } elsif ( length($password) < 13 ) { #plaintext
2499 $check_password eq $password;
2500 } elsif ( length($password) == 13 ) { #traditional DES crypt
2501 crypt($check_password, $password) eq $password;
2502 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2503 unix_md5_crypt($check_password, $password) eq $password;
2504 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2505 warn "Can't check password: Blowfish encryption not yet supported, ".
2506 "svcnum ". $self->svcnum. "\n";
2509 warn "Can't check password: Unrecognized encryption for svcnum ".
2510 $self->svcnum. "\n";
2518 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2520 Returns an encrypted password, either by passing through an encrypted password
2521 in the database or by encrypting a plaintext password from the database.
2523 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2524 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2525 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2526 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2527 encryption type is only used if the password is not already encrypted in the
2532 sub crypt_password {
2535 if ( $self->_password_encoding eq 'ldap' ) {
2537 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2540 #XXX this could be replaced with Authen::Passphrase stuff
2542 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2543 if ( $encryption eq 'crypt' ) {
2546 $saltset[int(rand(64))].$saltset[int(rand(64))]
2548 } elsif ( $encryption eq 'md5' ) {
2549 unix_md5_crypt( $self->_password );
2550 } elsif ( $encryption eq 'blowfish' ) {
2551 croak "unknown encryption method $encryption";
2553 croak "unknown encryption method $encryption";
2556 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2560 } elsif ( $self->_password_encoding eq 'crypt' ) {
2562 return $self->_password;
2564 } elsif ( $self->_password_encoding eq 'plain' ) {
2566 #XXX this could be replaced with Authen::Passphrase stuff
2568 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2569 if ( $encryption eq 'crypt' ) {
2572 $saltset[int(rand(64))].$saltset[int(rand(64))]
2574 } elsif ( $encryption eq 'md5' ) {
2575 unix_md5_crypt( $self->_password );
2576 } elsif ( $encryption eq 'blowfish' ) {
2577 croak "unknown encryption method $encryption";
2579 croak "unknown encryption method $encryption";
2584 if ( length($self->_password) == 13
2585 || $self->_password =~ /^\$(1|2a?)\$/
2586 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2592 #XXX this could be replaced with Authen::Passphrase stuff
2594 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2595 if ( $encryption eq 'crypt' ) {
2598 $saltset[int(rand(64))].$saltset[int(rand(64))]
2600 } elsif ( $encryption eq 'md5' ) {
2601 unix_md5_crypt( $self->_password );
2602 } elsif ( $encryption eq 'blowfish' ) {
2603 croak "unknown encryption method $encryption";
2605 croak "unknown encryption method $encryption";
2614 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2616 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2617 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2618 "{MD5}5426824942db4253f87a1009fd5d2d4".
2620 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2621 to work the same as the B</crypt_password> method.
2627 #eventually should check a "password-encoding" field
2629 if ( $self->_password_encoding eq 'ldap' ) {
2631 return $self->_password;
2633 } elsif ( $self->_password_encoding eq 'crypt' ) {
2635 if ( length($self->_password) == 13 ) { #crypt
2636 return '{CRYPT}'. $self->_password;
2637 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2639 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2640 # die "Blowfish encryption not supported in this context, svcnum ".
2641 # $self->svcnum. "\n";
2643 warn "encryption method not (yet?) supported in LDAP context";
2644 return '{CRYPT}*'; #unsupported, should not auth
2647 } elsif ( $self->_password_encoding eq 'plain' ) {
2649 return '{PLAIN}'. $self->_password;
2651 #return '{CLEARTEXT}'. $self->_password; #?
2655 if ( length($self->_password) == 13 ) { #crypt
2656 return '{CRYPT}'. $self->_password;
2657 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2659 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2660 warn "Blowfish encryption not supported in this context, svcnum ".
2661 $self->svcnum. "\n";
2664 #are these two necessary anymore?
2665 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2666 return '{SSHA}'. $1;
2667 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2668 return '{NS-MTA-MD5}'. $1;
2671 return '{PLAIN}'. $self->_password;
2673 #return '{CLEARTEXT}'. $self->_password; #?
2675 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2676 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2677 #if ( $encryption eq 'crypt' ) {
2678 # return '{CRYPT}'. crypt(
2680 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2682 #} elsif ( $encryption eq 'md5' ) {
2683 # unix_md5_crypt( $self->_password );
2684 #} elsif ( $encryption eq 'blowfish' ) {
2685 # croak "unknown encryption method $encryption";
2687 # croak "unknown encryption method $encryption";
2695 =item domain_slash_username
2697 Returns $domain/$username/
2701 sub domain_slash_username {
2703 $self->domain. '/'. $self->username. '/';
2706 =item virtual_maildir
2708 Returns $domain/maildirs/$username/
2712 sub virtual_maildir {
2714 $self->domain. '/maildirs/'. $self->username. '/';
2719 =head1 CLASS METHODS
2723 =item search HASHREF
2725 Class method which returns a qsearch hash expression to search for parameters
2726 specified in HASHREF. Valid parameters are
2740 Arrayref of pkgparts
2746 Arrayref of additional WHERE clauses, will be ANDed together.
2757 my ($class, $params) = @_;
2762 if ( $params->{'domain'} ) {
2763 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2764 #preserve previous behavior & bubble up an error if $svc_domain not found?
2765 push @where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2769 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2770 push @where, "domsvc = $1";
2774 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
2777 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2778 push @where, "agentnum = $1";
2782 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2783 push @where, "custnum = $1";
2787 if ( $params->{'pkgpart'} && scalar(@{ $params->{'pkgpart'} }) ) {
2788 #XXX untaint or sql quote
2790 'cust_pkg.pkgpart IN ('. join(',', @{ $params->{'pkgpart'} } ). ')';
2794 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2795 push @where, "popnum = $1";
2799 if ( $params->{'svcpart'} =~ /^(\d+)$/ ) {
2800 push @where, "svcpart = $1";
2804 # here is the agent virtualization
2805 #if ($params->{CurrentUser}) {
2807 # qsearchs('access_user', { username => $params->{CurrentUser} });
2809 # if ($access_user) {
2810 # push @where, $access_user->agentnums_sql('table'=>'cust_main');
2812 # push @where, "1=0";
2815 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
2816 'table' => 'cust_main',
2817 'null_right' => 'View/link unlinked services',
2821 push @where, @{ $params->{'where'} } if $params->{'where'};
2823 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2825 my $addl_from = ' LEFT JOIN cust_svc USING ( svcnum ) '.
2826 ' LEFT JOIN part_svc USING ( svcpart ) '.
2827 ' LEFT JOIN cust_pkg USING ( pkgnum ) '.
2828 ' LEFT JOIN cust_main USING ( custnum ) ';
2830 my $count_query = "SELECT COUNT(*) FROM svc_acct $addl_from $extra_sql";
2831 #if ( keys %svc_acct ) {
2832 # $count_query .= ' WHERE '.
2833 # join(' AND ', map "$_ = ". dbh->quote($svc_acct{$_}),
2839 'table' => 'svc_acct',
2840 'hashref' => {}, # \%svc_acct,
2841 'select' => join(', ',
2844 'cust_main.custnum',
2845 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
2847 'addl_from' => $addl_from,
2848 'extra_sql' => $extra_sql,
2849 'order_by' => $params->{'order_by'},
2850 'count_query' => $count_query,
2863 This is the FS::svc_acct job-queue-able version. It still uses
2864 FS::Misc::send_email under-the-hood.
2871 eval "use FS::Misc qw(send_email)";
2874 $opt{mimetype} ||= 'text/plain';
2875 $opt{mimetype} .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2877 my $error = send_email(
2878 'from' => $opt{from},
2880 'subject' => $opt{subject},
2881 'content-type' => $opt{mimetype},
2882 'body' => [ map "$_\n", split("\n", $opt{body}) ],
2884 die $error if $error;
2887 =item check_and_rebuild_fuzzyfiles
2891 sub check_and_rebuild_fuzzyfiles {
2892 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2893 -e "$dir/svc_acct.username"
2894 or &rebuild_fuzzyfiles;
2897 =item rebuild_fuzzyfiles
2901 sub rebuild_fuzzyfiles {
2903 use Fcntl qw(:flock);
2905 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2909 open(USERNAMELOCK,">>$dir/svc_acct.username")
2910 or die "can't open $dir/svc_acct.username: $!";
2911 flock(USERNAMELOCK,LOCK_EX)
2912 or die "can't lock $dir/svc_acct.username: $!";
2914 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2916 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2917 or die "can't open $dir/svc_acct.username.tmp: $!";
2918 print USERNAMECACHE join("\n", @all_username), "\n";
2919 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2921 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2931 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2932 open(USERNAMECACHE,"<$dir/svc_acct.username")
2933 or die "can't open $dir/svc_acct.username: $!";
2934 my @array = map { chomp; $_; } <USERNAMECACHE>;
2935 close USERNAMECACHE;
2939 =item append_fuzzyfiles USERNAME
2943 sub append_fuzzyfiles {
2944 my $username = shift;
2946 &check_and_rebuild_fuzzyfiles;
2948 use Fcntl qw(:flock);
2950 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2952 open(USERNAME,">>$dir/svc_acct.username")
2953 or die "can't open $dir/svc_acct.username: $!";
2954 flock(USERNAME,LOCK_EX)
2955 or die "can't lock $dir/svc_acct.username: $!";
2957 print USERNAME "$username\n";
2959 flock(USERNAME,LOCK_UN)
2960 or die "can't unlock $dir/svc_acct.username: $!";
2968 =item radius_usergroup_selector GROUPS_ARRAYREF [ SELECTNAME ]
2972 sub radius_usergroup_selector {
2973 my $sel_groups = shift;
2974 my %sel_groups = map { $_=>1 } @$sel_groups;
2976 my $selectname = shift || 'radius_usergroup';
2979 my $sth = $dbh->prepare(
2980 'SELECT DISTINCT(groupname) FROM radius_usergroup ORDER BY groupname'
2981 ) or die $dbh->errstr;
2982 $sth->execute() or die $sth->errstr;
2983 my @all_groups = map { $_->[0] } @{$sth->fetchall_arrayref};
2987 function ${selectname}_doadd(object) {
2988 var myvalue = object.${selectname}_add.value;
2989 var optionName = new Option(myvalue,myvalue,false,true);
2990 var length = object.$selectname.length;
2991 object.$selectname.options[length] = optionName;
2992 object.${selectname}_add.value = "";
2995 <SELECT MULTIPLE NAME="$selectname">
2998 foreach my $group ( @all_groups ) {
2999 $html .= qq(<OPTION VALUE="$group");
3000 if ( $sel_groups{$group} ) {
3001 $html .= ' SELECTED';
3002 $sel_groups{$group} = 0;
3004 $html .= ">$group</OPTION>\n";
3006 foreach my $group ( grep { $sel_groups{$_} } keys %sel_groups ) {
3007 $html .= qq(<OPTION VALUE="$group" SELECTED>$group</OPTION>\n);
3009 $html .= '</SELECT>';
3011 $html .= qq!<BR><INPUT TYPE="text" NAME="${selectname}_add">!.
3012 qq!<INPUT TYPE="button" VALUE="Add new group" onClick="${selectname}_doadd(this.form)">!;
3017 =item reached_threshold
3019 Performs some activities when svc_acct thresholds (such as number of seconds
3020 remaining) are reached.
3024 sub reached_threshold {
3027 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
3028 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
3030 if ( $opt{'op'} eq '+' ){
3031 $svc_acct->setfield( $opt{'column'}.'_threshold',
3032 int($svc_acct->getfield($opt{'column'})
3033 * ( $conf->exists('svc_acct-usage_threshold')
3034 ? $conf->config('svc_acct-usage_threshold')/100
3039 my $error = $svc_acct->replace;
3040 die $error if $error;
3041 }elsif ( $opt{'op'} eq '-' ){
3043 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
3044 return '' if ($threshold eq '' );
3046 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
3047 my $error = $svc_acct->replace;
3048 die $error if $error; # email next time, i guess
3050 if ( $warning_template ) {
3051 eval "use FS::Misc qw(send_email)";
3054 my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
3055 my $cust_main = $cust_pkg->cust_main;
3057 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ }
3058 $cust_main->invoicing_list,
3059 ($opt{'to'} ? $opt{'to'} : ())
3062 my $mimetype = $warning_mimetype;
3063 $mimetype .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
3065 my $body = $warning_template->fill_in( HASH => {
3066 'custnum' => $cust_main->custnum,
3067 'username' => $svc_acct->username,
3068 'password' => $svc_acct->_password,
3069 'first' => $cust_main->first,
3070 'last' => $cust_main->getfield('last'),
3071 'pkg' => $cust_pkg->part_pkg->pkg,
3072 'column' => $opt{'column'},
3073 'amount' => $opt{'column'} =~/bytes/
3074 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
3075 : $svc_acct->getfield($opt{'column'}),
3076 'threshold' => $opt{'column'} =~/bytes/
3077 ? FS::UI::bytecount::display_bytecount($threshold)
3082 my $error = send_email(
3083 'from' => $warning_from,
3085 'subject' => $warning_subject,
3086 'content-type' => $mimetype,
3087 'body' => [ map "$_\n", split("\n", $body) ],
3089 die $error if $error;
3092 die "unknown op: " . $opt{'op'};
3100 The $recref stuff in sub check should be cleaned up.
3102 The suspend, unsuspend and cancel methods update the database, but not the
3103 current object. This is probably a bug as it's unexpected and
3106 radius_usergroup_selector? putting web ui components in here? they should
3107 probably live somewhere else...
3109 insertion of RADIUS group stuff in insert could be done with child_objects now
3110 (would probably clean up export of them too)
3112 _op_usage and set_usage bypass the history... maybe they shouldn't
3116 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
3117 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
3118 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
3119 L<freeside-queued>), L<FS::svc_acct_pop>,
3120 schema.html from the base documentation.
3124 =item domain_select_hash %OPTIONS
3126 Returns a hash SVCNUM => DOMAIN ... representing the domains this customer
3127 may at present purchase.
3129 Currently available options are: I<pkgnum> I<svcpart>
3133 sub domain_select_hash {
3134 my ($self, %options) = @_;
3140 $part_svc = $self->part_svc;
3141 $cust_pkg = $self->cust_svc->cust_pkg
3145 $part_svc = qsearchs('part_svc', { 'svcpart' => $options{svcpart} })
3146 if $options{'svcpart'};
3148 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $options{pkgnum} })
3149 if $options{'pkgnum'};
3151 if ($part_svc && ( $part_svc->part_svc_column('domsvc')->columnflag eq 'S'
3152 || $part_svc->part_svc_column('domsvc')->columnflag eq 'F')) {
3153 %domains = map { $_->svcnum => $_->domain }
3154 map { qsearchs('svc_domain', { 'svcnum' => $_ }) }
3155 split(',', $part_svc->part_svc_column('domsvc')->columnvalue);
3156 }elsif ($cust_pkg && !$conf->exists('svc_acct-alldomains') ) {
3157 %domains = map { $_->svcnum => $_->domain }
3158 map { qsearchs('svc_domain', { 'svcnum' => $_->svcnum }) }
3159 map { qsearch('cust_svc', { 'pkgnum' => $_->pkgnum } ) }
3160 qsearch('cust_pkg', { 'custnum' => $cust_pkg->custnum });
3162 %domains = map { $_->svcnum => $_->domain } qsearch('svc_domain', {} );
3165 if ($part_svc && $part_svc->part_svc_column('domsvc')->columnflag eq 'D') {
3166 my $svc_domain = qsearchs('svc_domain',
3167 { 'svcnum' => $part_svc->part_svc_column('domsvc')->columnvalue } );
3168 if ( $svc_domain ) {
3169 $domains{$svc_domain->svcnum} = $svc_domain->domain;
3171 warn "unknown svc_domain.svcnum for part_svc_column domsvc: ".
3172 $part_svc->part_svc_column('domsvc')->columnvalue;