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',
277 select_list => [qw( MultiMailbox TextMailbox MailDirMailbox AGrade BGrade CGrade )],
278 disable_inventory => 1,
281 'cgp_accessmodes' => {
282 label => 'Communigate enabled services',
283 type => 'communigate_pro-accessmodes',
284 disable_inventory => 1,
288 label => 'Communigate aliases',
290 disable_inventory => 1,
293 'password_selfchange' => { label => 'Password modification',
296 'password_recover' => { label => 'Password recovery',
299 'cgp_deletemode' => {
300 label => 'Communigate message delete method',
302 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
303 disable_inventory => 1,
306 'cgp_emptytrash' => {
307 label => 'Communigate on logout remove trash',
309 disable_inventory => 1,
313 label => 'Quota', #Mail storage limit
315 disable_inventory => 1,
319 label => 'File storage limit',
321 disable_inventory => 1,
325 label => 'Number of files limit',
327 disable_inventory => 1,
331 label => 'File size limit',
333 disable_inventory => 1,
336 '_password' => 'Password',
339 def_info => 'when blank, defaults to UID',
344 def_info => 'set to blank for no shell tracking',
346 #select_list => [ $conf->config('shells') ],
347 select_list => [ $conf ? $conf->config('shells') : () ],
348 disable_inventory => 1,
351 'finger' => 'Real name', # (GECOS)',
355 select_table => 'svc_domain',
356 select_key => 'svcnum',
357 select_label => 'domain',
358 disable_inventory => 1,
364 select_table => 'svc_domain',
365 select_key => 'svcnum',
366 select_label => 'domain',
367 disable_inventory => 1,
370 'pbxsvc' => { label => 'PBX',
371 type => 'select-svc_pbx.html',
372 disable_inventory => 1,
373 disable_select => 1, #UI wonky, pry works otherwise
376 label => 'RADIUS groups',
377 type => 'radius_usergroup_selector',
378 disable_inventory => 1,
381 'seconds' => { label => 'Seconds',
382 label_sort => 'with Time Remaining',
384 disable_inventory => 1,
386 disable_part_svc_column => 1,
388 'upbytes' => { label => 'Upload',
390 disable_inventory => 1,
392 'format' => \&FS::UI::bytecount::display_bytecount,
393 'parse' => \&FS::UI::bytecount::parse_bytecount,
394 disable_part_svc_column => 1,
396 'downbytes' => { label => 'Download',
398 disable_inventory => 1,
400 'format' => \&FS::UI::bytecount::display_bytecount,
401 'parse' => \&FS::UI::bytecount::parse_bytecount,
402 disable_part_svc_column => 1,
404 'totalbytes'=> { label => 'Total up and download',
406 disable_inventory => 1,
408 'format' => \&FS::UI::bytecount::display_bytecount,
409 'parse' => \&FS::UI::bytecount::parse_bytecount,
410 disable_part_svc_column => 1,
412 'seconds_threshold' => { label => 'Seconds threshold',
414 disable_inventory => 1,
416 disable_part_svc_column => 1,
418 'upbytes_threshold' => { label => 'Upload threshold',
420 disable_inventory => 1,
422 'format' => \&FS::UI::bytecount::display_bytecount,
423 'parse' => \&FS::UI::bytecount::parse_bytecount,
424 disable_part_svc_column => 1,
426 'downbytes_threshold' => { label => 'Download threshold',
428 disable_inventory => 1,
430 'format' => \&FS::UI::bytecount::display_bytecount,
431 'parse' => \&FS::UI::bytecount::parse_bytecount,
432 disable_part_svc_column => 1,
434 'totalbytes_threshold'=> { label => 'Total up and download threshold',
436 disable_inventory => 1,
438 'format' => \&FS::UI::bytecount::display_bytecount,
439 'parse' => \&FS::UI::bytecount::parse_bytecount,
440 disable_part_svc_column => 1,
443 label => 'Last login',
447 label => 'Last logout',
454 sub table { 'svc_acct'; }
456 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
460 #false laziness with edit/svc_acct.cgi
462 my( $self, $groups ) = @_;
463 if ( ref($groups) eq 'ARRAY' ) {
465 } elsif ( length($groups) ) {
466 [ split(/\s*,\s*/, $groups) ];
475 shift->_lastlog('in', @_);
479 shift->_lastlog('out', @_);
483 my( $self, $op, $time ) = @_;
485 if ( defined($time) ) {
486 warn "$me last_log$op called on svcnum ". $self->svcnum.
487 ' ('. $self->email. "): $time\n"
492 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
496 my $sth = $dbh->prepare( $sql )
497 or die "Error preparing $sql: ". $dbh->errstr;
498 my $rv = $sth->execute($time, $self->svcnum);
499 die "Error executing $sql: ". $sth->errstr
501 die "Can't update last_log$op for svcnum". $self->svcnum
504 $self->{'Hash'}->{"last_log$op"} = $time;
506 $self->getfield("last_log$op");
510 =item search_sql STRING
512 Class method which returns an SQL fragment to search for the given string.
517 my( $class, $string ) = @_;
518 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
519 my( $username, $domain ) = ( $1, $2 );
520 my $q_username = dbh->quote($username);
521 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
523 "svc_acct.username = $q_username AND ( ".
524 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
529 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
531 $class->search_sql_field('slipip', $string ).
533 $class->search_sql_field('username', $string ).
536 $class->search_sql_field('username', $string);
540 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
542 Returns the "username@domain" string for this account.
544 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
554 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
556 Returns a longer string label for this acccount ("Real Name <username@domain>"
557 if available, or "username@domain").
559 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
566 my $label = $self->label(@_);
567 my $finger = $self->finger;
568 return $label unless $finger =~ /\S/;
569 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
570 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
574 =item insert [ , OPTION => VALUE ... ]
576 Adds this account to the database. If there is an error, returns the error,
577 otherwise returns false.
579 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
580 defined. An FS::cust_svc record will be created and inserted.
582 The additional field I<usergroup> can optionally be defined; if so it should
583 contain an arrayref of group names. See L<FS::radius_usergroup>.
585 The additional field I<child_objects> can optionally be defined; if so it
586 should contain an arrayref of FS::tablename objects. They will have their
587 svcnum fields set and will be inserted after this record, but before any
588 exports are run. Each element of the array can also optionally be a
589 two-element array reference containing the child object and the name of an
590 alternate field to be filled in with the newly-inserted svcnum, for example
591 C<[ $svc_forward, 'srcsvc' ]>
593 Currently available options are: I<depend_jobnum>
595 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
596 jobnums), all provisioning jobs will have a dependancy on the supplied
597 jobnum(s) (they will not run until the specific job(s) complete(s)).
599 (TODOC: L<FS::queue> and L<freeside-queued>)
601 (TODOC: new exports!)
610 warn "[$me] insert called on $self: ". Dumper($self).
611 "\nwith options: ". Dumper(%options);
614 local $SIG{HUP} = 'IGNORE';
615 local $SIG{INT} = 'IGNORE';
616 local $SIG{QUIT} = 'IGNORE';
617 local $SIG{TERM} = 'IGNORE';
618 local $SIG{TSTP} = 'IGNORE';
619 local $SIG{PIPE} = 'IGNORE';
621 my $oldAutoCommit = $FS::UID::AutoCommit;
622 local $FS::UID::AutoCommit = 0;
626 my $error = $self->SUPER::insert(
627 'jobnums' => \@jobnums,
628 'child_objects' => $self->child_objects,
632 $dbh->rollback if $oldAutoCommit;
636 if ( $self->usergroup ) {
637 foreach my $groupname ( @{$self->usergroup} ) {
638 my $radius_usergroup = new FS::radius_usergroup ( {
639 svcnum => $self->svcnum,
640 groupname => $groupname,
642 my $error = $radius_usergroup->insert;
644 $dbh->rollback if $oldAutoCommit;
650 unless ( $skip_fuzzyfiles ) {
651 $error = $self->queue_fuzzyfiles_update;
653 $dbh->rollback if $oldAutoCommit;
654 return "updating fuzzy search cache: $error";
658 my $cust_pkg = $self->cust_svc->cust_pkg;
661 my $cust_main = $cust_pkg->cust_main;
662 my $agentnum = $cust_main->agentnum;
664 if ( $conf->exists('emailinvoiceautoalways')
665 || $conf->exists('emailinvoiceauto')
666 && ! $cust_main->invoicing_list_emailonly
668 my @invoicing_list = $cust_main->invoicing_list;
669 push @invoicing_list, $self->email;
670 $cust_main->invoicing_list(\@invoicing_list);
674 my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
675 = ('','','','','','');
677 if ( $conf->exists('welcome_email', $agentnum) ) {
678 $welcome_template = new Text::Template (
680 SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
681 ) or warn "can't create welcome email template: $Text::Template::ERROR";
682 $welcome_from = $conf->config('welcome_email-from', $agentnum);
683 # || 'your-isp-is-dum'
684 $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
686 $welcome_subject_template = new Text::Template (
688 SOURCE => $welcome_subject,
689 ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
690 $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
693 if ( $welcome_template && $cust_pkg ) {
694 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
698 'custnum' => $self->custnum,
699 'username' => $self->username,
700 'password' => $self->_password,
701 'first' => $cust_main->first,
702 'last' => $cust_main->getfield('last'),
703 'pkg' => $cust_pkg->part_pkg->pkg,
705 my $wqueue = new FS::queue {
706 'svcnum' => $self->svcnum,
707 'job' => 'FS::svc_acct::send_email'
709 my $error = $wqueue->insert(
711 'from' => $welcome_from,
712 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
713 'mimetype' => $welcome_mimetype,
714 'body' => $welcome_template->fill_in( HASH => \%hash, ),
717 $dbh->rollback if $oldAutoCommit;
718 return "error queuing welcome email: $error";
721 if ( $options{'depend_jobnum'} ) {
722 warn "$me depend_jobnum found; adding to welcome email dependancies"
724 if ( ref($options{'depend_jobnum'}) ) {
725 warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
726 "to welcome email dependancies"
728 push @jobnums, @{ $options{'depend_jobnum'} };
730 warn "$me adding job $options{'depend_jobnum'} ".
731 "to welcome email dependancies"
733 push @jobnums, $options{'depend_jobnum'};
737 foreach my $jobnum ( @jobnums ) {
738 my $error = $wqueue->depend_insert($jobnum);
740 $dbh->rollback if $oldAutoCommit;
741 return "error queuing welcome email job dependancy: $error";
751 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
755 # set usage fields and thresholds if unset but set in a package def
756 # AND the package already has a last bill date (otherwise they get double added)
757 sub preinsert_hook_first {
760 return '' unless $self->pkgnum;
762 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
763 return '' unless $cust_pkg && $cust_pkg->last_bill;
765 my $part_pkg = $cust_pkg->part_pkg;
766 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
768 my %values = $part_pkg->usage_valuehash;
769 my $multiplier = $conf->exists('svc_acct-usage_threshold')
770 ? 1 - $conf->config('svc_acct-usage_threshold')/100
771 : 0.20; #doesn't matter
773 foreach ( keys %values ) {
774 next if $self->getfield($_);
775 $self->setfield( $_, $values{$_} );
776 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
777 if $conf->exists('svc_acct-usage_threshold');
785 Deletes this account from the database. If there is an error, returns the
786 error, otherwise returns false.
788 The corresponding FS::cust_svc record will be deleted as well.
790 (TODOC: new exports!)
797 return "can't delete system account" if $self->_check_system;
799 return "Can't delete an account which is a (svc_forward) source!"
800 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
802 return "Can't delete an account which is a (svc_forward) destination!"
803 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
805 return "Can't delete an account with (svc_www) web service!"
806 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
808 # what about records in session ? (they should refer to history table)
810 local $SIG{HUP} = 'IGNORE';
811 local $SIG{INT} = 'IGNORE';
812 local $SIG{QUIT} = 'IGNORE';
813 local $SIG{TERM} = 'IGNORE';
814 local $SIG{TSTP} = 'IGNORE';
815 local $SIG{PIPE} = 'IGNORE';
817 my $oldAutoCommit = $FS::UID::AutoCommit;
818 local $FS::UID::AutoCommit = 0;
821 foreach my $cust_main_invoice (
822 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
824 unless ( defined($cust_main_invoice) ) {
825 warn "WARNING: something's wrong with qsearch";
828 my %hash = $cust_main_invoice->hash;
829 $hash{'dest'} = $self->email;
830 my $new = new FS::cust_main_invoice \%hash;
831 my $error = $new->replace($cust_main_invoice);
833 $dbh->rollback if $oldAutoCommit;
838 foreach my $svc_domain (
839 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
841 my %hash = new FS::svc_domain->hash;
842 $hash{'catchall'} = '';
843 my $new = new FS::svc_domain \%hash;
844 my $error = $new->replace($svc_domain);
846 $dbh->rollback if $oldAutoCommit;
851 my $error = $self->SUPER::delete;
853 $dbh->rollback if $oldAutoCommit;
857 foreach my $radius_usergroup (
858 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } )
860 my $error = $radius_usergroup->delete;
862 $dbh->rollback if $oldAutoCommit;
867 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
871 =item replace OLD_RECORD
873 Replaces OLD_RECORD with this one in the database. If there is an error,
874 returns the error, otherwise returns false.
876 The additional field I<usergroup> can optionally be defined; if so it should
877 contain an arrayref of group names. See L<FS::radius_usergroup>.
885 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
889 warn "$me replacing $old with $new\n" if $DEBUG;
893 return "can't modify system account" if $old->_check_system;
896 #no warnings 'numeric'; #alas, a 5.006-ism
899 foreach my $xid (qw( uid gid )) {
901 return "Can't change $xid!"
902 if ! $conf->exists("svc_acct-edit_$xid")
903 && $old->$xid() != $new->$xid()
904 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
909 #change homdir when we change username
910 $new->setfield('dir', '') if $old->username ne $new->username;
912 local $SIG{HUP} = 'IGNORE';
913 local $SIG{INT} = 'IGNORE';
914 local $SIG{QUIT} = 'IGNORE';
915 local $SIG{TERM} = 'IGNORE';
916 local $SIG{TSTP} = 'IGNORE';
917 local $SIG{PIPE} = 'IGNORE';
919 my $oldAutoCommit = $FS::UID::AutoCommit;
920 local $FS::UID::AutoCommit = 0;
923 # redundant, but so $new->usergroup gets set
924 $error = $new->check;
925 return $error if $error;
927 $old->usergroup( [ $old->radius_groups ] );
929 warn $old->email. " old groups: ". join(' ',@{$old->usergroup}). "\n";
930 warn $new->email. "new groups: ". join(' ',@{$new->usergroup}). "\n";
932 if ( $new->usergroup ) {
933 #(sorta) false laziness with FS::part_export::sqlradius::_export_replace
934 my @newgroups = @{$new->usergroup};
935 foreach my $oldgroup ( @{$old->usergroup} ) {
936 if ( grep { $oldgroup eq $_ } @newgroups ) {
937 @newgroups = grep { $oldgroup ne $_ } @newgroups;
940 my $radius_usergroup = qsearchs('radius_usergroup', {
941 svcnum => $old->svcnum,
942 groupname => $oldgroup,
944 my $error = $radius_usergroup->delete;
946 $dbh->rollback if $oldAutoCommit;
947 return "error deleting radius_usergroup $oldgroup: $error";
951 foreach my $newgroup ( @newgroups ) {
952 my $radius_usergroup = new FS::radius_usergroup ( {
953 svcnum => $new->svcnum,
954 groupname => $newgroup,
956 my $error = $radius_usergroup->insert;
958 $dbh->rollback if $oldAutoCommit;
959 return "error adding radius_usergroup $newgroup: $error";
965 $error = $new->SUPER::replace($old, @_);
967 $dbh->rollback if $oldAutoCommit;
968 return $error if $error;
971 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
972 $error = $new->queue_fuzzyfiles_update;
974 $dbh->rollback if $oldAutoCommit;
975 return "updating fuzzy search cache: $error";
979 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
983 =item queue_fuzzyfiles_update
985 Used by insert & replace to update the fuzzy search cache
989 sub queue_fuzzyfiles_update {
992 local $SIG{HUP} = 'IGNORE';
993 local $SIG{INT} = 'IGNORE';
994 local $SIG{QUIT} = 'IGNORE';
995 local $SIG{TERM} = 'IGNORE';
996 local $SIG{TSTP} = 'IGNORE';
997 local $SIG{PIPE} = 'IGNORE';
999 my $oldAutoCommit = $FS::UID::AutoCommit;
1000 local $FS::UID::AutoCommit = 0;
1003 my $queue = new FS::queue {
1004 'svcnum' => $self->svcnum,
1005 'job' => 'FS::svc_acct::append_fuzzyfiles'
1007 my $error = $queue->insert($self->username);
1009 $dbh->rollback if $oldAutoCommit;
1010 return "queueing job (transaction rolled back): $error";
1013 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1021 Suspends this account by calling export-specific suspend hooks. If there is
1022 an error, returns the error, otherwise returns false.
1024 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1030 return "can't suspend system account" if $self->_check_system;
1031 $self->SUPER::suspend(@_);
1036 Unsuspends this account by by calling export-specific suspend hooks. If there
1037 is an error, returns the error, otherwise returns false.
1039 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1045 my %hash = $self->hash;
1046 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1047 $hash{_password} = $1;
1048 my $new = new FS::svc_acct ( \%hash );
1049 my $error = $new->replace($self);
1050 return $error if $error;
1053 $self->SUPER::unsuspend(@_);
1058 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1060 If the B<auto_unset_catchall> configuration option is set, this method will
1061 automatically remove any references to the canceled service in the catchall
1062 field of svc_domain. This allows packages that contain both a svc_domain and
1063 its catchall svc_acct to be canceled in one step.
1068 # Only one thing to do at this level
1070 foreach my $svc_domain (
1071 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1072 if($conf->exists('auto_unset_catchall')) {
1073 my %hash = $svc_domain->hash;
1074 $hash{catchall} = '';
1075 my $new = new FS::svc_domain ( \%hash );
1076 my $error = $new->replace($svc_domain);
1077 return $error if $error;
1079 return "cannot unprovision svc_acct #".$self->svcnum.
1080 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1084 $self->SUPER::cancel(@_);
1090 Checks all fields to make sure this is a valid service. If there is an error,
1091 returns the error, otherwise returns false. Called by the insert and replace
1094 Sets any fixed values; see L<FS::part_svc>.
1101 my($recref) = $self->hashref;
1103 my $x = $self->setfixed( $self->_fieldhandlers );
1104 return $x unless ref($x);
1107 if ( $part_svc->part_svc_column('usergroup')->columnflag eq "F" ) {
1109 [ split(',', $part_svc->part_svc_column('usergroup')->columnvalue) ] );
1112 my $error = $self->ut_numbern('svcnum')
1113 #|| $self->ut_number('domsvc')
1114 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1115 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1116 || $self->ut_textn('sec_phrase')
1117 || $self->ut_snumbern('seconds')
1118 || $self->ut_snumbern('upbytes')
1119 || $self->ut_snumbern('downbytes')
1120 || $self->ut_snumbern('totalbytes')
1121 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1122 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1123 || $self->ut_enum('password_recover', [ '', 'Y' ])
1124 || $self->ut_textn('cgp_accessmodes')
1125 || $self->ut_alphan('cgp_type')
1126 || $self->ut_textn('cgp_aliases' ) #well
1127 || $self->ut_alphasn('cgp_deletemode')
1128 || $self->ut_alphan('cgp_emptytrash')
1130 return $error if $error;
1133 local $username_letter = $username_letter;
1134 if ($self->svcnum) {
1135 my $cust_svc = $self->cust_svc
1136 or return "no cust_svc record found for svcnum ". $self->svcnum;
1137 my $cust_pkg = $cust_svc->cust_pkg;
1139 if ($self->pkgnum) {
1140 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1144 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1147 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1148 if ( $username_uppercase ) {
1149 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:]{$usernamemin,$ulen})$/i
1150 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1151 $recref->{username} = $1;
1153 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:]{$usernamemin,$ulen})$/
1154 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1155 $recref->{username} = $1;
1158 if ( $username_letterfirst ) {
1159 $recref->{username} =~ /^[a-z]/ or return gettext('illegal_username');
1160 } elsif ( $username_letter ) {
1161 $recref->{username} =~ /[a-z]/ or return gettext('illegal_username');
1163 if ( $username_noperiod ) {
1164 $recref->{username} =~ /\./ and return gettext('illegal_username');
1166 if ( $username_nounderscore ) {
1167 $recref->{username} =~ /_/ and return gettext('illegal_username');
1169 if ( $username_nodash ) {
1170 $recref->{username} =~ /\-/ and return gettext('illegal_username');
1172 unless ( $username_ampersand ) {
1173 $recref->{username} =~ /\&/ and return gettext('illegal_username');
1175 unless ( $username_percent ) {
1176 $recref->{username} =~ /\%/ and return gettext('illegal_username');
1178 unless ( $username_colon ) {
1179 $recref->{username} =~ /\:/ and return gettext('illegal_username');
1182 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1183 $recref->{popnum} = $1;
1184 return "Unknown popnum" unless
1185 ! $recref->{popnum} ||
1186 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1188 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1190 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1191 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1193 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1194 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1195 #not all systems use gid=uid
1196 #you can set a fixed gid in part_svc
1198 return "Only root can have uid 0"
1199 if $recref->{uid} == 0
1200 && $recref->{username} !~ /^(root|toor|smtp)$/;
1202 unless ( $recref->{username} eq 'sync' ) {
1203 if ( grep $_ eq $recref->{shell}, @shells ) {
1204 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1206 return "Illegal shell \`". $self->shell. "\'; ".
1207 "shells configuration value contains: @shells";
1210 $recref->{shell} = '/bin/sync';
1214 $recref->{gid} ne '' ?
1215 return "Can't have gid without uid" : ( $recref->{gid}='' );
1216 #$recref->{dir} ne '' ?
1217 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1218 $recref->{shell} ne '' ?
1219 return "Can't have shell without uid" : ( $recref->{shell}='' );
1222 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1224 $recref->{dir} =~ /^([\/\w\-\.\&]*)$/
1225 or return "Illegal directory: ". $recref->{dir};
1226 $recref->{dir} = $1;
1227 return "Illegal directory"
1228 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1229 return "Illegal directory"
1230 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1231 unless ( $recref->{dir} ) {
1232 $recref->{dir} = $dir_prefix . '/';
1233 if ( $dirhash > 0 ) {
1234 for my $h ( 1 .. $dirhash ) {
1235 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1237 } elsif ( $dirhash < 0 ) {
1238 for my $h ( reverse $dirhash .. -1 ) {
1239 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1242 $recref->{dir} .= $recref->{username};
1248 # $error = $self->ut_textn('finger');
1249 # return $error if $error;
1250 if ( $self->getfield('finger') eq '' ) {
1251 my $cust_pkg = $self->svcnum
1252 ? $self->cust_svc->cust_pkg
1253 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1255 my $cust_main = $cust_pkg->cust_main;
1256 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1259 $self->getfield('finger') =~
1260 /^([\w \t\!\@\#\$\%\&\(\)\-\+\;\'\"\,\.\?\/\*\<\>]*)$/
1261 or return "Illegal finger: ". $self->getfield('finger');
1262 $self->setfield('finger', $1);
1264 for (qw( quota file_quota file_maxsize )) {
1265 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1268 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1269 $recref->{file_maxnum} = $1;
1271 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1272 if ( $recref->{slipip} eq '' ) {
1273 $recref->{slipip} = '';
1274 } elsif ( $recref->{slipip} eq '0e0' ) {
1275 $recref->{slipip} = '0e0';
1277 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1278 or return "Illegal slipip: ". $self->slipip;
1279 $recref->{slipip} = $1;
1284 #arbitrary RADIUS stuff; allow ut_textn for now
1285 foreach ( grep /^radius_/, fields('svc_acct') ) {
1286 $self->ut_textn($_);
1289 # First, if _password is blank, generate one and set default encoding.
1290 if ( ! $recref->{_password} ) {
1291 $error = $self->set_password('');
1293 # But if there's a _password but no encoding, assume it's plaintext and
1294 # set it to default encoding.
1295 elsif ( ! $recref->{_password_encoding} ) {
1296 $error = $self->set_password($recref->{_password});
1298 return $error if $error;
1300 # Next, check _password to ensure compliance with the encoding.
1301 if ( $recref->{_password_encoding} eq 'ldap' ) {
1303 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1304 $recref->{_password} = uc($1).$2;
1306 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1309 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1311 if ( $recref->{_password} =~
1312 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1313 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1316 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1319 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1322 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1323 # Password randomization is now in set_password.
1324 # Strip whitespace characters, check length requirements, etc.
1325 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1326 $recref->{_password} = $1;
1328 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1329 FS::Msgcat::_gettext('illegal_password_characters').
1330 ": ". $recref->{_password};
1333 if ( $password_noampersand ) {
1334 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1336 if ( $password_noexclamation ) {
1337 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1341 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1343 $self->SUPER::check;
1348 sub _password_encryption {
1350 my $encoding = lc($self->_password_encoding);
1351 return if !$encoding;
1352 return 'plain' if $encoding eq 'plain';
1353 if($encoding eq 'crypt') {
1354 my $pass = $self->_password;
1355 $pass =~ s/^\*SUSPENDED\* //;
1357 return 'md5' if $pass =~ /^\$1\$/;
1358 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1359 return 'des' if length($pass) == 13;
1362 if($encoding eq 'ldap') {
1363 uc($self->_password) =~ /^\{([\w-]+)\}/;
1364 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1365 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1366 return 'md5' if $1 eq 'MD5';
1367 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1374 sub get_cleartext_password {
1376 if($self->_password_encryption eq 'plain') {
1377 if($self->_password_encoding eq 'ldap') {
1378 $self->_password =~ /\{\w+\}(.*)$/;
1382 return $self->_password;
1391 Set the cleartext password for the account. If _password_encoding is set, the
1392 new password will be encoded according to the existing method (including
1393 encryption mode, if it can be determined). Otherwise,
1394 config('default-password-encoding') is used.
1396 If no password is supplied (or a zero-length password when minimum password length
1397 is >0), one will be generated randomly.
1402 my( $self, $pass ) = ( shift, shift );
1404 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1407 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1408 FS::Msgcat::_gettext('illegal_password_characters').
1411 my( $encoding, $encryption ) = ('', '');
1413 if ( $self->_password_encoding ) {
1414 $encoding = $self->_password_encoding;
1415 # identify existing encryption method, try to use it.
1416 $encryption = $self->_password_encryption;
1418 # use the system default
1424 # set encoding to system default
1425 ($encoding, $encryption) =
1426 split(/-/, lc($conf->config('default-password-encoding')));
1427 $encoding ||= 'legacy';
1428 $self->_password_encoding($encoding);
1431 if ( $encoding eq 'legacy' ) {
1433 # The legacy behavior from check():
1434 # If the password is blank, randomize it and set encoding to 'plain'.
1435 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1436 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1437 $self->_password_encoding('plain');
1439 # Prefix + valid-length password
1440 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1442 $self->_password_encoding('plain');
1443 # Prefix + crypt string
1444 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1446 $self->_password_encoding('crypt');
1447 # Various disabled crypt passwords
1448 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1449 $self->_password_encoding('crypt');
1455 $self->_password($pass);
1461 if $passwordmin && length($pass) < $passwordmin
1462 or $passwordmax && length($pass) > $passwordmax;
1464 if ( $encoding eq 'crypt' ) {
1465 if ($encryption eq 'md5') {
1466 $pass = unix_md5_crypt($pass);
1467 } elsif ($encryption eq 'des') {
1468 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1471 } elsif ( $encoding eq 'ldap' ) {
1472 if ($encryption eq 'md5') {
1473 $pass = md5_base64($pass);
1474 } elsif ($encryption eq 'sha1') {
1475 $pass = sha1_base64($pass);
1476 } elsif ($encryption eq 'crypt') {
1477 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1479 # else $encryption eq 'plain', do nothing
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::svc_domain record for this account's domain (see
1820 # FS::h_svc_acct has a history-aware svc_domain override
1825 ? $self->{'_domsvc'}
1826 : qsearchs( 'svc_domain', { 'svcnum' => $self->domsvc } );
1831 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1835 #inherited from svc_Common
1837 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1839 Returns an email address associated with the account.
1841 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1848 $self->username. '@'. $self->domain(@_);
1853 Returns an array of FS::acct_snarf records associated with the account.
1854 If the acct_snarf table does not exist or there are no associated records,
1855 an empty list is returned
1861 return () unless dbdef->table('acct_snarf');
1862 eval "use FS::acct_snarf;";
1864 qsearch('acct_snarf', { 'svcnum' => $self->svcnum } );
1867 =item decrement_upbytes OCTETS
1869 Decrements the I<upbytes> field of this record by the given amount. If there
1870 is an error, returns the error, otherwise returns false.
1874 sub decrement_upbytes {
1875 shift->_op_usage('-', 'upbytes', @_);
1878 =item increment_upbytes OCTETS
1880 Increments the I<upbytes> field of this record by the given amount. If there
1881 is an error, returns the error, otherwise returns false.
1885 sub increment_upbytes {
1886 shift->_op_usage('+', 'upbytes', @_);
1889 =item decrement_downbytes OCTETS
1891 Decrements the I<downbytes> field of this record by the given amount. If there
1892 is an error, returns the error, otherwise returns false.
1896 sub decrement_downbytes {
1897 shift->_op_usage('-', 'downbytes', @_);
1900 =item increment_downbytes OCTETS
1902 Increments the I<downbytes> field of this record by the given amount. If there
1903 is an error, returns the error, otherwise returns false.
1907 sub increment_downbytes {
1908 shift->_op_usage('+', 'downbytes', @_);
1911 =item decrement_totalbytes OCTETS
1913 Decrements the I<totalbytes> field of this record by the given amount. If there
1914 is an error, returns the error, otherwise returns false.
1918 sub decrement_totalbytes {
1919 shift->_op_usage('-', 'totalbytes', @_);
1922 =item increment_totalbytes OCTETS
1924 Increments the I<totalbytes> field of this record by the given amount. If there
1925 is an error, returns the error, otherwise returns false.
1929 sub increment_totalbytes {
1930 shift->_op_usage('+', 'totalbytes', @_);
1933 =item decrement_seconds SECONDS
1935 Decrements the I<seconds> field of this record by the given amount. If there
1936 is an error, returns the error, otherwise returns false.
1940 sub decrement_seconds {
1941 shift->_op_usage('-', 'seconds', @_);
1944 =item increment_seconds SECONDS
1946 Increments the I<seconds> field of this record by the given amount. If there
1947 is an error, returns the error, otherwise returns false.
1951 sub increment_seconds {
1952 shift->_op_usage('+', 'seconds', @_);
1960 my %op2condition = (
1961 '-' => sub { my($self, $column, $amount) = @_;
1962 $self->$column - $amount <= 0;
1964 '+' => sub { my($self, $column, $amount) = @_;
1965 ($self->$column || 0) + $amount > 0;
1968 my %op2warncondition = (
1969 '-' => sub { my($self, $column, $amount) = @_;
1970 my $threshold = $column . '_threshold';
1971 $self->$column - $amount <= $self->$threshold + 0;
1973 '+' => sub { my($self, $column, $amount) = @_;
1974 ($self->$column || 0) + $amount > 0;
1979 my( $self, $op, $column, $amount ) = @_;
1981 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
1982 ' ('. $self->email. "): $op $amount\n"
1985 return '' unless $amount;
1987 local $SIG{HUP} = 'IGNORE';
1988 local $SIG{INT} = 'IGNORE';
1989 local $SIG{QUIT} = 'IGNORE';
1990 local $SIG{TERM} = 'IGNORE';
1991 local $SIG{TSTP} = 'IGNORE';
1992 local $SIG{PIPE} = 'IGNORE';
1994 my $oldAutoCommit = $FS::UID::AutoCommit;
1995 local $FS::UID::AutoCommit = 0;
1998 my $sql = "UPDATE svc_acct SET $column = ".
1999 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
2000 " $op ? WHERE svcnum = ?";
2004 my $sth = $dbh->prepare( $sql )
2005 or die "Error preparing $sql: ". $dbh->errstr;
2006 my $rv = $sth->execute($amount, $self->svcnum);
2007 die "Error executing $sql: ". $sth->errstr
2008 unless defined($rv);
2009 die "Can't update $column for svcnum". $self->svcnum
2012 #$self->snapshot; #not necessary, we retain the old values
2013 #create an object with the updated usage values
2014 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2016 my $error = $new->replace($self);
2018 $dbh->rollback if $oldAutoCommit;
2019 return "Error replacing: $error";
2022 #overlimit_action eq 'cancel' handling
2023 my $cust_pkg = $self->cust_svc->cust_pkg;
2025 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2026 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2030 my $error = $cust_pkg->cancel; #XXX should have a reason
2032 $dbh->rollback if $oldAutoCommit;
2033 return "Error cancelling: $error";
2036 #nothing else is relevant if we're cancelling, so commit & return success
2037 warn "$me update successful; committing\n"
2039 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2044 my $action = $op2action{$op};
2046 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2047 ( $action eq 'suspend' && !$self->overlimit
2048 || $action eq 'unsuspend' && $self->overlimit )
2051 my $error = $self->_op_overlimit($action);
2053 $dbh->rollback if $oldAutoCommit;
2059 if ( $conf->exists("svc_acct-usage_$action")
2060 && &{$op2condition{$op}}($self, $column, $amount) ) {
2061 #my $error = $self->$action();
2062 my $error = $self->cust_svc->cust_pkg->$action();
2063 # $error ||= $self->overlimit($action);
2065 $dbh->rollback if $oldAutoCommit;
2066 return "Error ${action}ing: $error";
2070 if ($warning_template && &{$op2warncondition{$op}}($self, $column, $amount)) {
2071 my $wqueue = new FS::queue {
2072 'svcnum' => $self->svcnum,
2073 'job' => 'FS::svc_acct::reached_threshold',
2078 $to = $warning_cc if &{$op2condition{$op}}($self, $column, $amount);
2082 my $error = $wqueue->insert(
2083 'svcnum' => $self->svcnum,
2085 'column' => $column,
2089 $dbh->rollback if $oldAutoCommit;
2090 return "Error queuing threshold activity: $error";
2094 warn "$me update successful; committing\n"
2096 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2102 my( $self, $action ) = @_;
2104 local $SIG{HUP} = 'IGNORE';
2105 local $SIG{INT} = 'IGNORE';
2106 local $SIG{QUIT} = 'IGNORE';
2107 local $SIG{TERM} = 'IGNORE';
2108 local $SIG{TSTP} = 'IGNORE';
2109 local $SIG{PIPE} = 'IGNORE';
2111 my $oldAutoCommit = $FS::UID::AutoCommit;
2112 local $FS::UID::AutoCommit = 0;
2115 my $cust_pkg = $self->cust_svc->cust_pkg;
2117 my $conf_overlimit =
2119 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2120 : $conf->config('overlimit_groups');
2122 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2124 my $groups = $conf_overlimit || $part_export->option('overlimit_groups');
2125 next unless $groups;
2127 my $gref = &{ $self->_fieldhandlers->{'usergroup'} }( $self, $groups );
2129 my $other = new FS::svc_acct $self->hashref;
2130 $other->usergroup( $gref );
2133 if ($action eq 'suspend') {
2136 } else { # $action eq 'unsuspend'
2141 my $error = $part_export->export_replace($new, $old)
2142 || $self->overlimit($action);
2145 $dbh->rollback if $oldAutoCommit;
2146 return "Error replacing radius groups: $error";
2151 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2157 my( $self, $valueref, %options ) = @_;
2159 warn "$me set_usage called for svcnum ". $self->svcnum.
2160 ' ('. $self->email. "): ".
2161 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2164 local $SIG{HUP} = 'IGNORE';
2165 local $SIG{INT} = 'IGNORE';
2166 local $SIG{QUIT} = 'IGNORE';
2167 local $SIG{TERM} = 'IGNORE';
2168 local $SIG{TSTP} = 'IGNORE';
2169 local $SIG{PIPE} = 'IGNORE';
2171 local $FS::svc_Common::noexport_hack = 1;
2172 my $oldAutoCommit = $FS::UID::AutoCommit;
2173 local $FS::UID::AutoCommit = 0;
2178 if ( $options{null} ) {
2179 %handyhash = ( map { ( $_ => 'NULL', $_."_threshold" => 'NULL' ) }
2180 qw( seconds upbytes downbytes totalbytes )
2183 foreach my $field (keys %$valueref){
2184 $reset = 1 if $valueref->{$field};
2185 $self->setfield($field, $valueref->{$field});
2186 $self->setfield( $field.'_threshold',
2187 int($self->getfield($field)
2188 * ( $conf->exists('svc_acct-usage_threshold')
2189 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2194 $handyhash{$field} = $self->getfield($field);
2195 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2197 #my $error = $self->replace; #NO! we avoid the call to ->check for
2198 #die $error if $error; #services not explicity changed via the UI
2200 my $sql = "UPDATE svc_acct SET " .
2201 join (',', map { "$_ = $handyhash{$_}" } (keys %handyhash) ).
2202 " WHERE svcnum = ". $self->svcnum;
2207 if (scalar(keys %handyhash)) {
2208 my $sth = $dbh->prepare( $sql )
2209 or die "Error preparing $sql: ". $dbh->errstr;
2210 my $rv = $sth->execute();
2211 die "Error executing $sql: ". $sth->errstr
2212 unless defined($rv);
2213 die "Can't update usage for svcnum ". $self->svcnum
2217 #$self->snapshot; #not necessary, we retain the old values
2218 #create an object with the updated usage values
2219 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2220 local($FS::Record::nowarn_identical) = 1;
2221 my $error = $new->replace($self); #call exports
2223 $dbh->rollback if $oldAutoCommit;
2224 return "Error replacing: $error";
2231 $error = $self->_op_overlimit('unsuspend')
2232 if $self->overlimit;;
2234 $error ||= $self->cust_svc->cust_pkg->unsuspend
2235 if $conf->exists("svc_acct-usage_unsuspend");
2238 $dbh->rollback if $oldAutoCommit;
2239 return "Error unsuspending: $error";
2244 warn "$me update successful; committing\n"
2246 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2252 =item recharge HASHREF
2254 Increments usage columns by the amount specified in HASHREF as
2255 column=>amount pairs.
2260 my ($self, $vhash) = @_;
2263 warn "[$me] recharge called on $self: ". Dumper($self).
2264 "\nwith vhash: ". Dumper($vhash);
2267 my $oldAutoCommit = $FS::UID::AutoCommit;
2268 local $FS::UID::AutoCommit = 0;
2272 foreach my $column (keys %$vhash){
2273 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2277 $dbh->rollback if $oldAutoCommit;
2279 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2284 =item is_rechargeable
2286 Returns true if this svc_account can be "recharged" and false otherwise.
2290 sub is_rechargable {
2292 $self->seconds ne ''
2293 || $self->upbytes ne ''
2294 || $self->downbytes ne ''
2295 || $self->totalbytes ne '';
2298 =item seconds_since TIMESTAMP
2300 Returns the number of seconds this account has been online since TIMESTAMP,
2301 according to the session monitor (see L<FS::Session>).
2303 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2304 L<Time::Local> and L<Date::Parse> for conversion functions.
2308 #note: POD here, implementation in FS::cust_svc
2311 $self->cust_svc->seconds_since(@_);
2314 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2316 Returns the numbers of seconds this account has been online between
2317 TIMESTAMP_START (inclusive) and TIMESTAMP_END (exclusive), according to an
2318 external SQL radacct table, specified via sqlradius export. Sessions which
2319 started in the specified range but are still open are counted from session
2320 start to the end of the range (unless they are over 1 day old, in which case
2321 they are presumed missing their stop record and not counted). Also, sessions
2322 which end in the range but started earlier are counted from the start of the
2323 range to session end. Finally, sessions which start before the range but end
2324 after are counted for the entire range.
2326 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2327 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2332 #note: POD here, implementation in FS::cust_svc
2333 sub seconds_since_sqlradacct {
2335 $self->cust_svc->seconds_since_sqlradacct(@_);
2338 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2340 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2341 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2342 TIMESTAMP_END (exclusive).
2344 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2345 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2350 #note: POD here, implementation in FS::cust_svc
2351 sub attribute_since_sqlradacct {
2353 $self->cust_svc->attribute_since_sqlradacct(@_);
2356 =item get_session_history TIMESTAMP_START TIMESTAMP_END
2358 Returns an array of hash references of this customers login history for the
2359 given time range. (document this better)
2363 sub get_session_history {
2365 $self->cust_svc->get_session_history(@_);
2368 =item last_login_text
2370 Returns text describing the time of last login.
2374 sub last_login_text {
2376 $self->last_login ? ctime($self->last_login) : 'unknown';
2379 =item get_cdrs TIMESTAMP_START TIMESTAMP_END [ 'OPTION' => 'VALUE ... ]
2384 my($self, $start, $end, %opt ) = @_;
2386 my $did = $self->username; #yup
2388 my $prefix = $opt{'default_prefix'}; #convergent.au '+61'
2390 my $for_update = $opt{'for_update'} ? 'FOR UPDATE' : '';
2392 #SELECT $for_update * FROM cdr
2393 # WHERE calldate >= $start #need a conversion
2394 # AND calldate < $end #ditto
2395 # AND ( charged_party = "$did"
2396 # OR charged_party = "$prefix$did" #if length($prefix);
2397 # OR ( ( charged_party IS NULL OR charged_party = '' )
2399 # ( src = "$did" OR src = "$prefix$did" ) # if length($prefix)
2402 # AND ( freesidestatus IS NULL OR freesidestatus = '' )
2405 if ( length($prefix) ) {
2407 " AND ( charged_party = '$did'
2408 OR charged_party = '$prefix$did'
2409 OR ( ( charged_party IS NULL OR charged_party = '' )
2411 ( src = '$did' OR src = '$prefix$did' )
2417 " AND ( charged_party = '$did'
2418 OR ( ( charged_party IS NULL OR charged_party = '' )
2428 'select' => "$for_update *",
2431 #( freesidestatus IS NULL OR freesidestatus = '' )
2432 'freesidestatus' => '',
2434 'extra_sql' => $charged_or_src,
2442 Returns all RADIUS groups for this account (see L<FS::radius_usergroup>).
2448 if ( $self->usergroup ) {
2449 confess "explicitly specified usergroup not an arrayref: ". $self->usergroup
2450 unless ref($self->usergroup) eq 'ARRAY';
2451 #when provisioning records, export callback runs in svc_Common.pm before
2452 #radius_usergroup records can be inserted...
2453 @{$self->usergroup};
2455 map { $_->groupname }
2456 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } );
2460 =item clone_suspended
2462 Constructor used by FS::part_export::_export_suspend fallback. Document
2467 sub clone_suspended {
2469 my %hash = $self->hash;
2470 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2471 new FS::svc_acct \%hash;
2474 =item clone_kludge_unsuspend
2476 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2481 sub clone_kludge_unsuspend {
2483 my %hash = $self->hash;
2484 $hash{_password} = '';
2485 new FS::svc_acct \%hash;
2488 =item check_password
2490 Checks the supplied password against the (possibly encrypted) password in the
2491 database. Returns true for a successful authentication, false for no match.
2493 Currently supported encryptions are: classic DES crypt() and MD5
2497 sub check_password {
2498 my($self, $check_password) = @_;
2500 #remove old-style SUSPENDED kludge, they should be allowed to login to
2501 #self-service and pay up
2502 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2504 if ( $self->_password_encoding eq 'ldap' ) {
2506 my $auth = from_rfc2307 Authen::Passphrase $self->_password;
2507 return $auth->match($check_password);
2509 } elsif ( $self->_password_encoding eq 'crypt' ) {
2511 my $auth = from_crypt Authen::Passphrase $self->_password;
2512 return $auth->match($check_password);
2514 } elsif ( $self->_password_encoding eq 'plain' ) {
2516 return $check_password eq $password;
2520 #XXX this could be replaced with Authen::Passphrase stuff
2522 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2524 } elsif ( length($password) < 13 ) { #plaintext
2525 $check_password eq $password;
2526 } elsif ( length($password) == 13 ) { #traditional DES crypt
2527 crypt($check_password, $password) eq $password;
2528 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2529 unix_md5_crypt($check_password, $password) eq $password;
2530 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2531 warn "Can't check password: Blowfish encryption not yet supported, ".
2532 "svcnum ". $self->svcnum. "\n";
2535 warn "Can't check password: Unrecognized encryption for svcnum ".
2536 $self->svcnum. "\n";
2544 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2546 Returns an encrypted password, either by passing through an encrypted password
2547 in the database or by encrypting a plaintext password from the database.
2549 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2550 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2551 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2552 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2553 encryption type is only used if the password is not already encrypted in the
2558 sub crypt_password {
2561 if ( $self->_password_encoding eq 'ldap' ) {
2563 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
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";
2582 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2586 } elsif ( $self->_password_encoding eq 'crypt' ) {
2588 return $self->_password;
2590 } elsif ( $self->_password_encoding eq 'plain' ) {
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";
2610 if ( length($self->_password) == 13
2611 || $self->_password =~ /^\$(1|2a?)\$/
2612 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2618 #XXX this could be replaced with Authen::Passphrase stuff
2620 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2621 if ( $encryption eq 'crypt' ) {
2624 $saltset[int(rand(64))].$saltset[int(rand(64))]
2626 } elsif ( $encryption eq 'md5' ) {
2627 unix_md5_crypt( $self->_password );
2628 } elsif ( $encryption eq 'blowfish' ) {
2629 croak "unknown encryption method $encryption";
2631 croak "unknown encryption method $encryption";
2640 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2642 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2643 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2644 "{MD5}5426824942db4253f87a1009fd5d2d4".
2646 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2647 to work the same as the B</crypt_password> method.
2653 #eventually should check a "password-encoding" field
2655 if ( $self->_password_encoding eq 'ldap' ) {
2657 return $self->_password;
2659 } elsif ( $self->_password_encoding eq 'crypt' ) {
2661 if ( length($self->_password) == 13 ) { #crypt
2662 return '{CRYPT}'. $self->_password;
2663 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2665 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2666 # die "Blowfish encryption not supported in this context, svcnum ".
2667 # $self->svcnum. "\n";
2669 warn "encryption method not (yet?) supported in LDAP context";
2670 return '{CRYPT}*'; #unsupported, should not auth
2673 } elsif ( $self->_password_encoding eq 'plain' ) {
2675 return '{PLAIN}'. $self->_password;
2677 #return '{CLEARTEXT}'. $self->_password; #?
2681 if ( length($self->_password) == 13 ) { #crypt
2682 return '{CRYPT}'. $self->_password;
2683 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2685 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2686 warn "Blowfish encryption not supported in this context, svcnum ".
2687 $self->svcnum. "\n";
2690 #are these two necessary anymore?
2691 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2692 return '{SSHA}'. $1;
2693 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2694 return '{NS-MTA-MD5}'. $1;
2697 return '{PLAIN}'. $self->_password;
2699 #return '{CLEARTEXT}'. $self->_password; #?
2701 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2702 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2703 #if ( $encryption eq 'crypt' ) {
2704 # return '{CRYPT}'. crypt(
2706 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2708 #} elsif ( $encryption eq 'md5' ) {
2709 # unix_md5_crypt( $self->_password );
2710 #} elsif ( $encryption eq 'blowfish' ) {
2711 # croak "unknown encryption method $encryption";
2713 # croak "unknown encryption method $encryption";
2721 =item domain_slash_username
2723 Returns $domain/$username/
2727 sub domain_slash_username {
2729 $self->domain. '/'. $self->username. '/';
2732 =item virtual_maildir
2734 Returns $domain/maildirs/$username/
2738 sub virtual_maildir {
2740 $self->domain. '/maildirs/'. $self->username. '/';
2745 =head1 CLASS METHODS
2749 =item search HASHREF
2751 Class method which returns a qsearch hash expression to search for parameters
2752 specified in HASHREF. Valid parameters are
2766 Arrayref of pkgparts
2772 Arrayref of additional WHERE clauses, will be ANDed together.
2783 my ($class, $params) = @_;
2788 if ( $params->{'domain'} ) {
2789 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2790 #preserve previous behavior & bubble up an error if $svc_domain not found?
2791 push @where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2795 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2796 push @where, "domsvc = $1";
2800 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
2803 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2804 push @where, "agentnum = $1";
2808 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2809 push @where, "custnum = $1";
2813 if ( $params->{'pkgpart'} && scalar(@{ $params->{'pkgpart'} }) ) {
2814 #XXX untaint or sql quote
2816 'cust_pkg.pkgpart IN ('. join(',', @{ $params->{'pkgpart'} } ). ')';
2820 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2821 push @where, "popnum = $1";
2825 if ( $params->{'svcpart'} =~ /^(\d+)$/ ) {
2826 push @where, "svcpart = $1";
2830 # here is the agent virtualization
2831 #if ($params->{CurrentUser}) {
2833 # qsearchs('access_user', { username => $params->{CurrentUser} });
2835 # if ($access_user) {
2836 # push @where, $access_user->agentnums_sql('table'=>'cust_main');
2838 # push @where, "1=0";
2841 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
2842 'table' => 'cust_main',
2843 'null_right' => 'View/link unlinked services',
2847 push @where, @{ $params->{'where'} } if $params->{'where'};
2849 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2851 my $addl_from = ' LEFT JOIN cust_svc USING ( svcnum ) '.
2852 ' LEFT JOIN part_svc USING ( svcpart ) '.
2853 ' LEFT JOIN cust_pkg USING ( pkgnum ) '.
2854 ' LEFT JOIN cust_main USING ( custnum ) ';
2856 my $count_query = "SELECT COUNT(*) FROM svc_acct $addl_from $extra_sql";
2857 #if ( keys %svc_acct ) {
2858 # $count_query .= ' WHERE '.
2859 # join(' AND ', map "$_ = ". dbh->quote($svc_acct{$_}),
2865 'table' => 'svc_acct',
2866 'hashref' => {}, # \%svc_acct,
2867 'select' => join(', ',
2870 'cust_main.custnum',
2871 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
2873 'addl_from' => $addl_from,
2874 'extra_sql' => $extra_sql,
2875 'order_by' => $params->{'order_by'},
2876 'count_query' => $count_query,
2889 This is the FS::svc_acct job-queue-able version. It still uses
2890 FS::Misc::send_email under-the-hood.
2897 eval "use FS::Misc qw(send_email)";
2900 $opt{mimetype} ||= 'text/plain';
2901 $opt{mimetype} .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2903 my $error = send_email(
2904 'from' => $opt{from},
2906 'subject' => $opt{subject},
2907 'content-type' => $opt{mimetype},
2908 'body' => [ map "$_\n", split("\n", $opt{body}) ],
2910 die $error if $error;
2913 =item check_and_rebuild_fuzzyfiles
2917 sub check_and_rebuild_fuzzyfiles {
2918 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2919 -e "$dir/svc_acct.username"
2920 or &rebuild_fuzzyfiles;
2923 =item rebuild_fuzzyfiles
2927 sub rebuild_fuzzyfiles {
2929 use Fcntl qw(:flock);
2931 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2935 open(USERNAMELOCK,">>$dir/svc_acct.username")
2936 or die "can't open $dir/svc_acct.username: $!";
2937 flock(USERNAMELOCK,LOCK_EX)
2938 or die "can't lock $dir/svc_acct.username: $!";
2940 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2942 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2943 or die "can't open $dir/svc_acct.username.tmp: $!";
2944 print USERNAMECACHE join("\n", @all_username), "\n";
2945 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2947 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2957 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2958 open(USERNAMECACHE,"<$dir/svc_acct.username")
2959 or die "can't open $dir/svc_acct.username: $!";
2960 my @array = map { chomp; $_; } <USERNAMECACHE>;
2961 close USERNAMECACHE;
2965 =item append_fuzzyfiles USERNAME
2969 sub append_fuzzyfiles {
2970 my $username = shift;
2972 &check_and_rebuild_fuzzyfiles;
2974 use Fcntl qw(:flock);
2976 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2978 open(USERNAME,">>$dir/svc_acct.username")
2979 or die "can't open $dir/svc_acct.username: $!";
2980 flock(USERNAME,LOCK_EX)
2981 or die "can't lock $dir/svc_acct.username: $!";
2983 print USERNAME "$username\n";
2985 flock(USERNAME,LOCK_UN)
2986 or die "can't unlock $dir/svc_acct.username: $!";
2994 =item radius_usergroup_selector GROUPS_ARRAYREF [ SELECTNAME ]
2998 sub radius_usergroup_selector {
2999 my $sel_groups = shift;
3000 my %sel_groups = map { $_=>1 } @$sel_groups;
3002 my $selectname = shift || 'radius_usergroup';
3005 my $sth = $dbh->prepare(
3006 'SELECT DISTINCT(groupname) FROM radius_usergroup ORDER BY groupname'
3007 ) or die $dbh->errstr;
3008 $sth->execute() or die $sth->errstr;
3009 my @all_groups = map { $_->[0] } @{$sth->fetchall_arrayref};
3013 function ${selectname}_doadd(object) {
3014 var myvalue = object.${selectname}_add.value;
3015 var optionName = new Option(myvalue,myvalue,false,true);
3016 var length = object.$selectname.length;
3017 object.$selectname.options[length] = optionName;
3018 object.${selectname}_add.value = "";
3021 <SELECT MULTIPLE NAME="$selectname">
3024 foreach my $group ( @all_groups ) {
3025 $html .= qq(<OPTION VALUE="$group");
3026 if ( $sel_groups{$group} ) {
3027 $html .= ' SELECTED';
3028 $sel_groups{$group} = 0;
3030 $html .= ">$group</OPTION>\n";
3032 foreach my $group ( grep { $sel_groups{$_} } keys %sel_groups ) {
3033 $html .= qq(<OPTION VALUE="$group" SELECTED>$group</OPTION>\n);
3035 $html .= '</SELECT>';
3037 $html .= qq!<BR><INPUT TYPE="text" NAME="${selectname}_add">!.
3038 qq!<INPUT TYPE="button" VALUE="Add new group" onClick="${selectname}_doadd(this.form)">!;
3043 =item reached_threshold
3045 Performs some activities when svc_acct thresholds (such as number of seconds
3046 remaining) are reached.
3050 sub reached_threshold {
3053 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
3054 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
3056 if ( $opt{'op'} eq '+' ){
3057 $svc_acct->setfield( $opt{'column'}.'_threshold',
3058 int($svc_acct->getfield($opt{'column'})
3059 * ( $conf->exists('svc_acct-usage_threshold')
3060 ? $conf->config('svc_acct-usage_threshold')/100
3065 my $error = $svc_acct->replace;
3066 die $error if $error;
3067 }elsif ( $opt{'op'} eq '-' ){
3069 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
3070 return '' if ($threshold eq '' );
3072 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
3073 my $error = $svc_acct->replace;
3074 die $error if $error; # email next time, i guess
3076 if ( $warning_template ) {
3077 eval "use FS::Misc qw(send_email)";
3080 my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
3081 my $cust_main = $cust_pkg->cust_main;
3083 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ }
3084 $cust_main->invoicing_list,
3085 ($opt{'to'} ? $opt{'to'} : ())
3088 my $mimetype = $warning_mimetype;
3089 $mimetype .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
3091 my $body = $warning_template->fill_in( HASH => {
3092 'custnum' => $cust_main->custnum,
3093 'username' => $svc_acct->username,
3094 'password' => $svc_acct->_password,
3095 'first' => $cust_main->first,
3096 'last' => $cust_main->getfield('last'),
3097 'pkg' => $cust_pkg->part_pkg->pkg,
3098 'column' => $opt{'column'},
3099 'amount' => $opt{'column'} =~/bytes/
3100 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
3101 : $svc_acct->getfield($opt{'column'}),
3102 'threshold' => $opt{'column'} =~/bytes/
3103 ? FS::UI::bytecount::display_bytecount($threshold)
3108 my $error = send_email(
3109 'from' => $warning_from,
3111 'subject' => $warning_subject,
3112 'content-type' => $mimetype,
3113 'body' => [ map "$_\n", split("\n", $body) ],
3115 die $error if $error;
3118 die "unknown op: " . $opt{'op'};
3126 The $recref stuff in sub check should be cleaned up.
3128 The suspend, unsuspend and cancel methods update the database, but not the
3129 current object. This is probably a bug as it's unexpected and
3132 radius_usergroup_selector? putting web ui components in here? they should
3133 probably live somewhere else...
3135 insertion of RADIUS group stuff in insert could be done with child_objects now
3136 (would probably clean up export of them too)
3138 _op_usage and set_usage bypass the history... maybe they shouldn't
3142 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
3143 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
3144 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
3145 L<freeside-queued>), L<FS::svc_acct_pop>,
3146 schema.html from the base documentation.
3150 =item domain_select_hash %OPTIONS
3152 Returns a hash SVCNUM => DOMAIN ... representing the domains this customer
3153 may at present purchase.
3155 Currently available options are: I<pkgnum> I<svcpart>
3159 sub domain_select_hash {
3160 my ($self, %options) = @_;
3166 $part_svc = $self->part_svc;
3167 $cust_pkg = $self->cust_svc->cust_pkg
3171 $part_svc = qsearchs('part_svc', { 'svcpart' => $options{svcpart} })
3172 if $options{'svcpart'};
3174 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $options{pkgnum} })
3175 if $options{'pkgnum'};
3177 if ($part_svc && ( $part_svc->part_svc_column('domsvc')->columnflag eq 'S'
3178 || $part_svc->part_svc_column('domsvc')->columnflag eq 'F')) {
3179 %domains = map { $_->svcnum => $_->domain }
3180 map { qsearchs('svc_domain', { 'svcnum' => $_ }) }
3181 split(',', $part_svc->part_svc_column('domsvc')->columnvalue);
3182 }elsif ($cust_pkg && !$conf->exists('svc_acct-alldomains') ) {
3183 %domains = map { $_->svcnum => $_->domain }
3184 map { qsearchs('svc_domain', { 'svcnum' => $_->svcnum }) }
3185 map { qsearch('cust_svc', { 'pkgnum' => $_->pkgnum } ) }
3186 qsearch('cust_pkg', { 'custnum' => $cust_pkg->custnum });
3188 %domains = map { $_->svcnum => $_->domain } qsearch('svc_domain', {} );
3191 if ($part_svc && $part_svc->part_svc_column('domsvc')->columnflag eq 'D') {
3192 my $svc_domain = qsearchs('svc_domain',
3193 { 'svcnum' => $part_svc->part_svc_column('domsvc')->columnvalue } );
3194 if ( $svc_domain ) {
3195 $domains{$svc_domain->svcnum} = $svc_domain->domain;
3197 warn "unknown svc_domain.svcnum for part_svc_column domsvc: ".
3198 $part_svc->part_svc_column('domsvc')->columnvalue;