2 use base qw( FS::svc_Domain_Mixin FS::svc_PBX_Mixin
3 FS::svc_CGP_Mixin FS::svc_CGPRule_Mixin
11 use vars qw( $DEBUG $me $conf $skip_fuzzyfiles
12 $dir_prefix @shells $usernamemin
13 $usernamemax $passwordmin $passwordmax
14 $username_ampersand $username_letter $username_letterfirst
15 $username_noperiod $username_nounderscore $username_nodash
16 $username_uppercase $username_percent $username_colon
17 $username_slash $username_equals $username_pound
19 $password_noampersand $password_noexclamation
20 $warning_template $warning_from $warning_subject $warning_mimetype
23 $radius_password $radius_ip
26 use Scalar::Util qw( blessed );
31 use Crypt::PasswdMD5 1.2;
32 use Digest::SHA 'sha1_base64';
33 use Digest::MD5 'md5_base64';
36 use Authen::Passphrase;
37 use FS::UID qw( datasrc driver_name );
39 use FS::Record qw( qsearch qsearchs fields dbh dbdef );
40 use FS::Msgcat qw(gettext);
41 use FS::UI::bytecount;
43 use FS::PagedSearch qw( psearch ); # XXX in v4, replace with FS::Cursor
47 use FS::cust_main_invoice;
52 use FS::radius_usergroup;
62 $me = '[FS::svc_acct]';
64 #ask FS::UID to run this stuff for us later
65 FS::UID->install_callback( sub {
67 $dir_prefix = $conf->config('home');
68 @shells = $conf->config('shells');
69 $usernamemin = $conf->config('usernamemin') || 2;
70 $usernamemax = $conf->config('usernamemax');
71 $passwordmin = $conf->config('passwordmin'); # || 6;
73 $passwordmin = ( defined($passwordmin) && $passwordmin =~ /\d+/ )
76 $passwordmax = $conf->config('passwordmax') || 8;
77 $username_letter = $conf->exists('username-letter');
78 $username_letterfirst = $conf->exists('username-letterfirst');
79 $username_noperiod = $conf->exists('username-noperiod');
80 $username_nounderscore = $conf->exists('username-nounderscore');
81 $username_nodash = $conf->exists('username-nodash');
82 $username_uppercase = $conf->exists('username-uppercase');
83 $username_ampersand = $conf->exists('username-ampersand');
84 $username_percent = $conf->exists('username-percent');
85 $username_colon = $conf->exists('username-colon');
86 $username_slash = $conf->exists('username-slash');
87 $username_equals = $conf->exists('username-equals');
88 $username_pound = $conf->exists('username-pound');
89 $username_exclamation = $conf->exists('username-exclamation');
90 $password_noampersand = $conf->exists('password-noexclamation');
91 $password_noexclamation = $conf->exists('password-noexclamation');
92 $dirhash = $conf->config('dirhash') || 0;
93 if ( $conf->exists('warning_email') ) {
94 $warning_template = new Text::Template (
96 SOURCE => [ map "$_\n", $conf->config('warning_email') ]
97 ) or warn "can't create warning email template: $Text::Template::ERROR";
98 $warning_from = $conf->config('warning_email-from'); # || 'your-isp-is-dum'
99 $warning_subject = $conf->config('warning_email-subject') || 'Warning';
100 $warning_mimetype = $conf->config('warning_email-mimetype') || 'text/plain';
101 $warning_cc = $conf->config('warning_email-cc');
103 $warning_template = '';
105 $warning_subject = '';
106 $warning_mimetype = '';
109 $smtpmachine = $conf->config('smtpmachine');
110 $radius_password = $conf->config('radius-password') || 'Password';
111 $radius_ip = $conf->config('radius-ip') || 'Framed-IP-Address';
112 @pw_set = ( 'A'..'Z' ) if $conf->exists('password-generated-allcaps');
116 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
117 @pw_set = ( 'a'..'z', 'A'..'Z', '0'..'9', '(', ')', '#', '.', ',' );
121 my ( $hashref, $cache ) = @_;
122 if ( $hashref->{'svc_acct_svcnum'} ) {
123 $self->{'_domsvc'} = FS::svc_domain->new( {
124 'svcnum' => $hashref->{'domsvc'},
125 'domain' => $hashref->{'svc_acct_domain'},
126 'catchall' => $hashref->{'svc_acct_catchall'},
133 FS::svc_acct - Object methods for svc_acct records
139 $record = new FS::svc_acct \%hash;
140 $record = new FS::svc_acct { 'column' => 'value' };
142 $error = $record->insert;
144 $error = $new_record->replace($old_record);
146 $error = $record->delete;
148 $error = $record->check;
150 $error = $record->suspend;
152 $error = $record->unsuspend;
154 $error = $record->cancel;
156 %hash = $record->radius;
158 %hash = $record->radius_reply;
160 %hash = $record->radius_check;
162 $domain = $record->domain;
164 $svc_domain = $record->svc_domain;
166 $email = $record->email;
168 $seconds_since = $record->seconds_since($timestamp);
172 An FS::svc_acct object represents an account. FS::svc_acct inherits from
173 FS::svc_Common. The following fields are currently supported:
179 Primary key (assigned automatcially for new accounts)
187 =item _password_encoding
189 plain, crypt, ldap (or empty for autodetection)
197 Point of presence (see L<FS::svc_acct_pop>)
209 set automatically if blank (and uid is not)
229 svcnum from svc_domain
233 Optional svcnum from svc_pbx
235 =item radius_I<Radius_Attribute>
237 I<Radius-Attribute> (reply)
239 =item rc_I<Radius_Attribute>
241 I<Radius-Attribute> (check)
251 Creates a new account. To add the account to the database, see L<"insert">.
258 'longname_plural' => 'Access accounts and mailboxes',
259 'sorts' => [ 'username', 'uid', 'seconds', 'last_login' ],
260 'display_weight' => 10,
261 'cancel_weight' => 50,
262 'ip_field' => 'slipip',
264 'dir' => 'Home directory',
267 def_info => 'set to fixed and blank for no UIDs',
270 'slipip' => 'IP address',
271 # 'popnum' => qq!<A HREF="$p/browse/svc_acct_pop.cgi/">POP number</A>!,
273 label => 'Access number',
275 select_table => 'svc_acct_pop',
276 select_key => 'popnum',
277 select_label => 'city',
283 disable_default => 1,
288 'password_selfchange' => { label => 'Password modification',
291 'password_recover' => { label => 'Password recovery',
295 label => 'Quota', #Mail storage limit
297 disable_inventory => 1,
300 label => 'File storage limit',
302 disable_inventory => 1,
305 label => 'Number of files limit',
307 disable_inventory => 1,
310 label => 'File size limit',
312 disable_inventory => 1,
314 '_password' => { label => 'Password',
319 def_info => 'when blank, defaults to UID',
324 def_info => 'set to blank for no shell tracking',
326 #select_list => [ $conf->config('shells') ],
327 select_list => [ $conf ? $conf->config('shells') : () ],
328 disable_inventory => 1,
331 'finger' => 'Real name', # (GECOS)',
335 select_table => 'svc_domain',
336 select_key => 'svcnum',
337 select_label => 'domain',
338 disable_inventory => 1,
341 'pbxsvc' => { label => 'PBX',
342 type => 'select-svc_pbx.html',
343 disable_inventory => 1,
344 disable_select => 1, #UI wonky, pry works otherwise
346 'sectornum' => 'Tower sector',
348 label => 'RADIUS groups',
349 type => 'select-radius_group.html',
350 disable_inventory => 1,
354 'seconds' => { label => 'Seconds',
355 label_sort => 'with Time Remaining',
357 disable_inventory => 1,
359 disable_part_svc_column => 1,
361 'upbytes' => { label => 'Upload',
363 disable_inventory => 1,
365 'format' => \&FS::UI::bytecount::display_bytecount,
366 'parse' => \&FS::UI::bytecount::parse_bytecount,
367 disable_part_svc_column => 1,
369 'downbytes' => { label => 'Download',
371 disable_inventory => 1,
373 'format' => \&FS::UI::bytecount::display_bytecount,
374 'parse' => \&FS::UI::bytecount::parse_bytecount,
375 disable_part_svc_column => 1,
377 'totalbytes'=> { label => 'Total up and download',
379 disable_inventory => 1,
381 'format' => \&FS::UI::bytecount::display_bytecount,
382 'parse' => \&FS::UI::bytecount::parse_bytecount,
383 disable_part_svc_column => 1,
385 'seconds_threshold' => { label => 'Seconds threshold',
387 disable_inventory => 1,
389 disable_part_svc_column => 1,
391 'upbytes_threshold' => { label => 'Upload threshold',
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 'downbytes_threshold' => { label => 'Download threshold',
401 disable_inventory => 1,
403 'format' => \&FS::UI::bytecount::display_bytecount,
404 'parse' => \&FS::UI::bytecount::parse_bytecount,
405 disable_part_svc_column => 1,
407 'totalbytes_threshold'=> { label => 'Total up and download threshold',
409 disable_inventory => 1,
411 'format' => \&FS::UI::bytecount::display_bytecount,
412 'parse' => \&FS::UI::bytecount::parse_bytecount,
413 disable_part_svc_column => 1,
416 label => 'Last login',
420 label => 'Last logout',
425 label => 'Communigate aliases',
427 disable_inventory => 1,
432 label => 'Communigate account type',
434 select_list => [qw( MultiMailbox TextMailbox MailDirMailbox AGrade BGrade CGrade )],
435 disable_inventory => 1,
438 'cgp_accessmodes' => {
439 label => 'Communigate enabled services',
440 type => 'communigate_pro-accessmodes',
441 disable_inventory => 1,
444 'cgp_rulesallowed' => {
445 label => 'Allowed mail rules',
447 select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ],
448 disable_inventory => 1,
451 'cgp_rpopallowed' => { label => 'RPOP modifications',
454 'cgp_mailtoall' => { label => 'Accepts mail to "all"',
457 'cgp_addmailtrailer' => { label => 'Add trailer to sent mail',
460 'cgp_archiveafter' => {
461 label => 'Archive messages after',
464 -2 => 'default(730 days)',
471 1209600 => '2 weeks',
472 2592000 => '30 days',
473 7776000 => '90 days',
474 15552000 => '180 days',
475 31536000 => '365 days',
476 63072000 => '730 days',
478 disable_inventory => 1,
484 'cgp_deletemode' => {
485 label => 'Communigate message delete method',
487 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
488 disable_inventory => 1,
491 'cgp_emptytrash' => {
492 label => 'Communigate on logout remove trash',
494 select_list => __PACKAGE__->cgp_emptytrash_values,
495 disable_inventory => 1,
499 label => 'Communigate language',
501 select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ],
502 disable_inventory => 1,
506 label => 'Communigate time zone',
508 select_list => __PACKAGE__->cgp_timezone_values,
509 disable_inventory => 1,
513 label => 'Communigate layout',
515 select_list => [ '', '***', 'GoldFleece', 'Skin2' ],
516 disable_inventory => 1,
519 'cgp_prontoskinname' => {
520 label => 'Communigate Pronto style',
522 select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ],
523 disable_inventory => 1,
526 'cgp_sendmdnmode' => {
527 label => 'Communigate send read receipts',
529 select_list => [ '', 'Never', 'Manually', 'Automatically' ],
530 disable_inventory => 1,
541 sub table { 'svc_acct'; }
543 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
546 shift->_lastlog('in', @_);
550 shift->_lastlog('out', @_);
554 my( $self, $op, $time ) = @_;
556 if ( defined($time) ) {
557 warn "$me last_log$op called on svcnum ". $self->svcnum.
558 ' ('. $self->email. "): $time\n"
563 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
567 my $sth = $dbh->prepare( $sql )
568 or die "Error preparing $sql: ". $dbh->errstr;
569 my $rv = $sth->execute($time, $self->svcnum);
570 die "Error executing $sql: ". $sth->errstr
572 die "Can't update last_log$op for svcnum". $self->svcnum
575 $self->{'Hash'}->{"last_log$op"} = $time;
577 $self->getfield("last_log$op");
581 =item search_sql STRING
583 Class method which returns an SQL fragment to search for the given string.
588 my( $class, $string ) = @_;
589 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
590 my( $username, $domain ) = ( $1, $2 );
591 my $q_username = dbh->quote($username);
592 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
594 "svc_acct.username = $q_username AND ( ".
595 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
600 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
602 $class->search_sql_field('slipip', $string ).
604 $class->search_sql_field('username', $string ).
607 $class->search_sql_field('username', $string);
611 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
613 Returns the "username@domain" string for this account.
615 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
625 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
627 Returns a longer string label for this acccount ("Real Name <username@domain>"
628 if available, or "username@domain").
630 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
637 my $label = $self->label(@_);
638 my $finger = $self->finger;
639 return $label unless $finger =~ /\S/;
640 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
641 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
645 =item insert [ , OPTION => VALUE ... ]
647 Adds this account to the database. If there is an error, returns the error,
648 otherwise returns false.
650 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
651 defined. An FS::cust_svc record will be created and inserted.
653 The additional field I<usergroup> can optionally be defined; if so it should
654 contain an arrayref of group names. See L<FS::radius_usergroup>.
656 The additional field I<child_objects> can optionally be defined; if so it
657 should contain an arrayref of FS::tablename objects. They will have their
658 svcnum fields set and will be inserted after this record, but before any
659 exports are run. Each element of the array can also optionally be a
660 two-element array reference containing the child object and the name of an
661 alternate field to be filled in with the newly-inserted svcnum, for example
662 C<[ $svc_forward, 'srcsvc' ]>
664 Currently available options are: I<depend_jobnum>
666 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
667 jobnums), all provisioning jobs will have a dependancy on the supplied
668 jobnum(s) (they will not run until the specific job(s) complete(s)).
670 (TODOC: L<FS::queue> and L<freeside-queued>)
672 (TODOC: new exports!)
681 warn "[$me] insert called on $self: ". Dumper($self).
682 "\nwith options: ". Dumper(%options);
685 local $SIG{HUP} = 'IGNORE';
686 local $SIG{INT} = 'IGNORE';
687 local $SIG{QUIT} = 'IGNORE';
688 local $SIG{TERM} = 'IGNORE';
689 local $SIG{TSTP} = 'IGNORE';
690 local $SIG{PIPE} = 'IGNORE';
692 my $oldAutoCommit = $FS::UID::AutoCommit;
693 local $FS::UID::AutoCommit = 0;
697 my $error = $self->SUPER::insert( # usergroup is here
698 'jobnums' => \@jobnums,
699 'child_objects' => $self->child_objects,
703 $dbh->rollback if $oldAutoCommit;
707 unless ( $skip_fuzzyfiles ) {
708 $error = $self->queue_fuzzyfiles_update;
710 $dbh->rollback if $oldAutoCommit;
711 return "updating fuzzy search cache: $error";
715 my $cust_pkg = $self->cust_svc->cust_pkg;
718 my $cust_main = $cust_pkg->cust_main;
719 my $agentnum = $cust_main->agentnum;
721 if ( $conf->exists('emailinvoiceautoalways')
722 || $conf->exists('emailinvoiceauto')
723 && ! $cust_main->invoicing_list_emailonly
725 my @invoicing_list = $cust_main->invoicing_list;
726 push @invoicing_list, $self->email;
727 $cust_main->invoicing_list(\@invoicing_list);
731 my @welcome_exclude_svcparts = $conf->config('svc_acct_welcome_exclude');
732 unless ( grep { $_ eq $self->svcpart } @welcome_exclude_svcparts ) {
734 my $msgnum = $conf->config('welcome_msgnum', $agentnum);
736 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
737 $error = $msg_template->send('cust_main' => $cust_main,
741 my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
742 = ('','','','','','');
744 if ( $conf->exists('welcome_email', $agentnum) ) {
745 $welcome_template = new Text::Template (
747 SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
748 ) or warn "can't create welcome email template: $Text::Template::ERROR";
749 $welcome_from = $conf->config('welcome_email-from', $agentnum);
750 # || 'your-isp-is-dum'
751 $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
753 $welcome_subject_template = new Text::Template (
755 SOURCE => $welcome_subject,
756 ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
757 $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
760 if ( $welcome_template ) {
761 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
765 'custnum' => $self->custnum,
766 'username' => $self->username,
767 'password' => $self->_password,
768 'first' => $cust_main->first,
769 'last' => $cust_main->getfield('last'),
770 'pkg' => $cust_pkg->part_pkg->pkg,
772 my $wqueue = new FS::queue {
773 'svcnum' => $self->svcnum,
774 'job' => 'FS::svc_acct::send_email'
776 my $error = $wqueue->insert(
778 'from' => $welcome_from,
779 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
780 'mimetype' => $welcome_mimetype,
781 'body' => $welcome_template->fill_in( HASH => \%hash, ),
784 $dbh->rollback if $oldAutoCommit;
785 return "error queuing welcome email: $error";
788 if ( $options{'depend_jobnum'} ) {
789 warn "$me depend_jobnum found; adding to welcome email dependancies"
791 if ( ref($options{'depend_jobnum'}) ) {
792 warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
793 "to welcome email dependancies"
795 push @jobnums, @{ $options{'depend_jobnum'} };
797 warn "$me adding job $options{'depend_jobnum'} ".
798 "to welcome email dependancies"
800 push @jobnums, $options{'depend_jobnum'};
804 foreach my $jobnum ( @jobnums ) {
805 my $error = $wqueue->depend_insert($jobnum);
807 $dbh->rollback if $oldAutoCommit;
808 return "error queuing welcome email job dependancy: $error";
814 } # if $welcome_template
819 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
823 # set usage fields and thresholds if unset but set in a package def
824 # AND the package already has a last bill date (otherwise they get double added)
825 sub preinsert_hook_first {
828 return '' unless $self->pkgnum;
830 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
831 return '' unless $cust_pkg && $cust_pkg->last_bill;
833 my $part_pkg = $cust_pkg->part_pkg;
834 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
836 my %values = $part_pkg->usage_valuehash;
837 my $multiplier = $conf->exists('svc_acct-usage_threshold')
838 ? 1 - $conf->config('svc_acct-usage_threshold')/100
839 : 0.20; #doesn't matter
841 foreach ( keys %values ) {
842 next if $self->getfield($_);
843 $self->setfield( $_, $values{$_} );
844 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
845 if $conf->exists('svc_acct-usage_threshold');
853 Deletes this account from the database. If there is an error, returns the
854 error, otherwise returns false.
856 The corresponding FS::cust_svc record will be deleted as well.
858 (TODOC: new exports!)
865 return "can't delete system account" if $self->_check_system;
867 return "Can't delete an account which is a (svc_forward) source!"
868 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
870 return "Can't delete an account which is a (svc_forward) destination!"
871 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
873 return "Can't delete an account with (svc_www) web service!"
874 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
876 # what about records in session ? (they should refer to history table)
878 local $SIG{HUP} = 'IGNORE';
879 local $SIG{INT} = 'IGNORE';
880 local $SIG{QUIT} = 'IGNORE';
881 local $SIG{TERM} = 'IGNORE';
882 local $SIG{TSTP} = 'IGNORE';
883 local $SIG{PIPE} = 'IGNORE';
885 my $oldAutoCommit = $FS::UID::AutoCommit;
886 local $FS::UID::AutoCommit = 0;
889 foreach my $cust_main_invoice (
890 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
892 unless ( defined($cust_main_invoice) ) {
893 warn "WARNING: something's wrong with qsearch";
896 my %hash = $cust_main_invoice->hash;
897 $hash{'dest'} = $self->email;
898 my $new = new FS::cust_main_invoice \%hash;
899 my $error = $new->replace($cust_main_invoice);
901 $dbh->rollback if $oldAutoCommit;
906 foreach my $svc_domain (
907 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
909 my %hash = new FS::svc_domain->hash;
910 $hash{'catchall'} = '';
911 my $new = new FS::svc_domain \%hash;
912 my $error = $new->replace($svc_domain);
914 $dbh->rollback if $oldAutoCommit;
919 my $error = $self->SUPER::delete; # usergroup here
921 $dbh->rollback if $oldAutoCommit;
925 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
929 =item replace OLD_RECORD
931 Replaces OLD_RECORD with this one in the database. If there is an error,
932 returns the error, otherwise returns false.
934 The additional field I<usergroup> can optionally be defined; if so it should
935 contain an arrayref of group names. See L<FS::radius_usergroup>.
943 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
947 warn "$me replacing $old with $new\n" if $DEBUG;
951 return "can't modify system account" if $old->_check_system;
954 #no warnings 'numeric'; #alas, a 5.006-ism
957 foreach my $xid (qw( uid gid )) {
959 return "Can't change $xid!"
960 if ! $conf->exists("svc_acct-edit_$xid")
961 && $old->$xid() != $new->$xid()
962 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
967 return "can't change username"
968 if $old->username ne $new->username
969 && $conf->exists('svc_acct-no_edit_username');
971 #change homdir when we change username
972 $new->setfield('dir', '') if $old->username ne $new->username;
974 local $SIG{HUP} = 'IGNORE';
975 local $SIG{INT} = 'IGNORE';
976 local $SIG{QUIT} = 'IGNORE';
977 local $SIG{TERM} = 'IGNORE';
978 local $SIG{TSTP} = 'IGNORE';
979 local $SIG{PIPE} = 'IGNORE';
981 my $oldAutoCommit = $FS::UID::AutoCommit;
982 local $FS::UID::AutoCommit = 0;
985 $error = $new->SUPER::replace($old, @_); # usergroup here
987 $dbh->rollback if $oldAutoCommit;
988 return $error if $error;
991 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
992 $error = $new->queue_fuzzyfiles_update;
994 $dbh->rollback if $oldAutoCommit;
995 return "updating fuzzy search cache: $error";
999 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1003 =item queue_fuzzyfiles_update
1005 Used by insert & replace to update the fuzzy search cache
1009 sub queue_fuzzyfiles_update {
1012 local $SIG{HUP} = 'IGNORE';
1013 local $SIG{INT} = 'IGNORE';
1014 local $SIG{QUIT} = 'IGNORE';
1015 local $SIG{TERM} = 'IGNORE';
1016 local $SIG{TSTP} = 'IGNORE';
1017 local $SIG{PIPE} = 'IGNORE';
1019 my $oldAutoCommit = $FS::UID::AutoCommit;
1020 local $FS::UID::AutoCommit = 0;
1023 my $queue = new FS::queue {
1024 'svcnum' => $self->svcnum,
1025 'job' => 'FS::svc_acct::append_fuzzyfiles'
1027 my $error = $queue->insert($self->username);
1029 $dbh->rollback if $oldAutoCommit;
1030 return "queueing job (transaction rolled back): $error";
1033 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1041 Suspends this account by calling export-specific suspend hooks. If there is
1042 an error, returns the error, otherwise returns false.
1044 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1050 return "can't suspend system account" if $self->_check_system;
1051 $self->SUPER::suspend(@_);
1056 Unsuspends this account by by calling export-specific suspend hooks. If there
1057 is an error, returns the error, otherwise returns false.
1059 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1065 my %hash = $self->hash;
1066 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1067 $hash{_password} = $1;
1068 my $new = new FS::svc_acct ( \%hash );
1069 my $error = $new->replace($self);
1070 return $error if $error;
1073 $self->SUPER::unsuspend(@_);
1078 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1080 If the B<auto_unset_catchall> configuration option is set, this method will
1081 automatically remove any references to the canceled service in the catchall
1082 field of svc_domain. This allows packages that contain both a svc_domain and
1083 its catchall svc_acct to be canceled in one step.
1088 # Only one thing to do at this level
1090 foreach my $svc_domain (
1091 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1092 if($conf->exists('auto_unset_catchall')) {
1093 my %hash = $svc_domain->hash;
1094 $hash{catchall} = '';
1095 my $new = new FS::svc_domain ( \%hash );
1096 my $error = $new->replace($svc_domain);
1097 return $error if $error;
1099 return "cannot unprovision svc_acct #".$self->svcnum.
1100 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1104 $self->SUPER::cancel(@_);
1110 Checks all fields to make sure this is a valid service. If there is an error,
1111 returns the error, otherwise returns false. Called by the insert and replace
1114 Sets any fixed values; see L<FS::part_svc>.
1121 my($recref) = $self->hashref;
1123 my $x = $self->setfixed;
1124 return $x unless ref($x);
1127 my $error = $self->ut_numbern('svcnum')
1128 #|| $self->ut_number('domsvc')
1129 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1130 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1131 || $self->ut_foreign_keyn('sectornum','tower_sector','sectornum')
1132 || $self->ut_foreign_keyn('routernum','router','routernum')
1133 || $self->ut_foreign_keyn('blocknum','addr_block','blocknum')
1134 || $self->ut_textn('sec_phrase')
1135 || $self->ut_snumbern('seconds')
1136 || $self->ut_snumbern('upbytes')
1137 || $self->ut_snumbern('downbytes')
1138 || $self->ut_snumbern('totalbytes')
1139 || $self->ut_snumbern('seconds_threshold')
1140 || $self->ut_snumbern('upbytes_threshold')
1141 || $self->ut_snumbern('downbytes_threshold')
1142 || $self->ut_snumbern('totalbytes_threshold')
1143 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1144 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1145 || $self->ut_enum('password_recover', [ '', 'Y' ])
1147 || $self->ut_anything('cf_privatekey')
1149 || $self->ut_textn('cgp_accessmodes')
1150 || $self->ut_alphan('cgp_type')
1151 || $self->ut_textn('cgp_aliases' ) #well
1153 || $self->ut_alphasn('cgp_rulesallowed')
1154 || $self->ut_enum('cgp_rpopallowed', [ '', 'Y' ])
1155 || $self->ut_enum('cgp_mailtoall', [ '', 'Y' ])
1156 || $self->ut_enum('cgp_addmailtrailer', [ '', 'Y' ])
1157 || $self->ut_snumbern('cgp_archiveafter')
1159 || $self->ut_alphasn('cgp_deletemode')
1160 || $self->ut_enum('cgp_emptytrash', $self->cgp_emptytrash_values)
1161 || $self->ut_alphan('cgp_language')
1162 || $self->ut_textn('cgp_timezone')
1163 || $self->ut_textn('cgp_skinname')
1164 || $self->ut_textn('cgp_prontoskinname')
1165 || $self->ut_alphan('cgp_sendmdnmode')
1167 return $error if $error;
1169 # assign IP address, etc.
1170 if ( $conf->exists('svc_acct-ip_addr') ) {
1171 my $error = $self->svc_ip_check;
1172 return $error if $error;
1173 } else { # I think this is correct
1174 $self->routernum('');
1175 $self->blocknum('');
1179 local $username_letter = $username_letter;
1180 local $username_uppercase = $username_uppercase;
1181 if ($self->svcnum) {
1182 my $cust_svc = $self->cust_svc
1183 or return "no cust_svc record found for svcnum ". $self->svcnum;
1184 my $cust_pkg = $cust_svc->cust_pkg;
1186 if ($self->pkgnum) {
1187 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1191 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1192 $username_uppercase =
1193 $conf->exists('username-uppercase', $cust_pkg->cust_main->agentnum);
1196 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1198 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:\/\=\#\!]{$usernamemin,$ulen})$/i
1199 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1200 $recref->{username} = $1;
1202 my $uerror = gettext('illegal_username'). ': '. $recref->{username};
1204 unless ( $username_uppercase ) {
1205 $recref->{username} =~ /[A-Z]/ and return $uerror;
1207 if ( $username_letterfirst ) {
1208 $recref->{username} =~ /^[a-z]/ or return $uerror;
1209 } elsif ( $username_letter ) {
1210 $recref->{username} =~ /[a-z]/ or return $uerror;
1212 if ( $username_noperiod ) {
1213 $recref->{username} =~ /\./ and return $uerror;
1215 if ( $username_nounderscore ) {
1216 $recref->{username} =~ /_/ and return $uerror;
1218 if ( $username_nodash ) {
1219 $recref->{username} =~ /\-/ and return $uerror;
1221 unless ( $username_ampersand ) {
1222 $recref->{username} =~ /\&/ and return $uerror;
1224 unless ( $username_percent ) {
1225 $recref->{username} =~ /\%/ and return $uerror;
1227 unless ( $username_colon ) {
1228 $recref->{username} =~ /\:/ and return $uerror;
1230 unless ( $username_slash ) {
1231 $recref->{username} =~ /\// and return $uerror;
1233 unless ( $username_equals ) {
1234 $recref->{username} =~ /\=/ and return $uerror;
1236 unless ( $username_pound ) {
1237 $recref->{username} =~ /\#/ and return $uerror;
1239 unless ( $username_exclamation ) {
1240 $recref->{username} =~ /\!/ and return $uerror;
1244 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1245 $recref->{popnum} = $1;
1246 return "Unknown popnum" unless
1247 ! $recref->{popnum} ||
1248 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1250 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1252 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1253 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1255 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1256 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1257 #not all systems use gid=uid
1258 #you can set a fixed gid in part_svc
1260 return "Only root can have uid 0"
1261 if $recref->{uid} == 0
1262 && $recref->{username} !~ /^(root|toor|smtp)$/;
1264 unless ( $recref->{username} eq 'sync' ) {
1265 if ( grep $_ eq $recref->{shell}, @shells ) {
1266 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1268 return "Illegal shell \`". $self->shell. "\'; ".
1269 "shells configuration value contains: @shells";
1272 $recref->{shell} = '/bin/sync';
1276 $recref->{gid} ne '' ?
1277 return "Can't have gid without uid" : ( $recref->{gid}='' );
1278 #$recref->{dir} ne '' ?
1279 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1280 $recref->{shell} ne '' ?
1281 return "Can't have shell without uid" : ( $recref->{shell}='' );
1284 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1286 $recref->{dir} =~ /^([\/\w\-\.\&\:\#]*)$/
1287 or return "Illegal directory: ". $recref->{dir};
1288 $recref->{dir} = $1;
1289 return "Illegal directory"
1290 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1291 return "Illegal directory"
1292 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1293 unless ( $recref->{dir} ) {
1294 $recref->{dir} = $dir_prefix . '/';
1295 if ( $dirhash > 0 ) {
1296 for my $h ( 1 .. $dirhash ) {
1297 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1299 } elsif ( $dirhash < 0 ) {
1300 for my $h ( reverse $dirhash .. -1 ) {
1301 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1304 $recref->{dir} .= $recref->{username};
1310 if ( $self->getfield('finger') eq '' ) {
1311 my $cust_pkg = $self->svcnum
1312 ? $self->cust_svc->cust_pkg
1313 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1315 my $cust_main = $cust_pkg->cust_main;
1316 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1319 # $error = $self->ut_textn('finger');
1320 # return $error if $error;
1321 $self->getfield('finger') =~ /^([\w \,\.\-\'\&\t\!\@\#\$\%\(\)\+\;\"\?\/\*\<\>]*)$/
1322 or return "Illegal finger: ". $self->getfield('finger');
1323 $self->setfield('finger', $1);
1325 for (qw( quota file_quota file_maxsize )) {
1326 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1329 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1330 $recref->{file_maxnum} = $1;
1332 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1333 if ( $recref->{slipip} eq '' ) {
1334 $recref->{slipip} = ''; # eh?
1335 } elsif ( $recref->{slipip} eq '0e0' ) {
1336 $recref->{slipip} = '0e0';
1338 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1339 or return "Illegal slipip: ". $self->slipip;
1340 $recref->{slipip} = $1;
1344 #arbitrary RADIUS stuff; allow ut_textn for now
1345 foreach ( grep /^radius_/, fields('svc_acct') ) {
1346 $self->ut_textn($_);
1349 # First, if _password is blank, generate one and set default encoding.
1350 if ( ! $recref->{_password} ) {
1351 $error = $self->set_password('');
1353 # But if there's a _password but no encoding, assume it's plaintext and
1354 # set it to default encoding.
1355 elsif ( ! $recref->{_password_encoding} ) {
1356 $error = $self->set_password($recref->{_password});
1358 return $error if $error;
1360 # Next, check _password to ensure compliance with the encoding.
1361 if ( $recref->{_password_encoding} eq 'ldap' ) {
1363 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1364 $recref->{_password} = uc($1).$2;
1366 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1369 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1371 if ( $recref->{_password} =~
1372 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1373 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1376 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1379 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1382 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1383 # Password randomization is now in set_password.
1384 # Strip whitespace characters, check length requirements, etc.
1385 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1386 $recref->{_password} = $1;
1388 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1389 FS::Msgcat::_gettext('illegal_password_characters').
1390 ": ". $recref->{_password};
1393 if ( $password_noampersand ) {
1394 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1396 if ( $password_noexclamation ) {
1397 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1401 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1404 $self->SUPER::check;
1409 sub _password_encryption {
1411 my $encoding = lc($self->_password_encoding);
1412 return if !$encoding;
1413 return 'plain' if $encoding eq 'plain';
1414 if($encoding eq 'crypt') {
1415 my $pass = $self->_password;
1416 $pass =~ s/^\*SUSPENDED\* //;
1418 return 'md5' if $pass =~ /^\$1\$/;
1419 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1420 return 'des' if length($pass) == 13;
1423 if($encoding eq 'ldap') {
1424 uc($self->_password) =~ /^\{([\w-]+)\}/;
1425 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1426 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1427 return 'md5' if $1 eq 'MD5';
1428 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1435 sub get_cleartext_password {
1437 if($self->_password_encryption eq 'plain') {
1438 if($self->_password_encoding eq 'ldap') {
1439 $self->_password =~ /\{\w+\}(.*)$/;
1443 return $self->_password;
1452 Set the cleartext password for the account. If _password_encoding is set, the
1453 new password will be encoded according to the existing method (including
1454 encryption mode, if it can be determined). Otherwise,
1455 config('default-password-encoding') is used.
1457 If no password is supplied (or a zero-length password when minimum password length
1458 is >0), one will be generated randomly.
1463 my( $self, $pass ) = ( shift, shift );
1465 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1468 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1469 FS::Msgcat::_gettext('illegal_password_characters').
1472 my( $encoding, $encryption ) = ('', '');
1474 if ( $self->_password_encoding ) {
1475 $encoding = $self->_password_encoding;
1476 # identify existing encryption method, try to use it.
1477 $encryption = $self->_password_encryption;
1479 # use the system default
1485 # set encoding to system default
1486 ($encoding, $encryption) =
1487 split(/-/, lc($conf->config('default-password-encoding') || ''));
1488 $encoding ||= 'legacy';
1489 $self->_password_encoding($encoding);
1492 if ( $encoding eq 'legacy' ) {
1494 # The legacy behavior from check():
1495 # If the password is blank, randomize it and set encoding to 'plain'.
1496 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1497 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1498 $self->_password_encoding('plain');
1500 # Prefix + valid-length password
1501 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1503 $self->_password_encoding('plain');
1504 # Prefix + crypt string
1505 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1507 $self->_password_encoding('crypt');
1508 # Various disabled crypt passwords
1509 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1510 $self->_password_encoding('crypt');
1516 $self->_password($pass);
1522 if $passwordmin && length($pass) < $passwordmin
1523 or $passwordmax && length($pass) > $passwordmax;
1525 if ( $encoding eq 'crypt' ) {
1526 if ($encryption eq 'md5') {
1527 $pass = unix_md5_crypt($pass);
1528 } elsif ($encryption eq 'des') {
1529 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1532 } elsif ( $encoding eq 'ldap' ) {
1533 if ($encryption eq 'md5') {
1534 $pass = md5_base64($pass);
1535 } elsif ($encryption eq 'sha1') {
1536 $pass = sha1_base64($pass);
1537 } elsif ($encryption eq 'crypt') {
1538 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1540 # else $encryption eq 'plain', do nothing
1541 $pass .= '=' x (4 - length($pass) % 4) #properly padded base64
1542 if $encryption eq 'md5' || $encryption eq 'sha1';
1543 $pass = '{'.uc($encryption).'}'.$pass;
1545 # else encoding eq 'plain'
1547 $self->_password($pass);
1553 Internal function to check the username against the list of system usernames
1554 from the I<system_usernames> configuration value. Returns true if the username
1555 is listed on the system username list.
1561 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1562 $conf->config('system_usernames')
1566 =item _check_duplicate
1568 Internal method to check for duplicates usernames, username@domain pairs and
1571 If the I<global_unique-username> configuration value is set to B<username> or
1572 B<username@domain>, enforces global username or username@domain uniqueness.
1574 In all cases, check for duplicate uids and usernames or username@domain pairs
1575 per export and with identical I<svcpart> values.
1579 sub _check_duplicate {
1582 my $global_unique = $conf->config('global_unique-username') || 'none';
1583 return '' if $global_unique eq 'disabled';
1587 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1588 unless ( $part_svc ) {
1589 return 'unknown svcpart '. $self->svcpart;
1592 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1593 qsearch( 'svc_acct', { 'username' => $self->username } );
1594 return gettext('username_in_use')
1595 if $global_unique eq 'username' && @dup_user;
1597 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1598 qsearch( 'svc_acct', { 'username' => $self->username,
1599 'domsvc' => $self->domsvc } );
1600 return gettext('username_in_use')
1601 if $global_unique eq 'username@domain' && @dup_userdomain;
1604 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1605 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1606 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1607 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1612 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1613 my $exports = FS::part_export::export_info('svc_acct');
1614 my %conflict_user_svcpart;
1615 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1617 foreach my $part_export ( $part_svc->part_export ) {
1619 #this will catch to the same exact export
1620 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1622 #this will catch to exports w/same exporthost+type ???
1623 #my @other_part_export = qsearch('part_export', {
1624 # 'machine' => $part_export->machine,
1625 # 'exporttype' => $part_export->exporttype,
1627 #foreach my $other_part_export ( @other_part_export ) {
1628 # push @svcparts, map { $_->svcpart }
1629 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1632 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1633 #silly kludge to avoid uninitialized value errors
1634 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1635 ? $exports->{$part_export->exporttype}{'nodomain'}
1637 if ( $nodomain =~ /^Y/i ) {
1638 $conflict_user_svcpart{$_} = $part_export->exportnum
1641 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1646 foreach my $dup_user ( @dup_user ) {
1647 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1648 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1649 return "duplicate username ". $self->username.
1650 ": conflicts with svcnum ". $dup_user->svcnum.
1651 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1655 foreach my $dup_userdomain ( @dup_userdomain ) {
1656 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1657 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1658 return "duplicate username\@domain ". $self->email.
1659 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1660 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1664 foreach my $dup_uid ( @dup_uid ) {
1665 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1666 if ( exists($conflict_user_svcpart{$dup_svcpart})
1667 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1668 return "duplicate uid ". $self->uid.
1669 ": conflicts with svcnum ". $dup_uid->svcnum.
1671 ( $conflict_user_svcpart{$dup_svcpart}
1672 || $conflict_userdomain_svcpart{$dup_svcpart} );
1684 Depriciated, use radius_reply instead.
1689 carp "FS::svc_acct::radius depriciated, use radius_reply";
1690 $_[0]->radius_reply;
1695 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1696 reply attributes of this record.
1698 Note that this is now the preferred method for reading RADIUS attributes -
1699 accessing the columns directly is discouraged, as the column names are
1700 expected to change in the future.
1707 return %{ $self->{'radius_reply'} }
1708 if exists $self->{'radius_reply'};
1713 my($column, $attrib) = ($1, $2);
1714 #$attrib =~ s/_/\-/g;
1715 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1716 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1718 if ( $self->slipip && $self->slipip ne '0e0' ) {
1719 $reply{$radius_ip} = $self->slipip;
1722 if ( $self->seconds !~ /^$/ ) {
1723 $reply{'Session-Timeout'} = $self->seconds;
1726 if ( $conf->exists('radius-chillispot-max') ) {
1727 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1729 #hmm. just because sqlradius.pm says so?
1736 foreach my $what (qw( input output total )) {
1737 my $is = $whatis{$what}.'bytes';
1738 if ( $self->$is() =~ /\d/ ) {
1739 my $big = new Math::BigInt $self->$is();
1740 $big = new Math::BigInt '0' if $big->is_neg();
1741 my $att = "Chillispot-Max-\u$what";
1742 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1743 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1754 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1755 check attributes of this record.
1757 Note that this is now the preferred method for reading RADIUS attributes -
1758 accessing the columns directly is discouraged, as the column names are
1759 expected to change in the future.
1766 return %{ $self->{'radius_check'} }
1767 if exists $self->{'radius_check'};
1772 my($column, $attrib) = ($1, $2);
1773 #$attrib =~ s/_/\-/g;
1774 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1775 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1778 my($pw_attrib, $password) = $self->radius_password;
1779 $check{$pw_attrib} = $password;
1781 my $cust_svc = $self->cust_svc;
1783 my $cust_pkg = $cust_svc->cust_pkg;
1784 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1785 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1788 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1789 "; can't set Expiration\n"
1797 =item radius_password
1799 Returns a key/value pair containing the RADIUS attribute name and value
1804 sub radius_password {
1808 if ( $self->_password_encoding eq 'ldap' ) {
1809 $pw_attrib = 'Password-With-Header';
1810 } elsif ( $self->_password_encoding eq 'crypt' ) {
1811 $pw_attrib = 'Crypt-Password';
1812 } elsif ( $self->_password_encoding eq 'plain' ) {
1813 $pw_attrib = $radius_password;
1815 $pw_attrib = length($self->_password) <= 12
1820 ($pw_attrib, $self->_password);
1826 This method instructs the object to "snapshot" or freeze RADIUS check and
1827 reply attributes to the current values.
1831 #bah, my english is too broken this morning
1832 #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
1833 #the FS::cust_pkg's replace method to trigger the correct export updates when
1834 #package dates change)
1839 $self->{$_} = { $self->$_() }
1840 foreach qw( radius_reply radius_check );
1844 =item forget_snapshot
1846 This methos instructs the object to forget any previously snapshotted
1847 RADIUS check and reply attributes.
1851 sub forget_snapshot {
1855 foreach qw( radius_reply radius_check );
1859 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1861 Returns the domain associated with this account.
1863 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1870 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1871 my $svc_domain = $self->svc_domain(@_)
1872 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1873 $svc_domain->domain;
1878 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1882 #inherited from svc_Common
1884 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1886 Returns an email address associated with the account.
1888 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1895 $self->username. '@'. $self->domain(@_);
1901 Returns an array of FS::acct_snarf records associated with the account.
1905 # unused as originally intended, but now by Communigate Pro "RPOP"
1907 =item cgp_rpop_hashref
1909 Returns an arrayref of RPOP data suitable for Communigate Pro API commands.
1913 sub cgp_rpop_hashref {
1915 { map { $_->snarfname => $_->cgp_hashref } $self->acct_snarf };
1918 =item decrement_upbytes OCTETS
1920 Decrements the I<upbytes> field of this record by the given amount. If there
1921 is an error, returns the error, otherwise returns false.
1925 sub decrement_upbytes {
1926 shift->_op_usage('-', 'upbytes', @_);
1929 =item increment_upbytes OCTETS
1931 Increments the I<upbytes> field of this record by the given amount. If there
1932 is an error, returns the error, otherwise returns false.
1936 sub increment_upbytes {
1937 shift->_op_usage('+', 'upbytes', @_);
1940 =item decrement_downbytes OCTETS
1942 Decrements the I<downbytes> field of this record by the given amount. If there
1943 is an error, returns the error, otherwise returns false.
1947 sub decrement_downbytes {
1948 shift->_op_usage('-', 'downbytes', @_);
1951 =item increment_downbytes OCTETS
1953 Increments the I<downbytes> field of this record by the given amount. If there
1954 is an error, returns the error, otherwise returns false.
1958 sub increment_downbytes {
1959 shift->_op_usage('+', 'downbytes', @_);
1962 =item decrement_totalbytes OCTETS
1964 Decrements the I<totalbytes> field of this record by the given amount. If there
1965 is an error, returns the error, otherwise returns false.
1969 sub decrement_totalbytes {
1970 shift->_op_usage('-', 'totalbytes', @_);
1973 =item increment_totalbytes OCTETS
1975 Increments the I<totalbytes> field of this record by the given amount. If there
1976 is an error, returns the error, otherwise returns false.
1980 sub increment_totalbytes {
1981 shift->_op_usage('+', 'totalbytes', @_);
1984 =item decrement_seconds SECONDS
1986 Decrements the I<seconds> field of this record by the given amount. If there
1987 is an error, returns the error, otherwise returns false.
1991 sub decrement_seconds {
1992 shift->_op_usage('-', 'seconds', @_);
1995 =item increment_seconds SECONDS
1997 Increments the I<seconds> field of this record by the given amount. If there
1998 is an error, returns the error, otherwise returns false.
2002 sub increment_seconds {
2003 shift->_op_usage('+', 'seconds', @_);
2011 my %op2condition = (
2012 '-' => sub { my($self, $column, $amount) = @_;
2013 $self->$column - $amount <= 0;
2015 '+' => sub { my($self, $column, $amount) = @_;
2016 ($self->$column || 0) + $amount > 0;
2019 my %op2warncondition = (
2020 '-' => sub { my($self, $column, $amount) = @_;
2021 my $threshold = $column . '_threshold';
2022 $self->$column - $amount <= $self->$threshold + 0;
2024 '+' => sub { my($self, $column, $amount) = @_;
2025 ($self->$column || 0) + $amount > 0;
2030 my( $self, $op, $column, $amount ) = @_;
2032 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
2033 ' ('. $self->email. "): $op $amount\n"
2036 return '' unless $amount;
2038 local $SIG{HUP} = 'IGNORE';
2039 local $SIG{INT} = 'IGNORE';
2040 local $SIG{QUIT} = 'IGNORE';
2041 local $SIG{TERM} = 'IGNORE';
2042 local $SIG{TSTP} = 'IGNORE';
2043 local $SIG{PIPE} = 'IGNORE';
2045 my $oldAutoCommit = $FS::UID::AutoCommit;
2046 local $FS::UID::AutoCommit = 0;
2049 my $sql = "UPDATE svc_acct SET $column = ".
2050 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
2051 " $op ? WHERE svcnum = ?";
2055 my $sth = $dbh->prepare( $sql )
2056 or die "Error preparing $sql: ". $dbh->errstr;
2057 my $rv = $sth->execute($amount, $self->svcnum);
2058 die "Error executing $sql: ". $sth->errstr
2059 unless defined($rv);
2060 die "Can't update $column for svcnum". $self->svcnum
2063 #$self->snapshot; #not necessary, we retain the old values
2064 #create an object with the updated usage values
2065 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2067 my $error = $new->replace($self);
2069 $dbh->rollback if $oldAutoCommit;
2070 return "Error replacing: $error";
2073 #overlimit_action eq 'cancel' handling
2074 my $cust_pkg = $self->cust_svc->cust_pkg;
2076 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2077 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2081 my $error = $cust_pkg->cancel; #XXX should have a reason
2083 $dbh->rollback if $oldAutoCommit;
2084 return "Error cancelling: $error";
2087 #nothing else is relevant if we're cancelling, so commit & return success
2088 warn "$me update successful; committing\n"
2090 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2095 my $action = $op2action{$op};
2097 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2098 ( $action eq 'suspend' && !$self->overlimit
2099 || $action eq 'unsuspend' && $self->overlimit )
2102 my $error = $self->_op_overlimit($action);
2104 $dbh->rollback if $oldAutoCommit;
2110 if ( $conf->exists("svc_acct-usage_$action")
2111 && &{$op2condition{$op}}($self, $column, $amount) ) {
2112 #my $error = $self->$action();
2113 my $error = $self->cust_svc->cust_pkg->$action();
2114 # $error ||= $self->overlimit($action);
2116 $dbh->rollback if $oldAutoCommit;
2117 return "Error ${action}ing: $error";
2121 if ($warning_template && &{$op2warncondition{$op}}($self, $column, $amount)) {
2122 my $wqueue = new FS::queue {
2123 'svcnum' => $self->svcnum,
2124 'job' => 'FS::svc_acct::reached_threshold',
2129 $to = $warning_cc if &{$op2condition{$op}}($self, $column, $amount);
2133 my $error = $wqueue->insert(
2134 'svcnum' => $self->svcnum,
2136 'column' => $column,
2140 $dbh->rollback if $oldAutoCommit;
2141 return "Error queuing threshold activity: $error";
2145 warn "$me update successful; committing\n"
2147 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2153 my( $self, $action ) = @_;
2155 local $SIG{HUP} = 'IGNORE';
2156 local $SIG{INT} = 'IGNORE';
2157 local $SIG{QUIT} = 'IGNORE';
2158 local $SIG{TERM} = 'IGNORE';
2159 local $SIG{TSTP} = 'IGNORE';
2160 local $SIG{PIPE} = 'IGNORE';
2162 my $oldAutoCommit = $FS::UID::AutoCommit;
2163 local $FS::UID::AutoCommit = 0;
2166 my $cust_pkg = $self->cust_svc->cust_pkg;
2168 my @conf_overlimit =
2170 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2171 : $conf->config('overlimit_groups');
2173 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2175 my @groups = scalar(@conf_overlimit) ? @conf_overlimit
2176 : split(' ',$part_export->option('overlimit_groups'));
2177 next unless scalar(@groups);
2179 my $other = new FS::svc_acct $self->hashref;
2180 $other->usergroup(\@groups);
2183 if ($action eq 'suspend') {
2186 } else { # $action eq 'unsuspend'
2191 my $error = $part_export->export_replace($new, $old)
2192 || $self->overlimit($action);
2195 $dbh->rollback if $oldAutoCommit;
2196 return "Error replacing radius groups: $error";
2201 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2207 my( $self, $valueref, %options ) = @_;
2209 warn "$me set_usage called for svcnum ". $self->svcnum.
2210 ' ('. $self->email. "): ".
2211 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2214 local $SIG{HUP} = 'IGNORE';
2215 local $SIG{INT} = 'IGNORE';
2216 local $SIG{QUIT} = 'IGNORE';
2217 local $SIG{TERM} = 'IGNORE';
2218 local $SIG{TSTP} = 'IGNORE';
2219 local $SIG{PIPE} = 'IGNORE';
2221 local $FS::svc_Common::noexport_hack = 1;
2222 my $oldAutoCommit = $FS::UID::AutoCommit;
2223 local $FS::UID::AutoCommit = 0;
2228 if ( $options{null} ) {
2229 %handyhash = ( map { ( $_ => undef, $_."_threshold" => undef ) }
2230 qw( seconds upbytes downbytes totalbytes )
2233 foreach my $field (keys %$valueref){
2234 $reset = 1 if $valueref->{$field};
2235 $self->setfield($field, $valueref->{$field});
2236 $self->setfield( $field.'_threshold',
2237 int($self->getfield($field)
2238 * ( $conf->exists('svc_acct-usage_threshold')
2239 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2244 $handyhash{$field} = $self->getfield($field);
2245 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2247 #my $error = $self->replace; #NO! we avoid the call to ->check for
2248 #die $error if $error; #services not explicity changed via the UI
2250 my $sql = "UPDATE svc_acct SET " .
2251 join (',', map { "$_ = ?" } (keys %handyhash) ).
2252 " WHERE svcnum = ". $self->svcnum;
2257 if (scalar(keys %handyhash)) {
2258 my $sth = $dbh->prepare( $sql )
2259 or die "Error preparing $sql: ". $dbh->errstr;
2260 my $rv = $sth->execute(values %handyhash);
2261 die "Error executing $sql: ". $sth->errstr
2262 unless defined($rv);
2263 die "Can't update usage for svcnum ". $self->svcnum
2267 #$self->snapshot; #not necessary, we retain the old values
2268 #create an object with the updated usage values
2269 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2270 local($FS::Record::nowarn_identical) = 1;
2271 my $error = $new->replace($self); #call exports
2273 $dbh->rollback if $oldAutoCommit;
2274 return "Error replacing: $error";
2281 $error = $self->_op_overlimit('unsuspend')
2282 if $self->overlimit;;
2284 $error ||= $self->cust_svc->cust_pkg->unsuspend
2285 if $conf->exists("svc_acct-usage_unsuspend");
2288 $dbh->rollback if $oldAutoCommit;
2289 return "Error unsuspending: $error";
2294 warn "$me update successful; committing\n"
2296 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2302 =item recharge HASHREF
2304 Increments usage columns by the amount specified in HASHREF as
2305 column=>amount pairs.
2310 my ($self, $vhash) = @_;
2313 warn "[$me] recharge called on $self: ". Dumper($self).
2314 "\nwith vhash: ". Dumper($vhash);
2317 my $oldAutoCommit = $FS::UID::AutoCommit;
2318 local $FS::UID::AutoCommit = 0;
2322 foreach my $column (keys %$vhash){
2323 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2327 $dbh->rollback if $oldAutoCommit;
2329 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2334 =item is_rechargeable
2336 Returns true if this svc_account can be "recharged" and false otherwise.
2340 sub is_rechargable {
2342 $self->seconds ne ''
2343 || $self->upbytes ne ''
2344 || $self->downbytes ne ''
2345 || $self->totalbytes ne '';
2348 =item seconds_since TIMESTAMP
2350 Returns the number of seconds this account has been online since TIMESTAMP,
2351 according to the session monitor (see L<FS::Session>).
2353 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2354 L<Time::Local> and L<Date::Parse> for conversion functions.
2358 #note: POD here, implementation in FS::cust_svc
2361 $self->cust_svc->seconds_since(@_);
2364 =item last_login_text
2366 Returns text describing the time of last login.
2370 sub last_login_text {
2372 $self->last_login ? ctime($self->last_login) : 'unknown';
2375 =item psearch_cdrs OPTIONS
2377 Returns a paged search (L<FS::PagedSearch>) for Call Detail Records
2378 associated with this service. For svc_acct, "associated with" means that
2379 either the "src" or the "charged_party" field of the CDR matches the
2380 "username" field of the service.
2385 my($self, %options) = @_;
2390 my $did = dbh->quote($self->username);
2392 my $prefix = $options{'default_prefix'} || ''; #convergent.au '+61'
2393 my $prefixdid = dbh->quote($prefix . $self->username);
2395 my $for_update = $options{'for_update'} ? 'FOR UPDATE' : '';
2397 if ( $options{inbound} ) {
2398 # these will be selected under their DIDs
2399 push @where, "FALSE";
2403 if (!$options{'disable_charged_party'}) {
2405 "charged_party = $did",
2406 "charged_party = $prefixdid";
2408 if (!$options{'disable_src'}) {
2410 "src = $did AND charged_party IS NULL",
2411 "src = $prefixdid AND charged_party IS NULL";
2413 push @where, '(' . join(' OR ', @orwhere) . ')';
2415 # $options{'status'} = '' is meaningful; for the rest of them it's not
2416 if ( exists $options{'status'} ) {
2417 $hash{'freesidestatus'} = $options{'status'};
2419 if ( $options{'cdrtypenum'} ) {
2420 $hash{'cdrtypenum'} = $options{'cdrtypenum'};
2422 if ( $options{'calltypenum'} ) {
2423 $hash{'calltypenum'} = $options{'calltypenum'};
2425 if ( $options{'begin'} ) {
2426 push @where, 'startdate >= '. $options{'begin'};
2428 if ( $options{'end'} ) {
2429 push @where, 'startdate < '. $options{'end'};
2431 if ( $options{'nonzero'} ) {
2432 push @where, 'duration > 0';
2435 my $extra_sql = join(' AND ', @where);
2438 $extra_sql = " AND ".$extra_sql;
2440 $extra_sql = " WHERE ".$extra_sql;
2446 'hashref' => \%hash,
2447 'extra_sql' => $extra_sql,
2448 'order_by' => "ORDER BY startdate $for_update",
2452 =item get_cdrs (DEPRECATED)
2454 Like psearch_cdrs, but returns all the L<FS::cdr> objects at once, in a
2455 single list. Arguments are the same as for psearch_cdrs.
2461 my $psearch = $self->psearch_cdrs(@_);
2462 qsearch ( $psearch->{query} )
2465 # sub radius_groups has moved to svc_Radius_Mixin
2467 =item clone_suspended
2469 Constructor used by FS::part_export::_export_suspend fallback. Document
2474 sub clone_suspended {
2476 my %hash = $self->hash;
2477 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2478 new FS::svc_acct \%hash;
2481 =item clone_kludge_unsuspend
2483 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2488 sub clone_kludge_unsuspend {
2490 my %hash = $self->hash;
2491 $hash{_password} = '';
2492 new FS::svc_acct \%hash;
2495 =item check_password
2497 Checks the supplied password against the (possibly encrypted) password in the
2498 database. Returns true for a successful authentication, false for no match.
2500 Currently supported encryptions are: classic DES crypt() and MD5
2504 sub check_password {
2505 my($self, $check_password) = @_;
2507 #remove old-style SUSPENDED kludge, they should be allowed to login to
2508 #self-service and pay up
2509 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2511 if ( $self->_password_encoding eq 'ldap' ) {
2513 $password =~ s/^{PLAIN}/{CLEARTEXT}/;
2514 my $auth = from_rfc2307 Authen::Passphrase $password;
2515 return $auth->match($check_password);
2517 } elsif ( $self->_password_encoding eq 'crypt' ) {
2519 my $auth = from_crypt Authen::Passphrase $self->_password;
2520 return $auth->match($check_password);
2522 } elsif ( $self->_password_encoding eq 'plain' ) {
2524 return $check_password eq $password;
2528 #XXX this could be replaced with Authen::Passphrase stuff
2530 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2532 } elsif ( length($password) < 13 ) { #plaintext
2533 $check_password eq $password;
2534 } elsif ( length($password) == 13 ) { #traditional DES crypt
2535 crypt($check_password, $password) eq $password;
2536 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2537 unix_md5_crypt($check_password, $password) eq $password;
2538 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2539 warn "Can't check password: Blowfish encryption not yet supported, ".
2540 "svcnum ". $self->svcnum. "\n";
2543 warn "Can't check password: Unrecognized encryption for svcnum ".
2544 $self->svcnum. "\n";
2552 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2554 Returns an encrypted password, either by passing through an encrypted password
2555 in the database or by encrypting a plaintext password from the database.
2557 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2558 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2559 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2560 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2561 encryption type is only used if the password is not already encrypted in the
2566 sub crypt_password {
2569 if ( $self->_password_encoding eq 'ldap' ) {
2571 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2574 #XXX this could be replaced with Authen::Passphrase stuff
2576 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2577 if ( $encryption eq 'crypt' ) {
2580 $saltset[int(rand(64))].$saltset[int(rand(64))]
2582 } elsif ( $encryption eq 'md5' ) {
2583 return unix_md5_crypt( $self->_password );
2584 } elsif ( $encryption eq 'blowfish' ) {
2585 croak "unknown encryption method $encryption";
2587 croak "unknown encryption method $encryption";
2590 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2594 } elsif ( $self->_password_encoding eq 'crypt' ) {
2596 return $self->_password;
2598 } elsif ( $self->_password_encoding eq 'plain' ) {
2600 #XXX this could be replaced with Authen::Passphrase stuff
2602 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2603 if ( $encryption eq 'crypt' ) {
2606 $saltset[int(rand(64))].$saltset[int(rand(64))]
2608 } elsif ( $encryption eq 'md5' ) {
2609 return unix_md5_crypt( $self->_password );
2610 } elsif ( $encryption eq 'sha1_base64' ) { #for acct_sql
2611 my $pass = sha1_base64( $self->_password );
2612 $pass .= '=' x (4 - length($pass) % 4); #properly padded base64
2614 } elsif ( $encryption eq 'blowfish' ) {
2615 croak "unknown encryption method $encryption";
2617 croak "unknown encryption method $encryption";
2622 if ( length($self->_password) == 13
2623 || $self->_password =~ /^\$(1|2a?)\$/
2624 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2630 #XXX this could be replaced with Authen::Passphrase stuff
2632 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2633 if ( $encryption eq 'crypt' ) {
2636 $saltset[int(rand(64))].$saltset[int(rand(64))]
2638 } elsif ( $encryption eq 'md5' ) {
2639 return unix_md5_crypt( $self->_password );
2640 } elsif ( $encryption eq 'blowfish' ) {
2641 croak "unknown encryption method $encryption";
2643 croak "unknown encryption method $encryption";
2652 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2654 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2655 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2656 "{MD5}5426824942db4253f87a1009fd5d2d4".
2658 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2659 to work the same as the B</crypt_password> method.
2665 #eventually should check a "password-encoding" field
2667 if ( $self->_password_encoding eq 'ldap' ) {
2669 return $self->_password;
2671 } elsif ( $self->_password_encoding eq 'crypt' ) {
2673 if ( length($self->_password) == 13 ) { #crypt
2674 return '{CRYPT}'. $self->_password;
2675 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2677 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2678 # die "Blowfish encryption not supported in this context, svcnum ".
2679 # $self->svcnum. "\n";
2681 warn "encryption method not (yet?) supported in LDAP context";
2682 return '{CRYPT}*'; #unsupported, should not auth
2685 } elsif ( $self->_password_encoding eq 'plain' ) {
2687 return '{PLAIN}'. $self->_password;
2689 #return '{CLEARTEXT}'. $self->_password; #?
2693 if ( length($self->_password) == 13 ) { #crypt
2694 return '{CRYPT}'. $self->_password;
2695 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2697 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2698 warn "Blowfish encryption not supported in this context, svcnum ".
2699 $self->svcnum. "\n";
2702 #are these two necessary anymore?
2703 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2704 return '{SSHA}'. $1;
2705 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2706 return '{NS-MTA-MD5}'. $1;
2709 return '{PLAIN}'. $self->_password;
2711 #return '{CLEARTEXT}'. $self->_password; #?
2713 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2714 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2715 #if ( $encryption eq 'crypt' ) {
2716 # return '{CRYPT}'. crypt(
2718 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2720 #} elsif ( $encryption eq 'md5' ) {
2721 # unix_md5_crypt( $self->_password );
2722 #} elsif ( $encryption eq 'blowfish' ) {
2723 # croak "unknown encryption method $encryption";
2725 # croak "unknown encryption method $encryption";
2733 =item domain_slash_username
2735 Returns $domain/$username/
2739 sub domain_slash_username {
2741 $self->domain. '/'. $self->username. '/';
2744 =item virtual_maildir
2746 Returns $domain/maildirs/$username/
2750 sub virtual_maildir {
2752 $self->domain. '/maildirs/'. $self->username. '/';
2757 =head1 CLASS METHODS
2761 =item search HASHREF
2763 Class method which returns a qsearch hash expression to search for parameters
2764 specified in HASHREF. Valid parameters are
2778 Arrayref of pkgparts
2784 Arrayref of additional WHERE clauses, will be ANDed together.
2795 my( $class, $params, $from, $where ) = @_;
2797 #these two should probably move to svc_Domain_Mixin ?
2800 if ( $params->{'domain'} ) {
2801 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2802 #preserve previous behavior & bubble up an error if $svc_domain not found?
2803 push @$where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2807 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2808 push @$where, "domsvc = $1";
2813 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2814 push @$where, "popnum = $1";
2818 #and these in svc_Tower_Mixin, or maybe we never should have done svc_acct
2819 # towers (or, as mark thought, never should have done svc_broadband)
2822 my @where_sector = $class->tower_sector_sql($params);
2823 if ( @where_sector ) {
2824 push @$where, @where_sector;
2825 push @$from, ' LEFT JOIN tower_sector USING ( sectornum )';
2838 This is the FS::svc_acct job-queue-able version. It still uses
2839 FS::Misc::send_email under-the-hood.
2846 eval "use FS::Misc qw(send_email)";
2849 $opt{mimetype} ||= 'text/plain';
2850 $opt{mimetype} .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2852 my $error = send_email(
2853 'from' => $opt{from},
2855 'subject' => $opt{subject},
2856 'content-type' => $opt{mimetype},
2857 'body' => [ map "$_\n", split("\n", $opt{body}) ],
2859 die $error if $error;
2862 =item check_and_rebuild_fuzzyfiles
2866 sub check_and_rebuild_fuzzyfiles {
2867 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2868 -e "$dir/svc_acct.username"
2869 or &rebuild_fuzzyfiles;
2872 =item rebuild_fuzzyfiles
2876 sub rebuild_fuzzyfiles {
2878 use Fcntl qw(:flock);
2880 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2884 open(USERNAMELOCK,">>$dir/svc_acct.username")
2885 or die "can't open $dir/svc_acct.username: $!";
2886 flock(USERNAMELOCK,LOCK_EX)
2887 or die "can't lock $dir/svc_acct.username: $!";
2889 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2891 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2892 or die "can't open $dir/svc_acct.username.tmp: $!";
2893 print USERNAMECACHE join("\n", @all_username), "\n";
2894 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2896 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2906 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2907 open(USERNAMECACHE,"<$dir/svc_acct.username")
2908 or die "can't open $dir/svc_acct.username: $!";
2909 my @array = map { chomp; $_; } <USERNAMECACHE>;
2910 close USERNAMECACHE;
2914 =item append_fuzzyfiles USERNAME
2918 sub append_fuzzyfiles {
2919 my $username = shift;
2921 &check_and_rebuild_fuzzyfiles;
2923 use Fcntl qw(:flock);
2925 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2927 open(USERNAME,">>$dir/svc_acct.username")
2928 or die "can't open $dir/svc_acct.username: $!";
2929 flock(USERNAME,LOCK_EX)
2930 or die "can't lock $dir/svc_acct.username: $!";
2932 print USERNAME "$username\n";
2934 flock(USERNAME,LOCK_UN)
2935 or die "can't unlock $dir/svc_acct.username: $!";
2942 =item reached_threshold
2944 Performs some activities when svc_acct thresholds (such as number of seconds
2945 remaining) are reached.
2949 sub reached_threshold {
2952 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
2953 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
2955 if ( $opt{'op'} eq '+' ){
2956 $svc_acct->setfield( $opt{'column'}.'_threshold',
2957 int($svc_acct->getfield($opt{'column'})
2958 * ( $conf->exists('svc_acct-usage_threshold')
2959 ? $conf->config('svc_acct-usage_threshold')/100
2964 my $error = $svc_acct->replace;
2965 die $error if $error;
2966 }elsif ( $opt{'op'} eq '-' ){
2968 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
2969 return '' if ($threshold eq '' );
2971 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
2972 my $error = $svc_acct->replace;
2973 die $error if $error; # email next time, i guess
2975 if ( $warning_template ) {
2976 eval "use FS::Misc qw(send_email)";
2979 my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
2980 my $cust_main = $cust_pkg->cust_main;
2982 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ }
2983 $cust_main->invoicing_list,
2984 ($opt{'to'} ? $opt{'to'} : ())
2987 my $mimetype = $warning_mimetype;
2988 $mimetype .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2990 my $body = $warning_template->fill_in( HASH => {
2991 'custnum' => $cust_main->custnum,
2992 'username' => $svc_acct->username,
2993 'password' => $svc_acct->_password,
2994 'first' => $cust_main->first,
2995 'last' => $cust_main->getfield('last'),
2996 'pkg' => $cust_pkg->part_pkg->pkg,
2997 'column' => $opt{'column'},
2998 'amount' => $opt{'column'} =~/bytes/
2999 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
3000 : $svc_acct->getfield($opt{'column'}),
3001 'threshold' => $opt{'column'} =~/bytes/
3002 ? FS::UI::bytecount::display_bytecount($threshold)
3007 my $error = send_email(
3008 'from' => $warning_from,
3010 'subject' => $warning_subject,
3011 'content-type' => $mimetype,
3012 'body' => [ map "$_\n", split("\n", $body) ],
3014 die $error if $error;
3017 die "unknown op: " . $opt{'op'};
3025 The $recref stuff in sub check should be cleaned up.
3027 The suspend, unsuspend and cancel methods update the database, but not the
3028 current object. This is probably a bug as it's unexpected and
3031 insertion of RADIUS group stuff in insert could be done with child_objects now
3032 (would probably clean up export of them too)
3034 _op_usage and set_usage bypass the history... maybe they shouldn't
3038 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
3039 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
3040 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
3041 L<freeside-queued>), L<FS::svc_acct_pop>,
3042 schema.html from the base documentation.