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 local $username_uppercase = $username_uppercase;
1167 if ($self->svcnum) {
1168 my $cust_svc = $self->cust_svc
1169 or return "no cust_svc record found for svcnum ". $self->svcnum;
1170 my $cust_pkg = $cust_svc->cust_pkg;
1172 if ($self->pkgnum) {
1173 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1177 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1178 $username_uppercase =
1179 $conf->exists('username-uppercase', $cust_pkg->cust_main->agentnum);
1182 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1184 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:\/\=\#]{$usernamemin,$ulen})$/i
1185 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1186 $recref->{username} = $1;
1188 my $uerror = gettext('illegal_username'). ': '. $recref->{username};
1190 unless ( $username_uppercase ) {
1191 $recref->{username} =~ /[A-Z]/ and return $uerror;
1193 if ( $username_letterfirst ) {
1194 $recref->{username} =~ /^[a-z]/ or return $uerror;
1195 } elsif ( $username_letter ) {
1196 $recref->{username} =~ /[a-z]/ or return $uerror;
1198 if ( $username_noperiod ) {
1199 $recref->{username} =~ /\./ and return $uerror;
1201 if ( $username_nounderscore ) {
1202 $recref->{username} =~ /_/ and return $uerror;
1204 if ( $username_nodash ) {
1205 $recref->{username} =~ /\-/ and return $uerror;
1207 unless ( $username_ampersand ) {
1208 $recref->{username} =~ /\&/ and return $uerror;
1210 unless ( $username_percent ) {
1211 $recref->{username} =~ /\%/ and return $uerror;
1213 unless ( $username_colon ) {
1214 $recref->{username} =~ /\:/ and return $uerror;
1216 unless ( $username_slash ) {
1217 $recref->{username} =~ /\// and return $uerror;
1219 unless ( $username_equals ) {
1220 $recref->{username} =~ /\=/ and return $uerror;
1222 unless ( $username_pound ) {
1223 $recref->{username} =~ /\#/ and return $uerror;
1227 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1228 $recref->{popnum} = $1;
1229 return "Unknown popnum" unless
1230 ! $recref->{popnum} ||
1231 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1233 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1235 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1236 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1238 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1239 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1240 #not all systems use gid=uid
1241 #you can set a fixed gid in part_svc
1243 return "Only root can have uid 0"
1244 if $recref->{uid} == 0
1245 && $recref->{username} !~ /^(root|toor|smtp)$/;
1247 unless ( $recref->{username} eq 'sync' ) {
1248 if ( grep $_ eq $recref->{shell}, @shells ) {
1249 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1251 return "Illegal shell \`". $self->shell. "\'; ".
1252 "shells configuration value contains: @shells";
1255 $recref->{shell} = '/bin/sync';
1259 $recref->{gid} ne '' ?
1260 return "Can't have gid without uid" : ( $recref->{gid}='' );
1261 #$recref->{dir} ne '' ?
1262 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1263 $recref->{shell} ne '' ?
1264 return "Can't have shell without uid" : ( $recref->{shell}='' );
1267 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1269 $recref->{dir} =~ /^([\/\w\-\.\&\:\#]*)$/
1270 or return "Illegal directory: ". $recref->{dir};
1271 $recref->{dir} = $1;
1272 return "Illegal directory"
1273 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1274 return "Illegal directory"
1275 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1276 unless ( $recref->{dir} ) {
1277 $recref->{dir} = $dir_prefix . '/';
1278 if ( $dirhash > 0 ) {
1279 for my $h ( 1 .. $dirhash ) {
1280 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1282 } elsif ( $dirhash < 0 ) {
1283 for my $h ( reverse $dirhash .. -1 ) {
1284 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1287 $recref->{dir} .= $recref->{username};
1293 if ( $self->getfield('finger') eq '' ) {
1294 my $cust_pkg = $self->svcnum
1295 ? $self->cust_svc->cust_pkg
1296 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1298 my $cust_main = $cust_pkg->cust_main;
1299 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1302 # $error = $self->ut_textn('finger');
1303 # return $error if $error;
1304 $self->getfield('finger') =~ /^([\w \,\.\-\'\&\t\!\@\#\$\%\(\)\+\;\"\?\/\*\<\>]*)$/
1305 or return "Illegal finger: ". $self->getfield('finger');
1306 $self->setfield('finger', $1);
1308 for (qw( quota file_quota file_maxsize )) {
1309 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1312 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1313 $recref->{file_maxnum} = $1;
1315 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1316 if ( $recref->{slipip} eq '' ) {
1317 $recref->{slipip} = '';
1318 } elsif ( $recref->{slipip} eq '0e0' ) {
1319 $recref->{slipip} = '0e0';
1321 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1322 or return "Illegal slipip: ". $self->slipip;
1323 $recref->{slipip} = $1;
1328 #arbitrary RADIUS stuff; allow ut_textn for now
1329 foreach ( grep /^radius_/, fields('svc_acct') ) {
1330 $self->ut_textn($_);
1333 # First, if _password is blank, generate one and set default encoding.
1334 if ( ! $recref->{_password} ) {
1335 $error = $self->set_password('');
1337 # But if there's a _password but no encoding, assume it's plaintext and
1338 # set it to default encoding.
1339 elsif ( ! $recref->{_password_encoding} ) {
1340 $error = $self->set_password($recref->{_password});
1342 return $error if $error;
1344 # Next, check _password to ensure compliance with the encoding.
1345 if ( $recref->{_password_encoding} eq 'ldap' ) {
1347 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1348 $recref->{_password} = uc($1).$2;
1350 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1353 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1355 if ( $recref->{_password} =~
1356 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1357 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1360 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1363 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1366 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1367 # Password randomization is now in set_password.
1368 # Strip whitespace characters, check length requirements, etc.
1369 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1370 $recref->{_password} = $1;
1372 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1373 FS::Msgcat::_gettext('illegal_password_characters').
1374 ": ". $recref->{_password};
1377 if ( $password_noampersand ) {
1378 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1380 if ( $password_noexclamation ) {
1381 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1385 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1387 $self->SUPER::check;
1392 sub _password_encryption {
1394 my $encoding = lc($self->_password_encoding);
1395 return if !$encoding;
1396 return 'plain' if $encoding eq 'plain';
1397 if($encoding eq 'crypt') {
1398 my $pass = $self->_password;
1399 $pass =~ s/^\*SUSPENDED\* //;
1401 return 'md5' if $pass =~ /^\$1\$/;
1402 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1403 return 'des' if length($pass) == 13;
1406 if($encoding eq 'ldap') {
1407 uc($self->_password) =~ /^\{([\w-]+)\}/;
1408 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1409 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1410 return 'md5' if $1 eq 'MD5';
1411 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1418 sub get_cleartext_password {
1420 if($self->_password_encryption eq 'plain') {
1421 if($self->_password_encoding eq 'ldap') {
1422 $self->_password =~ /\{\w+\}(.*)$/;
1426 return $self->_password;
1435 Set the cleartext password for the account. If _password_encoding is set, the
1436 new password will be encoded according to the existing method (including
1437 encryption mode, if it can be determined). Otherwise,
1438 config('default-password-encoding') is used.
1440 If no password is supplied (or a zero-length password when minimum password length
1441 is >0), one will be generated randomly.
1446 my( $self, $pass ) = ( shift, shift );
1448 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1451 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1452 FS::Msgcat::_gettext('illegal_password_characters').
1455 my( $encoding, $encryption ) = ('', '');
1457 if ( $self->_password_encoding ) {
1458 $encoding = $self->_password_encoding;
1459 # identify existing encryption method, try to use it.
1460 $encryption = $self->_password_encryption;
1462 # use the system default
1468 # set encoding to system default
1469 ($encoding, $encryption) =
1470 split(/-/, lc($conf->config('default-password-encoding') || ''));
1471 $encoding ||= 'legacy';
1472 $self->_password_encoding($encoding);
1475 if ( $encoding eq 'legacy' ) {
1477 # The legacy behavior from check():
1478 # If the password is blank, randomize it and set encoding to 'plain'.
1479 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1480 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1481 $self->_password_encoding('plain');
1483 # Prefix + valid-length password
1484 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1486 $self->_password_encoding('plain');
1487 # Prefix + crypt string
1488 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1490 $self->_password_encoding('crypt');
1491 # Various disabled crypt passwords
1492 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1493 $self->_password_encoding('crypt');
1499 $self->_password($pass);
1505 if $passwordmin && length($pass) < $passwordmin
1506 or $passwordmax && length($pass) > $passwordmax;
1508 if ( $encoding eq 'crypt' ) {
1509 if ($encryption eq 'md5') {
1510 $pass = unix_md5_crypt($pass);
1511 } elsif ($encryption eq 'des') {
1512 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1515 } elsif ( $encoding eq 'ldap' ) {
1516 if ($encryption eq 'md5') {
1517 $pass = md5_base64($pass);
1518 } elsif ($encryption eq 'sha1') {
1519 $pass = sha1_base64($pass);
1520 } elsif ($encryption eq 'crypt') {
1521 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1523 # else $encryption eq 'plain', do nothing
1524 $pass .= '=' x (4 - length($pass) % 4) #properly padded base64
1525 if $encryption eq 'md5' || $encryption eq 'sha1';
1526 $pass = '{'.uc($encryption).'}'.$pass;
1528 # else encoding eq 'plain'
1530 $self->_password($pass);
1536 Internal function to check the username against the list of system usernames
1537 from the I<system_usernames> configuration value. Returns true if the username
1538 is listed on the system username list.
1544 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1545 $conf->config('system_usernames')
1549 =item _check_duplicate
1551 Internal method to check for duplicates usernames, username@domain pairs and
1554 If the I<global_unique-username> configuration value is set to B<username> or
1555 B<username@domain>, enforces global username or username@domain uniqueness.
1557 In all cases, check for duplicate uids and usernames or username@domain pairs
1558 per export and with identical I<svcpart> values.
1562 sub _check_duplicate {
1565 my $global_unique = $conf->config('global_unique-username') || 'none';
1566 return '' if $global_unique eq 'disabled';
1570 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1571 unless ( $part_svc ) {
1572 return 'unknown svcpart '. $self->svcpart;
1575 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1576 qsearch( 'svc_acct', { 'username' => $self->username } );
1577 return gettext('username_in_use')
1578 if $global_unique eq 'username' && @dup_user;
1580 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1581 qsearch( 'svc_acct', { 'username' => $self->username,
1582 'domsvc' => $self->domsvc } );
1583 return gettext('username_in_use')
1584 if $global_unique eq 'username@domain' && @dup_userdomain;
1587 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1588 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1589 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1590 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1595 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1596 my $exports = FS::part_export::export_info('svc_acct');
1597 my %conflict_user_svcpart;
1598 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1600 foreach my $part_export ( $part_svc->part_export ) {
1602 #this will catch to the same exact export
1603 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1605 #this will catch to exports w/same exporthost+type ???
1606 #my @other_part_export = qsearch('part_export', {
1607 # 'machine' => $part_export->machine,
1608 # 'exporttype' => $part_export->exporttype,
1610 #foreach my $other_part_export ( @other_part_export ) {
1611 # push @svcparts, map { $_->svcpart }
1612 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1615 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1616 #silly kludge to avoid uninitialized value errors
1617 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1618 ? $exports->{$part_export->exporttype}{'nodomain'}
1620 if ( $nodomain =~ /^Y/i ) {
1621 $conflict_user_svcpart{$_} = $part_export->exportnum
1624 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1629 foreach my $dup_user ( @dup_user ) {
1630 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1631 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1632 return "duplicate username ". $self->username.
1633 ": conflicts with svcnum ". $dup_user->svcnum.
1634 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1638 foreach my $dup_userdomain ( @dup_userdomain ) {
1639 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1640 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1641 return "duplicate username\@domain ". $self->email.
1642 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1643 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1647 foreach my $dup_uid ( @dup_uid ) {
1648 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1649 if ( exists($conflict_user_svcpart{$dup_svcpart})
1650 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1651 return "duplicate uid ". $self->uid.
1652 ": conflicts with svcnum ". $dup_uid->svcnum.
1654 ( $conflict_user_svcpart{$dup_svcpart}
1655 || $conflict_userdomain_svcpart{$dup_svcpart} );
1667 Depriciated, use radius_reply instead.
1672 carp "FS::svc_acct::radius depriciated, use radius_reply";
1673 $_[0]->radius_reply;
1678 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1679 reply attributes of this record.
1681 Note that this is now the preferred method for reading RADIUS attributes -
1682 accessing the columns directly is discouraged, as the column names are
1683 expected to change in the future.
1690 return %{ $self->{'radius_reply'} }
1691 if exists $self->{'radius_reply'};
1696 my($column, $attrib) = ($1, $2);
1697 #$attrib =~ s/_/\-/g;
1698 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1699 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1701 if ( $self->slipip && $self->slipip ne '0e0' ) {
1702 $reply{$radius_ip} = $self->slipip;
1705 if ( $self->seconds !~ /^$/ ) {
1706 $reply{'Session-Timeout'} = $self->seconds;
1709 if ( $conf->exists('radius-chillispot-max') ) {
1710 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1712 #hmm. just because sqlradius.pm says so?
1719 foreach my $what (qw( input output total )) {
1720 my $is = $whatis{$what}.'bytes';
1721 if ( $self->$is() =~ /\d/ ) {
1722 my $big = new Math::BigInt $self->$is();
1723 $big = new Math::BigInt '0' if $big->is_neg();
1724 my $att = "Chillispot-Max-\u$what";
1725 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1726 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1737 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1738 check attributes of this record.
1740 Note that this is now the preferred method for reading RADIUS attributes -
1741 accessing the columns directly is discouraged, as the column names are
1742 expected to change in the future.
1749 return %{ $self->{'radius_check'} }
1750 if exists $self->{'radius_check'};
1755 my($column, $attrib) = ($1, $2);
1756 #$attrib =~ s/_/\-/g;
1757 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1758 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1761 my($pw_attrib, $password) = $self->radius_password;
1762 $check{$pw_attrib} = $password;
1764 my $cust_svc = $self->cust_svc;
1766 my $cust_pkg = $cust_svc->cust_pkg;
1767 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1768 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1771 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1772 "; can't set Expiration\n"
1780 =item radius_password
1782 Returns a key/value pair containing the RADIUS attribute name and value
1787 sub radius_password {
1791 if ( $self->_password_encoding eq 'ldap' ) {
1792 $pw_attrib = 'Password-With-Header';
1793 } elsif ( $self->_password_encoding eq 'crypt' ) {
1794 $pw_attrib = 'Crypt-Password';
1795 } elsif ( $self->_password_encoding eq 'plain' ) {
1796 $pw_attrib = $radius_password;
1798 $pw_attrib = length($self->_password) <= 12
1803 ($pw_attrib, $self->_password);
1809 This method instructs the object to "snapshot" or freeze RADIUS check and
1810 reply attributes to the current values.
1814 #bah, my english is too broken this morning
1815 #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
1816 #the FS::cust_pkg's replace method to trigger the correct export updates when
1817 #package dates change)
1822 $self->{$_} = { $self->$_() }
1823 foreach qw( radius_reply radius_check );
1827 =item forget_snapshot
1829 This methos instructs the object to forget any previously snapshotted
1830 RADIUS check and reply attributes.
1834 sub forget_snapshot {
1838 foreach qw( radius_reply radius_check );
1842 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1844 Returns the domain associated with this account.
1846 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1853 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1854 my $svc_domain = $self->svc_domain(@_)
1855 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1856 $svc_domain->domain;
1861 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1865 #inherited from svc_Common
1867 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1869 Returns an email address associated with the account.
1871 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1878 $self->username. '@'. $self->domain(@_);
1883 Returns an array of FS::acct_snarf records associated with the account.
1890 'table' => 'acct_snarf',
1891 'hashref' => { 'svcnum' => $self->svcnum },
1892 #'order_by' => 'ORDER BY priority ASC',
1896 =item cgp_rpop_hashref
1898 Returns an arrayref of RPOP data suitable for Communigate Pro API commands.
1902 sub cgp_rpop_hashref {
1904 { map { $_->snarfname => $_->cgp_hashref } $self->acct_snarf };
1907 =item decrement_upbytes OCTETS
1909 Decrements the I<upbytes> field of this record by the given amount. If there
1910 is an error, returns the error, otherwise returns false.
1914 sub decrement_upbytes {
1915 shift->_op_usage('-', 'upbytes', @_);
1918 =item increment_upbytes OCTETS
1920 Increments the I<upbytes> field of this record by the given amount. If there
1921 is an error, returns the error, otherwise returns false.
1925 sub increment_upbytes {
1926 shift->_op_usage('+', 'upbytes', @_);
1929 =item decrement_downbytes OCTETS
1931 Decrements the I<downbytes> field of this record by the given amount. If there
1932 is an error, returns the error, otherwise returns false.
1936 sub decrement_downbytes {
1937 shift->_op_usage('-', 'downbytes', @_);
1940 =item increment_downbytes OCTETS
1942 Increments the I<downbytes> field of this record by the given amount. If there
1943 is an error, returns the error, otherwise returns false.
1947 sub increment_downbytes {
1948 shift->_op_usage('+', 'downbytes', @_);
1951 =item decrement_totalbytes OCTETS
1953 Decrements the I<totalbytes> field of this record by the given amount. If there
1954 is an error, returns the error, otherwise returns false.
1958 sub decrement_totalbytes {
1959 shift->_op_usage('-', 'totalbytes', @_);
1962 =item increment_totalbytes OCTETS
1964 Increments the I<totalbytes> field of this record by the given amount. If there
1965 is an error, returns the error, otherwise returns false.
1969 sub increment_totalbytes {
1970 shift->_op_usage('+', 'totalbytes', @_);
1973 =item decrement_seconds SECONDS
1975 Decrements the I<seconds> field of this record by the given amount. If there
1976 is an error, returns the error, otherwise returns false.
1980 sub decrement_seconds {
1981 shift->_op_usage('-', 'seconds', @_);
1984 =item increment_seconds SECONDS
1986 Increments the I<seconds> field of this record by the given amount. If there
1987 is an error, returns the error, otherwise returns false.
1991 sub increment_seconds {
1992 shift->_op_usage('+', 'seconds', @_);
2000 my %op2condition = (
2001 '-' => sub { my($self, $column, $amount) = @_;
2002 $self->$column - $amount <= 0;
2004 '+' => sub { my($self, $column, $amount) = @_;
2005 ($self->$column || 0) + $amount > 0;
2008 my %op2warncondition = (
2009 '-' => sub { my($self, $column, $amount) = @_;
2010 my $threshold = $column . '_threshold';
2011 $self->$column - $amount <= $self->$threshold + 0;
2013 '+' => sub { my($self, $column, $amount) = @_;
2014 ($self->$column || 0) + $amount > 0;
2019 my( $self, $op, $column, $amount ) = @_;
2021 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
2022 ' ('. $self->email. "): $op $amount\n"
2025 return '' unless $amount;
2027 local $SIG{HUP} = 'IGNORE';
2028 local $SIG{INT} = 'IGNORE';
2029 local $SIG{QUIT} = 'IGNORE';
2030 local $SIG{TERM} = 'IGNORE';
2031 local $SIG{TSTP} = 'IGNORE';
2032 local $SIG{PIPE} = 'IGNORE';
2034 my $oldAutoCommit = $FS::UID::AutoCommit;
2035 local $FS::UID::AutoCommit = 0;
2038 my $sql = "UPDATE svc_acct SET $column = ".
2039 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
2040 " $op ? WHERE svcnum = ?";
2044 my $sth = $dbh->prepare( $sql )
2045 or die "Error preparing $sql: ". $dbh->errstr;
2046 my $rv = $sth->execute($amount, $self->svcnum);
2047 die "Error executing $sql: ". $sth->errstr
2048 unless defined($rv);
2049 die "Can't update $column for svcnum". $self->svcnum
2052 #$self->snapshot; #not necessary, we retain the old values
2053 #create an object with the updated usage values
2054 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2056 my $error = $new->replace($self);
2058 $dbh->rollback if $oldAutoCommit;
2059 return "Error replacing: $error";
2062 #overlimit_action eq 'cancel' handling
2063 my $cust_pkg = $self->cust_svc->cust_pkg;
2065 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2066 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2070 my $error = $cust_pkg->cancel; #XXX should have a reason
2072 $dbh->rollback if $oldAutoCommit;
2073 return "Error cancelling: $error";
2076 #nothing else is relevant if we're cancelling, so commit & return success
2077 warn "$me update successful; committing\n"
2079 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2084 my $action = $op2action{$op};
2086 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2087 ( $action eq 'suspend' && !$self->overlimit
2088 || $action eq 'unsuspend' && $self->overlimit )
2091 my $error = $self->_op_overlimit($action);
2093 $dbh->rollback if $oldAutoCommit;
2099 if ( $conf->exists("svc_acct-usage_$action")
2100 && &{$op2condition{$op}}($self, $column, $amount) ) {
2101 #my $error = $self->$action();
2102 my $error = $self->cust_svc->cust_pkg->$action();
2103 # $error ||= $self->overlimit($action);
2105 $dbh->rollback if $oldAutoCommit;
2106 return "Error ${action}ing: $error";
2110 if ($warning_template && &{$op2warncondition{$op}}($self, $column, $amount)) {
2111 my $wqueue = new FS::queue {
2112 'svcnum' => $self->svcnum,
2113 'job' => 'FS::svc_acct::reached_threshold',
2118 $to = $warning_cc if &{$op2condition{$op}}($self, $column, $amount);
2122 my $error = $wqueue->insert(
2123 'svcnum' => $self->svcnum,
2125 'column' => $column,
2129 $dbh->rollback if $oldAutoCommit;
2130 return "Error queuing threshold activity: $error";
2134 warn "$me update successful; committing\n"
2136 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2142 my( $self, $action ) = @_;
2144 local $SIG{HUP} = 'IGNORE';
2145 local $SIG{INT} = 'IGNORE';
2146 local $SIG{QUIT} = 'IGNORE';
2147 local $SIG{TERM} = 'IGNORE';
2148 local $SIG{TSTP} = 'IGNORE';
2149 local $SIG{PIPE} = 'IGNORE';
2151 my $oldAutoCommit = $FS::UID::AutoCommit;
2152 local $FS::UID::AutoCommit = 0;
2155 my $cust_pkg = $self->cust_svc->cust_pkg;
2157 my @conf_overlimit =
2159 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2160 : $conf->config('overlimit_groups');
2162 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2164 my @groups = scalar(@conf_overlimit) ? @conf_overlimit
2165 : split(' ',$part_export->option('overlimit_groups'));
2166 next unless scalar(@groups);
2168 my $other = new FS::svc_acct $self->hashref;
2169 $other->usergroup(\@groups);
2172 if ($action eq 'suspend') {
2175 } else { # $action eq 'unsuspend'
2180 my $error = $part_export->export_replace($new, $old)
2181 || $self->overlimit($action);
2184 $dbh->rollback if $oldAutoCommit;
2185 return "Error replacing radius groups: $error";
2190 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2196 my( $self, $valueref, %options ) = @_;
2198 warn "$me set_usage called for svcnum ". $self->svcnum.
2199 ' ('. $self->email. "): ".
2200 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2203 local $SIG{HUP} = 'IGNORE';
2204 local $SIG{INT} = 'IGNORE';
2205 local $SIG{QUIT} = 'IGNORE';
2206 local $SIG{TERM} = 'IGNORE';
2207 local $SIG{TSTP} = 'IGNORE';
2208 local $SIG{PIPE} = 'IGNORE';
2210 local $FS::svc_Common::noexport_hack = 1;
2211 my $oldAutoCommit = $FS::UID::AutoCommit;
2212 local $FS::UID::AutoCommit = 0;
2217 if ( $options{null} ) {
2218 %handyhash = ( map { ( $_ => undef, $_."_threshold" => undef ) }
2219 qw( seconds upbytes downbytes totalbytes )
2222 foreach my $field (keys %$valueref){
2223 $reset = 1 if $valueref->{$field};
2224 $self->setfield($field, $valueref->{$field});
2225 $self->setfield( $field.'_threshold',
2226 int($self->getfield($field)
2227 * ( $conf->exists('svc_acct-usage_threshold')
2228 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2233 $handyhash{$field} = $self->getfield($field);
2234 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2236 #my $error = $self->replace; #NO! we avoid the call to ->check for
2237 #die $error if $error; #services not explicity changed via the UI
2239 my $sql = "UPDATE svc_acct SET " .
2240 join (',', map { "$_ = ?" } (keys %handyhash) ).
2241 " WHERE svcnum = ". $self->svcnum;
2246 if (scalar(keys %handyhash)) {
2247 my $sth = $dbh->prepare( $sql )
2248 or die "Error preparing $sql: ". $dbh->errstr;
2249 my $rv = $sth->execute(values %handyhash);
2250 die "Error executing $sql: ". $sth->errstr
2251 unless defined($rv);
2252 die "Can't update usage for svcnum ". $self->svcnum
2256 #$self->snapshot; #not necessary, we retain the old values
2257 #create an object with the updated usage values
2258 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2259 local($FS::Record::nowarn_identical) = 1;
2260 my $error = $new->replace($self); #call exports
2262 $dbh->rollback if $oldAutoCommit;
2263 return "Error replacing: $error";
2270 $error = $self->_op_overlimit('unsuspend')
2271 if $self->overlimit;;
2273 $error ||= $self->cust_svc->cust_pkg->unsuspend
2274 if $conf->exists("svc_acct-usage_unsuspend");
2277 $dbh->rollback if $oldAutoCommit;
2278 return "Error unsuspending: $error";
2283 warn "$me update successful; committing\n"
2285 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2291 =item recharge HASHREF
2293 Increments usage columns by the amount specified in HASHREF as
2294 column=>amount pairs.
2299 my ($self, $vhash) = @_;
2302 warn "[$me] recharge called on $self: ". Dumper($self).
2303 "\nwith vhash: ". Dumper($vhash);
2306 my $oldAutoCommit = $FS::UID::AutoCommit;
2307 local $FS::UID::AutoCommit = 0;
2311 foreach my $column (keys %$vhash){
2312 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2316 $dbh->rollback if $oldAutoCommit;
2318 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2323 =item is_rechargeable
2325 Returns true if this svc_account can be "recharged" and false otherwise.
2329 sub is_rechargable {
2331 $self->seconds ne ''
2332 || $self->upbytes ne ''
2333 || $self->downbytes ne ''
2334 || $self->totalbytes ne '';
2337 =item seconds_since TIMESTAMP
2339 Returns the number of seconds this account has been online since TIMESTAMP,
2340 according to the session monitor (see L<FS::Session>).
2342 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2343 L<Time::Local> and L<Date::Parse> for conversion functions.
2347 #note: POD here, implementation in FS::cust_svc
2350 $self->cust_svc->seconds_since(@_);
2353 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2355 Returns the numbers of seconds this account has been online between
2356 TIMESTAMP_START (inclusive) and TIMESTAMP_END (exclusive), according to an
2357 external SQL radacct table, specified via sqlradius export. Sessions which
2358 started in the specified range but are still open are counted from session
2359 start to the end of the range (unless they are over 1 day old, in which case
2360 they are presumed missing their stop record and not counted). Also, sessions
2361 which end in the range but started earlier are counted from the start of the
2362 range to session end. Finally, sessions which start before the range but end
2363 after are counted for the entire range.
2365 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2366 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2371 #note: POD here, implementation in FS::cust_svc
2372 sub seconds_since_sqlradacct {
2374 $self->cust_svc->seconds_since_sqlradacct(@_);
2377 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2379 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2380 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2381 TIMESTAMP_END (exclusive).
2383 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2384 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2389 #note: POD here, implementation in FS::cust_svc
2390 sub attribute_since_sqlradacct {
2392 $self->cust_svc->attribute_since_sqlradacct(@_);
2395 =item get_session_history TIMESTAMP_START TIMESTAMP_END
2397 Returns an array of hash references of this customers login history for the
2398 given time range. (document this better)
2402 sub get_session_history {
2404 $self->cust_svc->get_session_history(@_);
2407 =item last_login_text
2409 Returns text describing the time of last login.
2413 sub last_login_text {
2415 $self->last_login ? ctime($self->last_login) : 'unknown';
2418 =item get_cdrs TIMESTAMP_START TIMESTAMP_END [ 'OPTION' => 'VALUE ... ]
2423 my($self, $start, $end, %opt ) = @_;
2425 my $did = $self->username; #yup
2427 my $prefix = $opt{'default_prefix'}; #convergent.au '+61'
2429 my $for_update = $opt{'for_update'} ? 'FOR UPDATE' : '';
2431 #SELECT $for_update * FROM cdr
2432 # WHERE calldate >= $start #need a conversion
2433 # AND calldate < $end #ditto
2434 # AND ( charged_party = "$did"
2435 # OR charged_party = "$prefix$did" #if length($prefix);
2436 # OR ( ( charged_party IS NULL OR charged_party = '' )
2438 # ( src = "$did" OR src = "$prefix$did" ) # if length($prefix)
2441 # AND ( freesidestatus IS NULL OR freesidestatus = '' )
2444 if ( length($prefix) ) {
2446 " AND ( charged_party = '$did'
2447 OR charged_party = '$prefix$did'
2448 OR ( ( charged_party IS NULL OR charged_party = '' )
2450 ( src = '$did' OR src = '$prefix$did' )
2456 " AND ( charged_party = '$did'
2457 OR ( ( charged_party IS NULL OR charged_party = '' )
2467 'select' => "$for_update *",
2470 #( freesidestatus IS NULL OR freesidestatus = '' )
2471 'freesidestatus' => '',
2473 'extra_sql' => $charged_or_src,
2479 # sub radius_groups has moved to svc_Radius_Mixin
2481 =item clone_suspended
2483 Constructor used by FS::part_export::_export_suspend fallback. Document
2488 sub clone_suspended {
2490 my %hash = $self->hash;
2491 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2492 new FS::svc_acct \%hash;
2495 =item clone_kludge_unsuspend
2497 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2502 sub clone_kludge_unsuspend {
2504 my %hash = $self->hash;
2505 $hash{_password} = '';
2506 new FS::svc_acct \%hash;
2509 =item check_password
2511 Checks the supplied password against the (possibly encrypted) password in the
2512 database. Returns true for a successful authentication, false for no match.
2514 Currently supported encryptions are: classic DES crypt() and MD5
2518 sub check_password {
2519 my($self, $check_password) = @_;
2521 #remove old-style SUSPENDED kludge, they should be allowed to login to
2522 #self-service and pay up
2523 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2525 if ( $self->_password_encoding eq 'ldap' ) {
2527 $password =~ s/^{PLAIN}/{CLEARTEXT}/;
2528 my $auth = from_rfc2307 Authen::Passphrase $password;
2529 return $auth->match($check_password);
2531 } elsif ( $self->_password_encoding eq 'crypt' ) {
2533 my $auth = from_crypt Authen::Passphrase $self->_password;
2534 return $auth->match($check_password);
2536 } elsif ( $self->_password_encoding eq 'plain' ) {
2538 return $check_password eq $password;
2542 #XXX this could be replaced with Authen::Passphrase stuff
2544 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2546 } elsif ( length($password) < 13 ) { #plaintext
2547 $check_password eq $password;
2548 } elsif ( length($password) == 13 ) { #traditional DES crypt
2549 crypt($check_password, $password) eq $password;
2550 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2551 unix_md5_crypt($check_password, $password) eq $password;
2552 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2553 warn "Can't check password: Blowfish encryption not yet supported, ".
2554 "svcnum ". $self->svcnum. "\n";
2557 warn "Can't check password: Unrecognized encryption for svcnum ".
2558 $self->svcnum. "\n";
2566 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2568 Returns an encrypted password, either by passing through an encrypted password
2569 in the database or by encrypting a plaintext password from the database.
2571 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2572 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2573 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2574 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2575 encryption type is only used if the password is not already encrypted in the
2580 sub crypt_password {
2583 if ( $self->_password_encoding eq 'ldap' ) {
2585 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2588 #XXX this could be replaced with Authen::Passphrase stuff
2590 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2591 if ( $encryption eq 'crypt' ) {
2594 $saltset[int(rand(64))].$saltset[int(rand(64))]
2596 } elsif ( $encryption eq 'md5' ) {
2597 return unix_md5_crypt( $self->_password );
2598 } elsif ( $encryption eq 'blowfish' ) {
2599 croak "unknown encryption method $encryption";
2601 croak "unknown encryption method $encryption";
2604 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2608 } elsif ( $self->_password_encoding eq 'crypt' ) {
2610 return $self->_password;
2612 } elsif ( $self->_password_encoding eq 'plain' ) {
2614 #XXX this could be replaced with Authen::Passphrase stuff
2616 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2617 if ( $encryption eq 'crypt' ) {
2620 $saltset[int(rand(64))].$saltset[int(rand(64))]
2622 } elsif ( $encryption eq 'md5' ) {
2623 return unix_md5_crypt( $self->_password );
2624 } elsif ( $encryption eq 'sha1_base64' ) { #for acct_sql
2625 my $pass = sha1_base64( $self->_password );
2626 $pass .= '=' x (4 - length($pass) % 4); #properly padded base64
2628 } elsif ( $encryption eq 'blowfish' ) {
2629 croak "unknown encryption method $encryption";
2631 croak "unknown encryption method $encryption";
2636 if ( length($self->_password) == 13
2637 || $self->_password =~ /^\$(1|2a?)\$/
2638 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2644 #XXX this could be replaced with Authen::Passphrase stuff
2646 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2647 if ( $encryption eq 'crypt' ) {
2650 $saltset[int(rand(64))].$saltset[int(rand(64))]
2652 } elsif ( $encryption eq 'md5' ) {
2653 return unix_md5_crypt( $self->_password );
2654 } elsif ( $encryption eq 'blowfish' ) {
2655 croak "unknown encryption method $encryption";
2657 croak "unknown encryption method $encryption";
2666 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2668 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2669 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2670 "{MD5}5426824942db4253f87a1009fd5d2d4".
2672 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2673 to work the same as the B</crypt_password> method.
2679 #eventually should check a "password-encoding" field
2681 if ( $self->_password_encoding eq 'ldap' ) {
2683 return $self->_password;
2685 } elsif ( $self->_password_encoding eq 'crypt' ) {
2687 if ( length($self->_password) == 13 ) { #crypt
2688 return '{CRYPT}'. $self->_password;
2689 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2691 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2692 # die "Blowfish encryption not supported in this context, svcnum ".
2693 # $self->svcnum. "\n";
2695 warn "encryption method not (yet?) supported in LDAP context";
2696 return '{CRYPT}*'; #unsupported, should not auth
2699 } elsif ( $self->_password_encoding eq 'plain' ) {
2701 return '{PLAIN}'. $self->_password;
2703 #return '{CLEARTEXT}'. $self->_password; #?
2707 if ( length($self->_password) == 13 ) { #crypt
2708 return '{CRYPT}'. $self->_password;
2709 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2711 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2712 warn "Blowfish encryption not supported in this context, svcnum ".
2713 $self->svcnum. "\n";
2716 #are these two necessary anymore?
2717 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2718 return '{SSHA}'. $1;
2719 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2720 return '{NS-MTA-MD5}'. $1;
2723 return '{PLAIN}'. $self->_password;
2725 #return '{CLEARTEXT}'. $self->_password; #?
2727 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2728 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2729 #if ( $encryption eq 'crypt' ) {
2730 # return '{CRYPT}'. crypt(
2732 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2734 #} elsif ( $encryption eq 'md5' ) {
2735 # unix_md5_crypt( $self->_password );
2736 #} elsif ( $encryption eq 'blowfish' ) {
2737 # croak "unknown encryption method $encryption";
2739 # croak "unknown encryption method $encryption";
2747 =item domain_slash_username
2749 Returns $domain/$username/
2753 sub domain_slash_username {
2755 $self->domain. '/'. $self->username. '/';
2758 =item virtual_maildir
2760 Returns $domain/maildirs/$username/
2764 sub virtual_maildir {
2766 $self->domain. '/maildirs/'. $self->username. '/';
2771 =head1 CLASS METHODS
2775 =item search HASHREF
2777 Class method which returns a qsearch hash expression to search for parameters
2778 specified in HASHREF. Valid parameters are
2792 Arrayref of pkgparts
2798 Arrayref of additional WHERE clauses, will be ANDed together.
2809 my ($class, $params) = @_;
2812 ' LEFT JOIN cust_svc USING ( svcnum ) ',
2813 ' LEFT JOIN part_svc USING ( svcpart ) ',
2814 ' LEFT JOIN cust_pkg USING ( pkgnum ) ',
2815 ' LEFT JOIN cust_main USING ( custnum ) ',
2821 if ( $params->{'domain'} ) {
2822 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2823 #preserve previous behavior & bubble up an error if $svc_domain not found?
2824 push @where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2828 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2829 push @where, "domsvc = $1";
2833 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
2836 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2837 push @where, "cust_main.agentnum = $1";
2841 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2842 push @where, "custnum = $1";
2846 if ( $params->{'pkgpart'} && scalar(@{ $params->{'pkgpart'} }) ) {
2847 #XXX untaint or sql quote
2849 'cust_pkg.pkgpart IN ('. join(',', @{ $params->{'pkgpart'} } ). ')';
2853 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2854 push @where, "popnum = $1";
2858 if ( $params->{'svcpart'} =~ /^(\d+)$/ ) {
2859 push @where, "svcpart = $1";
2862 if ( $params->{'exportnum'} =~ /^(\d+)$/ ) {
2863 push @from, ' LEFT JOIN export_svc USING ( svcpart )';
2864 push @where, "exportnum = $1";
2868 my @where_sector = $class->tower_sector_sql($params);
2869 if ( @where_sector ) {
2870 push @where, @where_sector;
2871 push @from, ' LEFT JOIN tower_sector USING ( sectornum )';
2874 # here is the agent virtualization
2875 #if ($params->{CurrentUser}) {
2877 # qsearchs('access_user', { username => $params->{CurrentUser} });
2879 # if ($access_user) {
2880 # push @where, $access_user->agentnums_sql('table'=>'cust_main');
2882 # push @where, "1=0";
2885 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
2886 'table' => 'cust_main',
2887 'null_right' => 'View/link unlinked services',
2891 push @where, @{ $params->{'where'} } if $params->{'where'};
2893 my $addl_from = join(' ', @from);
2894 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2896 my $count_query = "SELECT COUNT(*) FROM svc_acct $addl_from $extra_sql";
2897 #if ( keys %svc_acct ) {
2898 # $count_query .= ' WHERE '.
2899 # join(' AND ', map "$_ = ". dbh->quote($svc_acct{$_}),
2905 'table' => 'svc_acct',
2906 'hashref' => {}, # \%svc_acct,
2907 'select' => join(', ',
2910 'cust_main.custnum',
2911 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
2913 'addl_from' => $addl_from,
2914 'extra_sql' => $extra_sql,
2915 'order_by' => $params->{'order_by'},
2916 'count_query' => $count_query,
2929 This is the FS::svc_acct job-queue-able version. It still uses
2930 FS::Misc::send_email under-the-hood.
2937 eval "use FS::Misc qw(send_email)";
2940 $opt{mimetype} ||= 'text/plain';
2941 $opt{mimetype} .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
2943 my $error = send_email(
2944 'from' => $opt{from},
2946 'subject' => $opt{subject},
2947 'content-type' => $opt{mimetype},
2948 'body' => [ map "$_\n", split("\n", $opt{body}) ],
2950 die $error if $error;
2953 =item check_and_rebuild_fuzzyfiles
2957 sub check_and_rebuild_fuzzyfiles {
2958 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2959 -e "$dir/svc_acct.username"
2960 or &rebuild_fuzzyfiles;
2963 =item rebuild_fuzzyfiles
2967 sub rebuild_fuzzyfiles {
2969 use Fcntl qw(:flock);
2971 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2975 open(USERNAMELOCK,">>$dir/svc_acct.username")
2976 or die "can't open $dir/svc_acct.username: $!";
2977 flock(USERNAMELOCK,LOCK_EX)
2978 or die "can't lock $dir/svc_acct.username: $!";
2980 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2982 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2983 or die "can't open $dir/svc_acct.username.tmp: $!";
2984 print USERNAMECACHE join("\n", @all_username), "\n";
2985 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2987 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2997 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2998 open(USERNAMECACHE,"<$dir/svc_acct.username")
2999 or die "can't open $dir/svc_acct.username: $!";
3000 my @array = map { chomp; $_; } <USERNAMECACHE>;
3001 close USERNAMECACHE;
3005 =item append_fuzzyfiles USERNAME
3009 sub append_fuzzyfiles {
3010 my $username = shift;
3012 &check_and_rebuild_fuzzyfiles;
3014 use Fcntl qw(:flock);
3016 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
3018 open(USERNAME,">>$dir/svc_acct.username")
3019 or die "can't open $dir/svc_acct.username: $!";
3020 flock(USERNAME,LOCK_EX)
3021 or die "can't lock $dir/svc_acct.username: $!";
3023 print USERNAME "$username\n";
3025 flock(USERNAME,LOCK_UN)
3026 or die "can't unlock $dir/svc_acct.username: $!";
3033 =item reached_threshold
3035 Performs some activities when svc_acct thresholds (such as number of seconds
3036 remaining) are reached.
3040 sub reached_threshold {
3043 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
3044 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
3046 if ( $opt{'op'} eq '+' ){
3047 $svc_acct->setfield( $opt{'column'}.'_threshold',
3048 int($svc_acct->getfield($opt{'column'})
3049 * ( $conf->exists('svc_acct-usage_threshold')
3050 ? $conf->config('svc_acct-usage_threshold')/100
3055 my $error = $svc_acct->replace;
3056 die $error if $error;
3057 }elsif ( $opt{'op'} eq '-' ){
3059 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
3060 return '' if ($threshold eq '' );
3062 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
3063 my $error = $svc_acct->replace;
3064 die $error if $error; # email next time, i guess
3066 if ( $warning_template ) {
3067 eval "use FS::Misc qw(send_email)";
3070 my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
3071 my $cust_main = $cust_pkg->cust_main;
3073 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ }
3074 $cust_main->invoicing_list,
3075 ($opt{'to'} ? $opt{'to'} : ())
3078 my $mimetype = $warning_mimetype;
3079 $mimetype .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
3081 my $body = $warning_template->fill_in( HASH => {
3082 'custnum' => $cust_main->custnum,
3083 'username' => $svc_acct->username,
3084 'password' => $svc_acct->_password,
3085 'first' => $cust_main->first,
3086 'last' => $cust_main->getfield('last'),
3087 'pkg' => $cust_pkg->part_pkg->pkg,
3088 'column' => $opt{'column'},
3089 'amount' => $opt{'column'} =~/bytes/
3090 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
3091 : $svc_acct->getfield($opt{'column'}),
3092 'threshold' => $opt{'column'} =~/bytes/
3093 ? FS::UI::bytecount::display_bytecount($threshold)
3098 my $error = send_email(
3099 'from' => $warning_from,
3101 'subject' => $warning_subject,
3102 'content-type' => $mimetype,
3103 'body' => [ map "$_\n", split("\n", $body) ],
3105 die $error if $error;
3108 die "unknown op: " . $opt{'op'};
3116 The $recref stuff in sub check should be cleaned up.
3118 The suspend, unsuspend and cancel methods update the database, but not the
3119 current object. This is probably a bug as it's unexpected and
3122 insertion of RADIUS group stuff in insert could be done with child_objects now
3123 (would probably clean up export of them too)
3125 _op_usage and set_usage bypass the history... maybe they shouldn't
3129 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
3130 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
3131 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
3132 L<freeside-queued>), L<FS::svc_acct_pop>,
3133 schema.html from the base documentation.