4 use base qw( FS::svc_Domain_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
18 $password_noampersand $password_noexclamation
19 $warning_template $warning_from $warning_subject $warning_mimetype
22 $radius_password $radius_ip
25 use Scalar::Util qw( blessed );
30 use Crypt::PasswdMD5 1.2;
31 use Digest::SHA 'sha1_base64';
32 use Digest::MD5 'md5_base64';
35 use Authen::Passphrase;
36 use FS::UID qw( datasrc driver_name );
38 use FS::Record qw( qsearch qsearchs fields dbh dbdef );
39 use FS::Msgcat qw(gettext);
40 use FS::UI::bytecount;
45 use FS::cust_main_invoice;
50 use FS::radius_usergroup;
61 $me = '[FS::svc_acct]';
63 #ask FS::UID to run this stuff for us later
64 FS::UID->install_callback( sub {
66 $dir_prefix = $conf->config('home');
67 @shells = $conf->config('shells');
68 $usernamemin = $conf->config('usernamemin') || 2;
69 $usernamemax = $conf->config('usernamemax');
70 $passwordmin = $conf->config('passwordmin'); # || 6;
72 $passwordmin = ( defined($passwordmin) && $passwordmin =~ /\d+/ )
75 $passwordmax = $conf->config('passwordmax') || 8;
76 $username_letter = $conf->exists('username-letter');
77 $username_letterfirst = $conf->exists('username-letterfirst');
78 $username_noperiod = $conf->exists('username-noperiod');
79 $username_nounderscore = $conf->exists('username-nounderscore');
80 $username_nodash = $conf->exists('username-nodash');
81 $username_uppercase = $conf->exists('username-uppercase');
82 $username_ampersand = $conf->exists('username-ampersand');
83 $username_percent = $conf->exists('username-percent');
84 $username_colon = $conf->exists('username-colon');
85 $username_slash = $conf->exists('username-slash');
86 $username_equals = $conf->exists('username-equals');
87 $username_pound = $conf->exists('username-pound');
88 $password_noampersand = $conf->exists('password-noexclamation');
89 $password_noexclamation = $conf->exists('password-noexclamation');
90 $dirhash = $conf->config('dirhash') || 0;
91 if ( $conf->exists('warning_email') ) {
92 $warning_template = new Text::Template (
94 SOURCE => [ map "$_\n", $conf->config('warning_email') ]
95 ) or warn "can't create warning email template: $Text::Template::ERROR";
96 $warning_from = $conf->config('warning_email-from'); # || 'your-isp-is-dum'
97 $warning_subject = $conf->config('warning_email-subject') || 'Warning';
98 $warning_mimetype = $conf->config('warning_email-mimetype') || 'text/plain';
99 $warning_cc = $conf->config('warning_email-cc');
101 $warning_template = '';
103 $warning_subject = '';
104 $warning_mimetype = '';
107 $smtpmachine = $conf->config('smtpmachine');
108 $radius_password = $conf->config('radius-password') || 'Password';
109 $radius_ip = $conf->config('radius-ip') || 'Framed-IP-Address';
110 @pw_set = ( 'A'..'Z' ) if $conf->exists('password-generated-allcaps');
114 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
115 @pw_set = ( 'a'..'z', 'A'..'Z', '0'..'9', '(', ')', '#', '.', ',' );
119 my ( $hashref, $cache ) = @_;
120 if ( $hashref->{'svc_acct_svcnum'} ) {
121 $self->{'_domsvc'} = FS::svc_domain->new( {
122 'svcnum' => $hashref->{'domsvc'},
123 'domain' => $hashref->{'svc_acct_domain'},
124 'catchall' => $hashref->{'svc_acct_catchall'},
131 FS::svc_acct - Object methods for svc_acct records
137 $record = new FS::svc_acct \%hash;
138 $record = new FS::svc_acct { 'column' => 'value' };
140 $error = $record->insert;
142 $error = $new_record->replace($old_record);
144 $error = $record->delete;
146 $error = $record->check;
148 $error = $record->suspend;
150 $error = $record->unsuspend;
152 $error = $record->cancel;
154 %hash = $record->radius;
156 %hash = $record->radius_reply;
158 %hash = $record->radius_check;
160 $domain = $record->domain;
162 $svc_domain = $record->svc_domain;
164 $email = $record->email;
166 $seconds_since = $record->seconds_since($timestamp);
170 An FS::svc_acct object represents an account. FS::svc_acct inherits from
171 FS::svc_Common. The following fields are currently supported:
177 Primary key (assigned automatcially for new accounts)
185 =item _password_encoding
187 plain, crypt, ldap (or empty for autodetection)
195 Point of presence (see L<FS::svc_acct_pop>)
207 set automatically if blank (and uid is not)
227 svcnum from svc_domain
231 Optional svcnum from svc_pbx
233 =item radius_I<Radius_Attribute>
235 I<Radius-Attribute> (reply)
237 =item rc_I<Radius_Attribute>
239 I<Radius-Attribute> (check)
249 Creates a new account. To add the account to the database, see L<"insert">.
256 'longname_plural' => 'Access accounts and mailboxes',
257 'sorts' => [ 'username', 'uid', 'seconds', 'last_login' ],
258 'display_weight' => 10,
259 'cancel_weight' => 50,
260 'ip_field' => 'slipip',
262 'dir' => 'Home directory',
265 def_info => 'set to fixed and blank for no UIDs',
268 'slipip' => 'IP address',
269 # 'popnum' => qq!<A HREF="$p/browse/svc_acct_pop.cgi/">POP number</A>!,
271 label => 'Access number',
273 select_table => 'svc_acct_pop',
274 select_key => 'popnum',
275 select_label => 'city',
281 disable_default => 1,
285 'password_selfchange' => { label => 'Password modification',
288 'password_recover' => { label => 'Password recovery',
292 label => 'Quota', #Mail storage limit
294 disable_inventory => 1,
298 label => 'File storage limit',
300 disable_inventory => 1,
304 label => 'Number of files limit',
306 disable_inventory => 1,
310 label => 'File size limit',
312 disable_inventory => 1,
315 '_password' => 'Password',
318 def_info => 'when blank, defaults to UID',
323 def_info => 'set to blank for no shell tracking',
325 #select_list => [ $conf->config('shells') ],
326 select_list => [ $conf ? $conf->config('shells') : () ],
327 disable_inventory => 1,
330 'finger' => 'Real name', # (GECOS)',
334 select_table => 'svc_domain',
335 select_key => 'svcnum',
336 select_label => 'domain',
337 disable_inventory => 1,
339 'pbxsvc' => { label => 'PBX',
340 type => 'select-svc_pbx.html',
341 disable_inventory => 1,
342 disable_select => 1, #UI wonky, pry works otherwise
344 'sectornum' => 'Tower sector',
346 label => 'RADIUS groups',
347 type => 'select-radius_group.html',
348 disable_inventory => 1,
352 'seconds' => { label => 'Seconds',
353 label_sort => 'with Time Remaining',
355 disable_inventory => 1,
357 disable_part_svc_column => 1,
359 'upbytes' => { label => 'Upload',
361 disable_inventory => 1,
363 'format' => \&FS::UI::bytecount::display_bytecount,
364 'parse' => \&FS::UI::bytecount::parse_bytecount,
365 disable_part_svc_column => 1,
367 'downbytes' => { label => 'Download',
369 disable_inventory => 1,
371 'format' => \&FS::UI::bytecount::display_bytecount,
372 'parse' => \&FS::UI::bytecount::parse_bytecount,
373 disable_part_svc_column => 1,
375 'totalbytes'=> { label => 'Total up and download',
377 disable_inventory => 1,
379 'format' => \&FS::UI::bytecount::display_bytecount,
380 'parse' => \&FS::UI::bytecount::parse_bytecount,
381 disable_part_svc_column => 1,
383 'seconds_threshold' => { label => 'Seconds threshold',
385 disable_inventory => 1,
387 disable_part_svc_column => 1,
389 'upbytes_threshold' => { label => 'Upload threshold',
391 disable_inventory => 1,
393 'format' => \&FS::UI::bytecount::display_bytecount,
394 'parse' => \&FS::UI::bytecount::parse_bytecount,
395 disable_part_svc_column => 1,
397 'downbytes_threshold' => { label => 'Download threshold',
399 disable_inventory => 1,
401 'format' => \&FS::UI::bytecount::display_bytecount,
402 'parse' => \&FS::UI::bytecount::parse_bytecount,
403 disable_part_svc_column => 1,
405 'totalbytes_threshold'=> { label => 'Total up and download threshold',
407 disable_inventory => 1,
409 'format' => \&FS::UI::bytecount::display_bytecount,
410 'parse' => \&FS::UI::bytecount::parse_bytecount,
411 disable_part_svc_column => 1,
414 label => 'Last login',
418 label => 'Last logout',
423 label => 'Communigate aliases',
425 disable_inventory => 1,
430 label => 'Communigate account type',
432 select_list => [qw( MultiMailbox TextMailbox MailDirMailbox AGrade BGrade CGrade )],
433 disable_inventory => 1,
436 'cgp_accessmodes' => {
437 label => 'Communigate enabled services',
438 type => 'communigate_pro-accessmodes',
439 disable_inventory => 1,
442 'cgp_rulesallowed' => {
443 label => 'Allowed mail rules',
445 select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ],
446 disable_inventory => 1,
449 'cgp_rpopallowed' => { label => 'RPOP modifications',
452 'cgp_mailtoall' => { label => 'Accepts mail to "all"',
455 'cgp_addmailtrailer' => { label => 'Add trailer to sent mail',
458 'cgp_archiveafter' => {
459 label => 'Archive messages after',
462 -2 => 'default(730 days)',
469 1209600 => '2 weeks',
470 2592000 => '30 days',
471 7776000 => '90 days',
472 15552000 => '180 days',
473 31536000 => '365 days',
474 63072000 => '730 days',
476 disable_inventory => 1,
482 'cgp_deletemode' => {
483 label => 'Communigate message delete method',
485 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
486 disable_inventory => 1,
489 'cgp_emptytrash' => {
490 label => 'Communigate on logout remove trash',
492 select_list => __PACKAGE__->cgp_emptytrash_values,
493 disable_inventory => 1,
497 label => 'Communigate language',
499 select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ],
500 disable_inventory => 1,
504 label => 'Communigate time zone',
506 select_list => __PACKAGE__->cgp_timezone_values,
507 disable_inventory => 1,
511 label => 'Communigate layout',
513 select_list => [ '', '***', 'GoldFleece', 'Skin2' ],
514 disable_inventory => 1,
517 'cgp_prontoskinname' => {
518 label => 'Communigate Pronto style',
520 select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ],
521 disable_inventory => 1,
524 'cgp_sendmdnmode' => {
525 label => 'Communigate send read receipts',
527 select_list => [ '', 'Never', 'Manually', 'Automatically' ],
528 disable_inventory => 1,
539 sub table { 'svc_acct'; }
541 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
544 shift->_lastlog('in', @_);
548 shift->_lastlog('out', @_);
552 my( $self, $op, $time ) = @_;
554 if ( defined($time) ) {
555 warn "$me last_log$op called on svcnum ". $self->svcnum.
556 ' ('. $self->email. "): $time\n"
561 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
565 my $sth = $dbh->prepare( $sql )
566 or die "Error preparing $sql: ". $dbh->errstr;
567 my $rv = $sth->execute($time, $self->svcnum);
568 die "Error executing $sql: ". $sth->errstr
570 die "Can't update last_log$op for svcnum". $self->svcnum
573 $self->{'Hash'}->{"last_log$op"} = $time;
575 $self->getfield("last_log$op");
579 =item search_sql STRING
581 Class method which returns an SQL fragment to search for the given string.
586 my( $class, $string ) = @_;
587 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
588 my( $username, $domain ) = ( $1, $2 );
589 my $q_username = dbh->quote($username);
590 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
592 "svc_acct.username = $q_username AND ( ".
593 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
598 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
600 $class->search_sql_field('slipip', $string ).
602 $class->search_sql_field('username', $string ).
605 $class->search_sql_field('username', $string);
609 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
611 Returns the "username@domain" string for this account.
613 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
623 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
625 Returns a longer string label for this acccount ("Real Name <username@domain>"
626 if available, or "username@domain").
628 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
635 my $label = $self->label(@_);
636 my $finger = $self->finger;
637 return $label unless $finger =~ /\S/;
638 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
639 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
643 =item insert [ , OPTION => VALUE ... ]
645 Adds this account to the database. If there is an error, returns the error,
646 otherwise returns false.
648 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
649 defined. An FS::cust_svc record will be created and inserted.
651 The additional field I<usergroup> can optionally be defined; if so it should
652 contain an arrayref of group names. See L<FS::radius_usergroup>.
654 The additional field I<child_objects> can optionally be defined; if so it
655 should contain an arrayref of FS::tablename objects. They will have their
656 svcnum fields set and will be inserted after this record, but before any
657 exports are run. Each element of the array can also optionally be a
658 two-element array reference containing the child object and the name of an
659 alternate field to be filled in with the newly-inserted svcnum, for example
660 C<[ $svc_forward, 'srcsvc' ]>
662 Currently available options are: I<depend_jobnum>
664 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
665 jobnums), all provisioning jobs will have a dependancy on the supplied
666 jobnum(s) (they will not run until the specific job(s) complete(s)).
668 (TODOC: L<FS::queue> and L<freeside-queued>)
670 (TODOC: new exports!)
679 warn "[$me] insert called on $self: ". Dumper($self).
680 "\nwith options: ". Dumper(%options);
683 local $SIG{HUP} = 'IGNORE';
684 local $SIG{INT} = 'IGNORE';
685 local $SIG{QUIT} = 'IGNORE';
686 local $SIG{TERM} = 'IGNORE';
687 local $SIG{TSTP} = 'IGNORE';
688 local $SIG{PIPE} = 'IGNORE';
690 my $oldAutoCommit = $FS::UID::AutoCommit;
691 local $FS::UID::AutoCommit = 0;
695 my $error = $self->SUPER::insert( # usergroup is here
696 'jobnums' => \@jobnums,
697 'child_objects' => $self->child_objects,
701 $dbh->rollback if $oldAutoCommit;
705 unless ( $skip_fuzzyfiles ) {
706 $error = $self->queue_fuzzyfiles_update;
708 $dbh->rollback if $oldAutoCommit;
709 return "updating fuzzy search cache: $error";
713 my $cust_pkg = $self->cust_svc->cust_pkg;
716 my $cust_main = $cust_pkg->cust_main;
717 my $agentnum = $cust_main->agentnum;
719 if ( $conf->exists('emailinvoiceautoalways')
720 || $conf->exists('emailinvoiceauto')
721 && ! $cust_main->invoicing_list_emailonly
723 my @invoicing_list = $cust_main->invoicing_list;
724 push @invoicing_list, $self->email;
725 $cust_main->invoicing_list(\@invoicing_list);
729 my @welcome_exclude_svcparts = $conf->config('svc_acct_welcome_exclude');
730 unless ( grep { $_ eq $self->svcpart } @welcome_exclude_svcparts ) {
732 my $msgnum = $conf->config('welcome_msgnum', $agentnum);
734 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
735 $error = $msg_template->send('cust_main' => $cust_main,
739 my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
740 = ('','','','','','');
742 if ( $conf->exists('welcome_email', $agentnum) ) {
743 $welcome_template = new Text::Template (
745 SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
746 ) or warn "can't create welcome email template: $Text::Template::ERROR";
747 $welcome_from = $conf->config('welcome_email-from', $agentnum);
748 # || 'your-isp-is-dum'
749 $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
751 $welcome_subject_template = new Text::Template (
753 SOURCE => $welcome_subject,
754 ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
755 $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
758 if ( $welcome_template ) {
759 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
763 'custnum' => $self->custnum,
764 'username' => $self->username,
765 'password' => $self->_password,
766 'first' => $cust_main->first,
767 'last' => $cust_main->getfield('last'),
768 'pkg' => $cust_pkg->part_pkg->pkg,
770 my $wqueue = new FS::queue {
771 'svcnum' => $self->svcnum,
772 'job' => 'FS::svc_acct::send_email'
774 my $error = $wqueue->insert(
776 'from' => $welcome_from,
777 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
778 'mimetype' => $welcome_mimetype,
779 'body' => $welcome_template->fill_in( HASH => \%hash, ),
782 $dbh->rollback if $oldAutoCommit;
783 return "error queuing welcome email: $error";
786 if ( $options{'depend_jobnum'} ) {
787 warn "$me depend_jobnum found; adding to welcome email dependancies"
789 if ( ref($options{'depend_jobnum'}) ) {
790 warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
791 "to welcome email dependancies"
793 push @jobnums, @{ $options{'depend_jobnum'} };
795 warn "$me adding job $options{'depend_jobnum'} ".
796 "to welcome email dependancies"
798 push @jobnums, $options{'depend_jobnum'};
802 foreach my $jobnum ( @jobnums ) {
803 my $error = $wqueue->depend_insert($jobnum);
805 $dbh->rollback if $oldAutoCommit;
806 return "error queuing welcome email job dependancy: $error";
812 } # if $welcome_template
817 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
821 # set usage fields and thresholds if unset but set in a package def
822 # AND the package already has a last bill date (otherwise they get double added)
823 sub preinsert_hook_first {
826 return '' unless $self->pkgnum;
828 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
829 return '' unless $cust_pkg && $cust_pkg->last_bill;
831 my $part_pkg = $cust_pkg->part_pkg;
832 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
834 my %values = $part_pkg->usage_valuehash;
835 my $multiplier = $conf->exists('svc_acct-usage_threshold')
836 ? 1 - $conf->config('svc_acct-usage_threshold')/100
837 : 0.20; #doesn't matter
839 foreach ( keys %values ) {
840 next if $self->getfield($_);
841 $self->setfield( $_, $values{$_} );
842 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
843 if $conf->exists('svc_acct-usage_threshold');
851 Deletes this account from the database. If there is an error, returns the
852 error, otherwise returns false.
854 The corresponding FS::cust_svc record will be deleted as well.
856 (TODOC: new exports!)
863 return "can't delete system account" if $self->_check_system;
865 return "Can't delete an account which is a (svc_forward) source!"
866 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
868 return "Can't delete an account which is a (svc_forward) destination!"
869 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
871 return "Can't delete an account with (svc_www) web service!"
872 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
874 # what about records in session ? (they should refer to history table)
876 local $SIG{HUP} = 'IGNORE';
877 local $SIG{INT} = 'IGNORE';
878 local $SIG{QUIT} = 'IGNORE';
879 local $SIG{TERM} = 'IGNORE';
880 local $SIG{TSTP} = 'IGNORE';
881 local $SIG{PIPE} = 'IGNORE';
883 my $oldAutoCommit = $FS::UID::AutoCommit;
884 local $FS::UID::AutoCommit = 0;
887 foreach my $cust_main_invoice (
888 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
890 unless ( defined($cust_main_invoice) ) {
891 warn "WARNING: something's wrong with qsearch";
894 my %hash = $cust_main_invoice->hash;
895 $hash{'dest'} = $self->email;
896 my $new = new FS::cust_main_invoice \%hash;
897 my $error = $new->replace($cust_main_invoice);
899 $dbh->rollback if $oldAutoCommit;
904 foreach my $svc_domain (
905 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
907 my %hash = new FS::svc_domain->hash;
908 $hash{'catchall'} = '';
909 my $new = new FS::svc_domain \%hash;
910 my $error = $new->replace($svc_domain);
912 $dbh->rollback if $oldAutoCommit;
917 my $error = $self->SUPER::delete; # usergroup here
919 $dbh->rollback if $oldAutoCommit;
923 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
927 =item replace OLD_RECORD
929 Replaces OLD_RECORD with this one in the database. If there is an error,
930 returns the error, otherwise returns false.
932 The additional field I<usergroup> can optionally be defined; if so it should
933 contain an arrayref of group names. See L<FS::radius_usergroup>.
941 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
945 warn "$me replacing $old with $new\n" if $DEBUG;
949 return "can't modify system account" if $old->_check_system;
952 #no warnings 'numeric'; #alas, a 5.006-ism
955 foreach my $xid (qw( uid gid )) {
957 return "Can't change $xid!"
958 if ! $conf->exists("svc_acct-edit_$xid")
959 && $old->$xid() != $new->$xid()
960 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
965 return "can't change username"
966 if $old->username ne $new->username
967 && $conf->exists('svc_acct-no_edit_username');
969 #change homdir when we change username
970 $new->setfield('dir', '') if $old->username ne $new->username;
972 local $SIG{HUP} = 'IGNORE';
973 local $SIG{INT} = 'IGNORE';
974 local $SIG{QUIT} = 'IGNORE';
975 local $SIG{TERM} = 'IGNORE';
976 local $SIG{TSTP} = 'IGNORE';
977 local $SIG{PIPE} = 'IGNORE';
979 my $oldAutoCommit = $FS::UID::AutoCommit;
980 local $FS::UID::AutoCommit = 0;
983 $error = $new->SUPER::replace($old, @_); # usergroup here
985 $dbh->rollback if $oldAutoCommit;
986 return $error if $error;
989 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
990 $error = $new->queue_fuzzyfiles_update;
992 $dbh->rollback if $oldAutoCommit;
993 return "updating fuzzy search cache: $error";
997 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1001 =item queue_fuzzyfiles_update
1003 Used by insert & replace to update the fuzzy search cache
1007 sub queue_fuzzyfiles_update {
1010 local $SIG{HUP} = 'IGNORE';
1011 local $SIG{INT} = 'IGNORE';
1012 local $SIG{QUIT} = 'IGNORE';
1013 local $SIG{TERM} = 'IGNORE';
1014 local $SIG{TSTP} = 'IGNORE';
1015 local $SIG{PIPE} = 'IGNORE';
1017 my $oldAutoCommit = $FS::UID::AutoCommit;
1018 local $FS::UID::AutoCommit = 0;
1021 my $queue = new FS::queue {
1022 'svcnum' => $self->svcnum,
1023 'job' => 'FS::svc_acct::append_fuzzyfiles'
1025 my $error = $queue->insert($self->username);
1027 $dbh->rollback if $oldAutoCommit;
1028 return "queueing job (transaction rolled back): $error";
1031 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1039 Suspends this account by calling export-specific suspend hooks. If there is
1040 an error, returns the error, otherwise returns false.
1042 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1048 return "can't suspend system account" if $self->_check_system;
1049 $self->SUPER::suspend(@_);
1054 Unsuspends this account by by calling export-specific suspend hooks. If there
1055 is an error, returns the error, otherwise returns false.
1057 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1063 my %hash = $self->hash;
1064 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1065 $hash{_password} = $1;
1066 my $new = new FS::svc_acct ( \%hash );
1067 my $error = $new->replace($self);
1068 return $error if $error;
1071 $self->SUPER::unsuspend(@_);
1076 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1078 If the B<auto_unset_catchall> configuration option is set, this method will
1079 automatically remove any references to the canceled service in the catchall
1080 field of svc_domain. This allows packages that contain both a svc_domain and
1081 its catchall svc_acct to be canceled in one step.
1086 # Only one thing to do at this level
1088 foreach my $svc_domain (
1089 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1090 if($conf->exists('auto_unset_catchall')) {
1091 my %hash = $svc_domain->hash;
1092 $hash{catchall} = '';
1093 my $new = new FS::svc_domain ( \%hash );
1094 my $error = $new->replace($svc_domain);
1095 return $error if $error;
1097 return "cannot unprovision svc_acct #".$self->svcnum.
1098 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1102 $self->SUPER::cancel(@_);
1108 Checks all fields to make sure this is a valid service. If there is an error,
1109 returns the error, otherwise returns false. Called by the insert and replace
1112 Sets any fixed values; see L<FS::part_svc>.
1119 my($recref) = $self->hashref;
1121 my $x = $self->setfixed;
1122 return $x unless ref($x);
1125 my $error = $self->ut_numbern('svcnum')
1126 #|| $self->ut_number('domsvc')
1127 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1128 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1129 || $self->ut_foreign_keyn('sectornum','tower_sector','sectornum')
1130 || $self->ut_foreign_keyn('routernum','router','routernum')
1131 || $self->ut_foreign_keyn('blocknum','addr_block','blocknum')
1132 || $self->ut_textn('sec_phrase')
1133 || $self->ut_snumbern('seconds')
1134 || $self->ut_snumbern('upbytes')
1135 || $self->ut_snumbern('downbytes')
1136 || $self->ut_snumbern('totalbytes')
1137 || $self->ut_snumbern('seconds_threshold')
1138 || $self->ut_snumbern('upbytes_threshold')
1139 || $self->ut_snumbern('downbytes_threshold')
1140 || $self->ut_snumbern('totalbytes_threshold')
1141 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1142 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1143 || $self->ut_enum('password_recover', [ '', 'Y' ])
1145 || $self->ut_anything('cf_privatekey')
1147 || $self->ut_textn('cgp_accessmodes')
1148 || $self->ut_alphan('cgp_type')
1149 || $self->ut_textn('cgp_aliases' ) #well
1151 || $self->ut_alphasn('cgp_rulesallowed')
1152 || $self->ut_enum('cgp_rpopallowed', [ '', 'Y' ])
1153 || $self->ut_enum('cgp_mailtoall', [ '', 'Y' ])
1154 || $self->ut_enum('cgp_addmailtrailer', [ '', 'Y' ])
1155 || $self->ut_snumbern('cgp_archiveafter')
1157 || $self->ut_alphasn('cgp_deletemode')
1158 || $self->ut_enum('cgp_emptytrash', $self->cgp_emptytrash_values)
1159 || $self->ut_alphan('cgp_language')
1160 || $self->ut_textn('cgp_timezone')
1161 || $self->ut_textn('cgp_skinname')
1162 || $self->ut_textn('cgp_prontoskinname')
1163 || $self->ut_alphan('cgp_sendmdnmode')
1165 return $error if $error;
1167 # assign IP address, etc.
1168 if ( $conf->exists('svc_acct-ip_addr') ) {
1169 my $error = $self->svc_ip_check;
1170 return $error if $error;
1171 } else { # I think this is correct
1172 $self->routernum('');
1173 $self->blocknum('');
1177 local $username_letter = $username_letter;
1178 local $username_uppercase = $username_uppercase;
1179 if ($self->svcnum) {
1180 my $cust_svc = $self->cust_svc
1181 or return "no cust_svc record found for svcnum ". $self->svcnum;
1182 my $cust_pkg = $cust_svc->cust_pkg;
1184 if ($self->pkgnum) {
1185 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1189 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1190 $username_uppercase =
1191 $conf->exists('username-uppercase', $cust_pkg->cust_main->agentnum);
1194 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1196 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:\/\=\#]{$usernamemin,$ulen})$/i
1197 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1198 $recref->{username} = $1;
1200 my $uerror = gettext('illegal_username'). ': '. $recref->{username};
1202 unless ( $username_uppercase ) {
1203 $recref->{username} =~ /[A-Z]/ and return $uerror;
1205 if ( $username_letterfirst ) {
1206 $recref->{username} =~ /^[a-z]/ or return $uerror;
1207 } elsif ( $username_letter ) {
1208 $recref->{username} =~ /[a-z]/ or return $uerror;
1210 if ( $username_noperiod ) {
1211 $recref->{username} =~ /\./ and return $uerror;
1213 if ( $username_nounderscore ) {
1214 $recref->{username} =~ /_/ and return $uerror;
1216 if ( $username_nodash ) {
1217 $recref->{username} =~ /\-/ and return $uerror;
1219 unless ( $username_ampersand ) {
1220 $recref->{username} =~ /\&/ and return $uerror;
1222 unless ( $username_percent ) {
1223 $recref->{username} =~ /\%/ and return $uerror;
1225 unless ( $username_colon ) {
1226 $recref->{username} =~ /\:/ and return $uerror;
1228 unless ( $username_slash ) {
1229 $recref->{username} =~ /\// and return $uerror;
1231 unless ( $username_equals ) {
1232 $recref->{username} =~ /\=/ and return $uerror;
1234 unless ( $username_pound ) {
1235 $recref->{username} =~ /\#/ and return $uerror;
1239 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1240 $recref->{popnum} = $1;
1241 return "Unknown popnum" unless
1242 ! $recref->{popnum} ||
1243 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1245 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1247 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1248 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1250 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1251 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1252 #not all systems use gid=uid
1253 #you can set a fixed gid in part_svc
1255 return "Only root can have uid 0"
1256 if $recref->{uid} == 0
1257 && $recref->{username} !~ /^(root|toor|smtp)$/;
1259 unless ( $recref->{username} eq 'sync' ) {
1260 if ( grep $_ eq $recref->{shell}, @shells ) {
1261 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1263 return "Illegal shell \`". $self->shell. "\'; ".
1264 "shells configuration value contains: @shells";
1267 $recref->{shell} = '/bin/sync';
1271 $recref->{gid} ne '' ?
1272 return "Can't have gid without uid" : ( $recref->{gid}='' );
1273 #$recref->{dir} ne '' ?
1274 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1275 $recref->{shell} ne '' ?
1276 return "Can't have shell without uid" : ( $recref->{shell}='' );
1279 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1281 $recref->{dir} =~ /^([\/\w\-\.\&\:\#]*)$/
1282 or return "Illegal directory: ". $recref->{dir};
1283 $recref->{dir} = $1;
1284 return "Illegal directory"
1285 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1286 return "Illegal directory"
1287 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1288 unless ( $recref->{dir} ) {
1289 $recref->{dir} = $dir_prefix . '/';
1290 if ( $dirhash > 0 ) {
1291 for my $h ( 1 .. $dirhash ) {
1292 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1294 } elsif ( $dirhash < 0 ) {
1295 for my $h ( reverse $dirhash .. -1 ) {
1296 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1299 $recref->{dir} .= $recref->{username};
1305 if ( $self->getfield('finger') eq '' ) {
1306 my $cust_pkg = $self->svcnum
1307 ? $self->cust_svc->cust_pkg
1308 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1310 my $cust_main = $cust_pkg->cust_main;
1311 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1314 # $error = $self->ut_textn('finger');
1315 # return $error if $error;
1316 $self->getfield('finger') =~ /^([\w \,\.\-\'\&\t\!\@\#\$\%\(\)\+\;\"\?\/\*\<\>]*)$/
1317 or return "Illegal finger: ". $self->getfield('finger');
1318 $self->setfield('finger', $1);
1320 for (qw( quota file_quota file_maxsize )) {
1321 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1324 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1325 $recref->{file_maxnum} = $1;
1327 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1328 if ( $recref->{slipip} eq '' ) {
1329 $recref->{slipip} = ''; # eh?
1330 } elsif ( $recref->{slipip} eq '0e0' ) {
1331 $recref->{slipip} = '0e0';
1333 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1334 or return "Illegal slipip: ". $self->slipip;
1335 $recref->{slipip} = $1;
1339 #arbitrary RADIUS stuff; allow ut_textn for now
1340 foreach ( grep /^radius_/, fields('svc_acct') ) {
1341 $self->ut_textn($_);
1344 # First, if _password is blank, generate one and set default encoding.
1345 if ( ! $recref->{_password} ) {
1346 $error = $self->set_password('');
1348 # But if there's a _password but no encoding, assume it's plaintext and
1349 # set it to default encoding.
1350 elsif ( ! $recref->{_password_encoding} ) {
1351 $error = $self->set_password($recref->{_password});
1353 return $error if $error;
1355 # Next, check _password to ensure compliance with the encoding.
1356 if ( $recref->{_password_encoding} eq 'ldap' ) {
1358 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1359 $recref->{_password} = uc($1).$2;
1361 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1364 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1366 if ( $recref->{_password} =~
1367 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1368 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1371 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1374 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1377 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1378 # Password randomization is now in set_password.
1379 # Strip whitespace characters, check length requirements, etc.
1380 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1381 $recref->{_password} = $1;
1383 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1384 FS::Msgcat::_gettext('illegal_password_characters').
1385 ": ". $recref->{_password};
1388 if ( $password_noampersand ) {
1389 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1391 if ( $password_noexclamation ) {
1392 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1396 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1399 $self->SUPER::check;
1404 sub _password_encryption {
1406 my $encoding = lc($self->_password_encoding);
1407 return if !$encoding;
1408 return 'plain' if $encoding eq 'plain';
1409 if($encoding eq 'crypt') {
1410 my $pass = $self->_password;
1411 $pass =~ s/^\*SUSPENDED\* //;
1413 return 'md5' if $pass =~ /^\$1\$/;
1414 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1415 return 'des' if length($pass) == 13;
1418 if($encoding eq 'ldap') {
1419 uc($self->_password) =~ /^\{([\w-]+)\}/;
1420 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1421 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1422 return 'md5' if $1 eq 'MD5';
1423 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1430 sub get_cleartext_password {
1432 if($self->_password_encryption eq 'plain') {
1433 if($self->_password_encoding eq 'ldap') {
1434 $self->_password =~ /\{\w+\}(.*)$/;
1438 return $self->_password;
1447 Set the cleartext password for the account. If _password_encoding is set, the
1448 new password will be encoded according to the existing method (including
1449 encryption mode, if it can be determined). Otherwise,
1450 config('default-password-encoding') is used.
1452 If no password is supplied (or a zero-length password when minimum password length
1453 is >0), one will be generated randomly.
1458 my( $self, $pass ) = ( shift, shift );
1460 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1463 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1464 FS::Msgcat::_gettext('illegal_password_characters').
1467 my( $encoding, $encryption ) = ('', '');
1469 if ( $self->_password_encoding ) {
1470 $encoding = $self->_password_encoding;
1471 # identify existing encryption method, try to use it.
1472 $encryption = $self->_password_encryption;
1474 # use the system default
1480 # set encoding to system default
1481 ($encoding, $encryption) =
1482 split(/-/, lc($conf->config('default-password-encoding') || ''));
1483 $encoding ||= 'legacy';
1484 $self->_password_encoding($encoding);
1487 if ( $encoding eq 'legacy' ) {
1489 # The legacy behavior from check():
1490 # If the password is blank, randomize it and set encoding to 'plain'.
1491 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1492 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1493 $self->_password_encoding('plain');
1495 # Prefix + valid-length password
1496 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1498 $self->_password_encoding('plain');
1499 # Prefix + crypt string
1500 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1502 $self->_password_encoding('crypt');
1503 # Various disabled crypt passwords
1504 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1505 $self->_password_encoding('crypt');
1511 $self->_password($pass);
1517 if $passwordmin && length($pass) < $passwordmin
1518 or $passwordmax && length($pass) > $passwordmax;
1520 if ( $encoding eq 'crypt' ) {
1521 if ($encryption eq 'md5') {
1522 $pass = unix_md5_crypt($pass);
1523 } elsif ($encryption eq 'des') {
1524 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1527 } elsif ( $encoding eq 'ldap' ) {
1528 if ($encryption eq 'md5') {
1529 $pass = md5_base64($pass);
1530 } elsif ($encryption eq 'sha1') {
1531 $pass = sha1_base64($pass);
1532 } elsif ($encryption eq 'crypt') {
1533 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1535 # else $encryption eq 'plain', do nothing
1536 $pass .= '=' x (4 - length($pass) % 4) #properly padded base64
1537 if $encryption eq 'md5' || $encryption eq 'sha1';
1538 $pass = '{'.uc($encryption).'}'.$pass;
1540 # else encoding eq 'plain'
1542 $self->_password($pass);
1548 Internal function to check the username against the list of system usernames
1549 from the I<system_usernames> configuration value. Returns true if the username
1550 is listed on the system username list.
1556 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1557 $conf->config('system_usernames')
1561 =item _check_duplicate
1563 Internal method to check for duplicates usernames, username@domain pairs and
1566 If the I<global_unique-username> configuration value is set to B<username> or
1567 B<username@domain>, enforces global username or username@domain uniqueness.
1569 In all cases, check for duplicate uids and usernames or username@domain pairs
1570 per export and with identical I<svcpart> values.
1574 sub _check_duplicate {
1577 my $global_unique = $conf->config('global_unique-username') || 'none';
1578 return '' if $global_unique eq 'disabled';
1582 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1583 unless ( $part_svc ) {
1584 return 'unknown svcpart '. $self->svcpart;
1587 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1588 qsearch( 'svc_acct', { 'username' => $self->username } );
1589 return gettext('username_in_use')
1590 if $global_unique eq 'username' && @dup_user;
1592 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1593 qsearch( 'svc_acct', { 'username' => $self->username,
1594 'domsvc' => $self->domsvc } );
1595 return gettext('username_in_use')
1596 if $global_unique eq 'username@domain' && @dup_userdomain;
1599 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1600 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1601 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1602 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1607 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1608 my $exports = FS::part_export::export_info('svc_acct');
1609 my %conflict_user_svcpart;
1610 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1612 foreach my $part_export ( $part_svc->part_export ) {
1614 #this will catch to the same exact export
1615 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1617 #this will catch to exports w/same exporthost+type ???
1618 #my @other_part_export = qsearch('part_export', {
1619 # 'machine' => $part_export->machine,
1620 # 'exporttype' => $part_export->exporttype,
1622 #foreach my $other_part_export ( @other_part_export ) {
1623 # push @svcparts, map { $_->svcpart }
1624 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1627 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1628 #silly kludge to avoid uninitialized value errors
1629 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1630 ? $exports->{$part_export->exporttype}{'nodomain'}
1632 if ( $nodomain =~ /^Y/i ) {
1633 $conflict_user_svcpart{$_} = $part_export->exportnum
1636 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1641 foreach my $dup_user ( @dup_user ) {
1642 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1643 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1644 return "duplicate username ". $self->username.
1645 ": conflicts with svcnum ". $dup_user->svcnum.
1646 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1650 foreach my $dup_userdomain ( @dup_userdomain ) {
1651 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1652 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1653 return "duplicate username\@domain ". $self->email.
1654 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1655 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1659 foreach my $dup_uid ( @dup_uid ) {
1660 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1661 if ( exists($conflict_user_svcpart{$dup_svcpart})
1662 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1663 return "duplicate uid ". $self->uid.
1664 ": conflicts with svcnum ". $dup_uid->svcnum.
1666 ( $conflict_user_svcpart{$dup_svcpart}
1667 || $conflict_userdomain_svcpart{$dup_svcpart} );
1679 Depriciated, use radius_reply instead.
1684 carp "FS::svc_acct::radius depriciated, use radius_reply";
1685 $_[0]->radius_reply;
1690 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1691 reply attributes of this record.
1693 Note that this is now the preferred method for reading RADIUS attributes -
1694 accessing the columns directly is discouraged, as the column names are
1695 expected to change in the future.
1702 return %{ $self->{'radius_reply'} }
1703 if exists $self->{'radius_reply'};
1708 my($column, $attrib) = ($1, $2);
1709 #$attrib =~ s/_/\-/g;
1710 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1711 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1713 if ( $self->slipip && $self->slipip ne '0e0' ) {
1714 $reply{$radius_ip} = $self->slipip;
1717 if ( $self->seconds !~ /^$/ ) {
1718 $reply{'Session-Timeout'} = $self->seconds;
1721 if ( $conf->exists('radius-chillispot-max') ) {
1722 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1724 #hmm. just because sqlradius.pm says so?
1731 foreach my $what (qw( input output total )) {
1732 my $is = $whatis{$what}.'bytes';
1733 if ( $self->$is() =~ /\d/ ) {
1734 my $big = new Math::BigInt $self->$is();
1735 $big = new Math::BigInt '0' if $big->is_neg();
1736 my $att = "Chillispot-Max-\u$what";
1737 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1738 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1749 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1750 check attributes of this record.
1752 Note that this is now the preferred method for reading RADIUS attributes -
1753 accessing the columns directly is discouraged, as the column names are
1754 expected to change in the future.
1761 return %{ $self->{'radius_check'} }
1762 if exists $self->{'radius_check'};
1767 my($column, $attrib) = ($1, $2);
1768 #$attrib =~ s/_/\-/g;
1769 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1770 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1773 my($pw_attrib, $password) = $self->radius_password;
1774 $check{$pw_attrib} = $password;
1776 my $cust_svc = $self->cust_svc;
1778 my $cust_pkg = $cust_svc->cust_pkg;
1779 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1780 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1783 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1784 "; can't set Expiration\n"
1792 =item radius_password
1794 Returns a key/value pair containing the RADIUS attribute name and value
1799 sub radius_password {
1803 if ( $self->_password_encoding eq 'ldap' ) {
1804 $pw_attrib = 'Password-With-Header';
1805 } elsif ( $self->_password_encoding eq 'crypt' ) {
1806 $pw_attrib = 'Crypt-Password';
1807 } elsif ( $self->_password_encoding eq 'plain' ) {
1808 $pw_attrib = $radius_password;
1810 $pw_attrib = length($self->_password) <= 12
1815 ($pw_attrib, $self->_password);
1821 This method instructs the object to "snapshot" or freeze RADIUS check and
1822 reply attributes to the current values.
1826 #bah, my english is too broken this morning
1827 #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
1828 #the FS::cust_pkg's replace method to trigger the correct export updates when
1829 #package dates change)
1834 $self->{$_} = { $self->$_() }
1835 foreach qw( radius_reply radius_check );
1839 =item forget_snapshot
1841 This methos instructs the object to forget any previously snapshotted
1842 RADIUS check and reply attributes.
1846 sub forget_snapshot {
1850 foreach qw( radius_reply radius_check );
1854 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1856 Returns the domain associated with this account.
1858 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1865 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1866 my $svc_domain = $self->svc_domain(@_)
1867 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1868 $svc_domain->domain;
1873 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1877 #inherited from svc_Common
1879 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1881 Returns an email address associated with the account.
1883 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1890 $self->username. '@'. $self->domain(@_);
1895 Returns an array of FS::acct_snarf records associated with the account.
1902 'table' => 'acct_snarf',
1903 'hashref' => { 'svcnum' => $self->svcnum },
1904 #'order_by' => 'ORDER BY priority ASC',
1908 =item cgp_rpop_hashref
1910 Returns an arrayref of RPOP data suitable for Communigate Pro API commands.
1914 sub cgp_rpop_hashref {
1916 { map { $_->snarfname => $_->cgp_hashref } $self->acct_snarf };
1919 =item decrement_upbytes OCTETS
1921 Decrements the I<upbytes> field of this record by the given amount. If there
1922 is an error, returns the error, otherwise returns false.
1926 sub decrement_upbytes {
1927 shift->_op_usage('-', 'upbytes', @_);
1930 =item increment_upbytes OCTETS
1932 Increments the I<upbytes> field of this record by the given amount. If there
1933 is an error, returns the error, otherwise returns false.
1937 sub increment_upbytes {
1938 shift->_op_usage('+', 'upbytes', @_);
1941 =item decrement_downbytes OCTETS
1943 Decrements the I<downbytes> field of this record by the given amount. If there
1944 is an error, returns the error, otherwise returns false.
1948 sub decrement_downbytes {
1949 shift->_op_usage('-', 'downbytes', @_);
1952 =item increment_downbytes OCTETS
1954 Increments the I<downbytes> field of this record by the given amount. If there
1955 is an error, returns the error, otherwise returns false.
1959 sub increment_downbytes {
1960 shift->_op_usage('+', 'downbytes', @_);
1963 =item decrement_totalbytes OCTETS
1965 Decrements the I<totalbytes> field of this record by the given amount. If there
1966 is an error, returns the error, otherwise returns false.
1970 sub decrement_totalbytes {
1971 shift->_op_usage('-', 'totalbytes', @_);
1974 =item increment_totalbytes OCTETS
1976 Increments the I<totalbytes> field of this record by the given amount. If there
1977 is an error, returns the error, otherwise returns false.
1981 sub increment_totalbytes {
1982 shift->_op_usage('+', 'totalbytes', @_);
1985 =item decrement_seconds SECONDS
1987 Decrements the I<seconds> field of this record by the given amount. If there
1988 is an error, returns the error, otherwise returns false.
1992 sub decrement_seconds {
1993 shift->_op_usage('-', 'seconds', @_);
1996 =item increment_seconds SECONDS
1998 Increments the I<seconds> field of this record by the given amount. If there
1999 is an error, returns the error, otherwise returns false.
2003 sub increment_seconds {
2004 shift->_op_usage('+', 'seconds', @_);
2012 my %op2condition = (
2013 '-' => sub { my($self, $column, $amount) = @_;
2014 $self->$column - $amount <= 0;
2016 '+' => sub { my($self, $column, $amount) = @_;
2017 ($self->$column || 0) + $amount > 0;
2020 my %op2warncondition = (
2021 '-' => sub { my($self, $column, $amount) = @_;
2022 my $threshold = $column . '_threshold';
2023 $self->$column - $amount <= $self->$threshold + 0;
2025 '+' => sub { my($self, $column, $amount) = @_;
2026 ($self->$column || 0) + $amount > 0;
2031 my( $self, $op, $column, $amount ) = @_;
2033 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
2034 ' ('. $self->email. "): $op $amount\n"
2037 return '' unless $amount;
2039 local $SIG{HUP} = 'IGNORE';
2040 local $SIG{INT} = 'IGNORE';
2041 local $SIG{QUIT} = 'IGNORE';
2042 local $SIG{TERM} = 'IGNORE';
2043 local $SIG{TSTP} = 'IGNORE';
2044 local $SIG{PIPE} = 'IGNORE';
2046 my $oldAutoCommit = $FS::UID::AutoCommit;
2047 local $FS::UID::AutoCommit = 0;
2050 my $sql = "UPDATE svc_acct SET $column = ".
2051 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
2052 " $op ? WHERE svcnum = ?";
2056 my $sth = $dbh->prepare( $sql )
2057 or die "Error preparing $sql: ". $dbh->errstr;
2058 my $rv = $sth->execute($amount, $self->svcnum);
2059 die "Error executing $sql: ". $sth->errstr
2060 unless defined($rv);
2061 die "Can't update $column for svcnum". $self->svcnum
2064 #$self->snapshot; #not necessary, we retain the old values
2065 #create an object with the updated usage values
2066 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2068 my $error = $new->replace($self);
2070 $dbh->rollback if $oldAutoCommit;
2071 return "Error replacing: $error";
2074 #overlimit_action eq 'cancel' handling
2075 my $cust_pkg = $self->cust_svc->cust_pkg;
2077 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2078 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2082 my $error = $cust_pkg->cancel; #XXX should have a reason
2084 $dbh->rollback if $oldAutoCommit;
2085 return "Error cancelling: $error";
2088 #nothing else is relevant if we're cancelling, so commit & return success
2089 warn "$me update successful; committing\n"
2091 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2096 my $action = $op2action{$op};
2098 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2099 ( $action eq 'suspend' && !$self->overlimit
2100 || $action eq 'unsuspend' && $self->overlimit )
2103 my $error = $self->_op_overlimit($action);
2105 $dbh->rollback if $oldAutoCommit;
2111 if ( $conf->exists("svc_acct-usage_$action")
2112 && &{$op2condition{$op}}($self, $column, $amount) ) {
2113 #my $error = $self->$action();
2114 my $error = $self->cust_svc->cust_pkg->$action();
2115 # $error ||= $self->overlimit($action);
2117 $dbh->rollback if $oldAutoCommit;
2118 return "Error ${action}ing: $error";
2122 if ($warning_template && &{$op2warncondition{$op}}($self, $column, $amount)) {
2123 my $wqueue = new FS::queue {
2124 'svcnum' => $self->svcnum,
2125 'job' => 'FS::svc_acct::reached_threshold',
2130 $to = $warning_cc if &{$op2condition{$op}}($self, $column, $amount);
2134 my $error = $wqueue->insert(
2135 'svcnum' => $self->svcnum,
2137 'column' => $column,
2141 $dbh->rollback if $oldAutoCommit;
2142 return "Error queuing threshold activity: $error";
2146 warn "$me update successful; committing\n"
2148 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2154 my( $self, $action ) = @_;
2156 local $SIG{HUP} = 'IGNORE';
2157 local $SIG{INT} = 'IGNORE';
2158 local $SIG{QUIT} = 'IGNORE';
2159 local $SIG{TERM} = 'IGNORE';
2160 local $SIG{TSTP} = 'IGNORE';
2161 local $SIG{PIPE} = 'IGNORE';
2163 my $oldAutoCommit = $FS::UID::AutoCommit;
2164 local $FS::UID::AutoCommit = 0;
2167 my $cust_pkg = $self->cust_svc->cust_pkg;
2169 my @conf_overlimit =
2171 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2172 : $conf->config('overlimit_groups');
2174 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2176 my @groups = scalar(@conf_overlimit) ? @conf_overlimit
2177 : split(' ',$part_export->option('overlimit_groups'));
2178 next unless scalar(@groups);
2180 my $other = new FS::svc_acct $self->hashref;
2181 $other->usergroup(\@groups);
2184 if ($action eq 'suspend') {
2187 } else { # $action eq 'unsuspend'
2192 my $error = $part_export->export_replace($new, $old)
2193 || $self->overlimit($action);
2196 $dbh->rollback if $oldAutoCommit;
2197 return "Error replacing radius groups: $error";
2202 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2208 my( $self, $valueref, %options ) = @_;
2210 warn "$me set_usage called for svcnum ". $self->svcnum.
2211 ' ('. $self->email. "): ".
2212 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2215 local $SIG{HUP} = 'IGNORE';
2216 local $SIG{INT} = 'IGNORE';
2217 local $SIG{QUIT} = 'IGNORE';
2218 local $SIG{TERM} = 'IGNORE';
2219 local $SIG{TSTP} = 'IGNORE';
2220 local $SIG{PIPE} = 'IGNORE';
2222 local $FS::svc_Common::noexport_hack = 1;
2223 my $oldAutoCommit = $FS::UID::AutoCommit;
2224 local $FS::UID::AutoCommit = 0;
2229 if ( $options{null} ) {
2230 %handyhash = ( map { ( $_ => undef, $_."_threshold" => undef ) }
2231 qw( seconds upbytes downbytes totalbytes )
2234 foreach my $field (keys %$valueref){
2235 $reset = 1 if $valueref->{$field};
2236 $self->setfield($field, $valueref->{$field});
2237 $self->setfield( $field.'_threshold',
2238 int($self->getfield($field)
2239 * ( $conf->exists('svc_acct-usage_threshold')
2240 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2245 $handyhash{$field} = $self->getfield($field);
2246 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2248 #my $error = $self->replace; #NO! we avoid the call to ->check for
2249 #die $error if $error; #services not explicity changed via the UI
2251 my $sql = "UPDATE svc_acct SET " .
2252 join (',', map { "$_ = ?" } (keys %handyhash) ).
2253 " WHERE svcnum = ". $self->svcnum;
2258 if (scalar(keys %handyhash)) {
2259 my $sth = $dbh->prepare( $sql )
2260 or die "Error preparing $sql: ". $dbh->errstr;
2261 my $rv = $sth->execute(values %handyhash);
2262 die "Error executing $sql: ". $sth->errstr
2263 unless defined($rv);
2264 die "Can't update usage for svcnum ". $self->svcnum
2268 #$self->snapshot; #not necessary, we retain the old values
2269 #create an object with the updated usage values
2270 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2271 local($FS::Record::nowarn_identical) = 1;
2272 my $error = $new->replace($self); #call exports
2274 $dbh->rollback if $oldAutoCommit;
2275 return "Error replacing: $error";
2282 $error = $self->_op_overlimit('unsuspend')
2283 if $self->overlimit;;
2285 $error ||= $self->cust_svc->cust_pkg->unsuspend
2286 if $conf->exists("svc_acct-usage_unsuspend");
2289 $dbh->rollback if $oldAutoCommit;
2290 return "Error unsuspending: $error";
2295 warn "$me update successful; committing\n"
2297 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2303 =item recharge HASHREF
2305 Increments usage columns by the amount specified in HASHREF as
2306 column=>amount pairs.
2311 my ($self, $vhash) = @_;
2314 warn "[$me] recharge called on $self: ". Dumper($self).
2315 "\nwith vhash: ". Dumper($vhash);
2318 my $oldAutoCommit = $FS::UID::AutoCommit;
2319 local $FS::UID::AutoCommit = 0;
2323 foreach my $column (keys %$vhash){
2324 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2328 $dbh->rollback if $oldAutoCommit;
2330 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2335 =item is_rechargeable
2337 Returns true if this svc_account can be "recharged" and false otherwise.
2341 sub is_rechargable {
2343 $self->seconds ne ''
2344 || $self->upbytes ne ''
2345 || $self->downbytes ne ''
2346 || $self->totalbytes ne '';
2349 =item seconds_since TIMESTAMP
2351 Returns the number of seconds this account has been online since TIMESTAMP,
2352 according to the session monitor (see L<FS::Session>).
2354 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2355 L<Time::Local> and L<Date::Parse> for conversion functions.
2359 #note: POD here, implementation in FS::cust_svc
2362 $self->cust_svc->seconds_since(@_);
2365 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2367 Returns the numbers of seconds this account has been online between
2368 TIMESTAMP_START (inclusive) and TIMESTAMP_END (exclusive), according to an
2369 external SQL radacct table, specified via sqlradius export. Sessions which
2370 started in the specified range but are still open are counted from session
2371 start to the end of the range (unless they are over 1 day old, in which case
2372 they are presumed missing their stop record and not counted). Also, sessions
2373 which end in the range but started earlier are counted from the start of the
2374 range to session end. Finally, sessions which start before the range but end
2375 after are counted for the entire range.
2377 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2378 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2383 #note: POD here, implementation in FS::cust_svc
2384 sub seconds_since_sqlradacct {
2386 $self->cust_svc->seconds_since_sqlradacct(@_);
2389 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2391 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2392 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2393 TIMESTAMP_END (exclusive).
2395 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2396 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2401 #note: POD here, implementation in FS::cust_svc
2402 sub attribute_since_sqlradacct {
2404 $self->cust_svc->attribute_since_sqlradacct(@_);
2407 =item get_session_history TIMESTAMP_START TIMESTAMP_END
2409 Returns an array of hash references of this customers login history for the
2410 given time range. (document this better)
2414 sub get_session_history {
2416 $self->cust_svc->get_session_history(@_);
2419 =item last_login_text
2421 Returns text describing the time of last login.
2425 sub last_login_text {
2427 $self->last_login ? ctime($self->last_login) : 'unknown';
2430 =item get_cdrs TIMESTAMP_START TIMESTAMP_END [ 'OPTION' => 'VALUE ... ]
2435 my($self, $start, $end, %opt ) = @_;
2437 my $did = $self->username; #yup
2439 my $prefix = $opt{'default_prefix'}; #convergent.au '+61'
2441 my $for_update = $opt{'for_update'} ? 'FOR UPDATE' : '';
2443 #SELECT $for_update * FROM cdr
2444 # WHERE calldate >= $start #need a conversion
2445 # AND calldate < $end #ditto
2446 # AND ( charged_party = "$did"
2447 # OR charged_party = "$prefix$did" #if length($prefix);
2448 # OR ( ( charged_party IS NULL OR charged_party = '' )
2450 # ( src = "$did" OR src = "$prefix$did" ) # if length($prefix)
2453 # AND ( freesidestatus IS NULL OR freesidestatus = '' )
2456 if ( length($prefix) ) {
2458 " AND ( charged_party = '$did'
2459 OR charged_party = '$prefix$did'
2460 OR ( ( charged_party IS NULL OR charged_party = '' )
2462 ( src = '$did' OR src = '$prefix$did' )
2468 " AND ( charged_party = '$did'
2469 OR ( ( charged_party IS NULL OR charged_party = '' )
2479 'select' => "$for_update *",
2482 #( freesidestatus IS NULL OR freesidestatus = '' )
2483 'freesidestatus' => '',
2485 'extra_sql' => $charged_or_src,
2491 # sub radius_groups has moved to svc_Radius_Mixin
2493 =item clone_suspended
2495 Constructor used by FS::part_export::_export_suspend fallback. Document
2500 sub clone_suspended {
2502 my %hash = $self->hash;
2503 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2504 new FS::svc_acct \%hash;
2507 =item clone_kludge_unsuspend
2509 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2514 sub clone_kludge_unsuspend {
2516 my %hash = $self->hash;
2517 $hash{_password} = '';
2518 new FS::svc_acct \%hash;
2521 =item check_password
2523 Checks the supplied password against the (possibly encrypted) password in the
2524 database. Returns true for a successful authentication, false for no match.
2526 Currently supported encryptions are: classic DES crypt() and MD5
2530 sub check_password {
2531 my($self, $check_password) = @_;
2533 #remove old-style SUSPENDED kludge, they should be allowed to login to
2534 #self-service and pay up
2535 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2537 if ( $self->_password_encoding eq 'ldap' ) {
2539 $password =~ s/^{PLAIN}/{CLEARTEXT}/;
2540 my $auth = from_rfc2307 Authen::Passphrase $password;
2541 return $auth->match($check_password);
2543 } elsif ( $self->_password_encoding eq 'crypt' ) {
2545 my $auth = from_crypt Authen::Passphrase $self->_password;
2546 return $auth->match($check_password);
2548 } elsif ( $self->_password_encoding eq 'plain' ) {
2550 return $check_password eq $password;
2554 #XXX this could be replaced with Authen::Passphrase stuff
2556 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2558 } elsif ( length($password) < 13 ) { #plaintext
2559 $check_password eq $password;
2560 } elsif ( length($password) == 13 ) { #traditional DES crypt
2561 crypt($check_password, $password) eq $password;
2562 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2563 unix_md5_crypt($check_password, $password) eq $password;
2564 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2565 warn "Can't check password: Blowfish encryption not yet supported, ".
2566 "svcnum ". $self->svcnum. "\n";
2569 warn "Can't check password: Unrecognized encryption for svcnum ".
2570 $self->svcnum. "\n";
2578 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2580 Returns an encrypted password, either by passing through an encrypted password
2581 in the database or by encrypting a plaintext password from the database.
2583 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2584 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2585 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2586 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2587 encryption type is only used if the password is not already encrypted in the
2592 sub crypt_password {
2595 if ( $self->_password_encoding eq 'ldap' ) {
2597 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
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 'blowfish' ) {
2611 croak "unknown encryption method $encryption";
2613 croak "unknown encryption method $encryption";
2616 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2620 } elsif ( $self->_password_encoding eq 'crypt' ) {
2622 return $self->_password;
2624 } elsif ( $self->_password_encoding eq 'plain' ) {
2626 #XXX this could be replaced with Authen::Passphrase stuff
2628 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2629 if ( $encryption eq 'crypt' ) {
2632 $saltset[int(rand(64))].$saltset[int(rand(64))]
2634 } elsif ( $encryption eq 'md5' ) {
2635 return unix_md5_crypt( $self->_password );
2636 } elsif ( $encryption eq 'sha1_base64' ) { #for acct_sql
2637 my $pass = sha1_base64( $self->_password );
2638 $pass .= '=' x (4 - length($pass) % 4); #properly padded base64
2640 } elsif ( $encryption eq 'blowfish' ) {
2641 croak "unknown encryption method $encryption";
2643 croak "unknown encryption method $encryption";
2648 if ( length($self->_password) == 13
2649 || $self->_password =~ /^\$(1|2a?)\$/
2650 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2656 #XXX this could be replaced with Authen::Passphrase stuff
2658 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2659 if ( $encryption eq 'crypt' ) {
2662 $saltset[int(rand(64))].$saltset[int(rand(64))]
2664 } elsif ( $encryption eq 'md5' ) {
2665 return unix_md5_crypt( $self->_password );
2666 } elsif ( $encryption eq 'blowfish' ) {
2667 croak "unknown encryption method $encryption";
2669 croak "unknown encryption method $encryption";
2678 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2680 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2681 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2682 "{MD5}5426824942db4253f87a1009fd5d2d4".
2684 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2685 to work the same as the B</crypt_password> method.
2691 #eventually should check a "password-encoding" field
2693 if ( $self->_password_encoding eq 'ldap' ) {
2695 return $self->_password;
2697 } elsif ( $self->_password_encoding eq 'crypt' ) {
2699 if ( length($self->_password) == 13 ) { #crypt
2700 return '{CRYPT}'. $self->_password;
2701 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2703 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2704 # die "Blowfish encryption not supported in this context, svcnum ".
2705 # $self->svcnum. "\n";
2707 warn "encryption method not (yet?) supported in LDAP context";
2708 return '{CRYPT}*'; #unsupported, should not auth
2711 } elsif ( $self->_password_encoding eq 'plain' ) {
2713 return '{PLAIN}'. $self->_password;
2715 #return '{CLEARTEXT}'. $self->_password; #?
2719 if ( length($self->_password) == 13 ) { #crypt
2720 return '{CRYPT}'. $self->_password;
2721 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2723 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2724 warn "Blowfish encryption not supported in this context, svcnum ".
2725 $self->svcnum. "\n";
2728 #are these two necessary anymore?
2729 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2730 return '{SSHA}'. $1;
2731 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2732 return '{NS-MTA-MD5}'. $1;
2735 return '{PLAIN}'. $self->_password;
2737 #return '{CLEARTEXT}'. $self->_password; #?
2739 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2740 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2741 #if ( $encryption eq 'crypt' ) {
2742 # return '{CRYPT}'. crypt(
2744 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2746 #} elsif ( $encryption eq 'md5' ) {
2747 # unix_md5_crypt( $self->_password );
2748 #} elsif ( $encryption eq 'blowfish' ) {
2749 # croak "unknown encryption method $encryption";
2751 # croak "unknown encryption method $encryption";
2759 =item domain_slash_username
2761 Returns $domain/$username/
2765 sub domain_slash_username {
2767 $self->domain. '/'. $self->username. '/';
2770 =item virtual_maildir
2772 Returns $domain/maildirs/$username/
2776 sub virtual_maildir {
2778 $self->domain. '/maildirs/'. $self->username. '/';
2783 =head1 CLASS METHODS
2787 =item search HASHREF
2789 Class method which returns a qsearch hash expression to search for parameters
2790 specified in HASHREF. Valid parameters are
2804 Arrayref of pkgparts
2810 Arrayref of additional WHERE clauses, will be ANDed together.
2821 my ($class, $params) = @_;
2824 ' LEFT JOIN cust_svc USING ( svcnum ) ',
2825 ' LEFT JOIN part_svc USING ( svcpart ) ',
2826 ' LEFT JOIN cust_pkg USING ( pkgnum ) ',
2827 ' LEFT JOIN cust_main USING ( custnum ) ',
2833 if ( $params->{'domain'} ) {
2834 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2835 #preserve previous behavior & bubble up an error if $svc_domain not found?
2836 push @where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2840 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2841 push @where, "domsvc = $1";
2845 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
2848 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2849 push @where, "cust_main.agentnum = $1";
2853 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2854 push @where, "custnum = $1";
2858 if ( $params->{'pkgpart'} && scalar(@{ $params->{'pkgpart'} }) ) {
2859 #XXX untaint or sql quote
2861 'cust_pkg.pkgpart IN ('. join(',', @{ $params->{'pkgpart'} } ). ')';
2865 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2866 push @where, "popnum = $1";
2870 if ( $params->{'svcpart'} =~ /^(\d+)$/ ) {
2871 push @where, "svcpart = $1";
2874 if ( $params->{'exportnum'} =~ /^(\d+)$/ ) {
2875 push @from, ' LEFT JOIN export_svc USING ( svcpart )';
2876 push @where, "exportnum = $1";
2880 my @where_sector = $class->tower_sector_sql($params);
2881 if ( @where_sector ) {
2882 push @where, @where_sector;
2883 push @from, ' LEFT JOIN tower_sector USING ( sectornum )';
2886 # here is the agent virtualization
2887 #if ($params->{CurrentUser}) {
2889 # qsearchs('access_user', { username => $params->{CurrentUser} });
2891 # if ($access_user) {
2892 # push @where, $access_user->agentnums_sql('table'=>'cust_main');
2894 # push @where, "1=0";
2897 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
2898 'table' => 'cust_main',
2899 'null_right' => 'View/link unlinked services',
2903 push @where, @{ $params->{'where'} } if $params->{'where'};
2905 my $addl_from = join(' ', @from);
2906 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2908 my $count_query = "SELECT COUNT(*) FROM svc_acct $addl_from $extra_sql";
2909 #if ( keys %svc_acct ) {
2910 # $count_query .= ' WHERE '.
2911 # join(' AND ', map "$_ = ". dbh->quote($svc_acct{$_}),
2917 'table' => 'svc_acct',
2918 'hashref' => {}, # \%svc_acct,
2919 'select' => join(', ',
2922 'cust_main.custnum',
2923 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
2925 'addl_from' => $addl_from,
2926 'extra_sql' => $extra_sql,
2927 'order_by' => $params->{'order_by'},
2928 'count_query' => $count_query,
2941 This is the FS::svc_acct job-queue-able version. It still uses
2942 FS::Misc::send_email under-the-hood.
2949 eval "use FS::Misc qw(send_email)";
2952 $opt{mimetype} ||= 'text/plain';
2953 $opt{mimetype} .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2955 my $error = send_email(
2956 'from' => $opt{from},
2958 'subject' => $opt{subject},
2959 'content-type' => $opt{mimetype},
2960 'body' => [ map "$_\n", split("\n", $opt{body}) ],
2962 die $error if $error;
2965 =item check_and_rebuild_fuzzyfiles
2969 sub check_and_rebuild_fuzzyfiles {
2970 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2971 -e "$dir/svc_acct.username"
2972 or &rebuild_fuzzyfiles;
2975 =item rebuild_fuzzyfiles
2979 sub rebuild_fuzzyfiles {
2981 use Fcntl qw(:flock);
2983 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2987 open(USERNAMELOCK,">>$dir/svc_acct.username")
2988 or die "can't open $dir/svc_acct.username: $!";
2989 flock(USERNAMELOCK,LOCK_EX)
2990 or die "can't lock $dir/svc_acct.username: $!";
2992 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2994 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2995 or die "can't open $dir/svc_acct.username.tmp: $!";
2996 print USERNAMECACHE join("\n", @all_username), "\n";
2997 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2999 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
3009 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
3010 open(USERNAMECACHE,"<$dir/svc_acct.username")
3011 or die "can't open $dir/svc_acct.username: $!";
3012 my @array = map { chomp; $_; } <USERNAMECACHE>;
3013 close USERNAMECACHE;
3017 =item append_fuzzyfiles USERNAME
3021 sub append_fuzzyfiles {
3022 my $username = shift;
3024 &check_and_rebuild_fuzzyfiles;
3026 use Fcntl qw(:flock);
3028 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
3030 open(USERNAME,">>$dir/svc_acct.username")
3031 or die "can't open $dir/svc_acct.username: $!";
3032 flock(USERNAME,LOCK_EX)
3033 or die "can't lock $dir/svc_acct.username: $!";
3035 print USERNAME "$username\n";
3037 flock(USERNAME,LOCK_UN)
3038 or die "can't unlock $dir/svc_acct.username: $!";
3045 =item reached_threshold
3047 Performs some activities when svc_acct thresholds (such as number of seconds
3048 remaining) are reached.
3052 sub reached_threshold {
3055 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
3056 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
3058 if ( $opt{'op'} eq '+' ){
3059 $svc_acct->setfield( $opt{'column'}.'_threshold',
3060 int($svc_acct->getfield($opt{'column'})
3061 * ( $conf->exists('svc_acct-usage_threshold')
3062 ? $conf->config('svc_acct-usage_threshold')/100
3067 my $error = $svc_acct->replace;
3068 die $error if $error;
3069 }elsif ( $opt{'op'} eq '-' ){
3071 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
3072 return '' if ($threshold eq '' );
3074 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
3075 my $error = $svc_acct->replace;
3076 die $error if $error; # email next time, i guess
3078 if ( $warning_template ) {
3079 eval "use FS::Misc qw(send_email)";
3082 my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
3083 my $cust_main = $cust_pkg->cust_main;
3085 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ }
3086 $cust_main->invoicing_list,
3087 ($opt{'to'} ? $opt{'to'} : ())
3090 my $mimetype = $warning_mimetype;
3091 $mimetype .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
3093 my $body = $warning_template->fill_in( HASH => {
3094 'custnum' => $cust_main->custnum,
3095 'username' => $svc_acct->username,
3096 'password' => $svc_acct->_password,
3097 'first' => $cust_main->first,
3098 'last' => $cust_main->getfield('last'),
3099 'pkg' => $cust_pkg->part_pkg->pkg,
3100 'column' => $opt{'column'},
3101 'amount' => $opt{'column'} =~/bytes/
3102 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
3103 : $svc_acct->getfield($opt{'column'}),
3104 'threshold' => $opt{'column'} =~/bytes/
3105 ? FS::UI::bytecount::display_bytecount($threshold)
3110 my $error = send_email(
3111 'from' => $warning_from,
3113 'subject' => $warning_subject,
3114 'content-type' => $mimetype,
3115 'body' => [ map "$_\n", split("\n", $body) ],
3117 die $error if $error;
3120 die "unknown op: " . $opt{'op'};
3128 The $recref stuff in sub check should be cleaned up.
3130 The suspend, unsuspend and cancel methods update the database, but not the
3131 current object. This is probably a bug as it's unexpected and
3134 insertion of RADIUS group stuff in insert could be done with child_objects now
3135 (would probably clean up export of them too)
3137 _op_usage and set_usage bypass the history... maybe they shouldn't
3141 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
3142 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
3143 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
3144 L<freeside-queued>), L<FS::svc_acct_pop>,
3145 schema.html from the base documentation.