4 use base qw( FS::svc_Domain_Mixin FS::svc_Common );
5 use vars qw( $DEBUG $me $conf $skip_fuzzyfiles
6 $dir_prefix @shells $usernamemin
7 $usernamemax $passwordmin $passwordmax
8 $username_ampersand $username_letter $username_letterfirst
9 $username_noperiod $username_nounderscore $username_nodash
10 $username_uppercase $username_percent $username_colon
11 $password_noampersand $password_noexclamation
12 $warning_template $warning_from $warning_subject $warning_mimetype
15 $radius_password $radius_ip
18 use Scalar::Util qw( blessed );
23 use Crypt::PasswdMD5 1.2;
24 use Digest::SHA1 'sha1_base64';
25 use Digest::MD5 'md5_base64';
28 use Authen::Passphrase;
29 use FS::UID qw( datasrc driver_name );
31 use FS::Record qw( qsearch qsearchs fields dbh dbdef );
32 use FS::Msgcat qw(gettext);
33 use FS::UI::bytecount;
38 use FS::cust_main_invoice;
43 use FS::radius_usergroup;
51 $me = '[FS::svc_acct]';
53 #ask FS::UID to run this stuff for us later
54 FS::UID->install_callback( sub {
56 $dir_prefix = $conf->config('home');
57 @shells = $conf->config('shells');
58 $usernamemin = $conf->config('usernamemin') || 2;
59 $usernamemax = $conf->config('usernamemax');
60 $passwordmin = $conf->config('passwordmin'); # || 6;
62 $passwordmin = ( defined($passwordmin) && $passwordmin =~ /\d+/ )
65 $passwordmax = $conf->config('passwordmax') || 8;
66 $username_letter = $conf->exists('username-letter');
67 $username_letterfirst = $conf->exists('username-letterfirst');
68 $username_noperiod = $conf->exists('username-noperiod');
69 $username_nounderscore = $conf->exists('username-nounderscore');
70 $username_nodash = $conf->exists('username-nodash');
71 $username_uppercase = $conf->exists('username-uppercase');
72 $username_ampersand = $conf->exists('username-ampersand');
73 $username_percent = $conf->exists('username-percent');
74 $username_colon = $conf->exists('username-colon');
75 $password_noampersand = $conf->exists('password-noexclamation');
76 $password_noexclamation = $conf->exists('password-noexclamation');
77 $dirhash = $conf->config('dirhash') || 0;
78 if ( $conf->exists('warning_email') ) {
79 $warning_template = new Text::Template (
81 SOURCE => [ map "$_\n", $conf->config('warning_email') ]
82 ) or warn "can't create warning email template: $Text::Template::ERROR";
83 $warning_from = $conf->config('warning_email-from'); # || 'your-isp-is-dum'
84 $warning_subject = $conf->config('warning_email-subject') || 'Warning';
85 $warning_mimetype = $conf->config('warning_email-mimetype') || 'text/plain';
86 $warning_cc = $conf->config('warning_email-cc');
88 $warning_template = '';
90 $warning_subject = '';
91 $warning_mimetype = '';
94 $smtpmachine = $conf->config('smtpmachine');
95 $radius_password = $conf->config('radius-password') || 'Password';
96 $radius_ip = $conf->config('radius-ip') || 'Framed-IP-Address';
97 @pw_set = ( 'A'..'Z' ) if $conf->exists('password-generated-allcaps');
101 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
102 @pw_set = ( 'a'..'z', 'A'..'Z', '0'..'9', '(', ')', '#', '!', '.', ',' );
106 my ( $hashref, $cache ) = @_;
107 if ( $hashref->{'svc_acct_svcnum'} ) {
108 $self->{'_domsvc'} = FS::svc_domain->new( {
109 'svcnum' => $hashref->{'domsvc'},
110 'domain' => $hashref->{'svc_acct_domain'},
111 'catchall' => $hashref->{'svc_acct_catchall'},
118 FS::svc_acct - Object methods for svc_acct records
124 $record = new FS::svc_acct \%hash;
125 $record = new FS::svc_acct { 'column' => 'value' };
127 $error = $record->insert;
129 $error = $new_record->replace($old_record);
131 $error = $record->delete;
133 $error = $record->check;
135 $error = $record->suspend;
137 $error = $record->unsuspend;
139 $error = $record->cancel;
141 %hash = $record->radius;
143 %hash = $record->radius_reply;
145 %hash = $record->radius_check;
147 $domain = $record->domain;
149 $svc_domain = $record->svc_domain;
151 $email = $record->email;
153 $seconds_since = $record->seconds_since($timestamp);
157 An FS::svc_acct object represents an account. FS::svc_acct inherits from
158 FS::svc_Common. The following fields are currently supported:
164 Primary key (assigned automatcially for new accounts)
172 =item _password_encoding
174 plain, crypt, ldap (or empty for autodetection)
182 Point of presence (see L<FS::svc_acct_pop>)
194 set automatically if blank (and uid is not)
214 svcnum from svc_domain
218 Optional svcnum from svc_pbx
220 =item radius_I<Radius_Attribute>
222 I<Radius-Attribute> (reply)
224 =item rc_I<Radius_Attribute>
226 I<Radius-Attribute> (check)
236 Creates a new account. To add the account to the database, see L<"insert">.
243 'longname_plural' => 'Access accounts and mailboxes',
244 'sorts' => [ 'username', 'uid', 'seconds', 'last_login' ],
245 'display_weight' => 10,
246 'cancel_weight' => 50,
248 'dir' => 'Home directory',
251 def_info => 'set to fixed and blank for no UIDs',
254 'slipip' => 'IP address',
255 # 'popnum' => qq!<A HREF="$p/browse/svc_acct_pop.cgi/">POP number</A>!,
257 label => 'Access number',
259 select_table => 'svc_acct_pop',
260 select_key => 'popnum',
261 select_label => 'city',
267 disable_default => 1,
272 label => 'Communigate account type',
274 select_list => [qw( MultiMailbox TextMailbox MailDirMailbox AGrade BGrade CGrade )],
275 disable_inventory => 1,
278 'cgp_accessmodes' => {
279 label => 'Communigate enabled services',
280 type => 'communigate_pro-accessmodes',
281 disable_inventory => 1,
285 label => 'Communigate aliases',
287 disable_inventory => 1,
290 'password_selfchange' => { label => 'Password modification',
293 'password_recover' => { label => 'Password recovery',
296 'cgp_deletemode' => {
297 label => 'Communigate message delete method',
299 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
300 disable_inventory => 1,
303 'cgp_emptytrash' => {
304 label => 'Communigate on logout remove trash',
306 disable_inventory => 1,
310 label => 'Quota', #Mail storage limit
312 disable_inventory => 1,
316 label => 'File storage limit',
318 disable_inventory => 1,
322 label => 'Number of files limit',
324 disable_inventory => 1,
328 label => 'File size limit',
330 disable_inventory => 1,
333 '_password' => 'Password',
336 def_info => 'when blank, defaults to UID',
341 def_info => 'set to blank for no shell tracking',
343 #select_list => [ $conf->config('shells') ],
344 select_list => [ $conf ? $conf->config('shells') : () ],
345 disable_inventory => 1,
348 'finger' => 'Real name', # (GECOS)',
352 select_table => 'svc_domain',
353 select_key => 'svcnum',
354 select_label => 'domain',
355 disable_inventory => 1,
357 'pbxsvc' => { label => 'PBX',
358 type => 'select-svc_pbx.html',
359 disable_inventory => 1,
360 disable_select => 1, #UI wonky, pry works otherwise
363 label => 'RADIUS groups',
364 type => 'radius_usergroup_selector',
365 disable_inventory => 1,
368 'seconds' => { label => 'Seconds',
369 label_sort => 'with Time Remaining',
371 disable_inventory => 1,
373 disable_part_svc_column => 1,
375 'upbytes' => { label => 'Upload',
377 disable_inventory => 1,
379 'format' => \&FS::UI::bytecount::display_bytecount,
380 'parse' => \&FS::UI::bytecount::parse_bytecount,
381 disable_part_svc_column => 1,
383 'downbytes' => { label => 'Download',
385 disable_inventory => 1,
387 'format' => \&FS::UI::bytecount::display_bytecount,
388 'parse' => \&FS::UI::bytecount::parse_bytecount,
389 disable_part_svc_column => 1,
391 'totalbytes'=> { label => 'Total up and download',
393 disable_inventory => 1,
395 'format' => \&FS::UI::bytecount::display_bytecount,
396 'parse' => \&FS::UI::bytecount::parse_bytecount,
397 disable_part_svc_column => 1,
399 'seconds_threshold' => { label => 'Seconds threshold',
401 disable_inventory => 1,
403 disable_part_svc_column => 1,
405 'upbytes_threshold' => { label => 'Upload threshold',
407 disable_inventory => 1,
409 'format' => \&FS::UI::bytecount::display_bytecount,
410 'parse' => \&FS::UI::bytecount::parse_bytecount,
411 disable_part_svc_column => 1,
413 'downbytes_threshold' => { label => 'Download threshold',
415 disable_inventory => 1,
417 'format' => \&FS::UI::bytecount::display_bytecount,
418 'parse' => \&FS::UI::bytecount::parse_bytecount,
419 disable_part_svc_column => 1,
421 'totalbytes_threshold'=> { label => 'Total up and download threshold',
423 disable_inventory => 1,
425 'format' => \&FS::UI::bytecount::display_bytecount,
426 'parse' => \&FS::UI::bytecount::parse_bytecount,
427 disable_part_svc_column => 1,
430 label => 'Last login',
434 label => 'Last logout',
441 sub table { 'svc_acct'; }
443 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
447 #false laziness with edit/svc_acct.cgi
449 my( $self, $groups ) = @_;
450 if ( ref($groups) eq 'ARRAY' ) {
452 } elsif ( length($groups) ) {
453 [ split(/\s*,\s*/, $groups) ];
462 shift->_lastlog('in', @_);
466 shift->_lastlog('out', @_);
470 my( $self, $op, $time ) = @_;
472 if ( defined($time) ) {
473 warn "$me last_log$op called on svcnum ". $self->svcnum.
474 ' ('. $self->email. "): $time\n"
479 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
483 my $sth = $dbh->prepare( $sql )
484 or die "Error preparing $sql: ". $dbh->errstr;
485 my $rv = $sth->execute($time, $self->svcnum);
486 die "Error executing $sql: ". $sth->errstr
488 die "Can't update last_log$op for svcnum". $self->svcnum
491 $self->{'Hash'}->{"last_log$op"} = $time;
493 $self->getfield("last_log$op");
497 =item search_sql STRING
499 Class method which returns an SQL fragment to search for the given string.
504 my( $class, $string ) = @_;
505 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
506 my( $username, $domain ) = ( $1, $2 );
507 my $q_username = dbh->quote($username);
508 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
510 "svc_acct.username = $q_username AND ( ".
511 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
516 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
518 $class->search_sql_field('slipip', $string ).
520 $class->search_sql_field('username', $string ).
523 $class->search_sql_field('username', $string);
527 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
529 Returns the "username@domain" string for this account.
531 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
541 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
543 Returns a longer string label for this acccount ("Real Name <username@domain>"
544 if available, or "username@domain").
546 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
553 my $label = $self->label(@_);
554 my $finger = $self->finger;
555 return $label unless $finger =~ /\S/;
556 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
557 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
561 =item insert [ , OPTION => VALUE ... ]
563 Adds this account to the database. If there is an error, returns the error,
564 otherwise returns false.
566 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
567 defined. An FS::cust_svc record will be created and inserted.
569 The additional field I<usergroup> can optionally be defined; if so it should
570 contain an arrayref of group names. See L<FS::radius_usergroup>.
572 The additional field I<child_objects> can optionally be defined; if so it
573 should contain an arrayref of FS::tablename objects. They will have their
574 svcnum fields set and will be inserted after this record, but before any
575 exports are run. Each element of the array can also optionally be a
576 two-element array reference containing the child object and the name of an
577 alternate field to be filled in with the newly-inserted svcnum, for example
578 C<[ $svc_forward, 'srcsvc' ]>
580 Currently available options are: I<depend_jobnum>
582 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
583 jobnums), all provisioning jobs will have a dependancy on the supplied
584 jobnum(s) (they will not run until the specific job(s) complete(s)).
586 (TODOC: L<FS::queue> and L<freeside-queued>)
588 (TODOC: new exports!)
597 warn "[$me] insert called on $self: ". Dumper($self).
598 "\nwith options: ". Dumper(%options);
601 local $SIG{HUP} = 'IGNORE';
602 local $SIG{INT} = 'IGNORE';
603 local $SIG{QUIT} = 'IGNORE';
604 local $SIG{TERM} = 'IGNORE';
605 local $SIG{TSTP} = 'IGNORE';
606 local $SIG{PIPE} = 'IGNORE';
608 my $oldAutoCommit = $FS::UID::AutoCommit;
609 local $FS::UID::AutoCommit = 0;
613 my $error = $self->SUPER::insert(
614 'jobnums' => \@jobnums,
615 'child_objects' => $self->child_objects,
619 $dbh->rollback if $oldAutoCommit;
623 if ( $self->usergroup ) {
624 foreach my $groupname ( @{$self->usergroup} ) {
625 my $radius_usergroup = new FS::radius_usergroup ( {
626 svcnum => $self->svcnum,
627 groupname => $groupname,
629 my $error = $radius_usergroup->insert;
631 $dbh->rollback if $oldAutoCommit;
637 unless ( $skip_fuzzyfiles ) {
638 $error = $self->queue_fuzzyfiles_update;
640 $dbh->rollback if $oldAutoCommit;
641 return "updating fuzzy search cache: $error";
645 my $cust_pkg = $self->cust_svc->cust_pkg;
648 my $cust_main = $cust_pkg->cust_main;
649 my $agentnum = $cust_main->agentnum;
651 if ( $conf->exists('emailinvoiceautoalways')
652 || $conf->exists('emailinvoiceauto')
653 && ! $cust_main->invoicing_list_emailonly
655 my @invoicing_list = $cust_main->invoicing_list;
656 push @invoicing_list, $self->email;
657 $cust_main->invoicing_list(\@invoicing_list);
661 my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
662 = ('','','','','','');
664 if ( $conf->exists('welcome_email', $agentnum) ) {
665 $welcome_template = new Text::Template (
667 SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
668 ) or warn "can't create welcome email template: $Text::Template::ERROR";
669 $welcome_from = $conf->config('welcome_email-from', $agentnum);
670 # || 'your-isp-is-dum'
671 $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
673 $welcome_subject_template = new Text::Template (
675 SOURCE => $welcome_subject,
676 ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
677 $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
680 if ( $welcome_template && $cust_pkg ) {
681 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
685 'custnum' => $self->custnum,
686 'username' => $self->username,
687 'password' => $self->_password,
688 'first' => $cust_main->first,
689 'last' => $cust_main->getfield('last'),
690 'pkg' => $cust_pkg->part_pkg->pkg,
692 my $wqueue = new FS::queue {
693 'svcnum' => $self->svcnum,
694 'job' => 'FS::svc_acct::send_email'
696 my $error = $wqueue->insert(
698 'from' => $welcome_from,
699 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
700 'mimetype' => $welcome_mimetype,
701 'body' => $welcome_template->fill_in( HASH => \%hash, ),
704 $dbh->rollback if $oldAutoCommit;
705 return "error queuing welcome email: $error";
708 if ( $options{'depend_jobnum'} ) {
709 warn "$me depend_jobnum found; adding to welcome email dependancies"
711 if ( ref($options{'depend_jobnum'}) ) {
712 warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
713 "to welcome email dependancies"
715 push @jobnums, @{ $options{'depend_jobnum'} };
717 warn "$me adding job $options{'depend_jobnum'} ".
718 "to welcome email dependancies"
720 push @jobnums, $options{'depend_jobnum'};
724 foreach my $jobnum ( @jobnums ) {
725 my $error = $wqueue->depend_insert($jobnum);
727 $dbh->rollback if $oldAutoCommit;
728 return "error queuing welcome email job dependancy: $error";
738 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
742 # set usage fields and thresholds if unset but set in a package def
743 # AND the package already has a last bill date (otherwise they get double added)
744 sub preinsert_hook_first {
747 return '' unless $self->pkgnum;
749 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
750 return '' unless $cust_pkg && $cust_pkg->last_bill;
752 my $part_pkg = $cust_pkg->part_pkg;
753 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
755 my %values = $part_pkg->usage_valuehash;
756 my $multiplier = $conf->exists('svc_acct-usage_threshold')
757 ? 1 - $conf->config('svc_acct-usage_threshold')/100
758 : 0.20; #doesn't matter
760 foreach ( keys %values ) {
761 next if $self->getfield($_);
762 $self->setfield( $_, $values{$_} );
763 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
764 if $conf->exists('svc_acct-usage_threshold');
772 Deletes this account from the database. If there is an error, returns the
773 error, otherwise returns false.
775 The corresponding FS::cust_svc record will be deleted as well.
777 (TODOC: new exports!)
784 return "can't delete system account" if $self->_check_system;
786 return "Can't delete an account which is a (svc_forward) source!"
787 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
789 return "Can't delete an account which is a (svc_forward) destination!"
790 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
792 return "Can't delete an account with (svc_www) web service!"
793 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
795 # what about records in session ? (they should refer to history table)
797 local $SIG{HUP} = 'IGNORE';
798 local $SIG{INT} = 'IGNORE';
799 local $SIG{QUIT} = 'IGNORE';
800 local $SIG{TERM} = 'IGNORE';
801 local $SIG{TSTP} = 'IGNORE';
802 local $SIG{PIPE} = 'IGNORE';
804 my $oldAutoCommit = $FS::UID::AutoCommit;
805 local $FS::UID::AutoCommit = 0;
808 foreach my $cust_main_invoice (
809 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
811 unless ( defined($cust_main_invoice) ) {
812 warn "WARNING: something's wrong with qsearch";
815 my %hash = $cust_main_invoice->hash;
816 $hash{'dest'} = $self->email;
817 my $new = new FS::cust_main_invoice \%hash;
818 my $error = $new->replace($cust_main_invoice);
820 $dbh->rollback if $oldAutoCommit;
825 foreach my $svc_domain (
826 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
828 my %hash = new FS::svc_domain->hash;
829 $hash{'catchall'} = '';
830 my $new = new FS::svc_domain \%hash;
831 my $error = $new->replace($svc_domain);
833 $dbh->rollback if $oldAutoCommit;
838 my $error = $self->SUPER::delete;
840 $dbh->rollback if $oldAutoCommit;
844 foreach my $radius_usergroup (
845 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } )
847 my $error = $radius_usergroup->delete;
849 $dbh->rollback if $oldAutoCommit;
854 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
858 =item replace OLD_RECORD
860 Replaces OLD_RECORD with this one in the database. If there is an error,
861 returns the error, otherwise returns false.
863 The additional field I<usergroup> can optionally be defined; if so it should
864 contain an arrayref of group names. See L<FS::radius_usergroup>.
872 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
876 warn "$me replacing $old with $new\n" if $DEBUG;
880 return "can't modify system account" if $old->_check_system;
883 #no warnings 'numeric'; #alas, a 5.006-ism
886 foreach my $xid (qw( uid gid )) {
888 return "Can't change $xid!"
889 if ! $conf->exists("svc_acct-edit_$xid")
890 && $old->$xid() != $new->$xid()
891 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
896 #change homdir when we change username
897 $new->setfield('dir', '') if $old->username ne $new->username;
899 local $SIG{HUP} = 'IGNORE';
900 local $SIG{INT} = 'IGNORE';
901 local $SIG{QUIT} = 'IGNORE';
902 local $SIG{TERM} = 'IGNORE';
903 local $SIG{TSTP} = 'IGNORE';
904 local $SIG{PIPE} = 'IGNORE';
906 my $oldAutoCommit = $FS::UID::AutoCommit;
907 local $FS::UID::AutoCommit = 0;
910 # redundant, but so $new->usergroup gets set
911 $error = $new->check;
912 return $error if $error;
914 $old->usergroup( [ $old->radius_groups ] );
916 warn $old->email. " old groups: ". join(' ',@{$old->usergroup}). "\n";
917 warn $new->email. "new groups: ". join(' ',@{$new->usergroup}). "\n";
919 if ( $new->usergroup ) {
920 #(sorta) false laziness with FS::part_export::sqlradius::_export_replace
921 my @newgroups = @{$new->usergroup};
922 foreach my $oldgroup ( @{$old->usergroup} ) {
923 if ( grep { $oldgroup eq $_ } @newgroups ) {
924 @newgroups = grep { $oldgroup ne $_ } @newgroups;
927 my $radius_usergroup = qsearchs('radius_usergroup', {
928 svcnum => $old->svcnum,
929 groupname => $oldgroup,
931 my $error = $radius_usergroup->delete;
933 $dbh->rollback if $oldAutoCommit;
934 return "error deleting radius_usergroup $oldgroup: $error";
938 foreach my $newgroup ( @newgroups ) {
939 my $radius_usergroup = new FS::radius_usergroup ( {
940 svcnum => $new->svcnum,
941 groupname => $newgroup,
943 my $error = $radius_usergroup->insert;
945 $dbh->rollback if $oldAutoCommit;
946 return "error adding radius_usergroup $newgroup: $error";
952 $error = $new->SUPER::replace($old, @_);
954 $dbh->rollback if $oldAutoCommit;
955 return $error if $error;
958 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
959 $error = $new->queue_fuzzyfiles_update;
961 $dbh->rollback if $oldAutoCommit;
962 return "updating fuzzy search cache: $error";
966 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
970 =item queue_fuzzyfiles_update
972 Used by insert & replace to update the fuzzy search cache
976 sub queue_fuzzyfiles_update {
979 local $SIG{HUP} = 'IGNORE';
980 local $SIG{INT} = 'IGNORE';
981 local $SIG{QUIT} = 'IGNORE';
982 local $SIG{TERM} = 'IGNORE';
983 local $SIG{TSTP} = 'IGNORE';
984 local $SIG{PIPE} = 'IGNORE';
986 my $oldAutoCommit = $FS::UID::AutoCommit;
987 local $FS::UID::AutoCommit = 0;
990 my $queue = new FS::queue {
991 'svcnum' => $self->svcnum,
992 'job' => 'FS::svc_acct::append_fuzzyfiles'
994 my $error = $queue->insert($self->username);
996 $dbh->rollback if $oldAutoCommit;
997 return "queueing job (transaction rolled back): $error";
1000 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1008 Suspends this account by calling export-specific suspend hooks. If there is
1009 an error, returns the error, otherwise returns false.
1011 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1017 return "can't suspend system account" if $self->_check_system;
1018 $self->SUPER::suspend(@_);
1023 Unsuspends this account by by calling export-specific suspend hooks. If there
1024 is an error, returns the error, otherwise returns false.
1026 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1032 my %hash = $self->hash;
1033 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1034 $hash{_password} = $1;
1035 my $new = new FS::svc_acct ( \%hash );
1036 my $error = $new->replace($self);
1037 return $error if $error;
1040 $self->SUPER::unsuspend(@_);
1045 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1047 If the B<auto_unset_catchall> configuration option is set, this method will
1048 automatically remove any references to the canceled service in the catchall
1049 field of svc_domain. This allows packages that contain both a svc_domain and
1050 its catchall svc_acct to be canceled in one step.
1055 # Only one thing to do at this level
1057 foreach my $svc_domain (
1058 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1059 if($conf->exists('auto_unset_catchall')) {
1060 my %hash = $svc_domain->hash;
1061 $hash{catchall} = '';
1062 my $new = new FS::svc_domain ( \%hash );
1063 my $error = $new->replace($svc_domain);
1064 return $error if $error;
1066 return "cannot unprovision svc_acct #".$self->svcnum.
1067 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1071 $self->SUPER::cancel(@_);
1077 Checks all fields to make sure this is a valid service. If there is an error,
1078 returns the error, otherwise returns false. Called by the insert and replace
1081 Sets any fixed values; see L<FS::part_svc>.
1088 my($recref) = $self->hashref;
1090 my $x = $self->setfixed( $self->_fieldhandlers );
1091 return $x unless ref($x);
1094 if ( $part_svc->part_svc_column('usergroup')->columnflag eq "F" ) {
1096 [ split(',', $part_svc->part_svc_column('usergroup')->columnvalue) ] );
1099 my $error = $self->ut_numbern('svcnum')
1100 #|| $self->ut_number('domsvc')
1101 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1102 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1103 || $self->ut_textn('sec_phrase')
1104 || $self->ut_snumbern('seconds')
1105 || $self->ut_snumbern('upbytes')
1106 || $self->ut_snumbern('downbytes')
1107 || $self->ut_snumbern('totalbytes')
1108 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1109 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1110 || $self->ut_enum('password_recover', [ '', 'Y' ])
1111 || $self->ut_textn('cgp_accessmodes')
1112 || $self->ut_alphan('cgp_type')
1113 || $self->ut_textn('cgp_aliases' ) #well
1115 || $self->ut_alphasn('cgp_rulesallowed')
1116 || $self->ut_enum('cgp_rpopallowed', [ '', 'Y' ])
1117 || $self->ut_enum('cgp_mailtoall', [ '', 'Y' ])
1118 || $self->ut_enum('cgp_addmailtrailer', [ '', 'Y' ])
1120 || $self->ut_alphasn('cgp_deletemode')
1121 || $self->ut_alphan('cgp_emptytrash')
1123 return $error if $error;
1126 local $username_letter = $username_letter;
1127 if ($self->svcnum) {
1128 my $cust_svc = $self->cust_svc
1129 or return "no cust_svc record found for svcnum ". $self->svcnum;
1130 my $cust_pkg = $cust_svc->cust_pkg;
1132 if ($self->pkgnum) {
1133 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1137 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1140 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1141 if ( $username_uppercase ) {
1142 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:]{$usernamemin,$ulen})$/i
1143 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1144 $recref->{username} = $1;
1146 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:]{$usernamemin,$ulen})$/
1147 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1148 $recref->{username} = $1;
1151 if ( $username_letterfirst ) {
1152 $recref->{username} =~ /^[a-z]/ or return gettext('illegal_username');
1153 } elsif ( $username_letter ) {
1154 $recref->{username} =~ /[a-z]/ or return gettext('illegal_username');
1156 if ( $username_noperiod ) {
1157 $recref->{username} =~ /\./ and return gettext('illegal_username');
1159 if ( $username_nounderscore ) {
1160 $recref->{username} =~ /_/ and return gettext('illegal_username');
1162 if ( $username_nodash ) {
1163 $recref->{username} =~ /\-/ and return gettext('illegal_username');
1165 unless ( $username_ampersand ) {
1166 $recref->{username} =~ /\&/ and return gettext('illegal_username');
1168 unless ( $username_percent ) {
1169 $recref->{username} =~ /\%/ and return gettext('illegal_username');
1171 unless ( $username_colon ) {
1172 $recref->{username} =~ /\:/ and return gettext('illegal_username');
1175 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1176 $recref->{popnum} = $1;
1177 return "Unknown popnum" unless
1178 ! $recref->{popnum} ||
1179 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1181 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1183 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1184 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1186 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1187 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1188 #not all systems use gid=uid
1189 #you can set a fixed gid in part_svc
1191 return "Only root can have uid 0"
1192 if $recref->{uid} == 0
1193 && $recref->{username} !~ /^(root|toor|smtp)$/;
1195 unless ( $recref->{username} eq 'sync' ) {
1196 if ( grep $_ eq $recref->{shell}, @shells ) {
1197 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1199 return "Illegal shell \`". $self->shell. "\'; ".
1200 "shells configuration value contains: @shells";
1203 $recref->{shell} = '/bin/sync';
1207 $recref->{gid} ne '' ?
1208 return "Can't have gid without uid" : ( $recref->{gid}='' );
1209 #$recref->{dir} ne '' ?
1210 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1211 $recref->{shell} ne '' ?
1212 return "Can't have shell without uid" : ( $recref->{shell}='' );
1215 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1217 $recref->{dir} =~ /^([\/\w\-\.\&]*)$/
1218 or return "Illegal directory: ". $recref->{dir};
1219 $recref->{dir} = $1;
1220 return "Illegal directory"
1221 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1222 return "Illegal directory"
1223 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1224 unless ( $recref->{dir} ) {
1225 $recref->{dir} = $dir_prefix . '/';
1226 if ( $dirhash > 0 ) {
1227 for my $h ( 1 .. $dirhash ) {
1228 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1230 } elsif ( $dirhash < 0 ) {
1231 for my $h ( reverse $dirhash .. -1 ) {
1232 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1235 $recref->{dir} .= $recref->{username};
1241 # $error = $self->ut_textn('finger');
1242 # return $error if $error;
1243 if ( $self->getfield('finger') eq '' ) {
1244 my $cust_pkg = $self->svcnum
1245 ? $self->cust_svc->cust_pkg
1246 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1248 my $cust_main = $cust_pkg->cust_main;
1249 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1252 $self->getfield('finger') =~
1253 /^([\w \t\!\@\#\$\%\&\(\)\-\+\;\'\"\,\.\?\/\*\<\>]*)$/
1254 or return "Illegal finger: ". $self->getfield('finger');
1255 $self->setfield('finger', $1);
1257 for (qw( quota file_quota file_maxsize )) {
1258 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1261 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1262 $recref->{file_maxnum} = $1;
1264 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1265 if ( $recref->{slipip} eq '' ) {
1266 $recref->{slipip} = '';
1267 } elsif ( $recref->{slipip} eq '0e0' ) {
1268 $recref->{slipip} = '0e0';
1270 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1271 or return "Illegal slipip: ". $self->slipip;
1272 $recref->{slipip} = $1;
1277 #arbitrary RADIUS stuff; allow ut_textn for now
1278 foreach ( grep /^radius_/, fields('svc_acct') ) {
1279 $self->ut_textn($_);
1282 # First, if _password is blank, generate one and set default encoding.
1283 if ( ! $recref->{_password} ) {
1284 $error = $self->set_password('');
1286 # But if there's a _password but no encoding, assume it's plaintext and
1287 # set it to default encoding.
1288 elsif ( ! $recref->{_password_encoding} ) {
1289 $error = $self->set_password($recref->{_password});
1291 return $error if $error;
1293 # Next, check _password to ensure compliance with the encoding.
1294 if ( $recref->{_password_encoding} eq 'ldap' ) {
1296 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1297 $recref->{_password} = uc($1).$2;
1299 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1302 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1304 if ( $recref->{_password} =~
1305 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1306 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1309 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1312 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1315 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1316 # Password randomization is now in set_password.
1317 # Strip whitespace characters, check length requirements, etc.
1318 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1319 $recref->{_password} = $1;
1321 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1322 FS::Msgcat::_gettext('illegal_password_characters').
1323 ": ". $recref->{_password};
1326 if ( $password_noampersand ) {
1327 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1329 if ( $password_noexclamation ) {
1330 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1334 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1336 $self->SUPER::check;
1341 sub _password_encryption {
1343 my $encoding = lc($self->_password_encoding);
1344 return if !$encoding;
1345 return 'plain' if $encoding eq 'plain';
1346 if($encoding eq 'crypt') {
1347 my $pass = $self->_password;
1348 $pass =~ s/^\*SUSPENDED\* //;
1350 return 'md5' if $pass =~ /^\$1\$/;
1351 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1352 return 'des' if length($pass) == 13;
1355 if($encoding eq 'ldap') {
1356 uc($self->_password) =~ /^\{([\w-]+)\}/;
1357 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1358 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1359 return 'md5' if $1 eq 'MD5';
1360 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1367 sub get_cleartext_password {
1369 if($self->_password_encryption eq 'plain') {
1370 if($self->_password_encoding eq 'ldap') {
1371 $self->_password =~ /\{\w+\}(.*)$/;
1375 return $self->_password;
1384 Set the cleartext password for the account. If _password_encoding is set, the
1385 new password will be encoded according to the existing method (including
1386 encryption mode, if it can be determined). Otherwise,
1387 config('default-password-encoding') is used.
1389 If no password is supplied (or a zero-length password when minimum password length
1390 is >0), one will be generated randomly.
1395 my( $self, $pass ) = ( shift, shift );
1397 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1400 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1401 FS::Msgcat::_gettext('illegal_password_characters').
1404 my( $encoding, $encryption ) = ('', '');
1406 if ( $self->_password_encoding ) {
1407 $encoding = $self->_password_encoding;
1408 # identify existing encryption method, try to use it.
1409 $encryption = $self->_password_encryption;
1411 # use the system default
1417 # set encoding to system default
1418 ($encoding, $encryption) =
1419 split(/-/, lc($conf->config('default-password-encoding')));
1420 $encoding ||= 'legacy';
1421 $self->_password_encoding($encoding);
1424 if ( $encoding eq 'legacy' ) {
1426 # The legacy behavior from check():
1427 # If the password is blank, randomize it and set encoding to 'plain'.
1428 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1429 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1430 $self->_password_encoding('plain');
1432 # Prefix + valid-length password
1433 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1435 $self->_password_encoding('plain');
1436 # Prefix + crypt string
1437 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1439 $self->_password_encoding('crypt');
1440 # Various disabled crypt passwords
1441 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1442 $self->_password_encoding('crypt');
1448 $self->_password($pass);
1454 if $passwordmin && length($pass) < $passwordmin
1455 or $passwordmax && length($pass) > $passwordmax;
1457 if ( $encoding eq 'crypt' ) {
1458 if ($encryption eq 'md5') {
1459 $pass = unix_md5_crypt($pass);
1460 } elsif ($encryption eq 'des') {
1461 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1464 } elsif ( $encoding eq 'ldap' ) {
1465 if ($encryption eq 'md5') {
1466 $pass = md5_base64($pass);
1467 } elsif ($encryption eq 'sha1') {
1468 $pass = sha1_base64($pass);
1469 } elsif ($encryption eq 'crypt') {
1470 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1472 # else $encryption eq 'plain', do nothing
1473 $pass = '{'.uc($encryption).'}'.$pass;
1475 # else encoding eq 'plain'
1477 $self->_password($pass);
1483 Internal function to check the username against the list of system usernames
1484 from the I<system_usernames> configuration value. Returns true if the username
1485 is listed on the system username list.
1491 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1492 $conf->config('system_usernames')
1496 =item _check_duplicate
1498 Internal method to check for duplicates usernames, username@domain pairs and
1501 If the I<global_unique-username> configuration value is set to B<username> or
1502 B<username@domain>, enforces global username or username@domain uniqueness.
1504 In all cases, check for duplicate uids and usernames or username@domain pairs
1505 per export and with identical I<svcpart> values.
1509 sub _check_duplicate {
1512 my $global_unique = $conf->config('global_unique-username') || 'none';
1513 return '' if $global_unique eq 'disabled';
1517 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1518 unless ( $part_svc ) {
1519 return 'unknown svcpart '. $self->svcpart;
1522 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1523 qsearch( 'svc_acct', { 'username' => $self->username } );
1524 return gettext('username_in_use')
1525 if $global_unique eq 'username' && @dup_user;
1527 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1528 qsearch( 'svc_acct', { 'username' => $self->username,
1529 'domsvc' => $self->domsvc } );
1530 return gettext('username_in_use')
1531 if $global_unique eq 'username@domain' && @dup_userdomain;
1534 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1535 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1536 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1537 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1542 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1543 my $exports = FS::part_export::export_info('svc_acct');
1544 my %conflict_user_svcpart;
1545 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1547 foreach my $part_export ( $part_svc->part_export ) {
1549 #this will catch to the same exact export
1550 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1552 #this will catch to exports w/same exporthost+type ???
1553 #my @other_part_export = qsearch('part_export', {
1554 # 'machine' => $part_export->machine,
1555 # 'exporttype' => $part_export->exporttype,
1557 #foreach my $other_part_export ( @other_part_export ) {
1558 # push @svcparts, map { $_->svcpart }
1559 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1562 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1563 #silly kludge to avoid uninitialized value errors
1564 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1565 ? $exports->{$part_export->exporttype}{'nodomain'}
1567 if ( $nodomain =~ /^Y/i ) {
1568 $conflict_user_svcpart{$_} = $part_export->exportnum
1571 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1576 foreach my $dup_user ( @dup_user ) {
1577 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1578 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1579 return "duplicate username ". $self->username.
1580 ": conflicts with svcnum ". $dup_user->svcnum.
1581 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1585 foreach my $dup_userdomain ( @dup_userdomain ) {
1586 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1587 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1588 return "duplicate username\@domain ". $self->email.
1589 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1590 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1594 foreach my $dup_uid ( @dup_uid ) {
1595 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1596 if ( exists($conflict_user_svcpart{$dup_svcpart})
1597 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1598 return "duplicate uid ". $self->uid.
1599 ": conflicts with svcnum ". $dup_uid->svcnum.
1601 ( $conflict_user_svcpart{$dup_svcpart}
1602 || $conflict_userdomain_svcpart{$dup_svcpart} );
1614 Depriciated, use radius_reply instead.
1619 carp "FS::svc_acct::radius depriciated, use radius_reply";
1620 $_[0]->radius_reply;
1625 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1626 reply attributes of this record.
1628 Note that this is now the preferred method for reading RADIUS attributes -
1629 accessing the columns directly is discouraged, as the column names are
1630 expected to change in the future.
1637 return %{ $self->{'radius_reply'} }
1638 if exists $self->{'radius_reply'};
1643 my($column, $attrib) = ($1, $2);
1644 #$attrib =~ s/_/\-/g;
1645 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1646 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1648 if ( $self->slipip && $self->slipip ne '0e0' ) {
1649 $reply{$radius_ip} = $self->slipip;
1652 if ( $self->seconds !~ /^$/ ) {
1653 $reply{'Session-Timeout'} = $self->seconds;
1656 if ( $conf->exists('radius-chillispot-max') ) {
1657 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1659 #hmm. just because sqlradius.pm says so?
1666 foreach my $what (qw( input output total )) {
1667 my $is = $whatis{$what}.'bytes';
1668 if ( $self->$is() =~ /\d/ ) {
1669 my $big = new Math::BigInt $self->$is();
1670 $big = new Math::BigInt '0' if $big->is_neg();
1671 my $att = "Chillispot-Max-\u$what";
1672 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1673 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1684 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1685 check attributes of this record.
1687 Note that this is now the preferred method for reading RADIUS attributes -
1688 accessing the columns directly is discouraged, as the column names are
1689 expected to change in the future.
1696 return %{ $self->{'radius_check'} }
1697 if exists $self->{'radius_check'};
1702 my($column, $attrib) = ($1, $2);
1703 #$attrib =~ s/_/\-/g;
1704 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1705 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1708 my($pw_attrib, $password) = $self->radius_password;
1709 $check{$pw_attrib} = $password;
1711 my $cust_svc = $self->cust_svc;
1713 my $cust_pkg = $cust_svc->cust_pkg;
1714 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1715 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1718 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1719 "; can't set Expiration\n"
1727 =item radius_password
1729 Returns a key/value pair containing the RADIUS attribute name and value
1734 sub radius_password {
1738 if ( $self->_password_encoding eq 'ldap' ) {
1739 $pw_attrib = 'Password-With-Header';
1740 } elsif ( $self->_password_encoding eq 'crypt' ) {
1741 $pw_attrib = 'Crypt-Password';
1742 } elsif ( $self->_password_encoding eq 'plain' ) {
1743 $pw_attrib = $radius_password;
1745 $pw_attrib = length($self->_password) <= 12
1750 ($pw_attrib, $self->_password);
1756 This method instructs the object to "snapshot" or freeze RADIUS check and
1757 reply attributes to the current values.
1761 #bah, my english is too broken this morning
1762 #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
1763 #the FS::cust_pkg's replace method to trigger the correct export updates when
1764 #package dates change)
1769 $self->{$_} = { $self->$_() }
1770 foreach qw( radius_reply radius_check );
1774 =item forget_snapshot
1776 This methos instructs the object to forget any previously snapshotted
1777 RADIUS check and reply attributes.
1781 sub forget_snapshot {
1785 foreach qw( radius_reply radius_check );
1789 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1791 Returns the domain associated with this account.
1793 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1800 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1801 my $svc_domain = $self->svc_domain(@_)
1802 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1803 $svc_domain->domain;
1808 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1812 #inherited from svc_Common
1814 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1816 Returns an email address associated with the account.
1818 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1825 $self->username. '@'. $self->domain(@_);
1830 Returns an array of FS::acct_snarf records associated with the account.
1831 If the acct_snarf table does not exist or there are no associated records,
1832 an empty list is returned
1838 return () unless dbdef->table('acct_snarf');
1839 eval "use FS::acct_snarf;";
1841 qsearch('acct_snarf', { 'svcnum' => $self->svcnum } );
1844 =item decrement_upbytes OCTETS
1846 Decrements the I<upbytes> field of this record by the given amount. If there
1847 is an error, returns the error, otherwise returns false.
1851 sub decrement_upbytes {
1852 shift->_op_usage('-', 'upbytes', @_);
1855 =item increment_upbytes OCTETS
1857 Increments the I<upbytes> field of this record by the given amount. If there
1858 is an error, returns the error, otherwise returns false.
1862 sub increment_upbytes {
1863 shift->_op_usage('+', 'upbytes', @_);
1866 =item decrement_downbytes OCTETS
1868 Decrements the I<downbytes> field of this record by the given amount. If there
1869 is an error, returns the error, otherwise returns false.
1873 sub decrement_downbytes {
1874 shift->_op_usage('-', 'downbytes', @_);
1877 =item increment_downbytes OCTETS
1879 Increments the I<downbytes> field of this record by the given amount. If there
1880 is an error, returns the error, otherwise returns false.
1884 sub increment_downbytes {
1885 shift->_op_usage('+', 'downbytes', @_);
1888 =item decrement_totalbytes OCTETS
1890 Decrements the I<totalbytes> field of this record by the given amount. If there
1891 is an error, returns the error, otherwise returns false.
1895 sub decrement_totalbytes {
1896 shift->_op_usage('-', 'totalbytes', @_);
1899 =item increment_totalbytes OCTETS
1901 Increments the I<totalbytes> field of this record by the given amount. If there
1902 is an error, returns the error, otherwise returns false.
1906 sub increment_totalbytes {
1907 shift->_op_usage('+', 'totalbytes', @_);
1910 =item decrement_seconds SECONDS
1912 Decrements the I<seconds> field of this record by the given amount. If there
1913 is an error, returns the error, otherwise returns false.
1917 sub decrement_seconds {
1918 shift->_op_usage('-', 'seconds', @_);
1921 =item increment_seconds SECONDS
1923 Increments the I<seconds> field of this record by the given amount. If there
1924 is an error, returns the error, otherwise returns false.
1928 sub increment_seconds {
1929 shift->_op_usage('+', 'seconds', @_);
1937 my %op2condition = (
1938 '-' => sub { my($self, $column, $amount) = @_;
1939 $self->$column - $amount <= 0;
1941 '+' => sub { my($self, $column, $amount) = @_;
1942 ($self->$column || 0) + $amount > 0;
1945 my %op2warncondition = (
1946 '-' => sub { my($self, $column, $amount) = @_;
1947 my $threshold = $column . '_threshold';
1948 $self->$column - $amount <= $self->$threshold + 0;
1950 '+' => sub { my($self, $column, $amount) = @_;
1951 ($self->$column || 0) + $amount > 0;
1956 my( $self, $op, $column, $amount ) = @_;
1958 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
1959 ' ('. $self->email. "): $op $amount\n"
1962 return '' unless $amount;
1964 local $SIG{HUP} = 'IGNORE';
1965 local $SIG{INT} = 'IGNORE';
1966 local $SIG{QUIT} = 'IGNORE';
1967 local $SIG{TERM} = 'IGNORE';
1968 local $SIG{TSTP} = 'IGNORE';
1969 local $SIG{PIPE} = 'IGNORE';
1971 my $oldAutoCommit = $FS::UID::AutoCommit;
1972 local $FS::UID::AutoCommit = 0;
1975 my $sql = "UPDATE svc_acct SET $column = ".
1976 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
1977 " $op ? WHERE svcnum = ?";
1981 my $sth = $dbh->prepare( $sql )
1982 or die "Error preparing $sql: ". $dbh->errstr;
1983 my $rv = $sth->execute($amount, $self->svcnum);
1984 die "Error executing $sql: ". $sth->errstr
1985 unless defined($rv);
1986 die "Can't update $column for svcnum". $self->svcnum
1989 #$self->snapshot; #not necessary, we retain the old values
1990 #create an object with the updated usage values
1991 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
1993 my $error = $new->replace($self);
1995 $dbh->rollback if $oldAutoCommit;
1996 return "Error replacing: $error";
1999 #overlimit_action eq 'cancel' handling
2000 my $cust_pkg = $self->cust_svc->cust_pkg;
2002 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2003 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2007 my $error = $cust_pkg->cancel; #XXX should have a reason
2009 $dbh->rollback if $oldAutoCommit;
2010 return "Error cancelling: $error";
2013 #nothing else is relevant if we're cancelling, so commit & return success
2014 warn "$me update successful; committing\n"
2016 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2021 my $action = $op2action{$op};
2023 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2024 ( $action eq 'suspend' && !$self->overlimit
2025 || $action eq 'unsuspend' && $self->overlimit )
2028 my $error = $self->_op_overlimit($action);
2030 $dbh->rollback if $oldAutoCommit;
2036 if ( $conf->exists("svc_acct-usage_$action")
2037 && &{$op2condition{$op}}($self, $column, $amount) ) {
2038 #my $error = $self->$action();
2039 my $error = $self->cust_svc->cust_pkg->$action();
2040 # $error ||= $self->overlimit($action);
2042 $dbh->rollback if $oldAutoCommit;
2043 return "Error ${action}ing: $error";
2047 if ($warning_template && &{$op2warncondition{$op}}($self, $column, $amount)) {
2048 my $wqueue = new FS::queue {
2049 'svcnum' => $self->svcnum,
2050 'job' => 'FS::svc_acct::reached_threshold',
2055 $to = $warning_cc if &{$op2condition{$op}}($self, $column, $amount);
2059 my $error = $wqueue->insert(
2060 'svcnum' => $self->svcnum,
2062 'column' => $column,
2066 $dbh->rollback if $oldAutoCommit;
2067 return "Error queuing threshold activity: $error";
2071 warn "$me update successful; committing\n"
2073 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2079 my( $self, $action ) = @_;
2081 local $SIG{HUP} = 'IGNORE';
2082 local $SIG{INT} = 'IGNORE';
2083 local $SIG{QUIT} = 'IGNORE';
2084 local $SIG{TERM} = 'IGNORE';
2085 local $SIG{TSTP} = 'IGNORE';
2086 local $SIG{PIPE} = 'IGNORE';
2088 my $oldAutoCommit = $FS::UID::AutoCommit;
2089 local $FS::UID::AutoCommit = 0;
2092 my $cust_pkg = $self->cust_svc->cust_pkg;
2094 my $conf_overlimit =
2096 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2097 : $conf->config('overlimit_groups');
2099 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2101 my $groups = $conf_overlimit || $part_export->option('overlimit_groups');
2102 next unless $groups;
2104 my $gref = &{ $self->_fieldhandlers->{'usergroup'} }( $self, $groups );
2106 my $other = new FS::svc_acct $self->hashref;
2107 $other->usergroup( $gref );
2110 if ($action eq 'suspend') {
2113 } else { # $action eq 'unsuspend'
2118 my $error = $part_export->export_replace($new, $old)
2119 || $self->overlimit($action);
2122 $dbh->rollback if $oldAutoCommit;
2123 return "Error replacing radius groups: $error";
2128 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2134 my( $self, $valueref, %options ) = @_;
2136 warn "$me set_usage called for svcnum ". $self->svcnum.
2137 ' ('. $self->email. "): ".
2138 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2141 local $SIG{HUP} = 'IGNORE';
2142 local $SIG{INT} = 'IGNORE';
2143 local $SIG{QUIT} = 'IGNORE';
2144 local $SIG{TERM} = 'IGNORE';
2145 local $SIG{TSTP} = 'IGNORE';
2146 local $SIG{PIPE} = 'IGNORE';
2148 local $FS::svc_Common::noexport_hack = 1;
2149 my $oldAutoCommit = $FS::UID::AutoCommit;
2150 local $FS::UID::AutoCommit = 0;
2155 if ( $options{null} ) {
2156 %handyhash = ( map { ( $_ => 'NULL', $_."_threshold" => 'NULL' ) }
2157 qw( seconds upbytes downbytes totalbytes )
2160 foreach my $field (keys %$valueref){
2161 $reset = 1 if $valueref->{$field};
2162 $self->setfield($field, $valueref->{$field});
2163 $self->setfield( $field.'_threshold',
2164 int($self->getfield($field)
2165 * ( $conf->exists('svc_acct-usage_threshold')
2166 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2171 $handyhash{$field} = $self->getfield($field);
2172 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2174 #my $error = $self->replace; #NO! we avoid the call to ->check for
2175 #die $error if $error; #services not explicity changed via the UI
2177 my $sql = "UPDATE svc_acct SET " .
2178 join (',', map { "$_ = $handyhash{$_}" } (keys %handyhash) ).
2179 " WHERE svcnum = ". $self->svcnum;
2184 if (scalar(keys %handyhash)) {
2185 my $sth = $dbh->prepare( $sql )
2186 or die "Error preparing $sql: ". $dbh->errstr;
2187 my $rv = $sth->execute();
2188 die "Error executing $sql: ". $sth->errstr
2189 unless defined($rv);
2190 die "Can't update usage for svcnum ". $self->svcnum
2194 #$self->snapshot; #not necessary, we retain the old values
2195 #create an object with the updated usage values
2196 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2197 local($FS::Record::nowarn_identical) = 1;
2198 my $error = $new->replace($self); #call exports
2200 $dbh->rollback if $oldAutoCommit;
2201 return "Error replacing: $error";
2208 $error = $self->_op_overlimit('unsuspend')
2209 if $self->overlimit;;
2211 $error ||= $self->cust_svc->cust_pkg->unsuspend
2212 if $conf->exists("svc_acct-usage_unsuspend");
2215 $dbh->rollback if $oldAutoCommit;
2216 return "Error unsuspending: $error";
2221 warn "$me update successful; committing\n"
2223 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2229 =item recharge HASHREF
2231 Increments usage columns by the amount specified in HASHREF as
2232 column=>amount pairs.
2237 my ($self, $vhash) = @_;
2240 warn "[$me] recharge called on $self: ". Dumper($self).
2241 "\nwith vhash: ". Dumper($vhash);
2244 my $oldAutoCommit = $FS::UID::AutoCommit;
2245 local $FS::UID::AutoCommit = 0;
2249 foreach my $column (keys %$vhash){
2250 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2254 $dbh->rollback if $oldAutoCommit;
2256 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2261 =item is_rechargeable
2263 Returns true if this svc_account can be "recharged" and false otherwise.
2267 sub is_rechargable {
2269 $self->seconds ne ''
2270 || $self->upbytes ne ''
2271 || $self->downbytes ne ''
2272 || $self->totalbytes ne '';
2275 =item seconds_since TIMESTAMP
2277 Returns the number of seconds this account has been online since TIMESTAMP,
2278 according to the session monitor (see L<FS::Session>).
2280 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2281 L<Time::Local> and L<Date::Parse> for conversion functions.
2285 #note: POD here, implementation in FS::cust_svc
2288 $self->cust_svc->seconds_since(@_);
2291 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2293 Returns the numbers of seconds this account has been online between
2294 TIMESTAMP_START (inclusive) and TIMESTAMP_END (exclusive), according to an
2295 external SQL radacct table, specified via sqlradius export. Sessions which
2296 started in the specified range but are still open are counted from session
2297 start to the end of the range (unless they are over 1 day old, in which case
2298 they are presumed missing their stop record and not counted). Also, sessions
2299 which end in the range but started earlier are counted from the start of the
2300 range to session end. Finally, sessions which start before the range but end
2301 after are counted for the entire range.
2303 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2304 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2309 #note: POD here, implementation in FS::cust_svc
2310 sub seconds_since_sqlradacct {
2312 $self->cust_svc->seconds_since_sqlradacct(@_);
2315 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2317 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2318 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2319 TIMESTAMP_END (exclusive).
2321 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2322 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2327 #note: POD here, implementation in FS::cust_svc
2328 sub attribute_since_sqlradacct {
2330 $self->cust_svc->attribute_since_sqlradacct(@_);
2333 =item get_session_history TIMESTAMP_START TIMESTAMP_END
2335 Returns an array of hash references of this customers login history for the
2336 given time range. (document this better)
2340 sub get_session_history {
2342 $self->cust_svc->get_session_history(@_);
2345 =item last_login_text
2347 Returns text describing the time of last login.
2351 sub last_login_text {
2353 $self->last_login ? ctime($self->last_login) : 'unknown';
2356 =item get_cdrs TIMESTAMP_START TIMESTAMP_END [ 'OPTION' => 'VALUE ... ]
2361 my($self, $start, $end, %opt ) = @_;
2363 my $did = $self->username; #yup
2365 my $prefix = $opt{'default_prefix'}; #convergent.au '+61'
2367 my $for_update = $opt{'for_update'} ? 'FOR UPDATE' : '';
2369 #SELECT $for_update * FROM cdr
2370 # WHERE calldate >= $start #need a conversion
2371 # AND calldate < $end #ditto
2372 # AND ( charged_party = "$did"
2373 # OR charged_party = "$prefix$did" #if length($prefix);
2374 # OR ( ( charged_party IS NULL OR charged_party = '' )
2376 # ( src = "$did" OR src = "$prefix$did" ) # if length($prefix)
2379 # AND ( freesidestatus IS NULL OR freesidestatus = '' )
2382 if ( length($prefix) ) {
2384 " AND ( charged_party = '$did'
2385 OR charged_party = '$prefix$did'
2386 OR ( ( charged_party IS NULL OR charged_party = '' )
2388 ( src = '$did' OR src = '$prefix$did' )
2394 " AND ( charged_party = '$did'
2395 OR ( ( charged_party IS NULL OR charged_party = '' )
2405 'select' => "$for_update *",
2408 #( freesidestatus IS NULL OR freesidestatus = '' )
2409 'freesidestatus' => '',
2411 'extra_sql' => $charged_or_src,
2419 Returns all RADIUS groups for this account (see L<FS::radius_usergroup>).
2425 if ( $self->usergroup ) {
2426 confess "explicitly specified usergroup not an arrayref: ". $self->usergroup
2427 unless ref($self->usergroup) eq 'ARRAY';
2428 #when provisioning records, export callback runs in svc_Common.pm before
2429 #radius_usergroup records can be inserted...
2430 @{$self->usergroup};
2432 map { $_->groupname }
2433 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } );
2437 =item clone_suspended
2439 Constructor used by FS::part_export::_export_suspend fallback. Document
2444 sub clone_suspended {
2446 my %hash = $self->hash;
2447 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2448 new FS::svc_acct \%hash;
2451 =item clone_kludge_unsuspend
2453 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2458 sub clone_kludge_unsuspend {
2460 my %hash = $self->hash;
2461 $hash{_password} = '';
2462 new FS::svc_acct \%hash;
2465 =item check_password
2467 Checks the supplied password against the (possibly encrypted) password in the
2468 database. Returns true for a successful authentication, false for no match.
2470 Currently supported encryptions are: classic DES crypt() and MD5
2474 sub check_password {
2475 my($self, $check_password) = @_;
2477 #remove old-style SUSPENDED kludge, they should be allowed to login to
2478 #self-service and pay up
2479 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2481 if ( $self->_password_encoding eq 'ldap' ) {
2483 my $auth = from_rfc2307 Authen::Passphrase $self->_password;
2484 return $auth->match($check_password);
2486 } elsif ( $self->_password_encoding eq 'crypt' ) {
2488 my $auth = from_crypt Authen::Passphrase $self->_password;
2489 return $auth->match($check_password);
2491 } elsif ( $self->_password_encoding eq 'plain' ) {
2493 return $check_password eq $password;
2497 #XXX this could be replaced with Authen::Passphrase stuff
2499 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2501 } elsif ( length($password) < 13 ) { #plaintext
2502 $check_password eq $password;
2503 } elsif ( length($password) == 13 ) { #traditional DES crypt
2504 crypt($check_password, $password) eq $password;
2505 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2506 unix_md5_crypt($check_password, $password) eq $password;
2507 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2508 warn "Can't check password: Blowfish encryption not yet supported, ".
2509 "svcnum ". $self->svcnum. "\n";
2512 warn "Can't check password: Unrecognized encryption for svcnum ".
2513 $self->svcnum. "\n";
2521 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2523 Returns an encrypted password, either by passing through an encrypted password
2524 in the database or by encrypting a plaintext password from the database.
2526 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2527 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2528 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2529 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2530 encryption type is only used if the password is not already encrypted in the
2535 sub crypt_password {
2538 if ( $self->_password_encoding eq 'ldap' ) {
2540 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2543 #XXX this could be replaced with Authen::Passphrase stuff
2545 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2546 if ( $encryption eq 'crypt' ) {
2549 $saltset[int(rand(64))].$saltset[int(rand(64))]
2551 } elsif ( $encryption eq 'md5' ) {
2552 unix_md5_crypt( $self->_password );
2553 } elsif ( $encryption eq 'blowfish' ) {
2554 croak "unknown encryption method $encryption";
2556 croak "unknown encryption method $encryption";
2559 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2563 } elsif ( $self->_password_encoding eq 'crypt' ) {
2565 return $self->_password;
2567 } elsif ( $self->_password_encoding eq 'plain' ) {
2569 #XXX this could be replaced with Authen::Passphrase stuff
2571 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2572 if ( $encryption eq 'crypt' ) {
2575 $saltset[int(rand(64))].$saltset[int(rand(64))]
2577 } elsif ( $encryption eq 'md5' ) {
2578 unix_md5_crypt( $self->_password );
2579 } elsif ( $encryption eq 'blowfish' ) {
2580 croak "unknown encryption method $encryption";
2582 croak "unknown encryption method $encryption";
2587 if ( length($self->_password) == 13
2588 || $self->_password =~ /^\$(1|2a?)\$/
2589 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2595 #XXX this could be replaced with Authen::Passphrase stuff
2597 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2598 if ( $encryption eq 'crypt' ) {
2601 $saltset[int(rand(64))].$saltset[int(rand(64))]
2603 } elsif ( $encryption eq 'md5' ) {
2604 unix_md5_crypt( $self->_password );
2605 } elsif ( $encryption eq 'blowfish' ) {
2606 croak "unknown encryption method $encryption";
2608 croak "unknown encryption method $encryption";
2617 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2619 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2620 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2621 "{MD5}5426824942db4253f87a1009fd5d2d4".
2623 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2624 to work the same as the B</crypt_password> method.
2630 #eventually should check a "password-encoding" field
2632 if ( $self->_password_encoding eq 'ldap' ) {
2634 return $self->_password;
2636 } elsif ( $self->_password_encoding eq 'crypt' ) {
2638 if ( length($self->_password) == 13 ) { #crypt
2639 return '{CRYPT}'. $self->_password;
2640 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2642 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2643 # die "Blowfish encryption not supported in this context, svcnum ".
2644 # $self->svcnum. "\n";
2646 warn "encryption method not (yet?) supported in LDAP context";
2647 return '{CRYPT}*'; #unsupported, should not auth
2650 } elsif ( $self->_password_encoding eq 'plain' ) {
2652 return '{PLAIN}'. $self->_password;
2654 #return '{CLEARTEXT}'. $self->_password; #?
2658 if ( length($self->_password) == 13 ) { #crypt
2659 return '{CRYPT}'. $self->_password;
2660 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2662 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2663 warn "Blowfish encryption not supported in this context, svcnum ".
2664 $self->svcnum. "\n";
2667 #are these two necessary anymore?
2668 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2669 return '{SSHA}'. $1;
2670 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2671 return '{NS-MTA-MD5}'. $1;
2674 return '{PLAIN}'. $self->_password;
2676 #return '{CLEARTEXT}'. $self->_password; #?
2678 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2679 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2680 #if ( $encryption eq 'crypt' ) {
2681 # return '{CRYPT}'. crypt(
2683 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2685 #} elsif ( $encryption eq 'md5' ) {
2686 # unix_md5_crypt( $self->_password );
2687 #} elsif ( $encryption eq 'blowfish' ) {
2688 # croak "unknown encryption method $encryption";
2690 # croak "unknown encryption method $encryption";
2698 =item domain_slash_username
2700 Returns $domain/$username/
2704 sub domain_slash_username {
2706 $self->domain. '/'. $self->username. '/';
2709 =item virtual_maildir
2711 Returns $domain/maildirs/$username/
2715 sub virtual_maildir {
2717 $self->domain. '/maildirs/'. $self->username. '/';
2722 =head1 CLASS METHODS
2726 =item search HASHREF
2728 Class method which returns a qsearch hash expression to search for parameters
2729 specified in HASHREF. Valid parameters are
2743 Arrayref of pkgparts
2749 Arrayref of additional WHERE clauses, will be ANDed together.
2760 my ($class, $params) = @_;
2765 if ( $params->{'domain'} ) {
2766 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2767 #preserve previous behavior & bubble up an error if $svc_domain not found?
2768 push @where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2772 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2773 push @where, "domsvc = $1";
2777 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
2780 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2781 push @where, "agentnum = $1";
2785 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2786 push @where, "custnum = $1";
2790 if ( $params->{'pkgpart'} && scalar(@{ $params->{'pkgpart'} }) ) {
2791 #XXX untaint or sql quote
2793 'cust_pkg.pkgpart IN ('. join(',', @{ $params->{'pkgpart'} } ). ')';
2797 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2798 push @where, "popnum = $1";
2802 if ( $params->{'svcpart'} =~ /^(\d+)$/ ) {
2803 push @where, "svcpart = $1";
2807 # here is the agent virtualization
2808 #if ($params->{CurrentUser}) {
2810 # qsearchs('access_user', { username => $params->{CurrentUser} });
2812 # if ($access_user) {
2813 # push @where, $access_user->agentnums_sql('table'=>'cust_main');
2815 # push @where, "1=0";
2818 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
2819 'table' => 'cust_main',
2820 'null_right' => 'View/link unlinked services',
2824 push @where, @{ $params->{'where'} } if $params->{'where'};
2826 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2828 my $addl_from = ' LEFT JOIN cust_svc USING ( svcnum ) '.
2829 ' LEFT JOIN part_svc USING ( svcpart ) '.
2830 ' LEFT JOIN cust_pkg USING ( pkgnum ) '.
2831 ' LEFT JOIN cust_main USING ( custnum ) ';
2833 my $count_query = "SELECT COUNT(*) FROM svc_acct $addl_from $extra_sql";
2834 #if ( keys %svc_acct ) {
2835 # $count_query .= ' WHERE '.
2836 # join(' AND ', map "$_ = ". dbh->quote($svc_acct{$_}),
2842 'table' => 'svc_acct',
2843 'hashref' => {}, # \%svc_acct,
2844 'select' => join(', ',
2847 'cust_main.custnum',
2848 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
2850 'addl_from' => $addl_from,
2851 'extra_sql' => $extra_sql,
2852 'order_by' => $params->{'order_by'},
2853 'count_query' => $count_query,
2866 This is the FS::svc_acct job-queue-able version. It still uses
2867 FS::Misc::send_email under-the-hood.
2874 eval "use FS::Misc qw(send_email)";
2877 $opt{mimetype} ||= 'text/plain';
2878 $opt{mimetype} .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2880 my $error = send_email(
2881 'from' => $opt{from},
2883 'subject' => $opt{subject},
2884 'content-type' => $opt{mimetype},
2885 'body' => [ map "$_\n", split("\n", $opt{body}) ],
2887 die $error if $error;
2890 =item check_and_rebuild_fuzzyfiles
2894 sub check_and_rebuild_fuzzyfiles {
2895 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2896 -e "$dir/svc_acct.username"
2897 or &rebuild_fuzzyfiles;
2900 =item rebuild_fuzzyfiles
2904 sub rebuild_fuzzyfiles {
2906 use Fcntl qw(:flock);
2908 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2912 open(USERNAMELOCK,">>$dir/svc_acct.username")
2913 or die "can't open $dir/svc_acct.username: $!";
2914 flock(USERNAMELOCK,LOCK_EX)
2915 or die "can't lock $dir/svc_acct.username: $!";
2917 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2919 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2920 or die "can't open $dir/svc_acct.username.tmp: $!";
2921 print USERNAMECACHE join("\n", @all_username), "\n";
2922 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2924 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2934 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2935 open(USERNAMECACHE,"<$dir/svc_acct.username")
2936 or die "can't open $dir/svc_acct.username: $!";
2937 my @array = map { chomp; $_; } <USERNAMECACHE>;
2938 close USERNAMECACHE;
2942 =item append_fuzzyfiles USERNAME
2946 sub append_fuzzyfiles {
2947 my $username = shift;
2949 &check_and_rebuild_fuzzyfiles;
2951 use Fcntl qw(:flock);
2953 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2955 open(USERNAME,">>$dir/svc_acct.username")
2956 or die "can't open $dir/svc_acct.username: $!";
2957 flock(USERNAME,LOCK_EX)
2958 or die "can't lock $dir/svc_acct.username: $!";
2960 print USERNAME "$username\n";
2962 flock(USERNAME,LOCK_UN)
2963 or die "can't unlock $dir/svc_acct.username: $!";
2971 =item radius_usergroup_selector GROUPS_ARRAYREF [ SELECTNAME ]
2975 sub radius_usergroup_selector {
2976 my $sel_groups = shift;
2977 my %sel_groups = map { $_=>1 } @$sel_groups;
2979 my $selectname = shift || 'radius_usergroup';
2982 my $sth = $dbh->prepare(
2983 'SELECT DISTINCT(groupname) FROM radius_usergroup ORDER BY groupname'
2984 ) or die $dbh->errstr;
2985 $sth->execute() or die $sth->errstr;
2986 my @all_groups = map { $_->[0] } @{$sth->fetchall_arrayref};
2990 function ${selectname}_doadd(object) {
2991 var myvalue = object.${selectname}_add.value;
2992 var optionName = new Option(myvalue,myvalue,false,true);
2993 var length = object.$selectname.length;
2994 object.$selectname.options[length] = optionName;
2995 object.${selectname}_add.value = "";
2998 <SELECT MULTIPLE NAME="$selectname">
3001 foreach my $group ( @all_groups ) {
3002 $html .= qq(<OPTION VALUE="$group");
3003 if ( $sel_groups{$group} ) {
3004 $html .= ' SELECTED';
3005 $sel_groups{$group} = 0;
3007 $html .= ">$group</OPTION>\n";
3009 foreach my $group ( grep { $sel_groups{$_} } keys %sel_groups ) {
3010 $html .= qq(<OPTION VALUE="$group" SELECTED>$group</OPTION>\n);
3012 $html .= '</SELECT>';
3014 $html .= qq!<BR><INPUT TYPE="text" NAME="${selectname}_add">!.
3015 qq!<INPUT TYPE="button" VALUE="Add new group" onClick="${selectname}_doadd(this.form)">!;
3020 =item reached_threshold
3022 Performs some activities when svc_acct thresholds (such as number of seconds
3023 remaining) are reached.
3027 sub reached_threshold {
3030 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
3031 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
3033 if ( $opt{'op'} eq '+' ){
3034 $svc_acct->setfield( $opt{'column'}.'_threshold',
3035 int($svc_acct->getfield($opt{'column'})
3036 * ( $conf->exists('svc_acct-usage_threshold')
3037 ? $conf->config('svc_acct-usage_threshold')/100
3042 my $error = $svc_acct->replace;
3043 die $error if $error;
3044 }elsif ( $opt{'op'} eq '-' ){
3046 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
3047 return '' if ($threshold eq '' );
3049 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
3050 my $error = $svc_acct->replace;
3051 die $error if $error; # email next time, i guess
3053 if ( $warning_template ) {
3054 eval "use FS::Misc qw(send_email)";
3057 my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
3058 my $cust_main = $cust_pkg->cust_main;
3060 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ }
3061 $cust_main->invoicing_list,
3062 ($opt{'to'} ? $opt{'to'} : ())
3065 my $mimetype = $warning_mimetype;
3066 $mimetype .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
3068 my $body = $warning_template->fill_in( HASH => {
3069 'custnum' => $cust_main->custnum,
3070 'username' => $svc_acct->username,
3071 'password' => $svc_acct->_password,
3072 'first' => $cust_main->first,
3073 'last' => $cust_main->getfield('last'),
3074 'pkg' => $cust_pkg->part_pkg->pkg,
3075 'column' => $opt{'column'},
3076 'amount' => $opt{'column'} =~/bytes/
3077 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
3078 : $svc_acct->getfield($opt{'column'}),
3079 'threshold' => $opt{'column'} =~/bytes/
3080 ? FS::UI::bytecount::display_bytecount($threshold)
3085 my $error = send_email(
3086 'from' => $warning_from,
3088 'subject' => $warning_subject,
3089 'content-type' => $mimetype,
3090 'body' => [ map "$_\n", split("\n", $body) ],
3092 die $error if $error;
3095 die "unknown op: " . $opt{'op'};
3103 The $recref stuff in sub check should be cleaned up.
3105 The suspend, unsuspend and cancel methods update the database, but not the
3106 current object. This is probably a bug as it's unexpected and
3109 radius_usergroup_selector? putting web ui components in here? they should
3110 probably live somewhere else...
3112 insertion of RADIUS group stuff in insert could be done with child_objects now
3113 (would probably clean up export of them too)
3115 _op_usage and set_usage bypass the history... maybe they shouldn't
3119 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
3120 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
3121 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
3122 L<freeside-queued>), L<FS::svc_acct_pop>,
3123 schema.html from the base documentation.