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,
287 'cgp_deletemode' => {
288 label => 'Communigate message delete method',
290 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
291 disable_inventory => 1,
294 'cgp_emptytrash' => {
295 label => 'Communigate on logout remove trash',
297 disable_inventory => 1,
301 label => 'Quota', #Mail storage limit
303 disable_inventory => 1,
307 label => 'File storage limit',
309 disable_inventory => 1,
313 label => 'Number of files limit',
315 disable_inventory => 1,
319 label => 'File size limit',
321 disable_inventory => 1,
324 '_password' => 'Password',
327 def_info => 'when blank, defaults to UID',
332 def_info => 'set to blank for no shell tracking',
334 #select_list => [ $conf->config('shells') ],
335 select_list => [ $conf ? $conf->config('shells') : () ],
336 disable_inventory => 1,
339 'finger' => 'Real name', # (GECOS)',
343 select_table => 'svc_domain',
344 select_key => 'svcnum',
345 select_label => 'domain',
346 disable_inventory => 1,
352 select_table => 'svc_domain',
353 select_key => 'svcnum',
354 select_label => 'domain',
355 disable_inventory => 1,
358 'pbxsvc' => { label => 'PBX',
359 type => 'select-svc_pbx.html',
360 disable_inventory => 1,
361 disable_select => 1, #UI wonky, pry works otherwise
364 label => 'RADIUS groups',
365 type => 'radius_usergroup_selector',
366 disable_inventory => 1,
369 'seconds' => { label => 'Seconds',
370 label_sort => 'with Time Remaining',
372 disable_inventory => 1,
374 disable_part_svc_column => 1,
376 'upbytes' => { label => 'Upload',
378 disable_inventory => 1,
380 'format' => \&FS::UI::bytecount::display_bytecount,
381 'parse' => \&FS::UI::bytecount::parse_bytecount,
382 disable_part_svc_column => 1,
384 'downbytes' => { label => 'Download',
386 disable_inventory => 1,
388 'format' => \&FS::UI::bytecount::display_bytecount,
389 'parse' => \&FS::UI::bytecount::parse_bytecount,
390 disable_part_svc_column => 1,
392 'totalbytes'=> { label => 'Total up and download',
394 disable_inventory => 1,
396 'format' => \&FS::UI::bytecount::display_bytecount,
397 'parse' => \&FS::UI::bytecount::parse_bytecount,
398 disable_part_svc_column => 1,
400 'seconds_threshold' => { label => 'Seconds threshold',
402 disable_inventory => 1,
404 disable_part_svc_column => 1,
406 'upbytes_threshold' => { label => 'Upload threshold',
408 disable_inventory => 1,
410 'format' => \&FS::UI::bytecount::display_bytecount,
411 'parse' => \&FS::UI::bytecount::parse_bytecount,
412 disable_part_svc_column => 1,
414 'downbytes_threshold' => { label => 'Download threshold',
416 disable_inventory => 1,
418 'format' => \&FS::UI::bytecount::display_bytecount,
419 'parse' => \&FS::UI::bytecount::parse_bytecount,
420 disable_part_svc_column => 1,
422 'totalbytes_threshold'=> { label => 'Total up and download threshold',
424 disable_inventory => 1,
426 'format' => \&FS::UI::bytecount::display_bytecount,
427 'parse' => \&FS::UI::bytecount::parse_bytecount,
428 disable_part_svc_column => 1,
431 label => 'Last login',
435 label => 'Last logout',
442 sub table { 'svc_acct'; }
444 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
448 #false laziness with edit/svc_acct.cgi
450 my( $self, $groups ) = @_;
451 if ( ref($groups) eq 'ARRAY' ) {
453 } elsif ( length($groups) ) {
454 [ split(/\s*,\s*/, $groups) ];
463 shift->_lastlog('in', @_);
467 shift->_lastlog('out', @_);
471 my( $self, $op, $time ) = @_;
473 if ( defined($time) ) {
474 warn "$me last_log$op called on svcnum ". $self->svcnum.
475 ' ('. $self->email. "): $time\n"
480 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
484 my $sth = $dbh->prepare( $sql )
485 or die "Error preparing $sql: ". $dbh->errstr;
486 my $rv = $sth->execute($time, $self->svcnum);
487 die "Error executing $sql: ". $sth->errstr
489 die "Can't update last_log$op for svcnum". $self->svcnum
492 $self->{'Hash'}->{"last_log$op"} = $time;
494 $self->getfield("last_log$op");
498 =item search_sql STRING
500 Class method which returns an SQL fragment to search for the given string.
505 my( $class, $string ) = @_;
506 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
507 my( $username, $domain ) = ( $1, $2 );
508 my $q_username = dbh->quote($username);
509 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
511 "svc_acct.username = $q_username AND ( ".
512 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
517 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
519 $class->search_sql_field('slipip', $string ).
521 $class->search_sql_field('username', $string ).
524 $class->search_sql_field('username', $string);
528 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
530 Returns the "username@domain" string for this account.
532 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
542 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
544 Returns a longer string label for this acccount ("Real Name <username@domain>"
545 if available, or "username@domain").
547 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
554 my $label = $self->label(@_);
555 my $finger = $self->finger;
556 return $label unless $finger =~ /\S/;
557 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
558 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
562 =item insert [ , OPTION => VALUE ... ]
564 Adds this account to the database. If there is an error, returns the error,
565 otherwise returns false.
567 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
568 defined. An FS::cust_svc record will be created and inserted.
570 The additional field I<usergroup> can optionally be defined; if so it should
571 contain an arrayref of group names. See L<FS::radius_usergroup>.
573 The additional field I<child_objects> can optionally be defined; if so it
574 should contain an arrayref of FS::tablename objects. They will have their
575 svcnum fields set and will be inserted after this record, but before any
576 exports are run. Each element of the array can also optionally be a
577 two-element array reference containing the child object and the name of an
578 alternate field to be filled in with the newly-inserted svcnum, for example
579 C<[ $svc_forward, 'srcsvc' ]>
581 Currently available options are: I<depend_jobnum>
583 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
584 jobnums), all provisioning jobs will have a dependancy on the supplied
585 jobnum(s) (they will not run until the specific job(s) complete(s)).
587 (TODOC: L<FS::queue> and L<freeside-queued>)
589 (TODOC: new exports!)
598 warn "[$me] insert called on $self: ". Dumper($self).
599 "\nwith options: ". Dumper(%options);
602 local $SIG{HUP} = 'IGNORE';
603 local $SIG{INT} = 'IGNORE';
604 local $SIG{QUIT} = 'IGNORE';
605 local $SIG{TERM} = 'IGNORE';
606 local $SIG{TSTP} = 'IGNORE';
607 local $SIG{PIPE} = 'IGNORE';
609 my $oldAutoCommit = $FS::UID::AutoCommit;
610 local $FS::UID::AutoCommit = 0;
614 my $error = $self->SUPER::insert(
615 'jobnums' => \@jobnums,
616 'child_objects' => $self->child_objects,
620 $dbh->rollback if $oldAutoCommit;
624 if ( $self->usergroup ) {
625 foreach my $groupname ( @{$self->usergroup} ) {
626 my $radius_usergroup = new FS::radius_usergroup ( {
627 svcnum => $self->svcnum,
628 groupname => $groupname,
630 my $error = $radius_usergroup->insert;
632 $dbh->rollback if $oldAutoCommit;
638 unless ( $skip_fuzzyfiles ) {
639 $error = $self->queue_fuzzyfiles_update;
641 $dbh->rollback if $oldAutoCommit;
642 return "updating fuzzy search cache: $error";
646 my $cust_pkg = $self->cust_svc->cust_pkg;
649 my $cust_main = $cust_pkg->cust_main;
650 my $agentnum = $cust_main->agentnum;
652 if ( $conf->exists('emailinvoiceautoalways')
653 || $conf->exists('emailinvoiceauto')
654 && ! $cust_main->invoicing_list_emailonly
656 my @invoicing_list = $cust_main->invoicing_list;
657 push @invoicing_list, $self->email;
658 $cust_main->invoicing_list(\@invoicing_list);
662 my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
663 = ('','','','','','');
665 if ( $conf->exists('welcome_email', $agentnum) ) {
666 $welcome_template = new Text::Template (
668 SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
669 ) or warn "can't create welcome email template: $Text::Template::ERROR";
670 $welcome_from = $conf->config('welcome_email-from', $agentnum);
671 # || 'your-isp-is-dum'
672 $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
674 $welcome_subject_template = new Text::Template (
676 SOURCE => $welcome_subject,
677 ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
678 $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
681 if ( $welcome_template && $cust_pkg ) {
682 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
686 'custnum' => $self->custnum,
687 'username' => $self->username,
688 'password' => $self->_password,
689 'first' => $cust_main->first,
690 'last' => $cust_main->getfield('last'),
691 'pkg' => $cust_pkg->part_pkg->pkg,
693 my $wqueue = new FS::queue {
694 'svcnum' => $self->svcnum,
695 'job' => 'FS::svc_acct::send_email'
697 my $error = $wqueue->insert(
699 'from' => $welcome_from,
700 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
701 'mimetype' => $welcome_mimetype,
702 'body' => $welcome_template->fill_in( HASH => \%hash, ),
705 $dbh->rollback if $oldAutoCommit;
706 return "error queuing welcome email: $error";
709 if ( $options{'depend_jobnum'} ) {
710 warn "$me depend_jobnum found; adding to welcome email dependancies"
712 if ( ref($options{'depend_jobnum'}) ) {
713 warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
714 "to welcome email dependancies"
716 push @jobnums, @{ $options{'depend_jobnum'} };
718 warn "$me adding job $options{'depend_jobnum'} ".
719 "to welcome email dependancies"
721 push @jobnums, $options{'depend_jobnum'};
725 foreach my $jobnum ( @jobnums ) {
726 my $error = $wqueue->depend_insert($jobnum);
728 $dbh->rollback if $oldAutoCommit;
729 return "error queuing welcome email job dependancy: $error";
739 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
743 # set usage fields and thresholds if unset but set in a package def
744 # AND the package already has a last bill date (otherwise they get double added)
745 sub preinsert_hook_first {
748 return '' unless $self->pkgnum;
750 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
751 return '' unless $cust_pkg && $cust_pkg->last_bill;
753 my $part_pkg = $cust_pkg->part_pkg;
754 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
756 my %values = $part_pkg->usage_valuehash;
757 my $multiplier = $conf->exists('svc_acct-usage_threshold')
758 ? 1 - $conf->config('svc_acct-usage_threshold')/100
759 : 0.20; #doesn't matter
761 foreach ( keys %values ) {
762 next if $self->getfield($_);
763 $self->setfield( $_, $values{$_} );
764 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
765 if $conf->exists('svc_acct-usage_threshold');
773 Deletes this account from the database. If there is an error, returns the
774 error, otherwise returns false.
776 The corresponding FS::cust_svc record will be deleted as well.
778 (TODOC: new exports!)
785 return "can't delete system account" if $self->_check_system;
787 return "Can't delete an account which is a (svc_forward) source!"
788 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
790 return "Can't delete an account which is a (svc_forward) destination!"
791 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
793 return "Can't delete an account with (svc_www) web service!"
794 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
796 # what about records in session ? (they should refer to history table)
798 local $SIG{HUP} = 'IGNORE';
799 local $SIG{INT} = 'IGNORE';
800 local $SIG{QUIT} = 'IGNORE';
801 local $SIG{TERM} = 'IGNORE';
802 local $SIG{TSTP} = 'IGNORE';
803 local $SIG{PIPE} = 'IGNORE';
805 my $oldAutoCommit = $FS::UID::AutoCommit;
806 local $FS::UID::AutoCommit = 0;
809 foreach my $cust_main_invoice (
810 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
812 unless ( defined($cust_main_invoice) ) {
813 warn "WARNING: something's wrong with qsearch";
816 my %hash = $cust_main_invoice->hash;
817 $hash{'dest'} = $self->email;
818 my $new = new FS::cust_main_invoice \%hash;
819 my $error = $new->replace($cust_main_invoice);
821 $dbh->rollback if $oldAutoCommit;
826 foreach my $svc_domain (
827 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
829 my %hash = new FS::svc_domain->hash;
830 $hash{'catchall'} = '';
831 my $new = new FS::svc_domain \%hash;
832 my $error = $new->replace($svc_domain);
834 $dbh->rollback if $oldAutoCommit;
839 my $error = $self->SUPER::delete;
841 $dbh->rollback if $oldAutoCommit;
845 foreach my $radius_usergroup (
846 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } )
848 my $error = $radius_usergroup->delete;
850 $dbh->rollback if $oldAutoCommit;
855 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
859 =item replace OLD_RECORD
861 Replaces OLD_RECORD with this one in the database. If there is an error,
862 returns the error, otherwise returns false.
864 The additional field I<usergroup> can optionally be defined; if so it should
865 contain an arrayref of group names. See L<FS::radius_usergroup>.
873 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
877 warn "$me replacing $old with $new\n" if $DEBUG;
881 return "can't modify system account" if $old->_check_system;
884 #no warnings 'numeric'; #alas, a 5.006-ism
887 foreach my $xid (qw( uid gid )) {
889 return "Can't change $xid!"
890 if ! $conf->exists("svc_acct-edit_$xid")
891 && $old->$xid() != $new->$xid()
892 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
897 #change homdir when we change username
898 $new->setfield('dir', '') if $old->username ne $new->username;
900 local $SIG{HUP} = 'IGNORE';
901 local $SIG{INT} = 'IGNORE';
902 local $SIG{QUIT} = 'IGNORE';
903 local $SIG{TERM} = 'IGNORE';
904 local $SIG{TSTP} = 'IGNORE';
905 local $SIG{PIPE} = 'IGNORE';
907 my $oldAutoCommit = $FS::UID::AutoCommit;
908 local $FS::UID::AutoCommit = 0;
911 # redundant, but so $new->usergroup gets set
912 $error = $new->check;
913 return $error if $error;
915 $old->usergroup( [ $old->radius_groups ] );
917 warn $old->email. " old groups: ". join(' ',@{$old->usergroup}). "\n";
918 warn $new->email. "new groups: ". join(' ',@{$new->usergroup}). "\n";
920 if ( $new->usergroup ) {
921 #(sorta) false laziness with FS::part_export::sqlradius::_export_replace
922 my @newgroups = @{$new->usergroup};
923 foreach my $oldgroup ( @{$old->usergroup} ) {
924 if ( grep { $oldgroup eq $_ } @newgroups ) {
925 @newgroups = grep { $oldgroup ne $_ } @newgroups;
928 my $radius_usergroup = qsearchs('radius_usergroup', {
929 svcnum => $old->svcnum,
930 groupname => $oldgroup,
932 my $error = $radius_usergroup->delete;
934 $dbh->rollback if $oldAutoCommit;
935 return "error deleting radius_usergroup $oldgroup: $error";
939 foreach my $newgroup ( @newgroups ) {
940 my $radius_usergroup = new FS::radius_usergroup ( {
941 svcnum => $new->svcnum,
942 groupname => $newgroup,
944 my $error = $radius_usergroup->insert;
946 $dbh->rollback if $oldAutoCommit;
947 return "error adding radius_usergroup $newgroup: $error";
953 $error = $new->SUPER::replace($old, @_);
955 $dbh->rollback if $oldAutoCommit;
956 return $error if $error;
959 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
960 $error = $new->queue_fuzzyfiles_update;
962 $dbh->rollback if $oldAutoCommit;
963 return "updating fuzzy search cache: $error";
967 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
971 =item queue_fuzzyfiles_update
973 Used by insert & replace to update the fuzzy search cache
977 sub queue_fuzzyfiles_update {
980 local $SIG{HUP} = 'IGNORE';
981 local $SIG{INT} = 'IGNORE';
982 local $SIG{QUIT} = 'IGNORE';
983 local $SIG{TERM} = 'IGNORE';
984 local $SIG{TSTP} = 'IGNORE';
985 local $SIG{PIPE} = 'IGNORE';
987 my $oldAutoCommit = $FS::UID::AutoCommit;
988 local $FS::UID::AutoCommit = 0;
991 my $queue = new FS::queue {
992 'svcnum' => $self->svcnum,
993 'job' => 'FS::svc_acct::append_fuzzyfiles'
995 my $error = $queue->insert($self->username);
997 $dbh->rollback if $oldAutoCommit;
998 return "queueing job (transaction rolled back): $error";
1001 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1009 Suspends this account by calling export-specific suspend hooks. If there is
1010 an error, returns the error, otherwise returns false.
1012 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1018 return "can't suspend system account" if $self->_check_system;
1019 $self->SUPER::suspend(@_);
1024 Unsuspends this account by by calling export-specific suspend hooks. If there
1025 is an error, returns the error, otherwise returns false.
1027 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1033 my %hash = $self->hash;
1034 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1035 $hash{_password} = $1;
1036 my $new = new FS::svc_acct ( \%hash );
1037 my $error = $new->replace($self);
1038 return $error if $error;
1041 $self->SUPER::unsuspend(@_);
1046 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1048 If the B<auto_unset_catchall> configuration option is set, this method will
1049 automatically remove any references to the canceled service in the catchall
1050 field of svc_domain. This allows packages that contain both a svc_domain and
1051 its catchall svc_acct to be canceled in one step.
1056 # Only one thing to do at this level
1058 foreach my $svc_domain (
1059 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1060 if($conf->exists('auto_unset_catchall')) {
1061 my %hash = $svc_domain->hash;
1062 $hash{catchall} = '';
1063 my $new = new FS::svc_domain ( \%hash );
1064 my $error = $new->replace($svc_domain);
1065 return $error if $error;
1067 return "cannot unprovision svc_acct #".$self->svcnum.
1068 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1072 $self->SUPER::cancel(@_);
1078 Checks all fields to make sure this is a valid service. If there is an error,
1079 returns the error, otherwise returns false. Called by the insert and replace
1082 Sets any fixed values; see L<FS::part_svc>.
1089 my($recref) = $self->hashref;
1091 my $x = $self->setfixed( $self->_fieldhandlers );
1092 return $x unless ref($x);
1095 if ( $part_svc->part_svc_column('usergroup')->columnflag eq "F" ) {
1097 [ split(',', $part_svc->part_svc_column('usergroup')->columnvalue) ] );
1100 my $error = $self->ut_numbern('svcnum')
1101 #|| $self->ut_number('domsvc')
1102 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1103 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1104 || $self->ut_textn('sec_phrase')
1105 || $self->ut_snumbern('seconds')
1106 || $self->ut_snumbern('upbytes')
1107 || $self->ut_snumbern('downbytes')
1108 || $self->ut_snumbern('totalbytes')
1109 || $self->ut_enum( '_password_encoding',
1110 [ '', qw( plain crypt ldap ) ]
1112 || $self->ut_enum( 'password_selfchange', [ '', 'Y' ] )
1113 || $self->ut_enum( 'password_recover', [ '', 'Y' ] )
1114 || $self->ut_textn( 'cgp_accessmodes' )
1115 || $self->ut_alphan( 'cgp_type' )
1116 || $self->ut_textn( 'cgp_aliases' ) #well
1117 || $self->ut_alphasn( 'cgp_deletemode' )
1118 || $self->ut_alphan( 'cgp_emptytrash' )
1120 return $error if $error;
1123 local $username_letter = $username_letter;
1124 if ($self->svcnum) {
1125 my $cust_svc = $self->cust_svc
1126 or return "no cust_svc record found for svcnum ". $self->svcnum;
1127 my $cust_pkg = $cust_svc->cust_pkg;
1129 if ($self->pkgnum) {
1130 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1134 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1137 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1138 if ( $username_uppercase ) {
1139 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:]{$usernamemin,$ulen})$/i
1140 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1141 $recref->{username} = $1;
1143 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:]{$usernamemin,$ulen})$/
1144 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1145 $recref->{username} = $1;
1148 if ( $username_letterfirst ) {
1149 $recref->{username} =~ /^[a-z]/ or return gettext('illegal_username');
1150 } elsif ( $username_letter ) {
1151 $recref->{username} =~ /[a-z]/ or return gettext('illegal_username');
1153 if ( $username_noperiod ) {
1154 $recref->{username} =~ /\./ and return gettext('illegal_username');
1156 if ( $username_nounderscore ) {
1157 $recref->{username} =~ /_/ and return gettext('illegal_username');
1159 if ( $username_nodash ) {
1160 $recref->{username} =~ /\-/ and return gettext('illegal_username');
1162 unless ( $username_ampersand ) {
1163 $recref->{username} =~ /\&/ and return gettext('illegal_username');
1165 unless ( $username_percent ) {
1166 $recref->{username} =~ /\%/ and return gettext('illegal_username');
1168 unless ( $username_colon ) {
1169 $recref->{username} =~ /\:/ and return gettext('illegal_username');
1172 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1173 $recref->{popnum} = $1;
1174 return "Unknown popnum" unless
1175 ! $recref->{popnum} ||
1176 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1178 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1180 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1181 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1183 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1184 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1185 #not all systems use gid=uid
1186 #you can set a fixed gid in part_svc
1188 return "Only root can have uid 0"
1189 if $recref->{uid} == 0
1190 && $recref->{username} !~ /^(root|toor|smtp)$/;
1192 unless ( $recref->{username} eq 'sync' ) {
1193 if ( grep $_ eq $recref->{shell}, @shells ) {
1194 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1196 return "Illegal shell \`". $self->shell. "\'; ".
1197 "shells configuration value contains: @shells";
1200 $recref->{shell} = '/bin/sync';
1204 $recref->{gid} ne '' ?
1205 return "Can't have gid without uid" : ( $recref->{gid}='' );
1206 #$recref->{dir} ne '' ?
1207 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1208 $recref->{shell} ne '' ?
1209 return "Can't have shell without uid" : ( $recref->{shell}='' );
1212 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1214 $recref->{dir} =~ /^([\/\w\-\.\&]*)$/
1215 or return "Illegal directory: ". $recref->{dir};
1216 $recref->{dir} = $1;
1217 return "Illegal directory"
1218 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1219 return "Illegal directory"
1220 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1221 unless ( $recref->{dir} ) {
1222 $recref->{dir} = $dir_prefix . '/';
1223 if ( $dirhash > 0 ) {
1224 for my $h ( 1 .. $dirhash ) {
1225 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1227 } elsif ( $dirhash < 0 ) {
1228 for my $h ( reverse $dirhash .. -1 ) {
1229 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1232 $recref->{dir} .= $recref->{username};
1238 # $error = $self->ut_textn('finger');
1239 # return $error if $error;
1240 if ( $self->getfield('finger') eq '' ) {
1241 my $cust_pkg = $self->svcnum
1242 ? $self->cust_svc->cust_pkg
1243 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1245 my $cust_main = $cust_pkg->cust_main;
1246 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1249 $self->getfield('finger') =~
1250 /^([\w \t\!\@\#\$\%\&\(\)\-\+\;\'\"\,\.\?\/\*\<\>]*)$/
1251 or return "Illegal finger: ". $self->getfield('finger');
1252 $self->setfield('finger', $1);
1254 for (qw( quota file_quota file_maxsize )) {
1255 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1258 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1259 $recref->{file_maxnum} = $1;
1261 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1262 if ( $recref->{slipip} eq '' ) {
1263 $recref->{slipip} = '';
1264 } elsif ( $recref->{slipip} eq '0e0' ) {
1265 $recref->{slipip} = '0e0';
1267 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1268 or return "Illegal slipip: ". $self->slipip;
1269 $recref->{slipip} = $1;
1274 #arbitrary RADIUS stuff; allow ut_textn for now
1275 foreach ( grep /^radius_/, fields('svc_acct') ) {
1276 $self->ut_textn($_);
1279 # First, if _password is blank, generate one and set default encoding.
1280 if ( ! $recref->{_password} ) {
1281 $error = $self->set_password('');
1283 # But if there's a _password but no encoding, assume it's plaintext and
1284 # set it to default encoding.
1285 elsif ( ! $recref->{_password_encoding} ) {
1286 $error = $self->set_password($recref->{_password});
1288 return $error if $error;
1290 # Next, check _password to ensure compliance with the encoding.
1291 if ( $recref->{_password_encoding} eq 'ldap' ) {
1293 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1294 $recref->{_password} = uc($1).$2;
1296 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1299 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1301 if ( $recref->{_password} =~
1302 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1303 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1306 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1309 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1312 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1313 # Password randomization is now in set_password.
1314 # Strip whitespace characters, check length requirements, etc.
1315 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1316 $recref->{_password} = $1;
1318 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1319 FS::Msgcat::_gettext('illegal_password_characters').
1320 ": ". $recref->{_password};
1323 if ( $password_noampersand ) {
1324 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1326 if ( $password_noexclamation ) {
1327 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1331 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1333 $self->SUPER::check;
1338 sub _password_encryption {
1340 my $encoding = lc($self->_password_encoding);
1341 return if !$encoding;
1342 return 'plain' if $encoding eq 'plain';
1343 if($encoding eq 'crypt') {
1344 my $pass = $self->_password;
1345 $pass =~ s/^\*SUSPENDED\* //;
1347 return 'md5' if $pass =~ /^\$1\$/;
1348 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1349 return 'des' if length($pass) == 13;
1352 if($encoding eq 'ldap') {
1353 uc($self->_password) =~ /^\{([\w-]+)\}/;
1354 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1355 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1356 return 'md5' if $1 eq 'MD5';
1357 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1364 sub get_cleartext_password {
1366 if($self->_password_encryption eq 'plain') {
1367 if($self->_password_encoding eq 'ldap') {
1368 $self->_password =~ /\{\w+\}(.*)$/;
1372 return $self->_password;
1381 Set the cleartext password for the account. If _password_encoding is set, the
1382 new password will be encoded according to the existing method (including
1383 encryption mode, if it can be determined). Otherwise,
1384 config('default-password-encoding') is used.
1386 If no password is supplied (or a zero-length password when minimum password length
1387 is >0), one will be generated randomly.
1392 my( $self, $pass ) = ( shift, shift );
1394 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1397 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1398 FS::Msgcat::_gettext('illegal_password_characters').
1401 my( $encoding, $encryption ) = ('', '');
1403 if ( $self->_password_encoding ) {
1404 $encoding = $self->_password_encoding;
1405 # identify existing encryption method, try to use it.
1406 $encryption = $self->_password_encryption;
1408 # use the system default
1414 # set encoding to system default
1415 ($encoding, $encryption) =
1416 split(/-/, lc($conf->config('default-password-encoding')));
1417 $encoding ||= 'legacy';
1418 $self->_password_encoding($encoding);
1421 if ( $encoding eq 'legacy' ) {
1423 # The legacy behavior from check():
1424 # If the password is blank, randomize it and set encoding to 'plain'.
1425 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1426 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1427 $self->_password_encoding('plain');
1429 # Prefix + valid-length password
1430 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1432 $self->_password_encoding('plain');
1433 # Prefix + crypt string
1434 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1436 $self->_password_encoding('crypt');
1437 # Various disabled crypt passwords
1438 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1439 $self->_password_encoding('crypt');
1445 $self->_password($pass);
1451 if $passwordmin && length($pass) < $passwordmin
1452 or $passwordmax && length($pass) > $passwordmax;
1454 if ( $encoding eq 'crypt' ) {
1455 if ($encryption eq 'md5') {
1456 $pass = unix_md5_crypt($pass);
1457 } elsif ($encryption eq 'des') {
1458 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1461 } elsif ( $encoding eq 'ldap' ) {
1462 if ($encryption eq 'md5') {
1463 $pass = md5_base64($pass);
1464 } elsif ($encryption eq 'sha1') {
1465 $pass = sha1_base64($pass);
1466 } elsif ($encryption eq 'crypt') {
1467 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1469 # else $encryption eq 'plain', do nothing
1470 $pass = '{'.uc($encryption).'}'.$pass;
1472 # else encoding eq 'plain'
1474 $self->_password($pass);
1480 Internal function to check the username against the list of system usernames
1481 from the I<system_usernames> configuration value. Returns true if the username
1482 is listed on the system username list.
1488 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1489 $conf->config('system_usernames')
1493 =item _check_duplicate
1495 Internal method to check for duplicates usernames, username@domain pairs and
1498 If the I<global_unique-username> configuration value is set to B<username> or
1499 B<username@domain>, enforces global username or username@domain uniqueness.
1501 In all cases, check for duplicate uids and usernames or username@domain pairs
1502 per export and with identical I<svcpart> values.
1506 sub _check_duplicate {
1509 my $global_unique = $conf->config('global_unique-username') || 'none';
1510 return '' if $global_unique eq 'disabled';
1514 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1515 unless ( $part_svc ) {
1516 return 'unknown svcpart '. $self->svcpart;
1519 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1520 qsearch( 'svc_acct', { 'username' => $self->username } );
1521 return gettext('username_in_use')
1522 if $global_unique eq 'username' && @dup_user;
1524 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1525 qsearch( 'svc_acct', { 'username' => $self->username,
1526 'domsvc' => $self->domsvc } );
1527 return gettext('username_in_use')
1528 if $global_unique eq 'username@domain' && @dup_userdomain;
1531 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1532 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1533 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1534 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1539 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1540 my $exports = FS::part_export::export_info('svc_acct');
1541 my %conflict_user_svcpart;
1542 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1544 foreach my $part_export ( $part_svc->part_export ) {
1546 #this will catch to the same exact export
1547 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1549 #this will catch to exports w/same exporthost+type ???
1550 #my @other_part_export = qsearch('part_export', {
1551 # 'machine' => $part_export->machine,
1552 # 'exporttype' => $part_export->exporttype,
1554 #foreach my $other_part_export ( @other_part_export ) {
1555 # push @svcparts, map { $_->svcpart }
1556 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1559 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1560 #silly kludge to avoid uninitialized value errors
1561 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1562 ? $exports->{$part_export->exporttype}{'nodomain'}
1564 if ( $nodomain =~ /^Y/i ) {
1565 $conflict_user_svcpart{$_} = $part_export->exportnum
1568 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1573 foreach my $dup_user ( @dup_user ) {
1574 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1575 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1576 return "duplicate username ". $self->username.
1577 ": conflicts with svcnum ". $dup_user->svcnum.
1578 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1582 foreach my $dup_userdomain ( @dup_userdomain ) {
1583 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1584 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1585 return "duplicate username\@domain ". $self->email.
1586 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1587 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1591 foreach my $dup_uid ( @dup_uid ) {
1592 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1593 if ( exists($conflict_user_svcpart{$dup_svcpart})
1594 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1595 return "duplicate uid ". $self->uid.
1596 ": conflicts with svcnum ". $dup_uid->svcnum.
1598 ( $conflict_user_svcpart{$dup_svcpart}
1599 || $conflict_userdomain_svcpart{$dup_svcpart} );
1611 Depriciated, use radius_reply instead.
1616 carp "FS::svc_acct::radius depriciated, use radius_reply";
1617 $_[0]->radius_reply;
1622 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1623 reply attributes of this record.
1625 Note that this is now the preferred method for reading RADIUS attributes -
1626 accessing the columns directly is discouraged, as the column names are
1627 expected to change in the future.
1634 return %{ $self->{'radius_reply'} }
1635 if exists $self->{'radius_reply'};
1640 my($column, $attrib) = ($1, $2);
1641 #$attrib =~ s/_/\-/g;
1642 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1643 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1645 if ( $self->slipip && $self->slipip ne '0e0' ) {
1646 $reply{$radius_ip} = $self->slipip;
1649 if ( $self->seconds !~ /^$/ ) {
1650 $reply{'Session-Timeout'} = $self->seconds;
1653 if ( $conf->exists('radius-chillispot-max') ) {
1654 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1656 #hmm. just because sqlradius.pm says so?
1663 foreach my $what (qw( input output total )) {
1664 my $is = $whatis{$what}.'bytes';
1665 if ( $self->$is() =~ /\d/ ) {
1666 my $big = new Math::BigInt $self->$is();
1667 $big = new Math::BigInt '0' if $big->is_neg();
1668 my $att = "Chillispot-Max-\u$what";
1669 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1670 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1681 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1682 check attributes of this record.
1684 Note that this is now the preferred method for reading RADIUS attributes -
1685 accessing the columns directly is discouraged, as the column names are
1686 expected to change in the future.
1693 return %{ $self->{'radius_check'} }
1694 if exists $self->{'radius_check'};
1699 my($column, $attrib) = ($1, $2);
1700 #$attrib =~ s/_/\-/g;
1701 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1702 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1705 my($pw_attrib, $password) = $self->radius_password;
1706 $check{$pw_attrib} = $password;
1708 my $cust_svc = $self->cust_svc;
1710 my $cust_pkg = $cust_svc->cust_pkg;
1711 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1712 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1715 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1716 "; can't set Expiration\n"
1724 =item radius_password
1726 Returns a key/value pair containing the RADIUS attribute name and value
1731 sub radius_password {
1735 if ( $self->_password_encoding eq 'ldap' ) {
1736 $pw_attrib = 'Password-With-Header';
1737 } elsif ( $self->_password_encoding eq 'crypt' ) {
1738 $pw_attrib = 'Crypt-Password';
1739 } elsif ( $self->_password_encoding eq 'plain' ) {
1740 $pw_attrib = $radius_password;
1742 $pw_attrib = length($self->_password) <= 12
1747 ($pw_attrib, $self->_password);
1753 This method instructs the object to "snapshot" or freeze RADIUS check and
1754 reply attributes to the current values.
1758 #bah, my english is too broken this morning
1759 #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
1760 #the FS::cust_pkg's replace method to trigger the correct export updates when
1761 #package dates change)
1766 $self->{$_} = { $self->$_() }
1767 foreach qw( radius_reply radius_check );
1771 =item forget_snapshot
1773 This methos instructs the object to forget any previously snapshotted
1774 RADIUS check and reply attributes.
1778 sub forget_snapshot {
1782 foreach qw( radius_reply radius_check );
1786 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1788 Returns the domain associated with this account.
1790 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1797 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1798 my $svc_domain = $self->svc_domain(@_)
1799 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1800 $svc_domain->domain;
1805 Returns the FS::svc_domain record for this account's domain (see
1810 # FS::h_svc_acct has a history-aware svc_domain override
1815 ? $self->{'_domsvc'}
1816 : qsearchs( 'svc_domain', { 'svcnum' => $self->domsvc } );
1821 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1825 #inherited from svc_Common
1827 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1829 Returns an email address associated with the account.
1831 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1838 $self->username. '@'. $self->domain(@_);
1843 Returns an array of FS::acct_snarf records associated with the account.
1844 If the acct_snarf table does not exist or there are no associated records,
1845 an empty list is returned
1851 return () unless dbdef->table('acct_snarf');
1852 eval "use FS::acct_snarf;";
1854 qsearch('acct_snarf', { 'svcnum' => $self->svcnum } );
1857 =item decrement_upbytes OCTETS
1859 Decrements the I<upbytes> field of this record by the given amount. If there
1860 is an error, returns the error, otherwise returns false.
1864 sub decrement_upbytes {
1865 shift->_op_usage('-', 'upbytes', @_);
1868 =item increment_upbytes OCTETS
1870 Increments the I<upbytes> field of this record by the given amount. If there
1871 is an error, returns the error, otherwise returns false.
1875 sub increment_upbytes {
1876 shift->_op_usage('+', 'upbytes', @_);
1879 =item decrement_downbytes OCTETS
1881 Decrements the I<downbytes> field of this record by the given amount. If there
1882 is an error, returns the error, otherwise returns false.
1886 sub decrement_downbytes {
1887 shift->_op_usage('-', 'downbytes', @_);
1890 =item increment_downbytes OCTETS
1892 Increments the I<downbytes> field of this record by the given amount. If there
1893 is an error, returns the error, otherwise returns false.
1897 sub increment_downbytes {
1898 shift->_op_usage('+', 'downbytes', @_);
1901 =item decrement_totalbytes OCTETS
1903 Decrements the I<totalbytes> field of this record by the given amount. If there
1904 is an error, returns the error, otherwise returns false.
1908 sub decrement_totalbytes {
1909 shift->_op_usage('-', 'totalbytes', @_);
1912 =item increment_totalbytes OCTETS
1914 Increments the I<totalbytes> field of this record by the given amount. If there
1915 is an error, returns the error, otherwise returns false.
1919 sub increment_totalbytes {
1920 shift->_op_usage('+', 'totalbytes', @_);
1923 =item decrement_seconds SECONDS
1925 Decrements the I<seconds> field of this record by the given amount. If there
1926 is an error, returns the error, otherwise returns false.
1930 sub decrement_seconds {
1931 shift->_op_usage('-', 'seconds', @_);
1934 =item increment_seconds SECONDS
1936 Increments the I<seconds> field of this record by the given amount. If there
1937 is an error, returns the error, otherwise returns false.
1941 sub increment_seconds {
1942 shift->_op_usage('+', 'seconds', @_);
1950 my %op2condition = (
1951 '-' => sub { my($self, $column, $amount) = @_;
1952 $self->$column - $amount <= 0;
1954 '+' => sub { my($self, $column, $amount) = @_;
1955 ($self->$column || 0) + $amount > 0;
1958 my %op2warncondition = (
1959 '-' => sub { my($self, $column, $amount) = @_;
1960 my $threshold = $column . '_threshold';
1961 $self->$column - $amount <= $self->$threshold + 0;
1963 '+' => sub { my($self, $column, $amount) = @_;
1964 ($self->$column || 0) + $amount > 0;
1969 my( $self, $op, $column, $amount ) = @_;
1971 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
1972 ' ('. $self->email. "): $op $amount\n"
1975 return '' unless $amount;
1977 local $SIG{HUP} = 'IGNORE';
1978 local $SIG{INT} = 'IGNORE';
1979 local $SIG{QUIT} = 'IGNORE';
1980 local $SIG{TERM} = 'IGNORE';
1981 local $SIG{TSTP} = 'IGNORE';
1982 local $SIG{PIPE} = 'IGNORE';
1984 my $oldAutoCommit = $FS::UID::AutoCommit;
1985 local $FS::UID::AutoCommit = 0;
1988 my $sql = "UPDATE svc_acct SET $column = ".
1989 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
1990 " $op ? WHERE svcnum = ?";
1994 my $sth = $dbh->prepare( $sql )
1995 or die "Error preparing $sql: ". $dbh->errstr;
1996 my $rv = $sth->execute($amount, $self->svcnum);
1997 die "Error executing $sql: ". $sth->errstr
1998 unless defined($rv);
1999 die "Can't update $column for svcnum". $self->svcnum
2002 #$self->snapshot; #not necessary, we retain the old values
2003 #create an object with the updated usage values
2004 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2006 my $error = $new->replace($self);
2008 $dbh->rollback if $oldAutoCommit;
2009 return "Error replacing: $error";
2012 #overlimit_action eq 'cancel' handling
2013 my $cust_pkg = $self->cust_svc->cust_pkg;
2015 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2016 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2020 my $error = $cust_pkg->cancel; #XXX should have a reason
2022 $dbh->rollback if $oldAutoCommit;
2023 return "Error cancelling: $error";
2026 #nothing else is relevant if we're cancelling, so commit & return success
2027 warn "$me update successful; committing\n"
2029 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2034 my $action = $op2action{$op};
2036 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2037 ( $action eq 'suspend' && !$self->overlimit
2038 || $action eq 'unsuspend' && $self->overlimit )
2041 my $error = $self->_op_overlimit($action);
2043 $dbh->rollback if $oldAutoCommit;
2049 if ( $conf->exists("svc_acct-usage_$action")
2050 && &{$op2condition{$op}}($self, $column, $amount) ) {
2051 #my $error = $self->$action();
2052 my $error = $self->cust_svc->cust_pkg->$action();
2053 # $error ||= $self->overlimit($action);
2055 $dbh->rollback if $oldAutoCommit;
2056 return "Error ${action}ing: $error";
2060 if ($warning_template && &{$op2warncondition{$op}}($self, $column, $amount)) {
2061 my $wqueue = new FS::queue {
2062 'svcnum' => $self->svcnum,
2063 'job' => 'FS::svc_acct::reached_threshold',
2068 $to = $warning_cc if &{$op2condition{$op}}($self, $column, $amount);
2072 my $error = $wqueue->insert(
2073 'svcnum' => $self->svcnum,
2075 'column' => $column,
2079 $dbh->rollback if $oldAutoCommit;
2080 return "Error queuing threshold activity: $error";
2084 warn "$me update successful; committing\n"
2086 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2092 my( $self, $action ) = @_;
2094 local $SIG{HUP} = 'IGNORE';
2095 local $SIG{INT} = 'IGNORE';
2096 local $SIG{QUIT} = 'IGNORE';
2097 local $SIG{TERM} = 'IGNORE';
2098 local $SIG{TSTP} = 'IGNORE';
2099 local $SIG{PIPE} = 'IGNORE';
2101 my $oldAutoCommit = $FS::UID::AutoCommit;
2102 local $FS::UID::AutoCommit = 0;
2105 my $cust_pkg = $self->cust_svc->cust_pkg;
2107 my $conf_overlimit =
2109 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2110 : $conf->config('overlimit_groups');
2112 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2114 my $groups = $conf_overlimit || $part_export->option('overlimit_groups');
2115 next unless $groups;
2117 my $gref = &{ $self->_fieldhandlers->{'usergroup'} }( $self, $groups );
2119 my $other = new FS::svc_acct $self->hashref;
2120 $other->usergroup( $gref );
2123 if ($action eq 'suspend') {
2126 } else { # $action eq 'unsuspend'
2131 my $error = $part_export->export_replace($new, $old)
2132 || $self->overlimit($action);
2135 $dbh->rollback if $oldAutoCommit;
2136 return "Error replacing radius groups: $error";
2141 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2147 my( $self, $valueref, %options ) = @_;
2149 warn "$me set_usage called for svcnum ". $self->svcnum.
2150 ' ('. $self->email. "): ".
2151 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2154 local $SIG{HUP} = 'IGNORE';
2155 local $SIG{INT} = 'IGNORE';
2156 local $SIG{QUIT} = 'IGNORE';
2157 local $SIG{TERM} = 'IGNORE';
2158 local $SIG{TSTP} = 'IGNORE';
2159 local $SIG{PIPE} = 'IGNORE';
2161 local $FS::svc_Common::noexport_hack = 1;
2162 my $oldAutoCommit = $FS::UID::AutoCommit;
2163 local $FS::UID::AutoCommit = 0;
2168 if ( $options{null} ) {
2169 %handyhash = ( map { ( $_ => 'NULL', $_."_threshold" => 'NULL' ) }
2170 qw( seconds upbytes downbytes totalbytes )
2173 foreach my $field (keys %$valueref){
2174 $reset = 1 if $valueref->{$field};
2175 $self->setfield($field, $valueref->{$field});
2176 $self->setfield( $field.'_threshold',
2177 int($self->getfield($field)
2178 * ( $conf->exists('svc_acct-usage_threshold')
2179 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2184 $handyhash{$field} = $self->getfield($field);
2185 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2187 #my $error = $self->replace; #NO! we avoid the call to ->check for
2188 #die $error if $error; #services not explicity changed via the UI
2190 my $sql = "UPDATE svc_acct SET " .
2191 join (',', map { "$_ = $handyhash{$_}" } (keys %handyhash) ).
2192 " WHERE svcnum = ". $self->svcnum;
2197 if (scalar(keys %handyhash)) {
2198 my $sth = $dbh->prepare( $sql )
2199 or die "Error preparing $sql: ". $dbh->errstr;
2200 my $rv = $sth->execute();
2201 die "Error executing $sql: ". $sth->errstr
2202 unless defined($rv);
2203 die "Can't update usage for svcnum ". $self->svcnum
2207 #$self->snapshot; #not necessary, we retain the old values
2208 #create an object with the updated usage values
2209 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2210 local($FS::Record::nowarn_identical) = 1;
2211 my $error = $new->replace($self); #call exports
2213 $dbh->rollback if $oldAutoCommit;
2214 return "Error replacing: $error";
2221 $error = $self->_op_overlimit('unsuspend')
2222 if $self->overlimit;;
2224 $error ||= $self->cust_svc->cust_pkg->unsuspend
2225 if $conf->exists("svc_acct-usage_unsuspend");
2228 $dbh->rollback if $oldAutoCommit;
2229 return "Error unsuspending: $error";
2234 warn "$me update successful; committing\n"
2236 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2242 =item recharge HASHREF
2244 Increments usage columns by the amount specified in HASHREF as
2245 column=>amount pairs.
2250 my ($self, $vhash) = @_;
2253 warn "[$me] recharge called on $self: ". Dumper($self).
2254 "\nwith vhash: ". Dumper($vhash);
2257 my $oldAutoCommit = $FS::UID::AutoCommit;
2258 local $FS::UID::AutoCommit = 0;
2262 foreach my $column (keys %$vhash){
2263 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2267 $dbh->rollback if $oldAutoCommit;
2269 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2274 =item is_rechargeable
2276 Returns true if this svc_account can be "recharged" and false otherwise.
2280 sub is_rechargable {
2282 $self->seconds ne ''
2283 || $self->upbytes ne ''
2284 || $self->downbytes ne ''
2285 || $self->totalbytes ne '';
2288 =item seconds_since TIMESTAMP
2290 Returns the number of seconds this account has been online since TIMESTAMP,
2291 according to the session monitor (see L<FS::Session>).
2293 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2294 L<Time::Local> and L<Date::Parse> for conversion functions.
2298 #note: POD here, implementation in FS::cust_svc
2301 $self->cust_svc->seconds_since(@_);
2304 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2306 Returns the numbers of seconds this account has been online between
2307 TIMESTAMP_START (inclusive) and TIMESTAMP_END (exclusive), according to an
2308 external SQL radacct table, specified via sqlradius export. Sessions which
2309 started in the specified range but are still open are counted from session
2310 start to the end of the range (unless they are over 1 day old, in which case
2311 they are presumed missing their stop record and not counted). Also, sessions
2312 which end in the range but started earlier are counted from the start of the
2313 range to session end. Finally, sessions which start before the range but end
2314 after are counted for the entire range.
2316 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2317 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2322 #note: POD here, implementation in FS::cust_svc
2323 sub seconds_since_sqlradacct {
2325 $self->cust_svc->seconds_since_sqlradacct(@_);
2328 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2330 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2331 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2332 TIMESTAMP_END (exclusive).
2334 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2335 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2340 #note: POD here, implementation in FS::cust_svc
2341 sub attribute_since_sqlradacct {
2343 $self->cust_svc->attribute_since_sqlradacct(@_);
2346 =item get_session_history TIMESTAMP_START TIMESTAMP_END
2348 Returns an array of hash references of this customers login history for the
2349 given time range. (document this better)
2353 sub get_session_history {
2355 $self->cust_svc->get_session_history(@_);
2358 =item last_login_text
2360 Returns text describing the time of last login.
2364 sub last_login_text {
2366 $self->last_login ? ctime($self->last_login) : 'unknown';
2369 =item get_cdrs TIMESTAMP_START TIMESTAMP_END [ 'OPTION' => 'VALUE ... ]
2374 my($self, $start, $end, %opt ) = @_;
2376 my $did = $self->username; #yup
2378 my $prefix = $opt{'default_prefix'}; #convergent.au '+61'
2380 my $for_update = $opt{'for_update'} ? 'FOR UPDATE' : '';
2382 #SELECT $for_update * FROM cdr
2383 # WHERE calldate >= $start #need a conversion
2384 # AND calldate < $end #ditto
2385 # AND ( charged_party = "$did"
2386 # OR charged_party = "$prefix$did" #if length($prefix);
2387 # OR ( ( charged_party IS NULL OR charged_party = '' )
2389 # ( src = "$did" OR src = "$prefix$did" ) # if length($prefix)
2392 # AND ( freesidestatus IS NULL OR freesidestatus = '' )
2395 if ( length($prefix) ) {
2397 " AND ( charged_party = '$did'
2398 OR charged_party = '$prefix$did'
2399 OR ( ( charged_party IS NULL OR charged_party = '' )
2401 ( src = '$did' OR src = '$prefix$did' )
2407 " AND ( charged_party = '$did'
2408 OR ( ( charged_party IS NULL OR charged_party = '' )
2418 'select' => "$for_update *",
2421 #( freesidestatus IS NULL OR freesidestatus = '' )
2422 'freesidestatus' => '',
2424 'extra_sql' => $charged_or_src,
2432 Returns all RADIUS groups for this account (see L<FS::radius_usergroup>).
2438 if ( $self->usergroup ) {
2439 confess "explicitly specified usergroup not an arrayref: ". $self->usergroup
2440 unless ref($self->usergroup) eq 'ARRAY';
2441 #when provisioning records, export callback runs in svc_Common.pm before
2442 #radius_usergroup records can be inserted...
2443 @{$self->usergroup};
2445 map { $_->groupname }
2446 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } );
2450 =item clone_suspended
2452 Constructor used by FS::part_export::_export_suspend fallback. Document
2457 sub clone_suspended {
2459 my %hash = $self->hash;
2460 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2461 new FS::svc_acct \%hash;
2464 =item clone_kludge_unsuspend
2466 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2471 sub clone_kludge_unsuspend {
2473 my %hash = $self->hash;
2474 $hash{_password} = '';
2475 new FS::svc_acct \%hash;
2478 =item check_password
2480 Checks the supplied password against the (possibly encrypted) password in the
2481 database. Returns true for a successful authentication, false for no match.
2483 Currently supported encryptions are: classic DES crypt() and MD5
2487 sub check_password {
2488 my($self, $check_password) = @_;
2490 #remove old-style SUSPENDED kludge, they should be allowed to login to
2491 #self-service and pay up
2492 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2494 if ( $self->_password_encoding eq 'ldap' ) {
2496 my $auth = from_rfc2307 Authen::Passphrase $self->_password;
2497 return $auth->match($check_password);
2499 } elsif ( $self->_password_encoding eq 'crypt' ) {
2501 my $auth = from_crypt Authen::Passphrase $self->_password;
2502 return $auth->match($check_password);
2504 } elsif ( $self->_password_encoding eq 'plain' ) {
2506 return $check_password eq $password;
2510 #XXX this could be replaced with Authen::Passphrase stuff
2512 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2514 } elsif ( length($password) < 13 ) { #plaintext
2515 $check_password eq $password;
2516 } elsif ( length($password) == 13 ) { #traditional DES crypt
2517 crypt($check_password, $password) eq $password;
2518 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2519 unix_md5_crypt($check_password, $password) eq $password;
2520 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2521 warn "Can't check password: Blowfish encryption not yet supported, ".
2522 "svcnum ". $self->svcnum. "\n";
2525 warn "Can't check password: Unrecognized encryption for svcnum ".
2526 $self->svcnum. "\n";
2534 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2536 Returns an encrypted password, either by passing through an encrypted password
2537 in the database or by encrypting a plaintext password from the database.
2539 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2540 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2541 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2542 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2543 encryption type is only used if the password is not already encrypted in the
2548 sub crypt_password {
2551 if ( $self->_password_encoding eq 'ldap' ) {
2553 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2556 #XXX this could be replaced with Authen::Passphrase stuff
2558 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2559 if ( $encryption eq 'crypt' ) {
2562 $saltset[int(rand(64))].$saltset[int(rand(64))]
2564 } elsif ( $encryption eq 'md5' ) {
2565 unix_md5_crypt( $self->_password );
2566 } elsif ( $encryption eq 'blowfish' ) {
2567 croak "unknown encryption method $encryption";
2569 croak "unknown encryption method $encryption";
2572 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2576 } elsif ( $self->_password_encoding eq 'crypt' ) {
2578 return $self->_password;
2580 } elsif ( $self->_password_encoding eq 'plain' ) {
2582 #XXX this could be replaced with Authen::Passphrase stuff
2584 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2585 if ( $encryption eq 'crypt' ) {
2588 $saltset[int(rand(64))].$saltset[int(rand(64))]
2590 } elsif ( $encryption eq 'md5' ) {
2591 unix_md5_crypt( $self->_password );
2592 } elsif ( $encryption eq 'blowfish' ) {
2593 croak "unknown encryption method $encryption";
2595 croak "unknown encryption method $encryption";
2600 if ( length($self->_password) == 13
2601 || $self->_password =~ /^\$(1|2a?)\$/
2602 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2608 #XXX this could be replaced with Authen::Passphrase stuff
2610 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2611 if ( $encryption eq 'crypt' ) {
2614 $saltset[int(rand(64))].$saltset[int(rand(64))]
2616 } elsif ( $encryption eq 'md5' ) {
2617 unix_md5_crypt( $self->_password );
2618 } elsif ( $encryption eq 'blowfish' ) {
2619 croak "unknown encryption method $encryption";
2621 croak "unknown encryption method $encryption";
2630 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2632 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2633 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2634 "{MD5}5426824942db4253f87a1009fd5d2d4".
2636 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2637 to work the same as the B</crypt_password> method.
2643 #eventually should check a "password-encoding" field
2645 if ( $self->_password_encoding eq 'ldap' ) {
2647 return $self->_password;
2649 } elsif ( $self->_password_encoding eq 'crypt' ) {
2651 if ( length($self->_password) == 13 ) { #crypt
2652 return '{CRYPT}'. $self->_password;
2653 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2655 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2656 # die "Blowfish encryption not supported in this context, svcnum ".
2657 # $self->svcnum. "\n";
2659 warn "encryption method not (yet?) supported in LDAP context";
2660 return '{CRYPT}*'; #unsupported, should not auth
2663 } elsif ( $self->_password_encoding eq 'plain' ) {
2665 return '{PLAIN}'. $self->_password;
2667 #return '{CLEARTEXT}'. $self->_password; #?
2671 if ( length($self->_password) == 13 ) { #crypt
2672 return '{CRYPT}'. $self->_password;
2673 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2675 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2676 warn "Blowfish encryption not supported in this context, svcnum ".
2677 $self->svcnum. "\n";
2680 #are these two necessary anymore?
2681 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2682 return '{SSHA}'. $1;
2683 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2684 return '{NS-MTA-MD5}'. $1;
2687 return '{PLAIN}'. $self->_password;
2689 #return '{CLEARTEXT}'. $self->_password; #?
2691 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2692 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2693 #if ( $encryption eq 'crypt' ) {
2694 # return '{CRYPT}'. crypt(
2696 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2698 #} elsif ( $encryption eq 'md5' ) {
2699 # unix_md5_crypt( $self->_password );
2700 #} elsif ( $encryption eq 'blowfish' ) {
2701 # croak "unknown encryption method $encryption";
2703 # croak "unknown encryption method $encryption";
2711 =item domain_slash_username
2713 Returns $domain/$username/
2717 sub domain_slash_username {
2719 $self->domain. '/'. $self->username. '/';
2722 =item virtual_maildir
2724 Returns $domain/maildirs/$username/
2728 sub virtual_maildir {
2730 $self->domain. '/maildirs/'. $self->username. '/';
2735 =head1 CLASS METHODS
2739 =item search HASHREF
2741 Class method which returns a qsearch hash expression to search for parameters
2742 specified in HASHREF. Valid parameters are
2756 Arrayref of pkgparts
2762 Arrayref of additional WHERE clauses, will be ANDed together.
2773 my ($class, $params) = @_;
2778 if ( $params->{'domain'} ) {
2779 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2780 #preserve previous behavior & bubble up an error if $svc_domain not found?
2781 push @where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2785 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2786 push @where, "domsvc = $1";
2790 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
2793 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2794 push @where, "agentnum = $1";
2798 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2799 push @where, "custnum = $1";
2803 if ( $params->{'pkgpart'} && scalar(@{ $params->{'pkgpart'} }) ) {
2804 #XXX untaint or sql quote
2806 'cust_pkg.pkgpart IN ('. join(',', @{ $params->{'pkgpart'} } ). ')';
2810 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2811 push @where, "popnum = $1";
2815 if ( $params->{'svcpart'} =~ /^(\d+)$/ ) {
2816 push @where, "svcpart = $1";
2820 # here is the agent virtualization
2821 #if ($params->{CurrentUser}) {
2823 # qsearchs('access_user', { username => $params->{CurrentUser} });
2825 # if ($access_user) {
2826 # push @where, $access_user->agentnums_sql('table'=>'cust_main');
2828 # push @where, "1=0";
2831 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
2832 'table' => 'cust_main',
2833 'null_right' => 'View/link unlinked services',
2837 push @where, @{ $params->{'where'} } if $params->{'where'};
2839 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2841 my $addl_from = ' LEFT JOIN cust_svc USING ( svcnum ) '.
2842 ' LEFT JOIN part_svc USING ( svcpart ) '.
2843 ' LEFT JOIN cust_pkg USING ( pkgnum ) '.
2844 ' LEFT JOIN cust_main USING ( custnum ) ';
2846 my $count_query = "SELECT COUNT(*) FROM svc_acct $addl_from $extra_sql";
2847 #if ( keys %svc_acct ) {
2848 # $count_query .= ' WHERE '.
2849 # join(' AND ', map "$_ = ". dbh->quote($svc_acct{$_}),
2855 'table' => 'svc_acct',
2856 'hashref' => {}, # \%svc_acct,
2857 'select' => join(', ',
2860 'cust_main.custnum',
2861 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
2863 'addl_from' => $addl_from,
2864 'extra_sql' => $extra_sql,
2865 'order_by' => $params->{'order_by'},
2866 'count_query' => $count_query,
2879 This is the FS::svc_acct job-queue-able version. It still uses
2880 FS::Misc::send_email under-the-hood.
2887 eval "use FS::Misc qw(send_email)";
2890 $opt{mimetype} ||= 'text/plain';
2891 $opt{mimetype} .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2893 my $error = send_email(
2894 'from' => $opt{from},
2896 'subject' => $opt{subject},
2897 'content-type' => $opt{mimetype},
2898 'body' => [ map "$_\n", split("\n", $opt{body}) ],
2900 die $error if $error;
2903 =item check_and_rebuild_fuzzyfiles
2907 sub check_and_rebuild_fuzzyfiles {
2908 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2909 -e "$dir/svc_acct.username"
2910 or &rebuild_fuzzyfiles;
2913 =item rebuild_fuzzyfiles
2917 sub rebuild_fuzzyfiles {
2919 use Fcntl qw(:flock);
2921 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2925 open(USERNAMELOCK,">>$dir/svc_acct.username")
2926 or die "can't open $dir/svc_acct.username: $!";
2927 flock(USERNAMELOCK,LOCK_EX)
2928 or die "can't lock $dir/svc_acct.username: $!";
2930 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2932 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2933 or die "can't open $dir/svc_acct.username.tmp: $!";
2934 print USERNAMECACHE join("\n", @all_username), "\n";
2935 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2937 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2947 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2948 open(USERNAMECACHE,"<$dir/svc_acct.username")
2949 or die "can't open $dir/svc_acct.username: $!";
2950 my @array = map { chomp; $_; } <USERNAMECACHE>;
2951 close USERNAMECACHE;
2955 =item append_fuzzyfiles USERNAME
2959 sub append_fuzzyfiles {
2960 my $username = shift;
2962 &check_and_rebuild_fuzzyfiles;
2964 use Fcntl qw(:flock);
2966 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2968 open(USERNAME,">>$dir/svc_acct.username")
2969 or die "can't open $dir/svc_acct.username: $!";
2970 flock(USERNAME,LOCK_EX)
2971 or die "can't lock $dir/svc_acct.username: $!";
2973 print USERNAME "$username\n";
2975 flock(USERNAME,LOCK_UN)
2976 or die "can't unlock $dir/svc_acct.username: $!";
2984 =item radius_usergroup_selector GROUPS_ARRAYREF [ SELECTNAME ]
2988 sub radius_usergroup_selector {
2989 my $sel_groups = shift;
2990 my %sel_groups = map { $_=>1 } @$sel_groups;
2992 my $selectname = shift || 'radius_usergroup';
2995 my $sth = $dbh->prepare(
2996 'SELECT DISTINCT(groupname) FROM radius_usergroup ORDER BY groupname'
2997 ) or die $dbh->errstr;
2998 $sth->execute() or die $sth->errstr;
2999 my @all_groups = map { $_->[0] } @{$sth->fetchall_arrayref};
3003 function ${selectname}_doadd(object) {
3004 var myvalue = object.${selectname}_add.value;
3005 var optionName = new Option(myvalue,myvalue,false,true);
3006 var length = object.$selectname.length;
3007 object.$selectname.options[length] = optionName;
3008 object.${selectname}_add.value = "";
3011 <SELECT MULTIPLE NAME="$selectname">
3014 foreach my $group ( @all_groups ) {
3015 $html .= qq(<OPTION VALUE="$group");
3016 if ( $sel_groups{$group} ) {
3017 $html .= ' SELECTED';
3018 $sel_groups{$group} = 0;
3020 $html .= ">$group</OPTION>\n";
3022 foreach my $group ( grep { $sel_groups{$_} } keys %sel_groups ) {
3023 $html .= qq(<OPTION VALUE="$group" SELECTED>$group</OPTION>\n);
3025 $html .= '</SELECT>';
3027 $html .= qq!<BR><INPUT TYPE="text" NAME="${selectname}_add">!.
3028 qq!<INPUT TYPE="button" VALUE="Add new group" onClick="${selectname}_doadd(this.form)">!;
3033 =item reached_threshold
3035 Performs some activities when svc_acct thresholds (such as number of seconds
3036 remaining) are reached.
3040 sub reached_threshold {
3043 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
3044 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
3046 if ( $opt{'op'} eq '+' ){
3047 $svc_acct->setfield( $opt{'column'}.'_threshold',
3048 int($svc_acct->getfield($opt{'column'})
3049 * ( $conf->exists('svc_acct-usage_threshold')
3050 ? $conf->config('svc_acct-usage_threshold')/100
3055 my $error = $svc_acct->replace;
3056 die $error if $error;
3057 }elsif ( $opt{'op'} eq '-' ){
3059 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
3060 return '' if ($threshold eq '' );
3062 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
3063 my $error = $svc_acct->replace;
3064 die $error if $error; # email next time, i guess
3066 if ( $warning_template ) {
3067 eval "use FS::Misc qw(send_email)";
3070 my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
3071 my $cust_main = $cust_pkg->cust_main;
3073 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ }
3074 $cust_main->invoicing_list,
3075 ($opt{'to'} ? $opt{'to'} : ())
3078 my $mimetype = $warning_mimetype;
3079 $mimetype .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
3081 my $body = $warning_template->fill_in( HASH => {
3082 'custnum' => $cust_main->custnum,
3083 'username' => $svc_acct->username,
3084 'password' => $svc_acct->_password,
3085 'first' => $cust_main->first,
3086 'last' => $cust_main->getfield('last'),
3087 'pkg' => $cust_pkg->part_pkg->pkg,
3088 'column' => $opt{'column'},
3089 'amount' => $opt{'column'} =~/bytes/
3090 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
3091 : $svc_acct->getfield($opt{'column'}),
3092 'threshold' => $opt{'column'} =~/bytes/
3093 ? FS::UI::bytecount::display_bytecount($threshold)
3098 my $error = send_email(
3099 'from' => $warning_from,
3101 'subject' => $warning_subject,
3102 'content-type' => $mimetype,
3103 'body' => [ map "$_\n", split("\n", $body) ],
3105 die $error if $error;
3108 die "unknown op: " . $opt{'op'};
3116 The $recref stuff in sub check should be cleaned up.
3118 The suspend, unsuspend and cancel methods update the database, but not the
3119 current object. This is probably a bug as it's unexpected and
3122 radius_usergroup_selector? putting web ui components in here? they should
3123 probably live somewhere else...
3125 insertion of RADIUS group stuff in insert could be done with child_objects now
3126 (would probably clean up export of them too)
3128 _op_usage and set_usage bypass the history... maybe they shouldn't
3132 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
3133 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
3134 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
3135 L<freeside-queued>), L<FS::svc_acct_pop>,
3136 schema.html from the base documentation.
3140 =item domain_select_hash %OPTIONS
3142 Returns a hash SVCNUM => DOMAIN ... representing the domains this customer
3143 may at present purchase.
3145 Currently available options are: I<pkgnum> I<svcpart>
3149 sub domain_select_hash {
3150 my ($self, %options) = @_;
3156 $part_svc = $self->part_svc;
3157 $cust_pkg = $self->cust_svc->cust_pkg
3161 $part_svc = qsearchs('part_svc', { 'svcpart' => $options{svcpart} })
3162 if $options{'svcpart'};
3164 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $options{pkgnum} })
3165 if $options{'pkgnum'};
3167 if ($part_svc && ( $part_svc->part_svc_column('domsvc')->columnflag eq 'S'
3168 || $part_svc->part_svc_column('domsvc')->columnflag eq 'F')) {
3169 %domains = map { $_->svcnum => $_->domain }
3170 map { qsearchs('svc_domain', { 'svcnum' => $_ }) }
3171 split(',', $part_svc->part_svc_column('domsvc')->columnvalue);
3172 }elsif ($cust_pkg && !$conf->exists('svc_acct-alldomains') ) {
3173 %domains = map { $_->svcnum => $_->domain }
3174 map { qsearchs('svc_domain', { 'svcnum' => $_->svcnum }) }
3175 map { qsearch('cust_svc', { 'pkgnum' => $_->pkgnum } ) }
3176 qsearch('cust_pkg', { 'custnum' => $cust_pkg->custnum });
3178 %domains = map { $_->svcnum => $_->domain } qsearch('svc_domain', {} );
3181 if ($part_svc && $part_svc->part_svc_column('domsvc')->columnflag eq 'D') {
3182 my $svc_domain = qsearchs('svc_domain',
3183 { 'svcnum' => $part_svc->part_svc_column('domsvc')->columnvalue } );
3184 if ( $svc_domain ) {
3185 $domains{$svc_domain->svcnum} = $svc_domain->domain;
3187 warn "unknown svc_domain.svcnum for part_svc_column domsvc: ".
3188 $part_svc->part_svc_column('domsvc')->columnvalue;