4 use base qw( FS::svc_Domain_Mixin
10 use vars qw( $DEBUG $me $conf $skip_fuzzyfiles
11 $dir_prefix @shells $usernamemin
12 $usernamemax $passwordmin $passwordmax
13 $username_ampersand $username_letter $username_letterfirst
14 $username_noperiod $username_nounderscore $username_nodash
15 $username_uppercase $username_percent $username_colon
16 $username_slash $username_equals $username_pound
17 $password_noampersand $password_noexclamation
18 $warning_template $warning_from $warning_subject $warning_mimetype
21 $radius_password $radius_ip
24 use Scalar::Util qw( blessed );
29 use Crypt::PasswdMD5 1.2;
30 use Digest::SHA 'sha1_base64';
31 use Digest::MD5 'md5_base64';
34 use Authen::Passphrase;
35 use FS::UID qw( datasrc driver_name );
37 use FS::Record qw( qsearch qsearchs fields dbh dbdef );
38 use FS::Msgcat qw(gettext);
39 use FS::UI::bytecount;
44 use FS::cust_main_invoice;
49 use FS::radius_usergroup;
60 $me = '[FS::svc_acct]';
62 #ask FS::UID to run this stuff for us later
63 FS::UID->install_callback( sub {
65 $dir_prefix = $conf->config('home');
66 @shells = $conf->config('shells');
67 $usernamemin = $conf->config('usernamemin') || 2;
68 $usernamemax = $conf->config('usernamemax');
69 $passwordmin = $conf->config('passwordmin'); # || 6;
71 $passwordmin = ( defined($passwordmin) && $passwordmin =~ /\d+/ )
74 $passwordmax = $conf->config('passwordmax') || 8;
75 $username_letter = $conf->exists('username-letter');
76 $username_letterfirst = $conf->exists('username-letterfirst');
77 $username_noperiod = $conf->exists('username-noperiod');
78 $username_nounderscore = $conf->exists('username-nounderscore');
79 $username_nodash = $conf->exists('username-nodash');
80 $username_uppercase = $conf->exists('username-uppercase');
81 $username_ampersand = $conf->exists('username-ampersand');
82 $username_percent = $conf->exists('username-percent');
83 $username_colon = $conf->exists('username-colon');
84 $username_slash = $conf->exists('username-slash');
85 $username_equals = $conf->exists('username-equals');
86 $username_pound = $conf->exists('username-pound');
87 $password_noampersand = $conf->exists('password-noexclamation');
88 $password_noexclamation = $conf->exists('password-noexclamation');
89 $dirhash = $conf->config('dirhash') || 0;
90 if ( $conf->exists('warning_email') ) {
91 $warning_template = new Text::Template (
93 SOURCE => [ map "$_\n", $conf->config('warning_email') ]
94 ) or warn "can't create warning email template: $Text::Template::ERROR";
95 $warning_from = $conf->config('warning_email-from'); # || 'your-isp-is-dum'
96 $warning_subject = $conf->config('warning_email-subject') || 'Warning';
97 $warning_mimetype = $conf->config('warning_email-mimetype') || 'text/plain';
98 $warning_cc = $conf->config('warning_email-cc');
100 $warning_template = '';
102 $warning_subject = '';
103 $warning_mimetype = '';
106 $smtpmachine = $conf->config('smtpmachine');
107 $radius_password = $conf->config('radius-password') || 'Password';
108 $radius_ip = $conf->config('radius-ip') || 'Framed-IP-Address';
109 @pw_set = ( 'A'..'Z' ) if $conf->exists('password-generated-allcaps');
113 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
114 @pw_set = ( 'a'..'z', 'A'..'Z', '0'..'9', '(', ')', '#', '.', ',' );
118 my ( $hashref, $cache ) = @_;
119 if ( $hashref->{'svc_acct_svcnum'} ) {
120 $self->{'_domsvc'} = FS::svc_domain->new( {
121 'svcnum' => $hashref->{'domsvc'},
122 'domain' => $hashref->{'svc_acct_domain'},
123 'catchall' => $hashref->{'svc_acct_catchall'},
130 FS::svc_acct - Object methods for svc_acct records
136 $record = new FS::svc_acct \%hash;
137 $record = new FS::svc_acct { 'column' => 'value' };
139 $error = $record->insert;
141 $error = $new_record->replace($old_record);
143 $error = $record->delete;
145 $error = $record->check;
147 $error = $record->suspend;
149 $error = $record->unsuspend;
151 $error = $record->cancel;
153 %hash = $record->radius;
155 %hash = $record->radius_reply;
157 %hash = $record->radius_check;
159 $domain = $record->domain;
161 $svc_domain = $record->svc_domain;
163 $email = $record->email;
165 $seconds_since = $record->seconds_since($timestamp);
169 An FS::svc_acct object represents an account. FS::svc_acct inherits from
170 FS::svc_Common. The following fields are currently supported:
176 Primary key (assigned automatcially for new accounts)
184 =item _password_encoding
186 plain, crypt, ldap (or empty for autodetection)
194 Point of presence (see L<FS::svc_acct_pop>)
206 set automatically if blank (and uid is not)
226 svcnum from svc_domain
230 Optional svcnum from svc_pbx
232 =item radius_I<Radius_Attribute>
234 I<Radius-Attribute> (reply)
236 =item rc_I<Radius_Attribute>
238 I<Radius-Attribute> (check)
248 Creates a new account. To add the account to the database, see L<"insert">.
255 'longname_plural' => 'Access accounts and mailboxes',
256 'sorts' => [ 'username', 'uid', 'seconds', 'last_login' ],
257 'display_weight' => 10,
258 'cancel_weight' => 50,
259 'ip_field' => 'slipip',
261 'dir' => 'Home directory',
264 def_info => 'set to fixed and blank for no UIDs',
267 'slipip' => 'IP address',
268 # 'popnum' => qq!<A HREF="$p/browse/svc_acct_pop.cgi/">POP number</A>!,
270 label => 'Access number',
272 select_table => 'svc_acct_pop',
273 select_key => 'popnum',
274 select_label => 'city',
280 disable_default => 1,
284 'password_selfchange' => { label => 'Password modification',
287 'password_recover' => { label => 'Password recovery',
291 label => 'Quota', #Mail storage limit
293 disable_inventory => 1,
297 label => 'File storage limit',
299 disable_inventory => 1,
303 label => 'Number of files limit',
305 disable_inventory => 1,
309 label => 'File size limit',
311 disable_inventory => 1,
314 '_password' => 'Password',
317 def_info => 'when blank, defaults to UID',
322 def_info => 'set to blank for no shell tracking',
324 #select_list => [ $conf->config('shells') ],
325 select_list => [ $conf ? $conf->config('shells') : () ],
326 disable_inventory => 1,
329 'finger' => 'Real name', # (GECOS)',
333 select_table => 'svc_domain',
334 select_key => 'svcnum',
335 select_label => 'domain',
336 disable_inventory => 1,
338 'pbxsvc' => { label => 'PBX',
339 type => 'select-svc_pbx.html',
340 disable_inventory => 1,
341 disable_select => 1, #UI wonky, pry works otherwise
343 'sectornum' => 'Tower sector',
345 label => 'RADIUS groups',
346 type => 'select-radius_group.html',
347 disable_inventory => 1,
351 'seconds' => { label => 'Seconds',
352 label_sort => 'with Time Remaining',
354 disable_inventory => 1,
356 disable_part_svc_column => 1,
358 'upbytes' => { label => 'Upload',
360 disable_inventory => 1,
362 'format' => \&FS::UI::bytecount::display_bytecount,
363 'parse' => \&FS::UI::bytecount::parse_bytecount,
364 disable_part_svc_column => 1,
366 'downbytes' => { label => 'Download',
368 disable_inventory => 1,
370 'format' => \&FS::UI::bytecount::display_bytecount,
371 'parse' => \&FS::UI::bytecount::parse_bytecount,
372 disable_part_svc_column => 1,
374 'totalbytes'=> { label => 'Total up and download',
376 disable_inventory => 1,
378 'format' => \&FS::UI::bytecount::display_bytecount,
379 'parse' => \&FS::UI::bytecount::parse_bytecount,
380 disable_part_svc_column => 1,
382 'seconds_threshold' => { label => 'Seconds threshold',
384 disable_inventory => 1,
386 disable_part_svc_column => 1,
388 'upbytes_threshold' => { label => 'Upload threshold',
390 disable_inventory => 1,
392 'format' => \&FS::UI::bytecount::display_bytecount,
393 'parse' => \&FS::UI::bytecount::parse_bytecount,
394 disable_part_svc_column => 1,
396 'downbytes_threshold' => { label => 'Download threshold',
398 disable_inventory => 1,
400 'format' => \&FS::UI::bytecount::display_bytecount,
401 'parse' => \&FS::UI::bytecount::parse_bytecount,
402 disable_part_svc_column => 1,
404 'totalbytes_threshold'=> { label => 'Total up and download threshold',
406 disable_inventory => 1,
408 'format' => \&FS::UI::bytecount::display_bytecount,
409 'parse' => \&FS::UI::bytecount::parse_bytecount,
410 disable_part_svc_column => 1,
413 label => 'Last login',
417 label => 'Last logout',
422 label => 'Communigate aliases',
424 disable_inventory => 1,
429 label => 'Communigate account type',
431 select_list => [qw( MultiMailbox TextMailbox MailDirMailbox AGrade BGrade CGrade )],
432 disable_inventory => 1,
435 'cgp_accessmodes' => {
436 label => 'Communigate enabled services',
437 type => 'communigate_pro-accessmodes',
438 disable_inventory => 1,
441 'cgp_rulesallowed' => {
442 label => 'Allowed mail rules',
444 select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ],
445 disable_inventory => 1,
448 'cgp_rpopallowed' => { label => 'RPOP modifications',
451 'cgp_mailtoall' => { label => 'Accepts mail to "all"',
454 'cgp_addmailtrailer' => { label => 'Add trailer to sent mail',
457 'cgp_archiveafter' => {
458 label => 'Archive messages after',
461 -2 => 'default(730 days)',
468 1209600 => '2 weeks',
469 2592000 => '30 days',
470 7776000 => '90 days',
471 15552000 => '180 days',
472 31536000 => '365 days',
473 63072000 => '730 days',
475 disable_inventory => 1,
481 'cgp_deletemode' => {
482 label => 'Communigate message delete method',
484 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
485 disable_inventory => 1,
488 'cgp_emptytrash' => {
489 label => 'Communigate on logout remove trash',
491 select_list => __PACKAGE__->cgp_emptytrash_values,
492 disable_inventory => 1,
496 label => 'Communigate language',
498 select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ],
499 disable_inventory => 1,
503 label => 'Communigate time zone',
505 select_list => __PACKAGE__->cgp_timezone_values,
506 disable_inventory => 1,
510 label => 'Communigate layout',
512 select_list => [ '', '***', 'GoldFleece', 'Skin2' ],
513 disable_inventory => 1,
516 'cgp_prontoskinname' => {
517 label => 'Communigate Pronto style',
519 select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ],
520 disable_inventory => 1,
523 'cgp_sendmdnmode' => {
524 label => 'Communigate send read receipts',
526 select_list => [ '', 'Never', 'Manually', 'Automatically' ],
527 disable_inventory => 1,
538 sub table { 'svc_acct'; }
540 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
543 shift->_lastlog('in', @_);
547 shift->_lastlog('out', @_);
551 my( $self, $op, $time ) = @_;
553 if ( defined($time) ) {
554 warn "$me last_log$op called on svcnum ". $self->svcnum.
555 ' ('. $self->email. "): $time\n"
560 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
564 my $sth = $dbh->prepare( $sql )
565 or die "Error preparing $sql: ". $dbh->errstr;
566 my $rv = $sth->execute($time, $self->svcnum);
567 die "Error executing $sql: ". $sth->errstr
569 die "Can't update last_log$op for svcnum". $self->svcnum
572 $self->{'Hash'}->{"last_log$op"} = $time;
574 $self->getfield("last_log$op");
578 =item search_sql STRING
580 Class method which returns an SQL fragment to search for the given string.
585 my( $class, $string ) = @_;
586 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
587 my( $username, $domain ) = ( $1, $2 );
588 my $q_username = dbh->quote($username);
589 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
591 "svc_acct.username = $q_username AND ( ".
592 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
597 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
599 $class->search_sql_field('slipip', $string ).
601 $class->search_sql_field('username', $string ).
604 $class->search_sql_field('username', $string);
608 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
610 Returns the "username@domain" string for this account.
612 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
622 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
624 Returns a longer string label for this acccount ("Real Name <username@domain>"
625 if available, or "username@domain").
627 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
634 my $label = $self->label(@_);
635 my $finger = $self->finger;
636 return $label unless $finger =~ /\S/;
637 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
638 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
642 =item insert [ , OPTION => VALUE ... ]
644 Adds this account to the database. If there is an error, returns the error,
645 otherwise returns false.
647 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
648 defined. An FS::cust_svc record will be created and inserted.
650 The additional field I<usergroup> can optionally be defined; if so it should
651 contain an arrayref of group names. See L<FS::radius_usergroup>.
653 The additional field I<child_objects> can optionally be defined; if so it
654 should contain an arrayref of FS::tablename objects. They will have their
655 svcnum fields set and will be inserted after this record, but before any
656 exports are run. Each element of the array can also optionally be a
657 two-element array reference containing the child object and the name of an
658 alternate field to be filled in with the newly-inserted svcnum, for example
659 C<[ $svc_forward, 'srcsvc' ]>
661 Currently available options are: I<depend_jobnum>
663 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
664 jobnums), all provisioning jobs will have a dependancy on the supplied
665 jobnum(s) (they will not run until the specific job(s) complete(s)).
667 (TODOC: L<FS::queue> and L<freeside-queued>)
669 (TODOC: new exports!)
678 warn "[$me] insert called on $self: ". Dumper($self).
679 "\nwith options: ". Dumper(%options);
682 local $SIG{HUP} = 'IGNORE';
683 local $SIG{INT} = 'IGNORE';
684 local $SIG{QUIT} = 'IGNORE';
685 local $SIG{TERM} = 'IGNORE';
686 local $SIG{TSTP} = 'IGNORE';
687 local $SIG{PIPE} = 'IGNORE';
689 my $oldAutoCommit = $FS::UID::AutoCommit;
690 local $FS::UID::AutoCommit = 0;
694 my $error = $self->SUPER::insert( # usergroup is here
695 'jobnums' => \@jobnums,
696 'child_objects' => $self->child_objects,
700 $dbh->rollback if $oldAutoCommit;
704 unless ( $skip_fuzzyfiles ) {
705 $error = $self->queue_fuzzyfiles_update;
707 $dbh->rollback if $oldAutoCommit;
708 return "updating fuzzy search cache: $error";
712 my $cust_pkg = $self->cust_svc->cust_pkg;
715 my $cust_main = $cust_pkg->cust_main;
716 my $agentnum = $cust_main->agentnum;
718 if ( $conf->exists('emailinvoiceautoalways')
719 || $conf->exists('emailinvoiceauto')
720 && ! $cust_main->invoicing_list_emailonly
722 my @invoicing_list = $cust_main->invoicing_list;
723 push @invoicing_list, $self->email;
724 $cust_main->invoicing_list(\@invoicing_list);
728 my @welcome_exclude_svcparts = $conf->config('svc_acct_welcome_exclude');
729 unless ( grep { $_ eq $self->svcpart } @welcome_exclude_svcparts ) {
731 my $msgnum = $conf->config('welcome_msgnum', $agentnum);
733 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
734 $error = $msg_template->send('cust_main' => $cust_main,
738 my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
739 = ('','','','','','');
741 if ( $conf->exists('welcome_email', $agentnum) ) {
742 $welcome_template = new Text::Template (
744 SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
745 ) or warn "can't create welcome email template: $Text::Template::ERROR";
746 $welcome_from = $conf->config('welcome_email-from', $agentnum);
747 # || 'your-isp-is-dum'
748 $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
750 $welcome_subject_template = new Text::Template (
752 SOURCE => $welcome_subject,
753 ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
754 $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
757 if ( $welcome_template ) {
758 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
762 'custnum' => $self->custnum,
763 'username' => $self->username,
764 'password' => $self->_password,
765 'first' => $cust_main->first,
766 'last' => $cust_main->getfield('last'),
767 'pkg' => $cust_pkg->part_pkg->pkg,
769 my $wqueue = new FS::queue {
770 'svcnum' => $self->svcnum,
771 'job' => 'FS::svc_acct::send_email'
773 my $error = $wqueue->insert(
775 'from' => $welcome_from,
776 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
777 'mimetype' => $welcome_mimetype,
778 'body' => $welcome_template->fill_in( HASH => \%hash, ),
781 $dbh->rollback if $oldAutoCommit;
782 return "error queuing welcome email: $error";
785 if ( $options{'depend_jobnum'} ) {
786 warn "$me depend_jobnum found; adding to welcome email dependancies"
788 if ( ref($options{'depend_jobnum'}) ) {
789 warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
790 "to welcome email dependancies"
792 push @jobnums, @{ $options{'depend_jobnum'} };
794 warn "$me adding job $options{'depend_jobnum'} ".
795 "to welcome email dependancies"
797 push @jobnums, $options{'depend_jobnum'};
801 foreach my $jobnum ( @jobnums ) {
802 my $error = $wqueue->depend_insert($jobnum);
804 $dbh->rollback if $oldAutoCommit;
805 return "error queuing welcome email job dependancy: $error";
811 } # if $welcome_template
816 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
820 # set usage fields and thresholds if unset but set in a package def
821 # AND the package already has a last bill date (otherwise they get double added)
822 sub preinsert_hook_first {
825 return '' unless $self->pkgnum;
827 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
828 return '' unless $cust_pkg && $cust_pkg->last_bill;
830 my $part_pkg = $cust_pkg->part_pkg;
831 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
833 my %values = $part_pkg->usage_valuehash;
834 my $multiplier = $conf->exists('svc_acct-usage_threshold')
835 ? 1 - $conf->config('svc_acct-usage_threshold')/100
836 : 0.20; #doesn't matter
838 foreach ( keys %values ) {
839 next if $self->getfield($_);
840 $self->setfield( $_, $values{$_} );
841 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
842 if $conf->exists('svc_acct-usage_threshold');
850 Deletes this account from the database. If there is an error, returns the
851 error, otherwise returns false.
853 The corresponding FS::cust_svc record will be deleted as well.
855 (TODOC: new exports!)
862 return "can't delete system account" if $self->_check_system;
864 return "Can't delete an account which is a (svc_forward) source!"
865 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
867 return "Can't delete an account which is a (svc_forward) destination!"
868 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
870 return "Can't delete an account with (svc_www) web service!"
871 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
873 # what about records in session ? (they should refer to history table)
875 local $SIG{HUP} = 'IGNORE';
876 local $SIG{INT} = 'IGNORE';
877 local $SIG{QUIT} = 'IGNORE';
878 local $SIG{TERM} = 'IGNORE';
879 local $SIG{TSTP} = 'IGNORE';
880 local $SIG{PIPE} = 'IGNORE';
882 my $oldAutoCommit = $FS::UID::AutoCommit;
883 local $FS::UID::AutoCommit = 0;
886 foreach my $cust_main_invoice (
887 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
889 unless ( defined($cust_main_invoice) ) {
890 warn "WARNING: something's wrong with qsearch";
893 my %hash = $cust_main_invoice->hash;
894 $hash{'dest'} = $self->email;
895 my $new = new FS::cust_main_invoice \%hash;
896 my $error = $new->replace($cust_main_invoice);
898 $dbh->rollback if $oldAutoCommit;
903 foreach my $svc_domain (
904 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
906 my %hash = new FS::svc_domain->hash;
907 $hash{'catchall'} = '';
908 my $new = new FS::svc_domain \%hash;
909 my $error = $new->replace($svc_domain);
911 $dbh->rollback if $oldAutoCommit;
916 my $error = $self->SUPER::delete; # usergroup here
918 $dbh->rollback if $oldAutoCommit;
922 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
926 =item replace OLD_RECORD
928 Replaces OLD_RECORD with this one in the database. If there is an error,
929 returns the error, otherwise returns false.
931 The additional field I<usergroup> can optionally be defined; if so it should
932 contain an arrayref of group names. See L<FS::radius_usergroup>.
940 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
944 warn "$me replacing $old with $new\n" if $DEBUG;
948 return "can't modify system account" if $old->_check_system;
951 #no warnings 'numeric'; #alas, a 5.006-ism
954 foreach my $xid (qw( uid gid )) {
956 return "Can't change $xid!"
957 if ! $conf->exists("svc_acct-edit_$xid")
958 && $old->$xid() != $new->$xid()
959 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
964 return "can't change username"
965 if $old->username ne $new->username
966 && $conf->exists('svc_acct-no_edit_username');
968 #change homdir when we change username
969 $new->setfield('dir', '') if $old->username ne $new->username;
971 local $SIG{HUP} = 'IGNORE';
972 local $SIG{INT} = 'IGNORE';
973 local $SIG{QUIT} = 'IGNORE';
974 local $SIG{TERM} = 'IGNORE';
975 local $SIG{TSTP} = 'IGNORE';
976 local $SIG{PIPE} = 'IGNORE';
978 my $oldAutoCommit = $FS::UID::AutoCommit;
979 local $FS::UID::AutoCommit = 0;
982 $error = $new->SUPER::replace($old, @_); # usergroup here
984 $dbh->rollback if $oldAutoCommit;
985 return $error if $error;
988 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
989 $error = $new->queue_fuzzyfiles_update;
991 $dbh->rollback if $oldAutoCommit;
992 return "updating fuzzy search cache: $error";
996 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1000 =item queue_fuzzyfiles_update
1002 Used by insert & replace to update the fuzzy search cache
1006 sub queue_fuzzyfiles_update {
1009 local $SIG{HUP} = 'IGNORE';
1010 local $SIG{INT} = 'IGNORE';
1011 local $SIG{QUIT} = 'IGNORE';
1012 local $SIG{TERM} = 'IGNORE';
1013 local $SIG{TSTP} = 'IGNORE';
1014 local $SIG{PIPE} = 'IGNORE';
1016 my $oldAutoCommit = $FS::UID::AutoCommit;
1017 local $FS::UID::AutoCommit = 0;
1020 my $queue = new FS::queue {
1021 'svcnum' => $self->svcnum,
1022 'job' => 'FS::svc_acct::append_fuzzyfiles'
1024 my $error = $queue->insert($self->username);
1026 $dbh->rollback if $oldAutoCommit;
1027 return "queueing job (transaction rolled back): $error";
1030 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1038 Suspends this account by calling export-specific suspend hooks. If there is
1039 an error, returns the error, otherwise returns false.
1041 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1047 return "can't suspend system account" if $self->_check_system;
1048 $self->SUPER::suspend(@_);
1053 Unsuspends this account by by calling export-specific suspend hooks. If there
1054 is an error, returns the error, otherwise returns false.
1056 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1062 my %hash = $self->hash;
1063 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1064 $hash{_password} = $1;
1065 my $new = new FS::svc_acct ( \%hash );
1066 my $error = $new->replace($self);
1067 return $error if $error;
1070 $self->SUPER::unsuspend(@_);
1075 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1077 If the B<auto_unset_catchall> configuration option is set, this method will
1078 automatically remove any references to the canceled service in the catchall
1079 field of svc_domain. This allows packages that contain both a svc_domain and
1080 its catchall svc_acct to be canceled in one step.
1085 # Only one thing to do at this level
1087 foreach my $svc_domain (
1088 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1089 if($conf->exists('auto_unset_catchall')) {
1090 my %hash = $svc_domain->hash;
1091 $hash{catchall} = '';
1092 my $new = new FS::svc_domain ( \%hash );
1093 my $error = $new->replace($svc_domain);
1094 return $error if $error;
1096 return "cannot unprovision svc_acct #".$self->svcnum.
1097 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1101 $self->SUPER::cancel(@_);
1107 Checks all fields to make sure this is a valid service. If there is an error,
1108 returns the error, otherwise returns false. Called by the insert and replace
1111 Sets any fixed values; see L<FS::part_svc>.
1118 my($recref) = $self->hashref;
1120 my $x = $self->setfixed;
1121 return $x unless ref($x);
1124 my $error = $self->ut_numbern('svcnum')
1125 #|| $self->ut_number('domsvc')
1126 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1127 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1128 || $self->ut_foreign_keyn('sectornum','tower_sector','sectornum')
1129 || $self->ut_textn('sec_phrase')
1130 || $self->ut_snumbern('seconds')
1131 || $self->ut_snumbern('upbytes')
1132 || $self->ut_snumbern('downbytes')
1133 || $self->ut_snumbern('totalbytes')
1134 || $self->ut_snumbern('seconds_threshold')
1135 || $self->ut_snumbern('upbytes_threshold')
1136 || $self->ut_snumbern('downbytes_threshold')
1137 || $self->ut_snumbern('totalbytes_threshold')
1138 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1139 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1140 || $self->ut_enum('password_recover', [ '', 'Y' ])
1142 || $self->ut_anything('cf_privatekey')
1144 || $self->ut_textn('cgp_accessmodes')
1145 || $self->ut_alphan('cgp_type')
1146 || $self->ut_textn('cgp_aliases' ) #well
1148 || $self->ut_alphasn('cgp_rulesallowed')
1149 || $self->ut_enum('cgp_rpopallowed', [ '', 'Y' ])
1150 || $self->ut_enum('cgp_mailtoall', [ '', 'Y' ])
1151 || $self->ut_enum('cgp_addmailtrailer', [ '', 'Y' ])
1152 || $self->ut_snumbern('cgp_archiveafter')
1154 || $self->ut_alphasn('cgp_deletemode')
1155 || $self->ut_enum('cgp_emptytrash', $self->cgp_emptytrash_values)
1156 || $self->ut_alphan('cgp_language')
1157 || $self->ut_textn('cgp_timezone')
1158 || $self->ut_textn('cgp_skinname')
1159 || $self->ut_textn('cgp_prontoskinname')
1160 || $self->ut_alphan('cgp_sendmdnmode')
1162 return $error if $error;
1165 local $username_letter = $username_letter;
1166 if ($self->svcnum) {
1167 my $cust_svc = $self->cust_svc
1168 or return "no cust_svc record found for svcnum ". $self->svcnum;
1169 my $cust_pkg = $cust_svc->cust_pkg;
1171 if ($self->pkgnum) {
1172 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1176 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1179 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1181 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:\/\=\#]{$usernamemin,$ulen})$/i
1182 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1183 $recref->{username} = $1;
1185 unless ( $username_uppercase ) {
1186 $recref->{username} =~ /[A-Z]/ and return gettext('illegal_username');
1188 if ( $username_letterfirst ) {
1189 $recref->{username} =~ /^[a-z]/ or return gettext('illegal_username');
1190 } elsif ( $username_letter ) {
1191 $recref->{username} =~ /[a-z]/ or return gettext('illegal_username');
1193 if ( $username_noperiod ) {
1194 $recref->{username} =~ /\./ and return gettext('illegal_username');
1196 if ( $username_nounderscore ) {
1197 $recref->{username} =~ /_/ and return gettext('illegal_username');
1199 if ( $username_nodash ) {
1200 $recref->{username} =~ /\-/ and return gettext('illegal_username');
1202 unless ( $username_ampersand ) {
1203 $recref->{username} =~ /\&/ and return gettext('illegal_username');
1205 unless ( $username_percent ) {
1206 $recref->{username} =~ /\%/ and return gettext('illegal_username');
1208 unless ( $username_colon ) {
1209 $recref->{username} =~ /\:/ and return gettext('illegal_username');
1211 unless ( $username_slash ) {
1212 $recref->{username} =~ /\// and return gettext('illegal_username');
1214 unless ( $username_equals ) {
1215 $recref->{username} =~ /\=/ and return gettext('illegal_username');
1217 unless ( $username_pound ) {
1218 $recref->{username} =~ /\#/ and return gettext('illegal_username');
1222 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1223 $recref->{popnum} = $1;
1224 return "Unknown popnum" unless
1225 ! $recref->{popnum} ||
1226 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1228 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1230 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1231 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1233 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1234 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1235 #not all systems use gid=uid
1236 #you can set a fixed gid in part_svc
1238 return "Only root can have uid 0"
1239 if $recref->{uid} == 0
1240 && $recref->{username} !~ /^(root|toor|smtp)$/;
1242 unless ( $recref->{username} eq 'sync' ) {
1243 if ( grep $_ eq $recref->{shell}, @shells ) {
1244 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1246 return "Illegal shell \`". $self->shell. "\'; ".
1247 "shells configuration value contains: @shells";
1250 $recref->{shell} = '/bin/sync';
1254 $recref->{gid} ne '' ?
1255 return "Can't have gid without uid" : ( $recref->{gid}='' );
1256 #$recref->{dir} ne '' ?
1257 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1258 $recref->{shell} ne '' ?
1259 return "Can't have shell without uid" : ( $recref->{shell}='' );
1262 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1264 $recref->{dir} =~ /^([\/\w\-\.\&\:\#]*)$/
1265 or return "Illegal directory: ". $recref->{dir};
1266 $recref->{dir} = $1;
1267 return "Illegal directory"
1268 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1269 return "Illegal directory"
1270 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1271 unless ( $recref->{dir} ) {
1272 $recref->{dir} = $dir_prefix . '/';
1273 if ( $dirhash > 0 ) {
1274 for my $h ( 1 .. $dirhash ) {
1275 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1277 } elsif ( $dirhash < 0 ) {
1278 for my $h ( reverse $dirhash .. -1 ) {
1279 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1282 $recref->{dir} .= $recref->{username};
1288 # $error = $self->ut_textn('finger');
1289 # return $error if $error;
1290 if ( $self->getfield('finger') eq '' ) {
1291 my $cust_pkg = $self->svcnum
1292 ? $self->cust_svc->cust_pkg
1293 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1295 my $cust_main = $cust_pkg->cust_main;
1296 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1299 $self->getfield('finger') =~ /^([\w \,\.\-\'\&\t\!\@\#\$\%\(\)\+\;\"\?\/\*\<\>]+)$/
1300 or return "Illegal finger: ". $self->getfield('finger');
1301 $self->setfield('finger', $1);
1303 for (qw( quota file_quota file_maxsize )) {
1304 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1307 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1308 $recref->{file_maxnum} = $1;
1310 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1311 if ( $recref->{slipip} eq '' ) {
1312 $recref->{slipip} = '';
1313 } elsif ( $recref->{slipip} eq '0e0' ) {
1314 $recref->{slipip} = '0e0';
1316 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1317 or return "Illegal slipip: ". $self->slipip;
1318 $recref->{slipip} = $1;
1323 #arbitrary RADIUS stuff; allow ut_textn for now
1324 foreach ( grep /^radius_/, fields('svc_acct') ) {
1325 $self->ut_textn($_);
1328 # First, if _password is blank, generate one and set default encoding.
1329 if ( ! $recref->{_password} ) {
1330 $error = $self->set_password('');
1332 # But if there's a _password but no encoding, assume it's plaintext and
1333 # set it to default encoding.
1334 elsif ( ! $recref->{_password_encoding} ) {
1335 $error = $self->set_password($recref->{_password});
1337 return $error if $error;
1339 # Next, check _password to ensure compliance with the encoding.
1340 if ( $recref->{_password_encoding} eq 'ldap' ) {
1342 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1343 $recref->{_password} = uc($1).$2;
1345 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1348 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1350 if ( $recref->{_password} =~
1351 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1352 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1355 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1358 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1361 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1362 # Password randomization is now in set_password.
1363 # Strip whitespace characters, check length requirements, etc.
1364 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1365 $recref->{_password} = $1;
1367 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1368 FS::Msgcat::_gettext('illegal_password_characters').
1369 ": ". $recref->{_password};
1372 if ( $password_noampersand ) {
1373 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1375 if ( $password_noexclamation ) {
1376 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1380 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1382 $self->SUPER::check;
1387 sub _password_encryption {
1389 my $encoding = lc($self->_password_encoding);
1390 return if !$encoding;
1391 return 'plain' if $encoding eq 'plain';
1392 if($encoding eq 'crypt') {
1393 my $pass = $self->_password;
1394 $pass =~ s/^\*SUSPENDED\* //;
1396 return 'md5' if $pass =~ /^\$1\$/;
1397 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1398 return 'des' if length($pass) == 13;
1401 if($encoding eq 'ldap') {
1402 uc($self->_password) =~ /^\{([\w-]+)\}/;
1403 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1404 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1405 return 'md5' if $1 eq 'MD5';
1406 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1413 sub get_cleartext_password {
1415 if($self->_password_encryption eq 'plain') {
1416 if($self->_password_encoding eq 'ldap') {
1417 $self->_password =~ /\{\w+\}(.*)$/;
1421 return $self->_password;
1430 Set the cleartext password for the account. If _password_encoding is set, the
1431 new password will be encoded according to the existing method (including
1432 encryption mode, if it can be determined). Otherwise,
1433 config('default-password-encoding') is used.
1435 If no password is supplied (or a zero-length password when minimum password length
1436 is >0), one will be generated randomly.
1441 my( $self, $pass ) = ( shift, shift );
1443 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1446 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1447 FS::Msgcat::_gettext('illegal_password_characters').
1450 my( $encoding, $encryption ) = ('', '');
1452 if ( $self->_password_encoding ) {
1453 $encoding = $self->_password_encoding;
1454 # identify existing encryption method, try to use it.
1455 $encryption = $self->_password_encryption;
1457 # use the system default
1463 # set encoding to system default
1464 ($encoding, $encryption) =
1465 split(/-/, lc($conf->config('default-password-encoding')));
1466 $encoding ||= 'legacy';
1467 $self->_password_encoding($encoding);
1470 if ( $encoding eq 'legacy' ) {
1472 # The legacy behavior from check():
1473 # If the password is blank, randomize it and set encoding to 'plain'.
1474 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1475 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1476 $self->_password_encoding('plain');
1478 # Prefix + valid-length password
1479 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1481 $self->_password_encoding('plain');
1482 # Prefix + crypt string
1483 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1485 $self->_password_encoding('crypt');
1486 # Various disabled crypt passwords
1487 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1488 $self->_password_encoding('crypt');
1494 $self->_password($pass);
1500 if $passwordmin && length($pass) < $passwordmin
1501 or $passwordmax && length($pass) > $passwordmax;
1503 if ( $encoding eq 'crypt' ) {
1504 if ($encryption eq 'md5') {
1505 $pass = unix_md5_crypt($pass);
1506 } elsif ($encryption eq 'des') {
1507 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1510 } elsif ( $encoding eq 'ldap' ) {
1511 if ($encryption eq 'md5') {
1512 $pass = md5_base64($pass);
1513 } elsif ($encryption eq 'sha1') {
1514 $pass = sha1_base64($pass);
1515 } elsif ($encryption eq 'crypt') {
1516 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1518 # else $encryption eq 'plain', do nothing
1519 $pass .= '=' x (4 - length($pass) % 4) #properly padded base64
1520 if $encryption eq 'md5' || $encryption eq 'sha1';
1521 $pass = '{'.uc($encryption).'}'.$pass;
1523 # else encoding eq 'plain'
1525 $self->_password($pass);
1531 Internal function to check the username against the list of system usernames
1532 from the I<system_usernames> configuration value. Returns true if the username
1533 is listed on the system username list.
1539 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1540 $conf->config('system_usernames')
1544 =item _check_duplicate
1546 Internal method to check for duplicates usernames, username@domain pairs and
1549 If the I<global_unique-username> configuration value is set to B<username> or
1550 B<username@domain>, enforces global username or username@domain uniqueness.
1552 In all cases, check for duplicate uids and usernames or username@domain pairs
1553 per export and with identical I<svcpart> values.
1557 sub _check_duplicate {
1560 my $global_unique = $conf->config('global_unique-username') || 'none';
1561 return '' if $global_unique eq 'disabled';
1565 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1566 unless ( $part_svc ) {
1567 return 'unknown svcpart '. $self->svcpart;
1570 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1571 qsearch( 'svc_acct', { 'username' => $self->username } );
1572 return gettext('username_in_use')
1573 if $global_unique eq 'username' && @dup_user;
1575 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1576 qsearch( 'svc_acct', { 'username' => $self->username,
1577 'domsvc' => $self->domsvc } );
1578 return gettext('username_in_use')
1579 if $global_unique eq 'username@domain' && @dup_userdomain;
1582 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1583 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1584 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1585 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1590 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1591 my $exports = FS::part_export::export_info('svc_acct');
1592 my %conflict_user_svcpart;
1593 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1595 foreach my $part_export ( $part_svc->part_export ) {
1597 #this will catch to the same exact export
1598 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1600 #this will catch to exports w/same exporthost+type ???
1601 #my @other_part_export = qsearch('part_export', {
1602 # 'machine' => $part_export->machine,
1603 # 'exporttype' => $part_export->exporttype,
1605 #foreach my $other_part_export ( @other_part_export ) {
1606 # push @svcparts, map { $_->svcpart }
1607 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1610 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1611 #silly kludge to avoid uninitialized value errors
1612 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1613 ? $exports->{$part_export->exporttype}{'nodomain'}
1615 if ( $nodomain =~ /^Y/i ) {
1616 $conflict_user_svcpart{$_} = $part_export->exportnum
1619 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1624 foreach my $dup_user ( @dup_user ) {
1625 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1626 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1627 return "duplicate username ". $self->username.
1628 ": conflicts with svcnum ". $dup_user->svcnum.
1629 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1633 foreach my $dup_userdomain ( @dup_userdomain ) {
1634 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1635 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1636 return "duplicate username\@domain ". $self->email.
1637 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1638 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1642 foreach my $dup_uid ( @dup_uid ) {
1643 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1644 if ( exists($conflict_user_svcpart{$dup_svcpart})
1645 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1646 return "duplicate uid ". $self->uid.
1647 ": conflicts with svcnum ". $dup_uid->svcnum.
1649 ( $conflict_user_svcpart{$dup_svcpart}
1650 || $conflict_userdomain_svcpart{$dup_svcpart} );
1662 Depriciated, use radius_reply instead.
1667 carp "FS::svc_acct::radius depriciated, use radius_reply";
1668 $_[0]->radius_reply;
1673 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1674 reply attributes of this record.
1676 Note that this is now the preferred method for reading RADIUS attributes -
1677 accessing the columns directly is discouraged, as the column names are
1678 expected to change in the future.
1685 return %{ $self->{'radius_reply'} }
1686 if exists $self->{'radius_reply'};
1691 my($column, $attrib) = ($1, $2);
1692 #$attrib =~ s/_/\-/g;
1693 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1694 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1696 if ( $self->slipip && $self->slipip ne '0e0' ) {
1697 $reply{$radius_ip} = $self->slipip;
1700 if ( $self->seconds !~ /^$/ ) {
1701 $reply{'Session-Timeout'} = $self->seconds;
1704 if ( $conf->exists('radius-chillispot-max') ) {
1705 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1707 #hmm. just because sqlradius.pm says so?
1714 foreach my $what (qw( input output total )) {
1715 my $is = $whatis{$what}.'bytes';
1716 if ( $self->$is() =~ /\d/ ) {
1717 my $big = new Math::BigInt $self->$is();
1718 $big = new Math::BigInt '0' if $big->is_neg();
1719 my $att = "Chillispot-Max-\u$what";
1720 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1721 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1732 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1733 check attributes of this record.
1735 Note that this is now the preferred method for reading RADIUS attributes -
1736 accessing the columns directly is discouraged, as the column names are
1737 expected to change in the future.
1744 return %{ $self->{'radius_check'} }
1745 if exists $self->{'radius_check'};
1750 my($column, $attrib) = ($1, $2);
1751 #$attrib =~ s/_/\-/g;
1752 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1753 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1756 my($pw_attrib, $password) = $self->radius_password;
1757 $check{$pw_attrib} = $password;
1759 my $cust_svc = $self->cust_svc;
1761 my $cust_pkg = $cust_svc->cust_pkg;
1762 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1763 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1766 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1767 "; can't set Expiration\n"
1775 =item radius_password
1777 Returns a key/value pair containing the RADIUS attribute name and value
1782 sub radius_password {
1786 if ( $self->_password_encoding eq 'ldap' ) {
1787 $pw_attrib = 'Password-With-Header';
1788 } elsif ( $self->_password_encoding eq 'crypt' ) {
1789 $pw_attrib = 'Crypt-Password';
1790 } elsif ( $self->_password_encoding eq 'plain' ) {
1791 $pw_attrib = $radius_password;
1793 $pw_attrib = length($self->_password) <= 12
1798 ($pw_attrib, $self->_password);
1804 This method instructs the object to "snapshot" or freeze RADIUS check and
1805 reply attributes to the current values.
1809 #bah, my english is too broken this morning
1810 #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
1811 #the FS::cust_pkg's replace method to trigger the correct export updates when
1812 #package dates change)
1817 $self->{$_} = { $self->$_() }
1818 foreach qw( radius_reply radius_check );
1822 =item forget_snapshot
1824 This methos instructs the object to forget any previously snapshotted
1825 RADIUS check and reply attributes.
1829 sub forget_snapshot {
1833 foreach qw( radius_reply radius_check );
1837 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1839 Returns the domain associated with this account.
1841 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1848 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1849 my $svc_domain = $self->svc_domain(@_)
1850 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1851 $svc_domain->domain;
1856 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1860 #inherited from svc_Common
1862 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1864 Returns an email address associated with the account.
1866 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1873 $self->username. '@'. $self->domain(@_);
1878 Returns an array of FS::acct_snarf records associated with the account.
1885 'table' => 'acct_snarf',
1886 'hashref' => { 'svcnum' => $self->svcnum },
1887 #'order_by' => 'ORDER BY priority ASC',
1891 =item cgp_rpop_hashref
1893 Returns an arrayref of RPOP data suitable for Communigate Pro API commands.
1897 sub cgp_rpop_hashref {
1899 { map { $_->snarfname => $_->cgp_hashref } $self->acct_snarf };
1902 =item decrement_upbytes OCTETS
1904 Decrements the I<upbytes> field of this record by the given amount. If there
1905 is an error, returns the error, otherwise returns false.
1909 sub decrement_upbytes {
1910 shift->_op_usage('-', 'upbytes', @_);
1913 =item increment_upbytes OCTETS
1915 Increments the I<upbytes> field of this record by the given amount. If there
1916 is an error, returns the error, otherwise returns false.
1920 sub increment_upbytes {
1921 shift->_op_usage('+', 'upbytes', @_);
1924 =item decrement_downbytes OCTETS
1926 Decrements the I<downbytes> field of this record by the given amount. If there
1927 is an error, returns the error, otherwise returns false.
1931 sub decrement_downbytes {
1932 shift->_op_usage('-', 'downbytes', @_);
1935 =item increment_downbytes OCTETS
1937 Increments the I<downbytes> field of this record by the given amount. If there
1938 is an error, returns the error, otherwise returns false.
1942 sub increment_downbytes {
1943 shift->_op_usage('+', 'downbytes', @_);
1946 =item decrement_totalbytes OCTETS
1948 Decrements the I<totalbytes> field of this record by the given amount. If there
1949 is an error, returns the error, otherwise returns false.
1953 sub decrement_totalbytes {
1954 shift->_op_usage('-', 'totalbytes', @_);
1957 =item increment_totalbytes OCTETS
1959 Increments the I<totalbytes> field of this record by the given amount. If there
1960 is an error, returns the error, otherwise returns false.
1964 sub increment_totalbytes {
1965 shift->_op_usage('+', 'totalbytes', @_);
1968 =item decrement_seconds SECONDS
1970 Decrements the I<seconds> field of this record by the given amount. If there
1971 is an error, returns the error, otherwise returns false.
1975 sub decrement_seconds {
1976 shift->_op_usage('-', 'seconds', @_);
1979 =item increment_seconds SECONDS
1981 Increments the I<seconds> field of this record by the given amount. If there
1982 is an error, returns the error, otherwise returns false.
1986 sub increment_seconds {
1987 shift->_op_usage('+', 'seconds', @_);
1995 my %op2condition = (
1996 '-' => sub { my($self, $column, $amount) = @_;
1997 $self->$column - $amount <= 0;
1999 '+' => sub { my($self, $column, $amount) = @_;
2000 ($self->$column || 0) + $amount > 0;
2003 my %op2warncondition = (
2004 '-' => sub { my($self, $column, $amount) = @_;
2005 my $threshold = $column . '_threshold';
2006 $self->$column - $amount <= $self->$threshold + 0;
2008 '+' => sub { my($self, $column, $amount) = @_;
2009 ($self->$column || 0) + $amount > 0;
2014 my( $self, $op, $column, $amount ) = @_;
2016 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
2017 ' ('. $self->email. "): $op $amount\n"
2020 return '' unless $amount;
2022 local $SIG{HUP} = 'IGNORE';
2023 local $SIG{INT} = 'IGNORE';
2024 local $SIG{QUIT} = 'IGNORE';
2025 local $SIG{TERM} = 'IGNORE';
2026 local $SIG{TSTP} = 'IGNORE';
2027 local $SIG{PIPE} = 'IGNORE';
2029 my $oldAutoCommit = $FS::UID::AutoCommit;
2030 local $FS::UID::AutoCommit = 0;
2033 my $sql = "UPDATE svc_acct SET $column = ".
2034 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
2035 " $op ? WHERE svcnum = ?";
2039 my $sth = $dbh->prepare( $sql )
2040 or die "Error preparing $sql: ". $dbh->errstr;
2041 my $rv = $sth->execute($amount, $self->svcnum);
2042 die "Error executing $sql: ". $sth->errstr
2043 unless defined($rv);
2044 die "Can't update $column for svcnum". $self->svcnum
2047 #$self->snapshot; #not necessary, we retain the old values
2048 #create an object with the updated usage values
2049 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2051 my $error = $new->replace($self);
2053 $dbh->rollback if $oldAutoCommit;
2054 return "Error replacing: $error";
2057 #overlimit_action eq 'cancel' handling
2058 my $cust_pkg = $self->cust_svc->cust_pkg;
2060 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2061 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2065 my $error = $cust_pkg->cancel; #XXX should have a reason
2067 $dbh->rollback if $oldAutoCommit;
2068 return "Error cancelling: $error";
2071 #nothing else is relevant if we're cancelling, so commit & return success
2072 warn "$me update successful; committing\n"
2074 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2079 my $action = $op2action{$op};
2081 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2082 ( $action eq 'suspend' && !$self->overlimit
2083 || $action eq 'unsuspend' && $self->overlimit )
2086 my $error = $self->_op_overlimit($action);
2088 $dbh->rollback if $oldAutoCommit;
2094 if ( $conf->exists("svc_acct-usage_$action")
2095 && &{$op2condition{$op}}($self, $column, $amount) ) {
2096 #my $error = $self->$action();
2097 my $error = $self->cust_svc->cust_pkg->$action();
2098 # $error ||= $self->overlimit($action);
2100 $dbh->rollback if $oldAutoCommit;
2101 return "Error ${action}ing: $error";
2105 if ($warning_template && &{$op2warncondition{$op}}($self, $column, $amount)) {
2106 my $wqueue = new FS::queue {
2107 'svcnum' => $self->svcnum,
2108 'job' => 'FS::svc_acct::reached_threshold',
2113 $to = $warning_cc if &{$op2condition{$op}}($self, $column, $amount);
2117 my $error = $wqueue->insert(
2118 'svcnum' => $self->svcnum,
2120 'column' => $column,
2124 $dbh->rollback if $oldAutoCommit;
2125 return "Error queuing threshold activity: $error";
2129 warn "$me update successful; committing\n"
2131 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2137 my( $self, $action ) = @_;
2139 local $SIG{HUP} = 'IGNORE';
2140 local $SIG{INT} = 'IGNORE';
2141 local $SIG{QUIT} = 'IGNORE';
2142 local $SIG{TERM} = 'IGNORE';
2143 local $SIG{TSTP} = 'IGNORE';
2144 local $SIG{PIPE} = 'IGNORE';
2146 my $oldAutoCommit = $FS::UID::AutoCommit;
2147 local $FS::UID::AutoCommit = 0;
2150 my $cust_pkg = $self->cust_svc->cust_pkg;
2152 my @conf_overlimit =
2154 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2155 : $conf->config('overlimit_groups');
2157 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2159 my @groups = scalar(@conf_overlimit) ? @conf_overlimit
2160 : split(' ',$part_export->option('overlimit_groups'));
2161 next unless scalar(@groups);
2163 my $other = new FS::svc_acct $self->hashref;
2164 $other->usergroup(\@groups);
2167 if ($action eq 'suspend') {
2170 } else { # $action eq 'unsuspend'
2175 my $error = $part_export->export_replace($new, $old)
2176 || $self->overlimit($action);
2179 $dbh->rollback if $oldAutoCommit;
2180 return "Error replacing radius groups: $error";
2185 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2191 my( $self, $valueref, %options ) = @_;
2193 warn "$me set_usage called for svcnum ". $self->svcnum.
2194 ' ('. $self->email. "): ".
2195 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2198 local $SIG{HUP} = 'IGNORE';
2199 local $SIG{INT} = 'IGNORE';
2200 local $SIG{QUIT} = 'IGNORE';
2201 local $SIG{TERM} = 'IGNORE';
2202 local $SIG{TSTP} = 'IGNORE';
2203 local $SIG{PIPE} = 'IGNORE';
2205 local $FS::svc_Common::noexport_hack = 1;
2206 my $oldAutoCommit = $FS::UID::AutoCommit;
2207 local $FS::UID::AutoCommit = 0;
2212 if ( $options{null} ) {
2213 %handyhash = ( map { ( $_ => undef, $_."_threshold" => undef ) }
2214 qw( seconds upbytes downbytes totalbytes )
2217 foreach my $field (keys %$valueref){
2218 $reset = 1 if $valueref->{$field};
2219 $self->setfield($field, $valueref->{$field});
2220 $self->setfield( $field.'_threshold',
2221 int($self->getfield($field)
2222 * ( $conf->exists('svc_acct-usage_threshold')
2223 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2228 $handyhash{$field} = $self->getfield($field);
2229 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2231 #my $error = $self->replace; #NO! we avoid the call to ->check for
2232 #die $error if $error; #services not explicity changed via the UI
2234 my $sql = "UPDATE svc_acct SET " .
2235 join (',', map { "$_ = ?" } (keys %handyhash) ).
2236 " WHERE svcnum = ". $self->svcnum;
2241 if (scalar(keys %handyhash)) {
2242 my $sth = $dbh->prepare( $sql )
2243 or die "Error preparing $sql: ". $dbh->errstr;
2244 my $rv = $sth->execute(values %handyhash);
2245 die "Error executing $sql: ". $sth->errstr
2246 unless defined($rv);
2247 die "Can't update usage for svcnum ". $self->svcnum
2251 #$self->snapshot; #not necessary, we retain the old values
2252 #create an object with the updated usage values
2253 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2254 local($FS::Record::nowarn_identical) = 1;
2255 my $error = $new->replace($self); #call exports
2257 $dbh->rollback if $oldAutoCommit;
2258 return "Error replacing: $error";
2265 $error = $self->_op_overlimit('unsuspend')
2266 if $self->overlimit;;
2268 $error ||= $self->cust_svc->cust_pkg->unsuspend
2269 if $conf->exists("svc_acct-usage_unsuspend");
2272 $dbh->rollback if $oldAutoCommit;
2273 return "Error unsuspending: $error";
2278 warn "$me update successful; committing\n"
2280 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2286 =item recharge HASHREF
2288 Increments usage columns by the amount specified in HASHREF as
2289 column=>amount pairs.
2294 my ($self, $vhash) = @_;
2297 warn "[$me] recharge called on $self: ". Dumper($self).
2298 "\nwith vhash: ". Dumper($vhash);
2301 my $oldAutoCommit = $FS::UID::AutoCommit;
2302 local $FS::UID::AutoCommit = 0;
2306 foreach my $column (keys %$vhash){
2307 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2311 $dbh->rollback if $oldAutoCommit;
2313 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2318 =item is_rechargeable
2320 Returns true if this svc_account can be "recharged" and false otherwise.
2324 sub is_rechargable {
2326 $self->seconds ne ''
2327 || $self->upbytes ne ''
2328 || $self->downbytes ne ''
2329 || $self->totalbytes ne '';
2332 =item seconds_since TIMESTAMP
2334 Returns the number of seconds this account has been online since TIMESTAMP,
2335 according to the session monitor (see L<FS::Session>).
2337 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2338 L<Time::Local> and L<Date::Parse> for conversion functions.
2342 #note: POD here, implementation in FS::cust_svc
2345 $self->cust_svc->seconds_since(@_);
2348 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2350 Returns the numbers of seconds this account has been online between
2351 TIMESTAMP_START (inclusive) and TIMESTAMP_END (exclusive), according to an
2352 external SQL radacct table, specified via sqlradius export. Sessions which
2353 started in the specified range but are still open are counted from session
2354 start to the end of the range (unless they are over 1 day old, in which case
2355 they are presumed missing their stop record and not counted). Also, sessions
2356 which end in the range but started earlier are counted from the start of the
2357 range to session end. Finally, sessions which start before the range but end
2358 after are counted for the entire range.
2360 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2361 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2366 #note: POD here, implementation in FS::cust_svc
2367 sub seconds_since_sqlradacct {
2369 $self->cust_svc->seconds_since_sqlradacct(@_);
2372 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2374 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2375 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2376 TIMESTAMP_END (exclusive).
2378 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2379 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2384 #note: POD here, implementation in FS::cust_svc
2385 sub attribute_since_sqlradacct {
2387 $self->cust_svc->attribute_since_sqlradacct(@_);
2390 =item get_session_history TIMESTAMP_START TIMESTAMP_END
2392 Returns an array of hash references of this customers login history for the
2393 given time range. (document this better)
2397 sub get_session_history {
2399 $self->cust_svc->get_session_history(@_);
2402 =item last_login_text
2404 Returns text describing the time of last login.
2408 sub last_login_text {
2410 $self->last_login ? ctime($self->last_login) : 'unknown';
2413 =item get_cdrs TIMESTAMP_START TIMESTAMP_END [ 'OPTION' => 'VALUE ... ]
2418 my($self, $start, $end, %opt ) = @_;
2420 my $did = $self->username; #yup
2422 my $prefix = $opt{'default_prefix'}; #convergent.au '+61'
2424 my $for_update = $opt{'for_update'} ? 'FOR UPDATE' : '';
2426 #SELECT $for_update * FROM cdr
2427 # WHERE calldate >= $start #need a conversion
2428 # AND calldate < $end #ditto
2429 # AND ( charged_party = "$did"
2430 # OR charged_party = "$prefix$did" #if length($prefix);
2431 # OR ( ( charged_party IS NULL OR charged_party = '' )
2433 # ( src = "$did" OR src = "$prefix$did" ) # if length($prefix)
2436 # AND ( freesidestatus IS NULL OR freesidestatus = '' )
2439 if ( length($prefix) ) {
2441 " AND ( charged_party = '$did'
2442 OR charged_party = '$prefix$did'
2443 OR ( ( charged_party IS NULL OR charged_party = '' )
2445 ( src = '$did' OR src = '$prefix$did' )
2451 " AND ( charged_party = '$did'
2452 OR ( ( charged_party IS NULL OR charged_party = '' )
2462 'select' => "$for_update *",
2465 #( freesidestatus IS NULL OR freesidestatus = '' )
2466 'freesidestatus' => '',
2468 'extra_sql' => $charged_or_src,
2474 # sub radius_groups has moved to svc_Radius_Mixin
2476 =item clone_suspended
2478 Constructor used by FS::part_export::_export_suspend fallback. Document
2483 sub clone_suspended {
2485 my %hash = $self->hash;
2486 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2487 new FS::svc_acct \%hash;
2490 =item clone_kludge_unsuspend
2492 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2497 sub clone_kludge_unsuspend {
2499 my %hash = $self->hash;
2500 $hash{_password} = '';
2501 new FS::svc_acct \%hash;
2504 =item check_password
2506 Checks the supplied password against the (possibly encrypted) password in the
2507 database. Returns true for a successful authentication, false for no match.
2509 Currently supported encryptions are: classic DES crypt() and MD5
2513 sub check_password {
2514 my($self, $check_password) = @_;
2516 #remove old-style SUSPENDED kludge, they should be allowed to login to
2517 #self-service and pay up
2518 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2520 if ( $self->_password_encoding eq 'ldap' ) {
2522 my $auth = from_rfc2307 Authen::Passphrase $self->_password;
2523 return $auth->match($check_password);
2525 } elsif ( $self->_password_encoding eq 'crypt' ) {
2527 my $auth = from_crypt Authen::Passphrase $self->_password;
2528 return $auth->match($check_password);
2530 } elsif ( $self->_password_encoding eq 'plain' ) {
2532 return $check_password eq $password;
2536 #XXX this could be replaced with Authen::Passphrase stuff
2538 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2540 } elsif ( length($password) < 13 ) { #plaintext
2541 $check_password eq $password;
2542 } elsif ( length($password) == 13 ) { #traditional DES crypt
2543 crypt($check_password, $password) eq $password;
2544 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2545 unix_md5_crypt($check_password, $password) eq $password;
2546 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2547 warn "Can't check password: Blowfish encryption not yet supported, ".
2548 "svcnum ". $self->svcnum. "\n";
2551 warn "Can't check password: Unrecognized encryption for svcnum ".
2552 $self->svcnum. "\n";
2560 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2562 Returns an encrypted password, either by passing through an encrypted password
2563 in the database or by encrypting a plaintext password from the database.
2565 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2566 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2567 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2568 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2569 encryption type is only used if the password is not already encrypted in the
2574 sub crypt_password {
2577 if ( $self->_password_encoding eq 'ldap' ) {
2579 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2582 #XXX this could be replaced with Authen::Passphrase stuff
2584 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2585 if ( $encryption eq 'crypt' ) {
2588 $saltset[int(rand(64))].$saltset[int(rand(64))]
2590 } elsif ( $encryption eq 'md5' ) {
2591 return unix_md5_crypt( $self->_password );
2592 } elsif ( $encryption eq 'blowfish' ) {
2593 croak "unknown encryption method $encryption";
2595 croak "unknown encryption method $encryption";
2598 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2602 } elsif ( $self->_password_encoding eq 'crypt' ) {
2604 return $self->_password;
2606 } elsif ( $self->_password_encoding eq 'plain' ) {
2608 #XXX this could be replaced with Authen::Passphrase stuff
2610 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2611 if ( $encryption eq 'crypt' ) {
2614 $saltset[int(rand(64))].$saltset[int(rand(64))]
2616 } elsif ( $encryption eq 'md5' ) {
2617 return unix_md5_crypt( $self->_password );
2618 } elsif ( $encryption eq 'sha1_base64' ) { #for acct_sql
2619 my $pass = sha1_base64( $self->_password );
2620 $pass .= '=' x (4 - length($pass) % 4); #properly padded base64
2622 } elsif ( $encryption eq 'blowfish' ) {
2623 croak "unknown encryption method $encryption";
2625 croak "unknown encryption method $encryption";
2630 if ( length($self->_password) == 13
2631 || $self->_password =~ /^\$(1|2a?)\$/
2632 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2638 #XXX this could be replaced with Authen::Passphrase stuff
2640 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2641 if ( $encryption eq 'crypt' ) {
2644 $saltset[int(rand(64))].$saltset[int(rand(64))]
2646 } elsif ( $encryption eq 'md5' ) {
2647 return unix_md5_crypt( $self->_password );
2648 } elsif ( $encryption eq 'blowfish' ) {
2649 croak "unknown encryption method $encryption";
2651 croak "unknown encryption method $encryption";
2660 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2662 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2663 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2664 "{MD5}5426824942db4253f87a1009fd5d2d4".
2666 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2667 to work the same as the B</crypt_password> method.
2673 #eventually should check a "password-encoding" field
2675 if ( $self->_password_encoding eq 'ldap' ) {
2677 return $self->_password;
2679 } elsif ( $self->_password_encoding eq 'crypt' ) {
2681 if ( length($self->_password) == 13 ) { #crypt
2682 return '{CRYPT}'. $self->_password;
2683 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2685 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2686 # die "Blowfish encryption not supported in this context, svcnum ".
2687 # $self->svcnum. "\n";
2689 warn "encryption method not (yet?) supported in LDAP context";
2690 return '{CRYPT}*'; #unsupported, should not auth
2693 } elsif ( $self->_password_encoding eq 'plain' ) {
2695 return '{PLAIN}'. $self->_password;
2697 #return '{CLEARTEXT}'. $self->_password; #?
2701 if ( length($self->_password) == 13 ) { #crypt
2702 return '{CRYPT}'. $self->_password;
2703 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2705 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2706 warn "Blowfish encryption not supported in this context, svcnum ".
2707 $self->svcnum. "\n";
2710 #are these two necessary anymore?
2711 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2712 return '{SSHA}'. $1;
2713 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2714 return '{NS-MTA-MD5}'. $1;
2717 return '{PLAIN}'. $self->_password;
2719 #return '{CLEARTEXT}'. $self->_password; #?
2721 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2722 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2723 #if ( $encryption eq 'crypt' ) {
2724 # return '{CRYPT}'. crypt(
2726 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2728 #} elsif ( $encryption eq 'md5' ) {
2729 # unix_md5_crypt( $self->_password );
2730 #} elsif ( $encryption eq 'blowfish' ) {
2731 # croak "unknown encryption method $encryption";
2733 # croak "unknown encryption method $encryption";
2741 =item domain_slash_username
2743 Returns $domain/$username/
2747 sub domain_slash_username {
2749 $self->domain. '/'. $self->username. '/';
2752 =item virtual_maildir
2754 Returns $domain/maildirs/$username/
2758 sub virtual_maildir {
2760 $self->domain. '/maildirs/'. $self->username. '/';
2765 =head1 CLASS METHODS
2769 =item search HASHREF
2771 Class method which returns a qsearch hash expression to search for parameters
2772 specified in HASHREF. Valid parameters are
2786 Arrayref of pkgparts
2792 Arrayref of additional WHERE clauses, will be ANDed together.
2803 my ($class, $params) = @_;
2808 if ( $params->{'domain'} ) {
2809 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2810 #preserve previous behavior & bubble up an error if $svc_domain not found?
2811 push @where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2815 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2816 push @where, "domsvc = $1";
2820 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
2823 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2824 push @where, "cust_main.agentnum = $1";
2828 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2829 push @where, "custnum = $1";
2833 if ( $params->{'pkgpart'} && scalar(@{ $params->{'pkgpart'} }) ) {
2834 #XXX untaint or sql quote
2836 'cust_pkg.pkgpart IN ('. join(',', @{ $params->{'pkgpart'} } ). ')';
2840 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2841 push @where, "popnum = $1";
2845 if ( $params->{'svcpart'} =~ /^(\d+)$/ ) {
2846 push @where, "svcpart = $1";
2850 # here is the agent virtualization
2851 #if ($params->{CurrentUser}) {
2853 # qsearchs('access_user', { username => $params->{CurrentUser} });
2855 # if ($access_user) {
2856 # push @where, $access_user->agentnums_sql('table'=>'cust_main');
2858 # push @where, "1=0";
2861 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
2862 'table' => 'cust_main',
2863 'null_right' => 'View/link unlinked services',
2867 push @where, @{ $params->{'where'} } if $params->{'where'};
2869 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2871 my $addl_from = ' LEFT JOIN cust_svc USING ( svcnum ) '.
2872 ' LEFT JOIN part_svc USING ( svcpart ) '.
2873 ' LEFT JOIN cust_pkg USING ( pkgnum ) '.
2874 ' LEFT JOIN cust_main USING ( custnum ) ';
2876 my $count_query = "SELECT COUNT(*) FROM svc_acct $addl_from $extra_sql";
2877 #if ( keys %svc_acct ) {
2878 # $count_query .= ' WHERE '.
2879 # join(' AND ', map "$_ = ". dbh->quote($svc_acct{$_}),
2885 'table' => 'svc_acct',
2886 'hashref' => {}, # \%svc_acct,
2887 'select' => join(', ',
2890 'cust_main.custnum',
2891 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
2893 'addl_from' => $addl_from,
2894 'extra_sql' => $extra_sql,
2895 'order_by' => $params->{'order_by'},
2896 'count_query' => $count_query,
2909 This is the FS::svc_acct job-queue-able version. It still uses
2910 FS::Misc::send_email under-the-hood.
2917 eval "use FS::Misc qw(send_email)";
2920 $opt{mimetype} ||= 'text/plain';
2921 $opt{mimetype} .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2923 my $error = send_email(
2924 'from' => $opt{from},
2926 'subject' => $opt{subject},
2927 'content-type' => $opt{mimetype},
2928 'body' => [ map "$_\n", split("\n", $opt{body}) ],
2930 die $error if $error;
2933 =item check_and_rebuild_fuzzyfiles
2937 sub check_and_rebuild_fuzzyfiles {
2938 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2939 -e "$dir/svc_acct.username"
2940 or &rebuild_fuzzyfiles;
2943 =item rebuild_fuzzyfiles
2947 sub rebuild_fuzzyfiles {
2949 use Fcntl qw(:flock);
2951 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2955 open(USERNAMELOCK,">>$dir/svc_acct.username")
2956 or die "can't open $dir/svc_acct.username: $!";
2957 flock(USERNAMELOCK,LOCK_EX)
2958 or die "can't lock $dir/svc_acct.username: $!";
2960 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2962 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2963 or die "can't open $dir/svc_acct.username.tmp: $!";
2964 print USERNAMECACHE join("\n", @all_username), "\n";
2965 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2967 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2977 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2978 open(USERNAMECACHE,"<$dir/svc_acct.username")
2979 or die "can't open $dir/svc_acct.username: $!";
2980 my @array = map { chomp; $_; } <USERNAMECACHE>;
2981 close USERNAMECACHE;
2985 =item append_fuzzyfiles USERNAME
2989 sub append_fuzzyfiles {
2990 my $username = shift;
2992 &check_and_rebuild_fuzzyfiles;
2994 use Fcntl qw(:flock);
2996 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2998 open(USERNAME,">>$dir/svc_acct.username")
2999 or die "can't open $dir/svc_acct.username: $!";
3000 flock(USERNAME,LOCK_EX)
3001 or die "can't lock $dir/svc_acct.username: $!";
3003 print USERNAME "$username\n";
3005 flock(USERNAME,LOCK_UN)
3006 or die "can't unlock $dir/svc_acct.username: $!";
3013 =item reached_threshold
3015 Performs some activities when svc_acct thresholds (such as number of seconds
3016 remaining) are reached.
3020 sub reached_threshold {
3023 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
3024 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
3026 if ( $opt{'op'} eq '+' ){
3027 $svc_acct->setfield( $opt{'column'}.'_threshold',
3028 int($svc_acct->getfield($opt{'column'})
3029 * ( $conf->exists('svc_acct-usage_threshold')
3030 ? $conf->config('svc_acct-usage_threshold')/100
3035 my $error = $svc_acct->replace;
3036 die $error if $error;
3037 }elsif ( $opt{'op'} eq '-' ){
3039 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
3040 return '' if ($threshold eq '' );
3042 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
3043 my $error = $svc_acct->replace;
3044 die $error if $error; # email next time, i guess
3046 if ( $warning_template ) {
3047 eval "use FS::Misc qw(send_email)";
3050 my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
3051 my $cust_main = $cust_pkg->cust_main;
3053 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ }
3054 $cust_main->invoicing_list,
3055 ($opt{'to'} ? $opt{'to'} : ())
3058 my $mimetype = $warning_mimetype;
3059 $mimetype .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
3061 my $body = $warning_template->fill_in( HASH => {
3062 'custnum' => $cust_main->custnum,
3063 'username' => $svc_acct->username,
3064 'password' => $svc_acct->_password,
3065 'first' => $cust_main->first,
3066 'last' => $cust_main->getfield('last'),
3067 'pkg' => $cust_pkg->part_pkg->pkg,
3068 'column' => $opt{'column'},
3069 'amount' => $opt{'column'} =~/bytes/
3070 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
3071 : $svc_acct->getfield($opt{'column'}),
3072 'threshold' => $opt{'column'} =~/bytes/
3073 ? FS::UI::bytecount::display_bytecount($threshold)
3078 my $error = send_email(
3079 'from' => $warning_from,
3081 'subject' => $warning_subject,
3082 'content-type' => $mimetype,
3083 'body' => [ map "$_\n", split("\n", $body) ],
3085 die $error if $error;
3088 die "unknown op: " . $opt{'op'};
3096 The $recref stuff in sub check should be cleaned up.
3098 The suspend, unsuspend and cancel methods update the database, but not the
3099 current object. This is probably a bug as it's unexpected and
3102 insertion of RADIUS group stuff in insert could be done with child_objects now
3103 (would probably clean up export of them too)
3105 _op_usage and set_usage bypass the history... maybe they shouldn't
3109 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
3110 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
3111 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
3112 L<freeside-queued>), L<FS::svc_acct_pop>,
3113 schema.html from the base documentation.