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 );
21 use Crypt::PasswdMD5 1.2;
24 use Authen::Passphrase;
25 use FS::UID qw( datasrc driver_name );
27 use FS::Record qw( qsearch qsearchs fields dbh dbdef );
28 use FS::Msgcat qw(gettext);
29 use FS::UI::bytecount;
35 use FS::cust_main_invoice;
39 use FS::radius_usergroup;
46 @ISA = qw( FS::svc_Common );
49 $me = '[FS::svc_acct]';
51 #ask FS::UID to run this stuff for us later
52 FS::UID->install_callback( sub {
54 $dir_prefix = $conf->config('home');
55 @shells = $conf->config('shells');
56 $usernamemin = $conf->config('usernamemin') || 2;
57 $usernamemax = $conf->config('usernamemax');
58 $passwordmin = $conf->config('passwordmin') || 6;
59 $passwordmax = $conf->config('passwordmax') || 8;
60 $username_letter = $conf->exists('username-letter');
61 $username_letterfirst = $conf->exists('username-letterfirst');
62 $username_noperiod = $conf->exists('username-noperiod');
63 $username_nounderscore = $conf->exists('username-nounderscore');
64 $username_nodash = $conf->exists('username-nodash');
65 $username_uppercase = $conf->exists('username-uppercase');
66 $username_ampersand = $conf->exists('username-ampersand');
67 $username_percent = $conf->exists('username-percent');
68 $username_colon = $conf->exists('username-colon');
69 $password_noampersand = $conf->exists('password-noexclamation');
70 $password_noexclamation = $conf->exists('password-noexclamation');
71 $dirhash = $conf->config('dirhash') || 0;
72 if ( $conf->exists('warning_email') ) {
73 $warning_template = new Text::Template (
75 SOURCE => [ map "$_\n", $conf->config('warning_email') ]
76 ) or warn "can't create warning email template: $Text::Template::ERROR";
77 $warning_from = $conf->config('warning_email-from'); # || 'your-isp-is-dum'
78 $warning_subject = $conf->config('warning_email-subject') || 'Warning';
79 $warning_mimetype = $conf->config('warning_email-mimetype') || 'text/plain';
80 $warning_cc = $conf->config('warning_email-cc');
82 $warning_template = '';
84 $warning_subject = '';
85 $warning_mimetype = '';
88 $smtpmachine = $conf->config('smtpmachine');
89 $radius_password = $conf->config('radius-password') || 'Password';
90 $radius_ip = $conf->config('radius-ip') || 'Framed-IP-Address';
91 @pw_set = ( 'A'..'Z' ) if $conf->exists('password-generated-allcaps');
95 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
96 @pw_set = ( 'a'..'z', 'A'..'Z', '0'..'9', '(', ')', '#', '!', '.', ',' );
100 my ( $hashref, $cache ) = @_;
101 if ( $hashref->{'svc_acct_svcnum'} ) {
102 $self->{'_domsvc'} = FS::svc_domain->new( {
103 'svcnum' => $hashref->{'domsvc'},
104 'domain' => $hashref->{'svc_acct_domain'},
105 'catchall' => $hashref->{'svc_acct_catchall'},
112 FS::svc_acct - Object methods for svc_acct records
118 $record = new FS::svc_acct \%hash;
119 $record = new FS::svc_acct { 'column' => 'value' };
121 $error = $record->insert;
123 $error = $new_record->replace($old_record);
125 $error = $record->delete;
127 $error = $record->check;
129 $error = $record->suspend;
131 $error = $record->unsuspend;
133 $error = $record->cancel;
135 %hash = $record->radius;
137 %hash = $record->radius_reply;
139 %hash = $record->radius_check;
141 $domain = $record->domain;
143 $svc_domain = $record->svc_domain;
145 $email = $record->email;
147 $seconds_since = $record->seconds_since($timestamp);
151 An FS::svc_acct object represents an account. FS::svc_acct inherits from
152 FS::svc_Common. The following fields are currently supported:
156 =item svcnum - primary key (assigned automatcially for new accounts)
160 =item _password - generated if blank
162 =item _password_encoding - plain, crypt, ldap (or empty for autodetection)
164 =item sec_phrase - security phrase
166 =item popnum - Point of presence (see L<FS::svc_acct_pop>)
174 =item dir - set automatically if blank (and uid is not)
178 =item quota - (unimplementd)
180 =item slipip - IP address
190 =item domsvc - svcnum from svc_domain
192 =item radius_I<Radius_Attribute> - I<Radius-Attribute> (reply)
194 =item rc_I<Radius_Attribute> - I<Radius-Attribute> (check)
204 Creates a new account. To add the account to the database, see L<"insert">.
211 'longname_plural' => 'Access accounts and mailboxes',
212 'sorts' => [ 'username', 'uid', 'seconds', 'last_login' ],
213 'display_weight' => 10,
214 'cancel_weight' => 50,
216 'dir' => 'Home directory',
219 def_label => 'UID (set to fixed and blank for no UIDs)',
222 'slipip' => 'IP address',
223 # 'popnum' => qq!<A HREF="$p/browse/svc_acct_pop.cgi/">POP number</A>!,
225 label => 'Access number',
227 select_table => 'svc_acct_pop',
228 select_key => 'popnum',
229 select_label => 'city',
235 disable_default => 1,
242 disable_inventory => 1,
245 '_password' => 'Password',
248 def_label => 'GID (when blank, defaults to UID)',
252 #desc =>'Shell (all service definitions should have a default or fixed shell that is present in the <b>shells</b> configuration file, set to blank for no shell tracking)',
254 def_label=> 'Shell (set to blank for no shell tracking)',
256 #select_list => [ $conf->config('shells') ],
257 select_list => [ $conf ? $conf->config('shells') : () ],
258 disable_inventory => 1,
261 'finger' => 'Real name', # (GECOS)',
264 #def_label => 'svcnum from svc_domain',
266 select_table => 'svc_domain',
267 select_key => 'svcnum',
268 select_label => 'domain',
269 disable_inventory => 1,
273 label => 'RADIUS groups',
274 type => 'radius_usergroup_selector',
275 disable_inventory => 1,
278 'seconds' => { label => 'Seconds',
279 label_sort => 'with Time Remaining',
281 disable_inventory => 1,
283 disable_part_svc_column => 1,
285 'upbytes' => { label => 'Upload',
287 disable_inventory => 1,
289 'format' => \&FS::UI::bytecount::display_bytecount,
290 'parse' => \&FS::UI::bytecount::parse_bytecount,
291 disable_part_svc_column => 1,
293 'downbytes' => { label => 'Download',
295 disable_inventory => 1,
297 'format' => \&FS::UI::bytecount::display_bytecount,
298 'parse' => \&FS::UI::bytecount::parse_bytecount,
299 disable_part_svc_column => 1,
301 'totalbytes'=> { label => 'Total up and download',
303 disable_inventory => 1,
305 'format' => \&FS::UI::bytecount::display_bytecount,
306 'parse' => \&FS::UI::bytecount::parse_bytecount,
307 disable_part_svc_column => 1,
309 'seconds_threshold' => { label => 'Seconds threshold',
311 disable_inventory => 1,
313 disable_part_svc_column => 1,
315 'upbytes_threshold' => { label => 'Upload threshold',
317 disable_inventory => 1,
319 'format' => \&FS::UI::bytecount::display_bytecount,
320 'parse' => \&FS::UI::bytecount::parse_bytecount,
321 disable_part_svc_column => 1,
323 'downbytes_threshold' => { label => 'Download threshold',
325 disable_inventory => 1,
327 'format' => \&FS::UI::bytecount::display_bytecount,
328 'parse' => \&FS::UI::bytecount::parse_bytecount,
329 disable_part_svc_column => 1,
331 'totalbytes_threshold'=> { label => 'Total up and download threshold',
333 disable_inventory => 1,
335 'format' => \&FS::UI::bytecount::display_bytecount,
336 'parse' => \&FS::UI::bytecount::parse_bytecount,
337 disable_part_svc_column => 1,
340 label => 'Last login',
344 label => 'Last logout',
351 sub table { 'svc_acct'; }
353 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
357 #false laziness with edit/svc_acct.cgi
359 my( $self, $groups ) = @_;
360 if ( ref($groups) eq 'ARRAY' ) {
362 } elsif ( length($groups) ) {
363 [ split(/\s*,\s*/, $groups) ];
372 shift->_lastlog('in', @_);
376 shift->_lastlog('out', @_);
380 my( $self, $op, $time ) = @_;
382 if ( defined($time) ) {
383 warn "$me last_log$op called on svcnum ". $self->svcnum.
384 ' ('. $self->email. "): $time\n"
389 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
393 my $sth = $dbh->prepare( $sql )
394 or die "Error preparing $sql: ". $dbh->errstr;
395 my $rv = $sth->execute($time, $self->svcnum);
396 die "Error executing $sql: ". $sth->errstr
398 die "Can't update last_log$op for svcnum". $self->svcnum
401 $self->{'Hash'}->{"last_log$op"} = $time;
403 $self->getfield("last_log$op");
407 =item search_sql STRING
409 Class method which returns an SQL fragment to search for the given string.
414 my( $class, $string ) = @_;
415 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
416 my( $username, $domain ) = ( $1, $2 );
417 my $q_username = dbh->quote($username);
418 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
420 "svc_acct.username = $q_username AND ( ".
421 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
426 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
428 $class->search_sql_field('slipip', $string ).
430 $class->search_sql_field('username', $string ).
433 $class->search_sql_field('username', $string);
437 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
439 Returns the "username@domain" string for this account.
441 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
451 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
453 Returns a longer string label for this acccount ("Real Name <username@domain>"
454 if available, or "username@domain").
456 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
463 my $label = $self->label(@_);
464 my $finger = $self->finger;
465 return $label unless $finger =~ /\S/;
466 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
467 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
471 =item insert [ , OPTION => VALUE ... ]
473 Adds this account to the database. If there is an error, returns the error,
474 otherwise returns false.
476 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
477 defined. An FS::cust_svc record will be created and inserted.
479 The additional field I<usergroup> can optionally be defined; if so it should
480 contain an arrayref of group names. See L<FS::radius_usergroup>.
482 The additional field I<child_objects> can optionally be defined; if so it
483 should contain an arrayref of FS::tablename objects. They will have their
484 svcnum fields set and will be inserted after this record, but before any
485 exports are run. Each element of the array can also optionally be a
486 two-element array reference containing the child object and the name of an
487 alternate field to be filled in with the newly-inserted svcnum, for example
488 C<[ $svc_forward, 'srcsvc' ]>
490 Currently available options are: I<depend_jobnum>
492 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
493 jobnums), all provisioning jobs will have a dependancy on the supplied
494 jobnum(s) (they will not run until the specific job(s) complete(s)).
496 (TODOC: L<FS::queue> and L<freeside-queued>)
498 (TODOC: new exports!)
507 warn "[$me] insert called on $self: ". Dumper($self).
508 "\nwith options: ". Dumper(%options);
511 local $SIG{HUP} = 'IGNORE';
512 local $SIG{INT} = 'IGNORE';
513 local $SIG{QUIT} = 'IGNORE';
514 local $SIG{TERM} = 'IGNORE';
515 local $SIG{TSTP} = 'IGNORE';
516 local $SIG{PIPE} = 'IGNORE';
518 my $oldAutoCommit = $FS::UID::AutoCommit;
519 local $FS::UID::AutoCommit = 0;
522 my $error = $self->check;
523 return $error if $error;
525 if ( $self->svcnum && qsearchs('cust_svc',{'svcnum'=>$self->svcnum}) ) {
526 my $cust_svc = qsearchs('cust_svc',{'svcnum'=>$self->svcnum});
527 unless ( $cust_svc ) {
528 $dbh->rollback if $oldAutoCommit;
529 return "no cust_svc record found for svcnum ". $self->svcnum;
531 $self->pkgnum($cust_svc->pkgnum);
532 $self->svcpart($cust_svc->svcpart);
535 # set usage fields and thresholds if unset but set in a package def
536 if ( $self->pkgnum ) {
537 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
538 my $part_pkg = $cust_pkg->part_pkg if $cust_pkg;
539 if ( $part_pkg && $part_pkg->can('usage_valuehash') ) {
541 my %values = $part_pkg->usage_valuehash;
542 my $multiplier = $conf->exists('svc_acct-usage_threshold')
543 ? 1 - $conf->config('svc_acct-usage_threshold')/100
546 foreach ( keys %values ) {
547 next if $self->getfield($_);
548 $self->setfield( $_, $values{$_} );
549 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) );
556 $error = $self->SUPER::insert(
557 'jobnums' => \@jobnums,
558 'child_objects' => $self->child_objects,
562 $dbh->rollback if $oldAutoCommit;
566 if ( $self->usergroup ) {
567 foreach my $groupname ( @{$self->usergroup} ) {
568 my $radius_usergroup = new FS::radius_usergroup ( {
569 svcnum => $self->svcnum,
570 groupname => $groupname,
572 my $error = $radius_usergroup->insert;
574 $dbh->rollback if $oldAutoCommit;
580 unless ( $skip_fuzzyfiles ) {
581 $error = $self->queue_fuzzyfiles_update;
583 $dbh->rollback if $oldAutoCommit;
584 return "updating fuzzy search cache: $error";
588 my $cust_pkg = $self->cust_svc->cust_pkg;
591 my $cust_main = $cust_pkg->cust_main;
592 my $agentnum = $cust_main->agentnum;
594 if ( $conf->exists('emailinvoiceautoalways')
595 || $conf->exists('emailinvoiceauto')
596 && ! $cust_main->invoicing_list_emailonly
598 my @invoicing_list = $cust_main->invoicing_list;
599 push @invoicing_list, $self->email;
600 $cust_main->invoicing_list(\@invoicing_list);
604 my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
605 = ('','','','','','');
607 if ( $conf->exists('welcome_email', $agentnum) ) {
608 $welcome_template = new Text::Template (
610 SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
611 ) or warn "can't create welcome email template: $Text::Template::ERROR";
612 $welcome_from = $conf->config('welcome_email-from', $agentnum);
613 # || 'your-isp-is-dum'
614 $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
616 $welcome_subject_template = new Text::Template (
618 SOURCE => $welcome_subject,
619 ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
620 $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
623 if ( $welcome_template && $cust_pkg ) {
624 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
628 'custnum' => $self->custnum,
629 'username' => $self->username,
630 'password' => $self->_password,
631 'first' => $cust_main->first,
632 'last' => $cust_main->getfield('last'),
633 'pkg' => $cust_pkg->part_pkg->pkg,
635 my $wqueue = new FS::queue {
636 'svcnum' => $self->svcnum,
637 'job' => 'FS::svc_acct::send_email'
639 my $error = $wqueue->insert(
641 'from' => $welcome_from,
642 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
643 'mimetype' => $welcome_mimetype,
644 'body' => $welcome_template->fill_in( HASH => \%hash, ),
647 $dbh->rollback if $oldAutoCommit;
648 return "error queuing welcome email: $error";
651 if ( $options{'depend_jobnum'} ) {
652 warn "$me depend_jobnum found; adding to welcome email dependancies"
654 if ( ref($options{'depend_jobnum'}) ) {
655 warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
656 "to welcome email dependancies"
658 push @jobnums, @{ $options{'depend_jobnum'} };
660 warn "$me adding job $options{'depend_jobnum'} ".
661 "to welcome email dependancies"
663 push @jobnums, $options{'depend_jobnum'};
667 foreach my $jobnum ( @jobnums ) {
668 my $error = $wqueue->depend_insert($jobnum);
670 $dbh->rollback if $oldAutoCommit;
671 return "error queuing welcome email job dependancy: $error";
681 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
687 Deletes this account from the database. If there is an error, returns the
688 error, otherwise returns false.
690 The corresponding FS::cust_svc record will be deleted as well.
692 (TODOC: new exports!)
699 return "can't delete system account" if $self->_check_system;
701 return "Can't delete an account which is a (svc_forward) source!"
702 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
704 return "Can't delete an account which is a (svc_forward) destination!"
705 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
707 return "Can't delete an account with (svc_www) web service!"
708 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
710 # what about records in session ? (they should refer to history table)
712 local $SIG{HUP} = 'IGNORE';
713 local $SIG{INT} = 'IGNORE';
714 local $SIG{QUIT} = 'IGNORE';
715 local $SIG{TERM} = 'IGNORE';
716 local $SIG{TSTP} = 'IGNORE';
717 local $SIG{PIPE} = 'IGNORE';
719 my $oldAutoCommit = $FS::UID::AutoCommit;
720 local $FS::UID::AutoCommit = 0;
723 foreach my $cust_main_invoice (
724 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
726 unless ( defined($cust_main_invoice) ) {
727 warn "WARNING: something's wrong with qsearch";
730 my %hash = $cust_main_invoice->hash;
731 $hash{'dest'} = $self->email;
732 my $new = new FS::cust_main_invoice \%hash;
733 my $error = $new->replace($cust_main_invoice);
735 $dbh->rollback if $oldAutoCommit;
740 foreach my $svc_domain (
741 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
743 my %hash = new FS::svc_domain->hash;
744 $hash{'catchall'} = '';
745 my $new = new FS::svc_domain \%hash;
746 my $error = $new->replace($svc_domain);
748 $dbh->rollback if $oldAutoCommit;
753 my $error = $self->SUPER::delete;
755 $dbh->rollback if $oldAutoCommit;
759 foreach my $radius_usergroup (
760 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } )
762 my $error = $radius_usergroup->delete;
764 $dbh->rollback if $oldAutoCommit;
769 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
773 =item replace OLD_RECORD
775 Replaces OLD_RECORD with this one in the database. If there is an error,
776 returns the error, otherwise returns false.
778 The additional field I<usergroup> can optionally be defined; if so it should
779 contain an arrayref of group names. See L<FS::radius_usergroup>.
787 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
791 warn "$me replacing $old with $new\n" if $DEBUG;
795 return "can't modify system account" if $old->_check_system;
798 #no warnings 'numeric'; #alas, a 5.006-ism
801 foreach my $xid (qw( uid gid )) {
803 return "Can't change $xid!"
804 if ! $conf->exists("svc_acct-edit_$xid")
805 && $old->$xid() != $new->$xid()
806 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
811 #change homdir when we change username
812 $new->setfield('dir', '') if $old->username ne $new->username;
814 local $SIG{HUP} = 'IGNORE';
815 local $SIG{INT} = 'IGNORE';
816 local $SIG{QUIT} = 'IGNORE';
817 local $SIG{TERM} = 'IGNORE';
818 local $SIG{TSTP} = 'IGNORE';
819 local $SIG{PIPE} = 'IGNORE';
821 my $oldAutoCommit = $FS::UID::AutoCommit;
822 local $FS::UID::AutoCommit = 0;
825 # redundant, but so $new->usergroup gets set
826 $error = $new->check;
827 return $error if $error;
829 $old->usergroup( [ $old->radius_groups ] );
831 warn $old->email. " old groups: ". join(' ',@{$old->usergroup}). "\n";
832 warn $new->email. "new groups: ". join(' ',@{$new->usergroup}). "\n";
834 if ( $new->usergroup ) {
835 #(sorta) false laziness with FS::part_export::sqlradius::_export_replace
836 my @newgroups = @{$new->usergroup};
837 foreach my $oldgroup ( @{$old->usergroup} ) {
838 if ( grep { $oldgroup eq $_ } @newgroups ) {
839 @newgroups = grep { $oldgroup ne $_ } @newgroups;
842 my $radius_usergroup = qsearchs('radius_usergroup', {
843 svcnum => $old->svcnum,
844 groupname => $oldgroup,
846 my $error = $radius_usergroup->delete;
848 $dbh->rollback if $oldAutoCommit;
849 return "error deleting radius_usergroup $oldgroup: $error";
853 foreach my $newgroup ( @newgroups ) {
854 my $radius_usergroup = new FS::radius_usergroup ( {
855 svcnum => $new->svcnum,
856 groupname => $newgroup,
858 my $error = $radius_usergroup->insert;
860 $dbh->rollback if $oldAutoCommit;
861 return "error adding radius_usergroup $newgroup: $error";
867 $error = $new->SUPER::replace($old, @_);
869 $dbh->rollback if $oldAutoCommit;
870 return $error if $error;
873 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
874 $error = $new->queue_fuzzyfiles_update;
876 $dbh->rollback if $oldAutoCommit;
877 return "updating fuzzy search cache: $error";
881 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
885 =item queue_fuzzyfiles_update
887 Used by insert & replace to update the fuzzy search cache
891 sub queue_fuzzyfiles_update {
894 local $SIG{HUP} = 'IGNORE';
895 local $SIG{INT} = 'IGNORE';
896 local $SIG{QUIT} = 'IGNORE';
897 local $SIG{TERM} = 'IGNORE';
898 local $SIG{TSTP} = 'IGNORE';
899 local $SIG{PIPE} = 'IGNORE';
901 my $oldAutoCommit = $FS::UID::AutoCommit;
902 local $FS::UID::AutoCommit = 0;
905 my $queue = new FS::queue {
906 'svcnum' => $self->svcnum,
907 'job' => 'FS::svc_acct::append_fuzzyfiles'
909 my $error = $queue->insert($self->username);
911 $dbh->rollback if $oldAutoCommit;
912 return "queueing job (transaction rolled back): $error";
915 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
923 Suspends this account by calling export-specific suspend hooks. If there is
924 an error, returns the error, otherwise returns false.
926 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
932 return "can't suspend system account" if $self->_check_system;
933 $self->SUPER::suspend(@_);
938 Unsuspends this account by by calling export-specific suspend hooks. If there
939 is an error, returns the error, otherwise returns false.
941 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
947 my %hash = $self->hash;
948 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
949 $hash{_password} = $1;
950 my $new = new FS::svc_acct ( \%hash );
951 my $error = $new->replace($self);
952 return $error if $error;
955 $self->SUPER::unsuspend(@_);
960 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
962 If the B<auto_unset_catchall> configuration option is set, this method will
963 automatically remove any references to the canceled service in the catchall
964 field of svc_domain. This allows packages that contain both a svc_domain and
965 its catchall svc_acct to be canceled in one step.
970 # Only one thing to do at this level
972 foreach my $svc_domain (
973 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
974 if($conf->exists('auto_unset_catchall')) {
975 my %hash = $svc_domain->hash;
976 $hash{catchall} = '';
977 my $new = new FS::svc_domain ( \%hash );
978 my $error = $new->replace($svc_domain);
979 return $error if $error;
981 return "cannot unprovision svc_acct #".$self->svcnum.
982 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
986 $self->SUPER::cancel(@_);
992 Checks all fields to make sure this is a valid service. If there is an error,
993 returns the error, otherwise returns false. Called by the insert and replace
996 Sets any fixed values; see L<FS::part_svc>.
1003 my($recref) = $self->hashref;
1005 my $x = $self->setfixed( $self->_fieldhandlers );
1006 return $x unless ref($x);
1009 if ( $part_svc->part_svc_column('usergroup')->columnflag eq "F" ) {
1011 [ split(',', $part_svc->part_svc_column('usergroup')->columnvalue) ] );
1014 my $error = $self->ut_numbern('svcnum')
1015 #|| $self->ut_number('domsvc')
1016 || $self->ut_foreign_key('domsvc', 'svc_domain', 'svcnum' )
1017 || $self->ut_textn('sec_phrase')
1018 || $self->ut_snumbern('seconds')
1019 || $self->ut_snumbern('upbytes')
1020 || $self->ut_snumbern('downbytes')
1021 || $self->ut_snumbern('totalbytes')
1022 || $self->ut_enum( '_password_encoding',
1023 [ '', qw( plain crypt ldap ) ]
1026 return $error if $error;
1028 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1029 if ( $username_uppercase ) {
1030 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:]{$usernamemin,$ulen})$/i
1031 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1032 $recref->{username} = $1;
1034 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:]{$usernamemin,$ulen})$/
1035 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1036 $recref->{username} = $1;
1039 if ( $username_letterfirst ) {
1040 $recref->{username} =~ /^[a-z]/ or return gettext('illegal_username');
1041 } elsif ( $username_letter ) {
1042 $recref->{username} =~ /[a-z]/ or return gettext('illegal_username');
1044 if ( $username_noperiod ) {
1045 $recref->{username} =~ /\./ and return gettext('illegal_username');
1047 if ( $username_nounderscore ) {
1048 $recref->{username} =~ /_/ and return gettext('illegal_username');
1050 if ( $username_nodash ) {
1051 $recref->{username} =~ /\-/ and return gettext('illegal_username');
1053 unless ( $username_ampersand ) {
1054 $recref->{username} =~ /\&/ and return gettext('illegal_username');
1056 unless ( $username_percent ) {
1057 $recref->{username} =~ /\%/ and return gettext('illegal_username');
1059 unless ( $username_colon ) {
1060 $recref->{username} =~ /\:/ and return gettext('illegal_username');
1063 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1064 $recref->{popnum} = $1;
1065 return "Unknown popnum" unless
1066 ! $recref->{popnum} ||
1067 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1069 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1071 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1072 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1074 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1075 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1076 #not all systems use gid=uid
1077 #you can set a fixed gid in part_svc
1079 return "Only root can have uid 0"
1080 if $recref->{uid} == 0
1081 && $recref->{username} !~ /^(root|toor|smtp)$/;
1083 unless ( $recref->{username} eq 'sync' ) {
1084 if ( grep $_ eq $recref->{shell}, @shells ) {
1085 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1087 return "Illegal shell \`". $self->shell. "\'; ".
1088 "shells configuration value contains: @shells";
1091 $recref->{shell} = '/bin/sync';
1095 $recref->{gid} ne '' ?
1096 return "Can't have gid without uid" : ( $recref->{gid}='' );
1097 #$recref->{dir} ne '' ?
1098 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1099 $recref->{shell} ne '' ?
1100 return "Can't have shell without uid" : ( $recref->{shell}='' );
1103 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1105 $recref->{dir} =~ /^([\/\w\-\.\&]*)$/
1106 or return "Illegal directory: ". $recref->{dir};
1107 $recref->{dir} = $1;
1108 return "Illegal directory"
1109 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1110 return "Illegal directory"
1111 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1112 unless ( $recref->{dir} ) {
1113 $recref->{dir} = $dir_prefix . '/';
1114 if ( $dirhash > 0 ) {
1115 for my $h ( 1 .. $dirhash ) {
1116 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1118 } elsif ( $dirhash < 0 ) {
1119 for my $h ( reverse $dirhash .. -1 ) {
1120 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1123 $recref->{dir} .= $recref->{username};
1129 # $error = $self->ut_textn('finger');
1130 # return $error if $error;
1131 if ( $self->getfield('finger') eq '' ) {
1132 my $cust_pkg = $self->svcnum
1133 ? $self->cust_svc->cust_pkg
1134 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1136 my $cust_main = $cust_pkg->cust_main;
1137 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1140 $self->getfield('finger') =~
1141 /^([\w \t\!\@\#\$\%\&\(\)\-\+\;\'\"\,\.\?\/\*\<\>]*)$/
1142 or return "Illegal finger: ". $self->getfield('finger');
1143 $self->setfield('finger', $1);
1145 $recref->{quota} =~ /^(\w*)$/ or return "Illegal quota";
1146 $recref->{quota} = $1;
1148 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1149 if ( $recref->{slipip} eq '' ) {
1150 $recref->{slipip} = '';
1151 } elsif ( $recref->{slipip} eq '0e0' ) {
1152 $recref->{slipip} = '0e0';
1154 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1155 or return "Illegal slipip: ". $self->slipip;
1156 $recref->{slipip} = $1;
1161 #arbitrary RADIUS stuff; allow ut_textn for now
1162 foreach ( grep /^radius_/, fields('svc_acct') ) {
1163 $self->ut_textn($_);
1166 if ( $recref->{_password_encoding} eq 'ldap' ) {
1168 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1169 $recref->{_password} = uc($1).$2;
1171 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1174 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1176 if ( $recref->{_password} =~
1177 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1178 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1181 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1184 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1187 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1189 #generate a password if it is blank
1190 $recref->{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) )
1191 unless length( $recref->{_password} );
1193 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1194 $recref->{_password} = $1;
1196 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1197 FS::Msgcat::_gettext('illegal_password_characters').
1198 ": ". $recref->{_password};
1201 if ( $password_noampersand ) {
1202 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1204 if ( $password_noexclamation ) {
1205 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1210 #carp "warning: _password_encoding unspecified\n";
1212 #generate a password if it is blank
1213 unless ( length( $recref->{_password} ) ) {
1215 $recref->{_password} =
1216 join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1217 $recref->{_password_encoding} = 'plain';
1221 #if ( $recref->{_password} =~ /^((\*SUSPENDED\* )?)([^\t\n]{4,16})$/ ) {
1222 if ( $recref->{_password} =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1223 $recref->{_password} = $1.$3;
1224 $recref->{_password_encoding} = 'plain';
1225 } elsif ( $recref->{_password} =~
1226 /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/
1228 $recref->{_password} = $1.$3;
1229 $recref->{_password_encoding} = 'crypt';
1230 } elsif ( $recref->{_password} eq '*' ) {
1231 $recref->{_password} = '*';
1232 $recref->{_password_encoding} = 'crypt';
1233 } elsif ( $recref->{_password} eq '!' ) {
1234 $recref->{_password_encoding} = 'crypt';
1235 $recref->{_password} = '!';
1236 } elsif ( $recref->{_password} eq '!!' ) {
1237 $recref->{_password} = '!!';
1238 $recref->{_password_encoding} = 'crypt';
1240 #return "Illegal password";
1241 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1242 FS::Msgcat::_gettext('illegal_password_characters').
1243 ": ". $recref->{_password};
1250 $self->SUPER::check;
1256 Internal function to check the username against the list of system usernames
1257 from the I<system_usernames> configuration value. Returns true if the username
1258 is listed on the system username list.
1264 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1265 $conf->config('system_usernames')
1269 =item _check_duplicate
1271 Internal method to check for duplicates usernames, username@domain pairs and
1274 If the I<global_unique-username> configuration value is set to B<username> or
1275 B<username@domain>, enforces global username or username@domain uniqueness.
1277 In all cases, check for duplicate uids and usernames or username@domain pairs
1278 per export and with identical I<svcpart> values.
1282 sub _check_duplicate {
1285 my $global_unique = $conf->config('global_unique-username') || 'none';
1286 return '' if $global_unique eq 'disabled';
1290 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1291 unless ( $part_svc ) {
1292 return 'unknown svcpart '. $self->svcpart;
1295 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1296 qsearch( 'svc_acct', { 'username' => $self->username } );
1297 return gettext('username_in_use')
1298 if $global_unique eq 'username' && @dup_user;
1300 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1301 qsearch( 'svc_acct', { 'username' => $self->username,
1302 'domsvc' => $self->domsvc } );
1303 return gettext('username_in_use')
1304 if $global_unique eq 'username@domain' && @dup_userdomain;
1307 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1308 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1309 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1310 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1315 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1316 my $exports = FS::part_export::export_info('svc_acct');
1317 my %conflict_user_svcpart;
1318 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1320 foreach my $part_export ( $part_svc->part_export ) {
1322 #this will catch to the same exact export
1323 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1325 #this will catch to exports w/same exporthost+type ???
1326 #my @other_part_export = qsearch('part_export', {
1327 # 'machine' => $part_export->machine,
1328 # 'exporttype' => $part_export->exporttype,
1330 #foreach my $other_part_export ( @other_part_export ) {
1331 # push @svcparts, map { $_->svcpart }
1332 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1335 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1336 #silly kludge to avoid uninitialized value errors
1337 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1338 ? $exports->{$part_export->exporttype}{'nodomain'}
1340 if ( $nodomain =~ /^Y/i ) {
1341 $conflict_user_svcpart{$_} = $part_export->exportnum
1344 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1349 foreach my $dup_user ( @dup_user ) {
1350 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1351 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1352 return "duplicate username ". $self->username.
1353 ": conflicts with svcnum ". $dup_user->svcnum.
1354 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1358 foreach my $dup_userdomain ( @dup_userdomain ) {
1359 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1360 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1361 return "duplicate username\@domain ". $self->email.
1362 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1363 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1367 foreach my $dup_uid ( @dup_uid ) {
1368 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1369 if ( exists($conflict_user_svcpart{$dup_svcpart})
1370 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1371 return "duplicate uid ". $self->uid.
1372 ": conflicts with svcnum ". $dup_uid->svcnum.
1374 ( $conflict_user_svcpart{$dup_svcpart}
1375 || $conflict_userdomain_svcpart{$dup_svcpart} );
1387 Depriciated, use radius_reply instead.
1392 carp "FS::svc_acct::radius depriciated, use radius_reply";
1393 $_[0]->radius_reply;
1398 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1399 reply attributes of this record.
1401 Note that this is now the preferred method for reading RADIUS attributes -
1402 accessing the columns directly is discouraged, as the column names are
1403 expected to change in the future.
1410 return %{ $self->{'radius_reply'} }
1411 if exists $self->{'radius_reply'};
1416 my($column, $attrib) = ($1, $2);
1417 #$attrib =~ s/_/\-/g;
1418 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1419 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1421 if ( $self->slipip && $self->slipip ne '0e0' ) {
1422 $reply{$radius_ip} = $self->slipip;
1425 if ( $self->seconds !~ /^$/ ) {
1426 $reply{'Session-Timeout'} = $self->seconds;
1434 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1435 check attributes of this record.
1437 Note that this is now the preferred method for reading RADIUS attributes -
1438 accessing the columns directly is discouraged, as the column names are
1439 expected to change in the future.
1446 return %{ $self->{'radius_check'} }
1447 if exists $self->{'radius_check'};
1452 my($column, $attrib) = ($1, $2);
1453 #$attrib =~ s/_/\-/g;
1454 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1455 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1458 my($pw_attrib, $password) = $self->radius_password;
1459 $check{$pw_attrib} = $password;
1461 my $cust_svc = $self->cust_svc;
1462 die "FATAL: no cust_svc record for svc_acct.svcnum ". $self->svcnum. "\n"
1464 my $cust_pkg = $cust_svc->cust_pkg;
1465 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1466 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1473 =item radius_password
1475 Returns a key/value pair containing the RADIUS attribute name and value
1480 sub radius_password {
1483 my($pw_attrib, $password);
1484 if ( $self->_password_encoding eq 'ldap' ) {
1486 $pw_attrib = 'Password-With-Header';
1487 $password = $self->_password;
1489 } elsif ( $self->_password_encoding eq 'crypt' ) {
1491 $pw_attrib = 'Crypt-Password';
1492 $password = $self->_password;
1494 } elsif ( $self->_password_encoding eq 'plain' ) {
1496 $pw_attrib = $radius_password; #Cleartext-Password? man rlm_pap
1497 $password = $self->_password;
1501 $pw_attrib = length($password) <= 12 ? $radius_password : 'Crypt-Password';
1502 $password = $self->_password;
1506 ($pw_attrib, $password);
1512 This method instructs the object to "snapshot" or freeze RADIUS check and
1513 reply attributes to the current values.
1517 #bah, my english is too broken this morning
1518 #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
1519 #the FS::cust_pkg's replace method to trigger the correct export updates when
1520 #package dates change)
1525 $self->{$_} = { $self->$_() }
1526 foreach qw( radius_reply radius_check );
1530 =item forget_snapshot
1532 This methos instructs the object to forget any previously snapshotted
1533 RADIUS check and reply attributes.
1537 sub forget_snapshot {
1541 foreach qw( radius_reply radius_check );
1545 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1547 Returns the domain associated with this account.
1549 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1556 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1557 my $svc_domain = $self->svc_domain(@_)
1558 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1559 $svc_domain->domain;
1564 Returns the FS::svc_domain record for this account's domain (see
1569 # FS::h_svc_acct has a history-aware svc_domain override
1574 ? $self->{'_domsvc'}
1575 : qsearchs( 'svc_domain', { 'svcnum' => $self->domsvc } );
1580 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1584 #inherited from svc_Common
1586 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1588 Returns an email address associated with the account.
1590 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1597 $self->username. '@'. $self->domain(@_);
1602 Returns an array of FS::acct_snarf records associated with the account.
1603 If the acct_snarf table does not exist or there are no associated records,
1604 an empty list is returned
1610 return () unless dbdef->table('acct_snarf');
1611 eval "use FS::acct_snarf;";
1613 qsearch('acct_snarf', { 'svcnum' => $self->svcnum } );
1616 =item decrement_upbytes OCTETS
1618 Decrements the I<upbytes> field of this record by the given amount. If there
1619 is an error, returns the error, otherwise returns false.
1623 sub decrement_upbytes {
1624 shift->_op_usage('-', 'upbytes', @_);
1627 =item increment_upbytes OCTETS
1629 Increments the I<upbytes> field of this record by the given amount. If there
1630 is an error, returns the error, otherwise returns false.
1634 sub increment_upbytes {
1635 shift->_op_usage('+', 'upbytes', @_);
1638 =item decrement_downbytes OCTETS
1640 Decrements the I<downbytes> field of this record by the given amount. If there
1641 is an error, returns the error, otherwise returns false.
1645 sub decrement_downbytes {
1646 shift->_op_usage('-', 'downbytes', @_);
1649 =item increment_downbytes OCTETS
1651 Increments the I<downbytes> field of this record by the given amount. If there
1652 is an error, returns the error, otherwise returns false.
1656 sub increment_downbytes {
1657 shift->_op_usage('+', 'downbytes', @_);
1660 =item decrement_totalbytes OCTETS
1662 Decrements the I<totalbytes> field of this record by the given amount. If there
1663 is an error, returns the error, otherwise returns false.
1667 sub decrement_totalbytes {
1668 shift->_op_usage('-', 'totalbytes', @_);
1671 =item increment_totalbytes OCTETS
1673 Increments the I<totalbytes> field of this record by the given amount. If there
1674 is an error, returns the error, otherwise returns false.
1678 sub increment_totalbytes {
1679 shift->_op_usage('+', 'totalbytes', @_);
1682 =item decrement_seconds SECONDS
1684 Decrements the I<seconds> field of this record by the given amount. If there
1685 is an error, returns the error, otherwise returns false.
1689 sub decrement_seconds {
1690 shift->_op_usage('-', 'seconds', @_);
1693 =item increment_seconds SECONDS
1695 Increments the I<seconds> field of this record by the given amount. If there
1696 is an error, returns the error, otherwise returns false.
1700 sub increment_seconds {
1701 shift->_op_usage('+', 'seconds', @_);
1709 my %op2condition = (
1710 '-' => sub { my($self, $column, $amount) = @_;
1711 $self->$column - $amount <= 0;
1713 '+' => sub { my($self, $column, $amount) = @_;
1714 ($self->$column || 0) + $amount > 0;
1717 my %op2warncondition = (
1718 '-' => sub { my($self, $column, $amount) = @_;
1719 my $threshold = $column . '_threshold';
1720 $self->$column - $amount <= $self->$threshold + 0;
1722 '+' => sub { my($self, $column, $amount) = @_;
1723 ($self->$column || 0) + $amount > 0;
1728 my( $self, $op, $column, $amount ) = @_;
1730 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
1731 ' ('. $self->email. "): $op $amount\n"
1734 return '' unless $amount;
1736 local $SIG{HUP} = 'IGNORE';
1737 local $SIG{INT} = 'IGNORE';
1738 local $SIG{QUIT} = 'IGNORE';
1739 local $SIG{TERM} = 'IGNORE';
1740 local $SIG{TSTP} = 'IGNORE';
1741 local $SIG{PIPE} = 'IGNORE';
1743 my $oldAutoCommit = $FS::UID::AutoCommit;
1744 local $FS::UID::AutoCommit = 0;
1747 my $sql = "UPDATE svc_acct SET $column = ".
1748 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
1749 " $op ? WHERE svcnum = ?";
1753 my $sth = $dbh->prepare( $sql )
1754 or die "Error preparing $sql: ". $dbh->errstr;
1755 my $rv = $sth->execute($amount, $self->svcnum);
1756 die "Error executing $sql: ". $sth->errstr
1757 unless defined($rv);
1758 die "Can't update $column for svcnum". $self->svcnum
1761 my $action = $op2action{$op};
1763 if ( &{$op2condition{$op}}($self, $column, $amount) &&
1764 ( $action eq 'suspend' && !$self->overlimit
1765 || $action eq 'unsuspend' && $self->overlimit )
1767 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
1768 if ($part_export->option('overlimit_groups')) {
1770 my $other = new FS::svc_acct $self->hashref;
1771 my $groups = &{ $self->_fieldhandlers->{'usergroup'} }
1772 ($self, $part_export->option('overlimit_groups'));
1773 $other->usergroup( $groups );
1774 if ($action eq 'suspend'){
1775 $new = $other; $old = $self;
1777 $new = $self; $old = $other;
1779 my $error = $part_export->export_replace($new, $old);
1780 $error ||= $self->overlimit($action);
1782 $dbh->rollback if $oldAutoCommit;
1783 return "Error replacing radius groups in export, ${op}: $error";
1789 if ( $conf->exists("svc_acct-usage_$action")
1790 && &{$op2condition{$op}}($self, $column, $amount) ) {
1791 #my $error = $self->$action();
1792 my $error = $self->cust_svc->cust_pkg->$action();
1793 # $error ||= $self->overlimit($action);
1795 $dbh->rollback if $oldAutoCommit;
1796 return "Error ${action}ing: $error";
1800 if ($warning_template && &{$op2warncondition{$op}}($self, $column, $amount)) {
1801 my $wqueue = new FS::queue {
1802 'svcnum' => $self->svcnum,
1803 'job' => 'FS::svc_acct::reached_threshold',
1808 $to = $warning_cc if &{$op2condition{$op}}($self, $column, $amount);
1812 my $error = $wqueue->insert(
1813 'svcnum' => $self->svcnum,
1815 'column' => $column,
1819 $dbh->rollback if $oldAutoCommit;
1820 return "Error queuing threshold activity: $error";
1824 warn "$me update successful; committing\n"
1826 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1832 my( $self, $valueref, %options ) = @_;
1834 warn "$me set_usage called for svcnum ". $self->svcnum.
1835 ' ('. $self->email. "): ".
1836 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
1839 local $SIG{HUP} = 'IGNORE';
1840 local $SIG{INT} = 'IGNORE';
1841 local $SIG{QUIT} = 'IGNORE';
1842 local $SIG{TERM} = 'IGNORE';
1843 local $SIG{TSTP} = 'IGNORE';
1844 local $SIG{PIPE} = 'IGNORE';
1846 local $FS::svc_Common::noexport_hack = 1;
1847 my $oldAutoCommit = $FS::UID::AutoCommit;
1848 local $FS::UID::AutoCommit = 0;
1853 if ( $options{null} ) {
1854 %handyhash = ( map { ( $_ => 'NULL', $_."_threshold" => 'NULL' ) }
1855 qw( seconds upbytes downbytes totalbytes )
1858 foreach my $field (keys %$valueref){
1859 $reset = 1 if $valueref->{$field};
1860 $self->setfield($field, $valueref->{$field});
1861 $self->setfield( $field.'_threshold',
1862 int($self->getfield($field)
1863 * ( $conf->exists('svc_acct-usage_threshold')
1864 ? 1 - $conf->config('svc_acct-usage_threshold')/100
1869 $handyhash{$field} = $self->getfield($field);
1870 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
1872 #my $error = $self->replace; #NO! we avoid the call to ->check for
1873 #die $error if $error; #services not explicity changed via the UI
1875 my $sql = "UPDATE svc_acct SET " .
1876 join (',', map { "$_ = $handyhash{$_}" } (keys %handyhash) ).
1877 " WHERE svcnum = ". $self->svcnum;
1882 if (scalar(keys %handyhash)) {
1883 my $sth = $dbh->prepare( $sql )
1884 or die "Error preparing $sql: ". $dbh->errstr;
1885 my $rv = $sth->execute();
1886 die "Error executing $sql: ". $sth->errstr
1887 unless defined($rv);
1888 die "Can't update usage for svcnum ". $self->svcnum
1895 if ($self->overlimit) {
1896 $error = $self->overlimit('unsuspend');
1897 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
1898 if ($part_export->option('overlimit_groups')) {
1899 my $old = new FS::svc_acct $self->hashref;
1900 my $groups = &{ $self->_fieldhandlers->{'usergroup'} }
1901 ($self, $part_export->option('overlimit_groups'));
1902 $old->usergroup( $groups );
1903 $error ||= $part_export->export_replace($self, $old);
1908 if ( $conf->exists("svc_acct-usage_unsuspend")) {
1909 $error ||= $self->cust_svc->cust_pkg->unsuspend;
1912 $dbh->rollback if $oldAutoCommit;
1913 return "Error unsuspending: $error";
1917 warn "$me update successful; committing\n"
1919 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1925 =item recharge HASHREF
1927 Increments usage columns by the amount specified in HASHREF as
1928 column=>amount pairs.
1933 my ($self, $vhash) = @_;
1936 warn "[$me] recharge called on $self: ". Dumper($self).
1937 "\nwith vhash: ". Dumper($vhash);
1940 my $oldAutoCommit = $FS::UID::AutoCommit;
1941 local $FS::UID::AutoCommit = 0;
1945 foreach my $column (keys %$vhash){
1946 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
1950 $dbh->rollback if $oldAutoCommit;
1952 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1957 =item is_rechargeable
1959 Returns true if this svc_account can be "recharged" and false otherwise.
1963 sub is_rechargable {
1965 $self->seconds ne ''
1966 || $self->upbytes ne ''
1967 || $self->downbytes ne ''
1968 || $self->totalbytes ne '';
1971 =item seconds_since TIMESTAMP
1973 Returns the number of seconds this account has been online since TIMESTAMP,
1974 according to the session monitor (see L<FS::Session>).
1976 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1977 L<Time::Local> and L<Date::Parse> for conversion functions.
1981 #note: POD here, implementation in FS::cust_svc
1984 $self->cust_svc->seconds_since(@_);
1987 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
1989 Returns the numbers of seconds this account has been online between
1990 TIMESTAMP_START (inclusive) and TIMESTAMP_END (exclusive), according to an
1991 external SQL radacct table, specified via sqlradius export. Sessions which
1992 started in the specified range but are still open are counted from session
1993 start to the end of the range (unless they are over 1 day old, in which case
1994 they are presumed missing their stop record and not counted). Also, sessions
1995 which end in the range but started earlier are counted from the start of the
1996 range to session end. Finally, sessions which start before the range but end
1997 after are counted for the entire range.
1999 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2000 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2005 #note: POD here, implementation in FS::cust_svc
2006 sub seconds_since_sqlradacct {
2008 $self->cust_svc->seconds_since_sqlradacct(@_);
2011 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2013 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2014 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2015 TIMESTAMP_END (exclusive).
2017 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2018 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2023 #note: POD here, implementation in FS::cust_svc
2024 sub attribute_since_sqlradacct {
2026 $self->cust_svc->attribute_since_sqlradacct(@_);
2029 =item get_session_history TIMESTAMP_START TIMESTAMP_END
2031 Returns an array of hash references of this customers login history for the
2032 given time range. (document this better)
2036 sub get_session_history {
2038 $self->cust_svc->get_session_history(@_);
2041 =item last_login_text
2043 Returns text describing the time of last login.
2047 sub last_login_text {
2049 $self->last_login ? ctime($self->last_login) : 'unknown';
2052 =item get_cdrs TIMESTAMP_START TIMESTAMP_END [ 'OPTION' => 'VALUE ... ]
2057 my($self, $start, $end, %opt ) = @_;
2059 my $did = $self->username; #yup
2061 my $prefix = $opt{'default_prefix'}; #convergent.au '+61'
2063 my $for_update = $opt{'for_update'} ? 'FOR UPDATE' : '';
2065 #SELECT $for_update * FROM cdr
2066 # WHERE calldate >= $start #need a conversion
2067 # AND calldate < $end #ditto
2068 # AND ( charged_party = "$did"
2069 # OR charged_party = "$prefix$did" #if length($prefix);
2070 # OR ( ( charged_party IS NULL OR charged_party = '' )
2072 # ( src = "$did" OR src = "$prefix$did" ) # if length($prefix)
2075 # AND ( freesidestatus IS NULL OR freesidestatus = '' )
2078 if ( length($prefix) ) {
2080 " AND ( charged_party = '$did'
2081 OR charged_party = '$prefix$did'
2082 OR ( ( charged_party IS NULL OR charged_party = '' )
2084 ( src = '$did' OR src = '$prefix$did' )
2090 " AND ( charged_party = '$did'
2091 OR ( ( charged_party IS NULL OR charged_party = '' )
2101 'select' => "$for_update *",
2104 #( freesidestatus IS NULL OR freesidestatus = '' )
2105 'freesidestatus' => '',
2107 'extra_sql' => $charged_or_src,
2115 Returns all RADIUS groups for this account (see L<FS::radius_usergroup>).
2121 if ( $self->usergroup ) {
2122 confess "explicitly specified usergroup not an arrayref: ". $self->usergroup
2123 unless ref($self->usergroup) eq 'ARRAY';
2124 #when provisioning records, export callback runs in svc_Common.pm before
2125 #radius_usergroup records can be inserted...
2126 @{$self->usergroup};
2128 map { $_->groupname }
2129 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } );
2133 =item clone_suspended
2135 Constructor used by FS::part_export::_export_suspend fallback. Document
2140 sub clone_suspended {
2142 my %hash = $self->hash;
2143 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2144 new FS::svc_acct \%hash;
2147 =item clone_kludge_unsuspend
2149 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2154 sub clone_kludge_unsuspend {
2156 my %hash = $self->hash;
2157 $hash{_password} = '';
2158 new FS::svc_acct \%hash;
2161 =item check_password
2163 Checks the supplied password against the (possibly encrypted) password in the
2164 database. Returns true for a successful authentication, false for no match.
2166 Currently supported encryptions are: classic DES crypt() and MD5
2170 sub check_password {
2171 my($self, $check_password) = @_;
2173 #remove old-style SUSPENDED kludge, they should be allowed to login to
2174 #self-service and pay up
2175 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2177 if ( $self->_password_encoding eq 'ldap' ) {
2179 my $auth = from_rfc2307 Authen::Passphrase $self->_password;
2180 return $auth->match($check_password);
2182 } elsif ( $self->_password_encoding eq 'crypt' ) {
2184 my $auth = from_crypt Authen::Passphrase $self->_password;
2185 return $auth->match($check_password);
2187 } elsif ( $self->_password_encoding eq 'plain' ) {
2189 return $check_password eq $password;
2193 #XXX this could be replaced with Authen::Passphrase stuff
2195 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2197 } elsif ( length($password) < 13 ) { #plaintext
2198 $check_password eq $password;
2199 } elsif ( length($password) == 13 ) { #traditional DES crypt
2200 crypt($check_password, $password) eq $password;
2201 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2202 unix_md5_crypt($check_password, $password) eq $password;
2203 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2204 warn "Can't check password: Blowfish encryption not yet supported, ".
2205 "svcnum ". $self->svcnum. "\n";
2208 warn "Can't check password: Unrecognized encryption for svcnum ".
2209 $self->svcnum. "\n";
2217 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2219 Returns an encrypted password, either by passing through an encrypted password
2220 in the database or by encrypting a plaintext password from the database.
2222 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2223 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2224 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2225 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2226 encryption type is only used if the password is not already encrypted in the
2231 sub crypt_password {
2234 if ( $self->_password_encoding eq 'ldap' ) {
2236 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2239 #XXX this could be replaced with Authen::Passphrase stuff
2241 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2242 if ( $encryption eq 'crypt' ) {
2245 $saltset[int(rand(64))].$saltset[int(rand(64))]
2247 } elsif ( $encryption eq 'md5' ) {
2248 unix_md5_crypt( $self->_password );
2249 } elsif ( $encryption eq 'blowfish' ) {
2250 croak "unknown encryption method $encryption";
2252 croak "unknown encryption method $encryption";
2255 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2259 } elsif ( $self->_password_encoding eq 'crypt' ) {
2261 return $self->_password;
2263 } elsif ( $self->_password_encoding eq 'plain' ) {
2265 #XXX this could be replaced with Authen::Passphrase stuff
2267 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2268 if ( $encryption eq 'crypt' ) {
2271 $saltset[int(rand(64))].$saltset[int(rand(64))]
2273 } elsif ( $encryption eq 'md5' ) {
2274 unix_md5_crypt( $self->_password );
2275 } elsif ( $encryption eq 'blowfish' ) {
2276 croak "unknown encryption method $encryption";
2278 croak "unknown encryption method $encryption";
2283 if ( length($self->_password) == 13
2284 || $self->_password =~ /^\$(1|2a?)\$/
2285 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2291 #XXX this could be replaced with Authen::Passphrase stuff
2293 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2294 if ( $encryption eq 'crypt' ) {
2297 $saltset[int(rand(64))].$saltset[int(rand(64))]
2299 } elsif ( $encryption eq 'md5' ) {
2300 unix_md5_crypt( $self->_password );
2301 } elsif ( $encryption eq 'blowfish' ) {
2302 croak "unknown encryption method $encryption";
2304 croak "unknown encryption method $encryption";
2313 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2315 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2316 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2317 "{MD5}5426824942db4253f87a1009fd5d2d4".
2319 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2320 to work the same as the B</crypt_password> method.
2326 #eventually should check a "password-encoding" field
2328 if ( $self->_password_encoding eq 'ldap' ) {
2330 return $self->_password;
2332 } elsif ( $self->_password_encoding eq 'crypt' ) {
2334 if ( length($self->_password) == 13 ) { #crypt
2335 return '{CRYPT}'. $self->_password;
2336 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2338 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2339 # die "Blowfish encryption not supported in this context, svcnum ".
2340 # $self->svcnum. "\n";
2342 warn "encryption method not (yet?) supported in LDAP context";
2343 return '{CRYPT}*'; #unsupported, should not auth
2346 } elsif ( $self->_password_encoding eq 'plain' ) {
2348 return '{PLAIN}'. $self->_password;
2350 #return '{CLEARTEXT}'. $self->_password; #?
2354 if ( length($self->_password) == 13 ) { #crypt
2355 return '{CRYPT}'. $self->_password;
2356 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2358 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2359 warn "Blowfish encryption not supported in this context, svcnum ".
2360 $self->svcnum. "\n";
2363 #are these two necessary anymore?
2364 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2365 return '{SSHA}'. $1;
2366 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2367 return '{NS-MTA-MD5}'. $1;
2370 return '{PLAIN}'. $self->_password;
2372 #return '{CLEARTEXT}'. $self->_password; #?
2374 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2375 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2376 #if ( $encryption eq 'crypt' ) {
2377 # return '{CRYPT}'. crypt(
2379 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2381 #} elsif ( $encryption eq 'md5' ) {
2382 # unix_md5_crypt( $self->_password );
2383 #} elsif ( $encryption eq 'blowfish' ) {
2384 # croak "unknown encryption method $encryption";
2386 # croak "unknown encryption method $encryption";
2394 =item domain_slash_username
2396 Returns $domain/$username/
2400 sub domain_slash_username {
2402 $self->domain. '/'. $self->username. '/';
2405 =item virtual_maildir
2407 Returns $domain/maildirs/$username/
2411 sub virtual_maildir {
2413 $self->domain. '/maildirs/'. $self->username. '/';
2424 This is the FS::svc_acct job-queue-able version. It still uses
2425 FS::Misc::send_email under-the-hood.
2432 eval "use FS::Misc qw(send_email)";
2435 $opt{mimetype} ||= 'text/plain';
2436 $opt{mimetype} .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2438 my $error = send_email(
2439 'from' => $opt{from},
2441 'subject' => $opt{subject},
2442 'content-type' => $opt{mimetype},
2443 'body' => [ map "$_\n", split("\n", $opt{body}) ],
2445 die $error if $error;
2448 =item check_and_rebuild_fuzzyfiles
2452 sub check_and_rebuild_fuzzyfiles {
2453 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2454 -e "$dir/svc_acct.username"
2455 or &rebuild_fuzzyfiles;
2458 =item rebuild_fuzzyfiles
2462 sub rebuild_fuzzyfiles {
2464 use Fcntl qw(:flock);
2466 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2470 open(USERNAMELOCK,">>$dir/svc_acct.username")
2471 or die "can't open $dir/svc_acct.username: $!";
2472 flock(USERNAMELOCK,LOCK_EX)
2473 or die "can't lock $dir/svc_acct.username: $!";
2475 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2477 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2478 or die "can't open $dir/svc_acct.username.tmp: $!";
2479 print USERNAMECACHE join("\n", @all_username), "\n";
2480 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2482 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2492 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2493 open(USERNAMECACHE,"<$dir/svc_acct.username")
2494 or die "can't open $dir/svc_acct.username: $!";
2495 my @array = map { chomp; $_; } <USERNAMECACHE>;
2496 close USERNAMECACHE;
2500 =item append_fuzzyfiles USERNAME
2504 sub append_fuzzyfiles {
2505 my $username = shift;
2507 &check_and_rebuild_fuzzyfiles;
2509 use Fcntl qw(:flock);
2511 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2513 open(USERNAME,">>$dir/svc_acct.username")
2514 or die "can't open $dir/svc_acct.username: $!";
2515 flock(USERNAME,LOCK_EX)
2516 or die "can't lock $dir/svc_acct.username: $!";
2518 print USERNAME "$username\n";
2520 flock(USERNAME,LOCK_UN)
2521 or die "can't unlock $dir/svc_acct.username: $!";
2529 =item radius_usergroup_selector GROUPS_ARRAYREF [ SELECTNAME ]
2533 sub radius_usergroup_selector {
2534 my $sel_groups = shift;
2535 my %sel_groups = map { $_=>1 } @$sel_groups;
2537 my $selectname = shift || 'radius_usergroup';
2540 my $sth = $dbh->prepare(
2541 'SELECT DISTINCT(groupname) FROM radius_usergroup ORDER BY groupname'
2542 ) or die $dbh->errstr;
2543 $sth->execute() or die $sth->errstr;
2544 my @all_groups = map { $_->[0] } @{$sth->fetchall_arrayref};
2548 function ${selectname}_doadd(object) {
2549 var myvalue = object.${selectname}_add.value;
2550 var optionName = new Option(myvalue,myvalue,false,true);
2551 var length = object.$selectname.length;
2552 object.$selectname.options[length] = optionName;
2553 object.${selectname}_add.value = "";
2556 <SELECT MULTIPLE NAME="$selectname">
2559 foreach my $group ( @all_groups ) {
2560 $html .= qq(<OPTION VALUE="$group");
2561 if ( $sel_groups{$group} ) {
2562 $html .= ' SELECTED';
2563 $sel_groups{$group} = 0;
2565 $html .= ">$group</OPTION>\n";
2567 foreach my $group ( grep { $sel_groups{$_} } keys %sel_groups ) {
2568 $html .= qq(<OPTION VALUE="$group" SELECTED>$group</OPTION>\n);
2570 $html .= '</SELECT>';
2572 $html .= qq!<BR><INPUT TYPE="text" NAME="${selectname}_add">!.
2573 qq!<INPUT TYPE="button" VALUE="Add new group" onClick="${selectname}_doadd(this.form)">!;
2578 =item reached_threshold
2580 Performs some activities when svc_acct thresholds (such as number of seconds
2581 remaining) are reached.
2585 sub reached_threshold {
2588 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
2589 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
2591 if ( $opt{'op'} eq '+' ){
2592 $svc_acct->setfield( $opt{'column'}.'_threshold',
2593 int($svc_acct->getfield($opt{'column'})
2594 * ( $conf->exists('svc_acct-usage_threshold')
2595 ? $conf->config('svc_acct-usage_threshold')/100
2600 my $error = $svc_acct->replace;
2601 die $error if $error;
2602 }elsif ( $opt{'op'} eq '-' ){
2604 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
2605 return '' if ($threshold eq '' );
2607 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
2608 my $error = $svc_acct->replace;
2609 die $error if $error; # email next time, i guess
2611 if ( $warning_template ) {
2612 eval "use FS::Misc qw(send_email)";
2615 my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
2616 my $cust_main = $cust_pkg->cust_main;
2618 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ }
2619 $cust_main->invoicing_list,
2620 ($opt{'to'} ? $opt{'to'} : ())
2623 my $mimetype = $warning_mimetype;
2624 $mimetype .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2626 my $body = $warning_template->fill_in( HASH => {
2627 'custnum' => $cust_main->custnum,
2628 'username' => $svc_acct->username,
2629 'password' => $svc_acct->_password,
2630 'first' => $cust_main->first,
2631 'last' => $cust_main->getfield('last'),
2632 'pkg' => $cust_pkg->part_pkg->pkg,
2633 'column' => $opt{'column'},
2634 'amount' => $opt{'column'} =~/bytes/
2635 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
2636 : $svc_acct->getfield($opt{'column'}),
2637 'threshold' => $opt{'column'} =~/bytes/
2638 ? FS::UI::bytecount::display_bytecount($threshold)
2643 my $error = send_email(
2644 'from' => $warning_from,
2646 'subject' => $warning_subject,
2647 'content-type' => $mimetype,
2648 'body' => [ map "$_\n", split("\n", $body) ],
2650 die $error if $error;
2653 die "unknown op: " . $opt{'op'};
2661 The $recref stuff in sub check should be cleaned up.
2663 The suspend, unsuspend and cancel methods update the database, but not the
2664 current object. This is probably a bug as it's unexpected and
2667 radius_usergroup_selector? putting web ui components in here? they should
2668 probably live somewhere else...
2670 insertion of RADIUS group stuff in insert could be done with child_objects now
2671 (would probably clean up export of them too)
2675 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
2676 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
2677 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
2678 L<freeside-queued>), L<FS::svc_acct_pop>,
2679 schema.html from the base documentation.
2683 =item domain_select_hash %OPTIONS
2685 Returns a hash SVCNUM => DOMAIN ... representing the domains this customer
2686 may at present purchase.
2688 Currently available options are: I<pkgnum> I<svcpart>
2692 sub domain_select_hash {
2693 my ($self, %options) = @_;
2699 $part_svc = $self->part_svc;
2700 $cust_pkg = $self->cust_svc->cust_pkg
2704 $part_svc = qsearchs('part_svc', { 'svcpart' => $options{svcpart} })
2705 if $options{'svcpart'};
2707 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $options{pkgnum} })
2708 if $options{'pkgnum'};
2710 if ($part_svc && ( $part_svc->part_svc_column('domsvc')->columnflag eq 'S'
2711 || $part_svc->part_svc_column('domsvc')->columnflag eq 'F')) {
2712 %domains = map { $_->svcnum => $_->domain }
2713 map { qsearchs('svc_domain', { 'svcnum' => $_ }) }
2714 split(',', $part_svc->part_svc_column('domsvc')->columnvalue);
2715 }elsif ($cust_pkg && !$conf->exists('svc_acct-alldomains') ) {
2716 %domains = map { $_->svcnum => $_->domain }
2717 map { qsearchs('svc_domain', { 'svcnum' => $_->svcnum }) }
2718 map { qsearch('cust_svc', { 'pkgnum' => $_->pkgnum } ) }
2719 qsearch('cust_pkg', { 'custnum' => $cust_pkg->custnum });
2721 %domains = map { $_->svcnum => $_->domain } qsearch('svc_domain', {} );
2724 if ($part_svc && $part_svc->part_svc_column('domsvc')->columnflag eq 'D') {
2725 my $svc_domain = qsearchs('svc_domain',
2726 { 'svcnum' => $part_svc->part_svc_column('domsvc')->columnvalue } );
2727 if ( $svc_domain ) {
2728 $domains{$svc_domain->svcnum} = $svc_domain->domain;
2730 warn "unknown svc_domain.svcnum for part_svc_column domsvc: ".
2731 $part_svc->part_svc_column('domsvc')->columnvalue;