4 use base qw( FS::svc_Domain_Mixin FS::svc_CGP_Mixin FS::svc_CGPRule_Mixin
6 use vars qw( $DEBUG $me $conf $skip_fuzzyfiles
7 $dir_prefix @shells $usernamemin
8 $usernamemax $passwordmin $passwordmax
9 $username_ampersand $username_letter $username_letterfirst
10 $username_noperiod $username_nounderscore $username_nodash
11 $username_uppercase $username_percent $username_colon
12 $username_slash $username_equals $username_pound
13 $password_noampersand $password_noexclamation
14 $warning_template $warning_from $warning_subject $warning_mimetype
17 $radius_password $radius_ip
20 use Scalar::Util qw( blessed );
25 use Crypt::PasswdMD5 1.2;
26 use Digest::SHA1 'sha1_base64';
27 use Digest::MD5 'md5_base64';
30 use Authen::Passphrase;
31 use FS::UID qw( datasrc driver_name );
33 use FS::Record qw( qsearch qsearchs fields dbh dbdef );
34 use FS::Msgcat qw(gettext);
35 use FS::UI::bytecount;
40 use FS::cust_main_invoice;
45 use FS::radius_usergroup;
54 $me = '[FS::svc_acct]';
56 #ask FS::UID to run this stuff for us later
57 FS::UID->install_callback( sub {
59 $dir_prefix = $conf->config('home');
60 @shells = $conf->config('shells');
61 $usernamemin = $conf->config('usernamemin') || 2;
62 $usernamemax = $conf->config('usernamemax');
63 $passwordmin = $conf->config('passwordmin'); # || 6;
65 $passwordmin = ( defined($passwordmin) && $passwordmin =~ /\d+/ )
68 $passwordmax = $conf->config('passwordmax') || 8;
69 $username_letter = $conf->exists('username-letter');
70 $username_letterfirst = $conf->exists('username-letterfirst');
71 $username_noperiod = $conf->exists('username-noperiod');
72 $username_nounderscore = $conf->exists('username-nounderscore');
73 $username_nodash = $conf->exists('username-nodash');
74 $username_uppercase = $conf->exists('username-uppercase');
75 $username_ampersand = $conf->exists('username-ampersand');
76 $username_percent = $conf->exists('username-percent');
77 $username_colon = $conf->exists('username-colon');
78 $username_slash = $conf->exists('username-slash');
79 $username_equals = $conf->exists('username-equals');
80 $username_pound = $conf->exists('username-pound');
81 $password_noampersand = $conf->exists('password-noexclamation');
82 $password_noexclamation = $conf->exists('password-noexclamation');
83 $dirhash = $conf->config('dirhash') || 0;
84 if ( $conf->exists('warning_email') ) {
85 $warning_template = new Text::Template (
87 SOURCE => [ map "$_\n", $conf->config('warning_email') ]
88 ) or warn "can't create warning email template: $Text::Template::ERROR";
89 $warning_from = $conf->config('warning_email-from'); # || 'your-isp-is-dum'
90 $warning_subject = $conf->config('warning_email-subject') || 'Warning';
91 $warning_mimetype = $conf->config('warning_email-mimetype') || 'text/plain';
92 $warning_cc = $conf->config('warning_email-cc');
94 $warning_template = '';
96 $warning_subject = '';
97 $warning_mimetype = '';
100 $smtpmachine = $conf->config('smtpmachine');
101 $radius_password = $conf->config('radius-password') || 'Password';
102 $radius_ip = $conf->config('radius-ip') || 'Framed-IP-Address';
103 @pw_set = ( 'A'..'Z' ) if $conf->exists('password-generated-allcaps');
107 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
108 @pw_set = ( 'a'..'z', 'A'..'Z', '0'..'9', '(', ')', '#', '.', ',' );
112 my ( $hashref, $cache ) = @_;
113 if ( $hashref->{'svc_acct_svcnum'} ) {
114 $self->{'_domsvc'} = FS::svc_domain->new( {
115 'svcnum' => $hashref->{'domsvc'},
116 'domain' => $hashref->{'svc_acct_domain'},
117 'catchall' => $hashref->{'svc_acct_catchall'},
124 FS::svc_acct - Object methods for svc_acct records
130 $record = new FS::svc_acct \%hash;
131 $record = new FS::svc_acct { 'column' => 'value' };
133 $error = $record->insert;
135 $error = $new_record->replace($old_record);
137 $error = $record->delete;
139 $error = $record->check;
141 $error = $record->suspend;
143 $error = $record->unsuspend;
145 $error = $record->cancel;
147 %hash = $record->radius;
149 %hash = $record->radius_reply;
151 %hash = $record->radius_check;
153 $domain = $record->domain;
155 $svc_domain = $record->svc_domain;
157 $email = $record->email;
159 $seconds_since = $record->seconds_since($timestamp);
163 An FS::svc_acct object represents an account. FS::svc_acct inherits from
164 FS::svc_Common. The following fields are currently supported:
170 Primary key (assigned automatcially for new accounts)
178 =item _password_encoding
180 plain, crypt, ldap (or empty for autodetection)
188 Point of presence (see L<FS::svc_acct_pop>)
200 set automatically if blank (and uid is not)
220 svcnum from svc_domain
224 Optional svcnum from svc_pbx
226 =item radius_I<Radius_Attribute>
228 I<Radius-Attribute> (reply)
230 =item rc_I<Radius_Attribute>
232 I<Radius-Attribute> (check)
242 Creates a new account. To add the account to the database, see L<"insert">.
249 'longname_plural' => 'Access accounts and mailboxes',
250 'sorts' => [ 'username', 'uid', 'seconds', 'last_login' ],
251 'display_weight' => 10,
252 'cancel_weight' => 50,
254 'dir' => 'Home directory',
257 def_info => 'set to fixed and blank for no UIDs',
260 'slipip' => 'IP address',
261 # 'popnum' => qq!<A HREF="$p/browse/svc_acct_pop.cgi/">POP number</A>!,
263 label => 'Access number',
265 select_table => 'svc_acct_pop',
266 select_key => 'popnum',
267 select_label => 'city',
273 disable_default => 1,
277 'password_selfchange' => { label => 'Password modification',
280 'password_recover' => { label => 'Password recovery',
284 label => 'Quota', #Mail storage limit
286 disable_inventory => 1,
290 label => 'File storage limit',
292 disable_inventory => 1,
296 label => 'Number of files limit',
298 disable_inventory => 1,
302 label => 'File size limit',
304 disable_inventory => 1,
307 '_password' => 'Password',
310 def_info => 'when blank, defaults to UID',
315 def_info => 'set to blank for no shell tracking',
317 #select_list => [ $conf->config('shells') ],
318 select_list => [ $conf ? $conf->config('shells') : () ],
319 disable_inventory => 1,
322 'finger' => 'Real name', # (GECOS)',
326 select_table => 'svc_domain',
327 select_key => 'svcnum',
328 select_label => 'domain',
329 disable_inventory => 1,
331 'pbxsvc' => { label => 'PBX',
332 type => 'select-svc_pbx.html',
333 disable_inventory => 1,
334 disable_select => 1, #UI wonky, pry works otherwise
337 label => 'RADIUS groups',
338 type => 'radius_usergroup_selector',
339 disable_inventory => 1,
342 'seconds' => { label => 'Seconds',
343 label_sort => 'with Time Remaining',
345 disable_inventory => 1,
347 disable_part_svc_column => 1,
349 'upbytes' => { label => 'Upload',
351 disable_inventory => 1,
353 'format' => \&FS::UI::bytecount::display_bytecount,
354 'parse' => \&FS::UI::bytecount::parse_bytecount,
355 disable_part_svc_column => 1,
357 'downbytes' => { label => 'Download',
359 disable_inventory => 1,
361 'format' => \&FS::UI::bytecount::display_bytecount,
362 'parse' => \&FS::UI::bytecount::parse_bytecount,
363 disable_part_svc_column => 1,
365 'totalbytes'=> { label => 'Total up and download',
367 disable_inventory => 1,
369 'format' => \&FS::UI::bytecount::display_bytecount,
370 'parse' => \&FS::UI::bytecount::parse_bytecount,
371 disable_part_svc_column => 1,
373 'seconds_threshold' => { label => 'Seconds threshold',
375 disable_inventory => 1,
377 disable_part_svc_column => 1,
379 'upbytes_threshold' => { label => 'Upload threshold',
381 disable_inventory => 1,
383 'format' => \&FS::UI::bytecount::display_bytecount,
384 'parse' => \&FS::UI::bytecount::parse_bytecount,
385 disable_part_svc_column => 1,
387 'downbytes_threshold' => { label => 'Download threshold',
389 disable_inventory => 1,
391 'format' => \&FS::UI::bytecount::display_bytecount,
392 'parse' => \&FS::UI::bytecount::parse_bytecount,
393 disable_part_svc_column => 1,
395 'totalbytes_threshold'=> { label => 'Total up and download threshold',
397 disable_inventory => 1,
399 'format' => \&FS::UI::bytecount::display_bytecount,
400 'parse' => \&FS::UI::bytecount::parse_bytecount,
401 disable_part_svc_column => 1,
404 label => 'Last login',
408 label => 'Last logout',
413 label => 'Communigate aliases',
415 disable_inventory => 1,
420 label => 'Communigate account type',
422 select_list => [qw( MultiMailbox TextMailbox MailDirMailbox AGrade BGrade CGrade )],
423 disable_inventory => 1,
426 'cgp_accessmodes' => {
427 label => 'Communigate enabled services',
428 type => 'communigate_pro-accessmodes',
429 disable_inventory => 1,
432 'cgp_rulesallowed' => {
433 label => 'Allowed mail rules',
435 select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ],
436 disable_inventory => 1,
439 'cgp_rpopallowed' => { label => 'RPOP modifications',
442 'cgp_mailtoall' => { label => 'Accepts mail to "all"',
445 'cgp_addmailtrailer' => { label => 'Add trailer to sent mail',
448 'cgp_archiveafter' => {
449 label => 'Archive messages after',
452 -2 => 'default(730 days)',
459 1209600 => '2 weeks',
460 2592000 => '30 days',
461 7776000 => '90 days',
462 15552000 => '180 days',
463 31536000 => '365 days',
464 63072000 => '730 days',
466 disable_inventory => 1,
472 'cgp_deletemode' => {
473 label => 'Communigate message delete method',
475 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
476 disable_inventory => 1,
479 'cgp_emptytrash' => {
480 label => 'Communigate on logout remove trash',
482 select_list => __PACKAGE__->cgp_emptytrash_values,
483 disable_inventory => 1,
487 label => 'Communigate language',
489 select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ],
490 disable_inventory => 1,
494 label => 'Communigate time zone',
496 select_list => __PACKAGE__->cgp_timezone_values,
497 disable_inventory => 1,
501 label => 'Communigate layout',
503 select_list => [ '', '***', 'GoldFleece', 'Skin2' ],
504 disable_inventory => 1,
507 'cgp_prontoskinname' => {
508 label => 'Communigate Pronto style',
510 select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ],
511 disable_inventory => 1,
514 'cgp_sendmdnmode' => {
515 label => 'Communigate send read receipts',
517 select_list => [ '', 'Never', 'Manually', 'Automatically' ],
518 disable_inventory => 1,
529 sub table { 'svc_acct'; }
531 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
535 #false laziness with edit/svc_acct.cgi
537 my( $self, $groups ) = @_;
538 if ( ref($groups) eq 'ARRAY' ) {
540 } elsif ( length($groups) ) {
541 [ split(/\s*,\s*/, $groups) ];
550 shift->_lastlog('in', @_);
554 shift->_lastlog('out', @_);
558 my( $self, $op, $time ) = @_;
560 if ( defined($time) ) {
561 warn "$me last_log$op called on svcnum ". $self->svcnum.
562 ' ('. $self->email. "): $time\n"
567 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
571 my $sth = $dbh->prepare( $sql )
572 or die "Error preparing $sql: ". $dbh->errstr;
573 my $rv = $sth->execute($time, $self->svcnum);
574 die "Error executing $sql: ". $sth->errstr
576 die "Can't update last_log$op for svcnum". $self->svcnum
579 $self->{'Hash'}->{"last_log$op"} = $time;
581 $self->getfield("last_log$op");
585 =item search_sql STRING
587 Class method which returns an SQL fragment to search for the given string.
592 my( $class, $string ) = @_;
593 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
594 my( $username, $domain ) = ( $1, $2 );
595 my $q_username = dbh->quote($username);
596 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
598 "svc_acct.username = $q_username AND ( ".
599 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
604 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
606 $class->search_sql_field('slipip', $string ).
608 $class->search_sql_field('username', $string ).
611 $class->search_sql_field('username', $string);
615 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
617 Returns the "username@domain" string for this account.
619 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
629 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
631 Returns a longer string label for this acccount ("Real Name <username@domain>"
632 if available, or "username@domain").
634 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
641 my $label = $self->label(@_);
642 my $finger = $self->finger;
643 return $label unless $finger =~ /\S/;
644 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
645 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
649 =item insert [ , OPTION => VALUE ... ]
651 Adds this account to the database. If there is an error, returns the error,
652 otherwise returns false.
654 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
655 defined. An FS::cust_svc record will be created and inserted.
657 The additional field I<usergroup> can optionally be defined; if so it should
658 contain an arrayref of group names. See L<FS::radius_usergroup>.
660 The additional field I<child_objects> can optionally be defined; if so it
661 should contain an arrayref of FS::tablename objects. They will have their
662 svcnum fields set and will be inserted after this record, but before any
663 exports are run. Each element of the array can also optionally be a
664 two-element array reference containing the child object and the name of an
665 alternate field to be filled in with the newly-inserted svcnum, for example
666 C<[ $svc_forward, 'srcsvc' ]>
668 Currently available options are: I<depend_jobnum>
670 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
671 jobnums), all provisioning jobs will have a dependancy on the supplied
672 jobnum(s) (they will not run until the specific job(s) complete(s)).
674 (TODOC: L<FS::queue> and L<freeside-queued>)
676 (TODOC: new exports!)
685 warn "[$me] insert called on $self: ". Dumper($self).
686 "\nwith options: ". Dumper(%options);
689 local $SIG{HUP} = 'IGNORE';
690 local $SIG{INT} = 'IGNORE';
691 local $SIG{QUIT} = 'IGNORE';
692 local $SIG{TERM} = 'IGNORE';
693 local $SIG{TSTP} = 'IGNORE';
694 local $SIG{PIPE} = 'IGNORE';
696 my $oldAutoCommit = $FS::UID::AutoCommit;
697 local $FS::UID::AutoCommit = 0;
701 my $error = $self->SUPER::insert(
702 'jobnums' => \@jobnums,
703 'child_objects' => $self->child_objects,
707 $dbh->rollback if $oldAutoCommit;
711 if ( $self->usergroup ) {
712 foreach my $groupname ( @{$self->usergroup} ) {
713 my $radius_usergroup = new FS::radius_usergroup ( {
714 svcnum => $self->svcnum,
715 groupname => $groupname,
717 my $error = $radius_usergroup->insert;
719 $dbh->rollback if $oldAutoCommit;
725 unless ( $skip_fuzzyfiles ) {
726 $error = $self->queue_fuzzyfiles_update;
728 $dbh->rollback if $oldAutoCommit;
729 return "updating fuzzy search cache: $error";
733 my $cust_pkg = $self->cust_svc->cust_pkg;
736 my $cust_main = $cust_pkg->cust_main;
737 my $agentnum = $cust_main->agentnum;
739 if ( $conf->exists('emailinvoiceautoalways')
740 || $conf->exists('emailinvoiceauto')
741 && ! $cust_main->invoicing_list_emailonly
743 my @invoicing_list = $cust_main->invoicing_list;
744 push @invoicing_list, $self->email;
745 $cust_main->invoicing_list(\@invoicing_list);
750 my $msgnum = $conf->config('welcome_msgnum', $agentnum);
752 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
753 $error = $msg_template->send('cust_main' => $cust_main,
757 my ($to,$welcome_template,$welcome_from,$welcome_subject,$welcome_subject_template,$welcome_mimetype)
758 = ('','','','','','');
760 if ( $conf->exists('welcome_email', $agentnum) ) {
761 $welcome_template = new Text::Template (
763 SOURCE => [ map "$_\n", $conf->config('welcome_email', $agentnum) ]
764 ) or warn "can't create welcome email template: $Text::Template::ERROR";
765 $welcome_from = $conf->config('welcome_email-from', $agentnum);
766 # || 'your-isp-is-dum'
767 $welcome_subject = $conf->config('welcome_email-subject', $agentnum)
769 $welcome_subject_template = new Text::Template (
771 SOURCE => $welcome_subject,
772 ) or warn "can't create welcome email subject template: $Text::Template::ERROR";
773 $welcome_mimetype = $conf->config('welcome_email-mimetype', $agentnum)
776 if ( $welcome_template ) {
777 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list );
781 'custnum' => $self->custnum,
782 'username' => $self->username,
783 'password' => $self->_password,
784 'first' => $cust_main->first,
785 'last' => $cust_main->getfield('last'),
786 'pkg' => $cust_pkg->part_pkg->pkg,
788 my $wqueue = new FS::queue {
789 'svcnum' => $self->svcnum,
790 'job' => 'FS::svc_acct::send_email'
792 my $error = $wqueue->insert(
794 'from' => $welcome_from,
795 'subject' => $welcome_subject_template->fill_in( HASH => \%hash, ),
796 'mimetype' => $welcome_mimetype,
797 'body' => $welcome_template->fill_in( HASH => \%hash, ),
800 $dbh->rollback if $oldAutoCommit;
801 return "error queuing welcome email: $error";
804 if ( $options{'depend_jobnum'} ) {
805 warn "$me depend_jobnum found; adding to welcome email dependancies"
807 if ( ref($options{'depend_jobnum'}) ) {
808 warn "$me adding jobs ". join(', ', @{$options{'depend_jobnum'}} ).
809 "to welcome email dependancies"
811 push @jobnums, @{ $options{'depend_jobnum'} };
813 warn "$me adding job $options{'depend_jobnum'} ".
814 "to welcome email dependancies"
816 push @jobnums, $options{'depend_jobnum'};
820 foreach my $jobnum ( @jobnums ) {
821 my $error = $wqueue->depend_insert($jobnum);
823 $dbh->rollback if $oldAutoCommit;
824 return "error queuing welcome email job dependancy: $error";
830 } # if $welcome_template
834 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
838 # set usage fields and thresholds if unset but set in a package def
839 # AND the package already has a last bill date (otherwise they get double added)
840 sub preinsert_hook_first {
843 return '' unless $self->pkgnum;
845 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
846 return '' unless $cust_pkg && $cust_pkg->last_bill;
848 my $part_pkg = $cust_pkg->part_pkg;
849 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
851 my %values = $part_pkg->usage_valuehash;
852 my $multiplier = $conf->exists('svc_acct-usage_threshold')
853 ? 1 - $conf->config('svc_acct-usage_threshold')/100
854 : 0.20; #doesn't matter
856 foreach ( keys %values ) {
857 next if $self->getfield($_);
858 $self->setfield( $_, $values{$_} );
859 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
860 if $conf->exists('svc_acct-usage_threshold');
868 Deletes this account from the database. If there is an error, returns the
869 error, otherwise returns false.
871 The corresponding FS::cust_svc record will be deleted as well.
873 (TODOC: new exports!)
880 return "can't delete system account" if $self->_check_system;
882 return "Can't delete an account which is a (svc_forward) source!"
883 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
885 return "Can't delete an account which is a (svc_forward) destination!"
886 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
888 return "Can't delete an account with (svc_www) web service!"
889 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
891 # what about records in session ? (they should refer to history table)
893 local $SIG{HUP} = 'IGNORE';
894 local $SIG{INT} = 'IGNORE';
895 local $SIG{QUIT} = 'IGNORE';
896 local $SIG{TERM} = 'IGNORE';
897 local $SIG{TSTP} = 'IGNORE';
898 local $SIG{PIPE} = 'IGNORE';
900 my $oldAutoCommit = $FS::UID::AutoCommit;
901 local $FS::UID::AutoCommit = 0;
904 foreach my $cust_main_invoice (
905 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
907 unless ( defined($cust_main_invoice) ) {
908 warn "WARNING: something's wrong with qsearch";
911 my %hash = $cust_main_invoice->hash;
912 $hash{'dest'} = $self->email;
913 my $new = new FS::cust_main_invoice \%hash;
914 my $error = $new->replace($cust_main_invoice);
916 $dbh->rollback if $oldAutoCommit;
921 foreach my $svc_domain (
922 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
924 my %hash = new FS::svc_domain->hash;
925 $hash{'catchall'} = '';
926 my $new = new FS::svc_domain \%hash;
927 my $error = $new->replace($svc_domain);
929 $dbh->rollback if $oldAutoCommit;
934 my $error = $self->SUPER::delete;
936 $dbh->rollback if $oldAutoCommit;
940 foreach my $radius_usergroup (
941 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } )
943 my $error = $radius_usergroup->delete;
945 $dbh->rollback if $oldAutoCommit;
950 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
954 =item replace OLD_RECORD
956 Replaces OLD_RECORD with this one in the database. If there is an error,
957 returns the error, otherwise returns false.
959 The additional field I<usergroup> can optionally be defined; if so it should
960 contain an arrayref of group names. See L<FS::radius_usergroup>.
968 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
972 warn "$me replacing $old with $new\n" if $DEBUG;
976 return "can't modify system account" if $old->_check_system;
979 #no warnings 'numeric'; #alas, a 5.006-ism
982 foreach my $xid (qw( uid gid )) {
984 return "Can't change $xid!"
985 if ! $conf->exists("svc_acct-edit_$xid")
986 && $old->$xid() != $new->$xid()
987 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
992 #change homdir when we change username
993 $new->setfield('dir', '') if $old->username ne $new->username;
995 local $SIG{HUP} = 'IGNORE';
996 local $SIG{INT} = 'IGNORE';
997 local $SIG{QUIT} = 'IGNORE';
998 local $SIG{TERM} = 'IGNORE';
999 local $SIG{TSTP} = 'IGNORE';
1000 local $SIG{PIPE} = 'IGNORE';
1002 my $oldAutoCommit = $FS::UID::AutoCommit;
1003 local $FS::UID::AutoCommit = 0;
1006 # redundant, but so $new->usergroup gets set
1007 $error = $new->check;
1008 return $error if $error;
1010 $old->usergroup( [ $old->radius_groups ] );
1012 warn $old->email. " old groups: ". join(' ',@{$old->usergroup}). "\n";
1013 warn $new->email. "new groups: ". join(' ',@{$new->usergroup}). "\n";
1015 if ( $new->usergroup ) {
1016 #(sorta) false laziness with FS::part_export::sqlradius::_export_replace
1017 my @newgroups = @{$new->usergroup};
1018 foreach my $oldgroup ( @{$old->usergroup} ) {
1019 if ( grep { $oldgroup eq $_ } @newgroups ) {
1020 @newgroups = grep { $oldgroup ne $_ } @newgroups;
1023 my $radius_usergroup = qsearchs('radius_usergroup', {
1024 svcnum => $old->svcnum,
1025 groupname => $oldgroup,
1027 my $error = $radius_usergroup->delete;
1029 $dbh->rollback if $oldAutoCommit;
1030 return "error deleting radius_usergroup $oldgroup: $error";
1034 foreach my $newgroup ( @newgroups ) {
1035 my $radius_usergroup = new FS::radius_usergroup ( {
1036 svcnum => $new->svcnum,
1037 groupname => $newgroup,
1039 my $error = $radius_usergroup->insert;
1041 $dbh->rollback if $oldAutoCommit;
1042 return "error adding radius_usergroup $newgroup: $error";
1048 $error = $new->SUPER::replace($old, @_);
1050 $dbh->rollback if $oldAutoCommit;
1051 return $error if $error;
1054 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
1055 $error = $new->queue_fuzzyfiles_update;
1057 $dbh->rollback if $oldAutoCommit;
1058 return "updating fuzzy search cache: $error";
1062 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1066 =item queue_fuzzyfiles_update
1068 Used by insert & replace to update the fuzzy search cache
1072 sub queue_fuzzyfiles_update {
1075 local $SIG{HUP} = 'IGNORE';
1076 local $SIG{INT} = 'IGNORE';
1077 local $SIG{QUIT} = 'IGNORE';
1078 local $SIG{TERM} = 'IGNORE';
1079 local $SIG{TSTP} = 'IGNORE';
1080 local $SIG{PIPE} = 'IGNORE';
1082 my $oldAutoCommit = $FS::UID::AutoCommit;
1083 local $FS::UID::AutoCommit = 0;
1086 my $queue = new FS::queue {
1087 'svcnum' => $self->svcnum,
1088 'job' => 'FS::svc_acct::append_fuzzyfiles'
1090 my $error = $queue->insert($self->username);
1092 $dbh->rollback if $oldAutoCommit;
1093 return "queueing job (transaction rolled back): $error";
1096 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1104 Suspends this account by calling export-specific suspend hooks. If there is
1105 an error, returns the error, otherwise returns false.
1107 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1113 return "can't suspend system account" if $self->_check_system;
1114 $self->SUPER::suspend(@_);
1119 Unsuspends this account by by calling export-specific suspend hooks. If there
1120 is an error, returns the error, otherwise returns false.
1122 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1128 my %hash = $self->hash;
1129 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1130 $hash{_password} = $1;
1131 my $new = new FS::svc_acct ( \%hash );
1132 my $error = $new->replace($self);
1133 return $error if $error;
1136 $self->SUPER::unsuspend(@_);
1141 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1143 If the B<auto_unset_catchall> configuration option is set, this method will
1144 automatically remove any references to the canceled service in the catchall
1145 field of svc_domain. This allows packages that contain both a svc_domain and
1146 its catchall svc_acct to be canceled in one step.
1151 # Only one thing to do at this level
1153 foreach my $svc_domain (
1154 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1155 if($conf->exists('auto_unset_catchall')) {
1156 my %hash = $svc_domain->hash;
1157 $hash{catchall} = '';
1158 my $new = new FS::svc_domain ( \%hash );
1159 my $error = $new->replace($svc_domain);
1160 return $error if $error;
1162 return "cannot unprovision svc_acct #".$self->svcnum.
1163 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1167 $self->SUPER::cancel(@_);
1173 Checks all fields to make sure this is a valid service. If there is an error,
1174 returns the error, otherwise returns false. Called by the insert and replace
1177 Sets any fixed values; see L<FS::part_svc>.
1184 my($recref) = $self->hashref;
1186 my $x = $self->setfixed( $self->_fieldhandlers );
1187 return $x unless ref($x);
1190 if ( $part_svc->part_svc_column('usergroup')->columnflag eq "F" ) {
1192 [ split(',', $part_svc->part_svc_column('usergroup')->columnvalue) ] );
1195 my $error = $self->ut_numbern('svcnum')
1196 #|| $self->ut_number('domsvc')
1197 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1198 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1199 || $self->ut_textn('sec_phrase')
1200 || $self->ut_snumbern('seconds')
1201 || $self->ut_snumbern('upbytes')
1202 || $self->ut_snumbern('downbytes')
1203 || $self->ut_snumbern('totalbytes')
1204 || $self->ut_snumbern('seconds_threshold')
1205 || $self->ut_snumbern('upbytes_threshold')
1206 || $self->ut_snumbern('downbytes_threshold')
1207 || $self->ut_snumbern('totalbytes_threshold')
1208 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1209 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1210 || $self->ut_enum('password_recover', [ '', 'Y' ])
1212 || $self->ut_anything('cf_privatekey')
1214 || $self->ut_textn('cgp_accessmodes')
1215 || $self->ut_alphan('cgp_type')
1216 || $self->ut_textn('cgp_aliases' ) #well
1218 || $self->ut_alphasn('cgp_rulesallowed')
1219 || $self->ut_enum('cgp_rpopallowed', [ '', 'Y' ])
1220 || $self->ut_enum('cgp_mailtoall', [ '', 'Y' ])
1221 || $self->ut_enum('cgp_addmailtrailer', [ '', 'Y' ])
1222 || $self->ut_snumbern('cgp_archiveafter')
1224 || $self->ut_alphasn('cgp_deletemode')
1225 || $self->ut_enum('cgp_emptytrash', $self->cgp_emptytrash_values)
1226 || $self->ut_alphan('cgp_language')
1227 || $self->ut_textn('cgp_timezone')
1228 || $self->ut_textn('cgp_skinname')
1229 || $self->ut_textn('cgp_prontoskinname')
1230 || $self->ut_alphan('cgp_sendmdnmode')
1232 return $error if $error;
1235 local $username_letter = $username_letter;
1236 if ($self->svcnum) {
1237 my $cust_svc = $self->cust_svc
1238 or return "no cust_svc record found for svcnum ". $self->svcnum;
1239 my $cust_pkg = $cust_svc->cust_pkg;
1241 if ($self->pkgnum) {
1242 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1246 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1249 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1251 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:\/\=\#]{$usernamemin,$ulen})$/i
1252 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1253 $recref->{username} = $1;
1255 unless ( $username_uppercase ) {
1256 $recref->{username} =~ /[A-Z]/ and return gettext('illegal_username');
1258 if ( $username_letterfirst ) {
1259 $recref->{username} =~ /^[a-z]/ or return gettext('illegal_username');
1260 } elsif ( $username_letter ) {
1261 $recref->{username} =~ /[a-z]/ or return gettext('illegal_username');
1263 if ( $username_noperiod ) {
1264 $recref->{username} =~ /\./ and return gettext('illegal_username');
1266 if ( $username_nounderscore ) {
1267 $recref->{username} =~ /_/ and return gettext('illegal_username');
1269 if ( $username_nodash ) {
1270 $recref->{username} =~ /\-/ and return gettext('illegal_username');
1272 unless ( $username_ampersand ) {
1273 $recref->{username} =~ /\&/ and return gettext('illegal_username');
1275 unless ( $username_percent ) {
1276 $recref->{username} =~ /\%/ and return gettext('illegal_username');
1278 unless ( $username_colon ) {
1279 $recref->{username} =~ /\:/ and return gettext('illegal_username');
1281 unless ( $username_slash ) {
1282 $recref->{username} =~ /\// and return gettext('illegal_username');
1284 unless ( $username_equals ) {
1285 $recref->{username} =~ /\=/ and return gettext('illegal_username');
1287 unless ( $username_pound ) {
1288 $recref->{username} =~ /\#/ and return gettext('illegal_username');
1292 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1293 $recref->{popnum} = $1;
1294 return "Unknown popnum" unless
1295 ! $recref->{popnum} ||
1296 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1298 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1300 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1301 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1303 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1304 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1305 #not all systems use gid=uid
1306 #you can set a fixed gid in part_svc
1308 return "Only root can have uid 0"
1309 if $recref->{uid} == 0
1310 && $recref->{username} !~ /^(root|toor|smtp)$/;
1312 unless ( $recref->{username} eq 'sync' ) {
1313 if ( grep $_ eq $recref->{shell}, @shells ) {
1314 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1316 return "Illegal shell \`". $self->shell. "\'; ".
1317 "shells configuration value contains: @shells";
1320 $recref->{shell} = '/bin/sync';
1324 $recref->{gid} ne '' ?
1325 return "Can't have gid without uid" : ( $recref->{gid}='' );
1326 #$recref->{dir} ne '' ?
1327 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1328 $recref->{shell} ne '' ?
1329 return "Can't have shell without uid" : ( $recref->{shell}='' );
1332 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1334 $recref->{dir} =~ /^([\/\w\-\.\&\:\#]*)$/
1335 or return "Illegal directory: ". $recref->{dir};
1336 $recref->{dir} = $1;
1337 return "Illegal directory"
1338 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1339 return "Illegal directory"
1340 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1341 unless ( $recref->{dir} ) {
1342 $recref->{dir} = $dir_prefix . '/';
1343 if ( $dirhash > 0 ) {
1344 for my $h ( 1 .. $dirhash ) {
1345 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1347 } elsif ( $dirhash < 0 ) {
1348 for my $h ( reverse $dirhash .. -1 ) {
1349 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1352 $recref->{dir} .= $recref->{username};
1358 # $error = $self->ut_textn('finger');
1359 # return $error if $error;
1360 if ( $self->getfield('finger') eq '' ) {
1361 my $cust_pkg = $self->svcnum
1362 ? $self->cust_svc->cust_pkg
1363 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1365 my $cust_main = $cust_pkg->cust_main;
1366 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1369 $self->getfield('finger') =~
1370 /^([µ_0123456789aAáÁàÀâÂåÅäÄãêæÆbBcCçÇdDðÐeEéÉèÈêÊëËfFgGhHiIíÍìÌîÎïÏjJkKlLmMnNñÑoOóÓòÒôÔöÖõÕøغpPqQrRsSßtTuUúÚùÙûÛüÜvVwWxXyYýÝÿzZþÞ \t\!\@\#\$\%\&\(\)\-\+\;\'\"\,\.\?\/\*\<\>]*)$/
1371 or return "Illegal finger: ". $self->getfield('finger');
1372 $self->setfield('finger', $1);
1374 for (qw( quota file_quota file_maxsize )) {
1375 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1378 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1379 $recref->{file_maxnum} = $1;
1381 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1382 if ( $recref->{slipip} eq '' ) {
1383 $recref->{slipip} = '';
1384 } elsif ( $recref->{slipip} eq '0e0' ) {
1385 $recref->{slipip} = '0e0';
1387 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1388 or return "Illegal slipip: ". $self->slipip;
1389 $recref->{slipip} = $1;
1394 #arbitrary RADIUS stuff; allow ut_textn for now
1395 foreach ( grep /^radius_/, fields('svc_acct') ) {
1396 $self->ut_textn($_);
1399 # First, if _password is blank, generate one and set default encoding.
1400 if ( ! $recref->{_password} ) {
1401 $error = $self->set_password('');
1403 # But if there's a _password but no encoding, assume it's plaintext and
1404 # set it to default encoding.
1405 elsif ( ! $recref->{_password_encoding} ) {
1406 $error = $self->set_password($recref->{_password});
1408 return $error if $error;
1410 # Next, check _password to ensure compliance with the encoding.
1411 if ( $recref->{_password_encoding} eq 'ldap' ) {
1413 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1414 $recref->{_password} = uc($1).$2;
1416 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1419 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1421 if ( $recref->{_password} =~
1422 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1423 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1426 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1429 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1432 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1433 # Password randomization is now in set_password.
1434 # Strip whitespace characters, check length requirements, etc.
1435 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1436 $recref->{_password} = $1;
1438 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1439 FS::Msgcat::_gettext('illegal_password_characters').
1440 ": ". $recref->{_password};
1443 if ( $password_noampersand ) {
1444 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1446 if ( $password_noexclamation ) {
1447 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1451 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1453 $self->SUPER::check;
1458 sub _password_encryption {
1460 my $encoding = lc($self->_password_encoding);
1461 return if !$encoding;
1462 return 'plain' if $encoding eq 'plain';
1463 if($encoding eq 'crypt') {
1464 my $pass = $self->_password;
1465 $pass =~ s/^\*SUSPENDED\* //;
1467 return 'md5' if $pass =~ /^\$1\$/;
1468 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1469 return 'des' if length($pass) == 13;
1472 if($encoding eq 'ldap') {
1473 uc($self->_password) =~ /^\{([\w-]+)\}/;
1474 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1475 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1476 return 'md5' if $1 eq 'MD5';
1477 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1484 sub get_cleartext_password {
1486 if($self->_password_encryption eq 'plain') {
1487 if($self->_password_encoding eq 'ldap') {
1488 $self->_password =~ /\{\w+\}(.*)$/;
1492 return $self->_password;
1501 Set the cleartext password for the account. If _password_encoding is set, the
1502 new password will be encoded according to the existing method (including
1503 encryption mode, if it can be determined). Otherwise,
1504 config('default-password-encoding') is used.
1506 If no password is supplied (or a zero-length password when minimum password length
1507 is >0), one will be generated randomly.
1512 my( $self, $pass ) = ( shift, shift );
1514 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1517 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1518 FS::Msgcat::_gettext('illegal_password_characters').
1521 my( $encoding, $encryption ) = ('', '');
1523 if ( $self->_password_encoding ) {
1524 $encoding = $self->_password_encoding;
1525 # identify existing encryption method, try to use it.
1526 $encryption = $self->_password_encryption;
1528 # use the system default
1534 # set encoding to system default
1535 ($encoding, $encryption) =
1536 split(/-/, lc($conf->config('default-password-encoding')));
1537 $encoding ||= 'legacy';
1538 $self->_password_encoding($encoding);
1541 if ( $encoding eq 'legacy' ) {
1543 # The legacy behavior from check():
1544 # If the password is blank, randomize it and set encoding to 'plain'.
1545 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1546 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1547 $self->_password_encoding('plain');
1549 # Prefix + valid-length password
1550 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1552 $self->_password_encoding('plain');
1553 # Prefix + crypt string
1554 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1556 $self->_password_encoding('crypt');
1557 # Various disabled crypt passwords
1558 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1559 $self->_password_encoding('crypt');
1565 $self->_password($pass);
1571 if $passwordmin && length($pass) < $passwordmin
1572 or $passwordmax && length($pass) > $passwordmax;
1574 if ( $encoding eq 'crypt' ) {
1575 if ($encryption eq 'md5') {
1576 $pass = unix_md5_crypt($pass);
1577 } elsif ($encryption eq 'des') {
1578 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1581 } elsif ( $encoding eq 'ldap' ) {
1582 if ($encryption eq 'md5') {
1583 $pass = md5_base64($pass);
1584 } elsif ($encryption eq 'sha1') {
1585 $pass = sha1_base64($pass);
1586 } elsif ($encryption eq 'crypt') {
1587 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1589 # else $encryption eq 'plain', do nothing
1590 $pass = '{'.uc($encryption).'}'.$pass;
1592 # else encoding eq 'plain'
1594 $self->_password($pass);
1600 Internal function to check the username against the list of system usernames
1601 from the I<system_usernames> configuration value. Returns true if the username
1602 is listed on the system username list.
1608 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1609 $conf->config('system_usernames')
1613 =item _check_duplicate
1615 Internal method to check for duplicates usernames, username@domain pairs and
1618 If the I<global_unique-username> configuration value is set to B<username> or
1619 B<username@domain>, enforces global username or username@domain uniqueness.
1621 In all cases, check for duplicate uids and usernames or username@domain pairs
1622 per export and with identical I<svcpart> values.
1626 sub _check_duplicate {
1629 my $global_unique = $conf->config('global_unique-username') || 'none';
1630 return '' if $global_unique eq 'disabled';
1634 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1635 unless ( $part_svc ) {
1636 return 'unknown svcpart '. $self->svcpart;
1639 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1640 qsearch( 'svc_acct', { 'username' => $self->username } );
1641 return gettext('username_in_use')
1642 if $global_unique eq 'username' && @dup_user;
1644 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1645 qsearch( 'svc_acct', { 'username' => $self->username,
1646 'domsvc' => $self->domsvc } );
1647 return gettext('username_in_use')
1648 if $global_unique eq 'username@domain' && @dup_userdomain;
1651 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1652 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1653 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1654 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1659 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1660 my $exports = FS::part_export::export_info('svc_acct');
1661 my %conflict_user_svcpart;
1662 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1664 foreach my $part_export ( $part_svc->part_export ) {
1666 #this will catch to the same exact export
1667 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1669 #this will catch to exports w/same exporthost+type ???
1670 #my @other_part_export = qsearch('part_export', {
1671 # 'machine' => $part_export->machine,
1672 # 'exporttype' => $part_export->exporttype,
1674 #foreach my $other_part_export ( @other_part_export ) {
1675 # push @svcparts, map { $_->svcpart }
1676 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1679 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1680 #silly kludge to avoid uninitialized value errors
1681 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1682 ? $exports->{$part_export->exporttype}{'nodomain'}
1684 if ( $nodomain =~ /^Y/i ) {
1685 $conflict_user_svcpart{$_} = $part_export->exportnum
1688 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1693 foreach my $dup_user ( @dup_user ) {
1694 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1695 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1696 return "duplicate username ". $self->username.
1697 ": conflicts with svcnum ". $dup_user->svcnum.
1698 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1702 foreach my $dup_userdomain ( @dup_userdomain ) {
1703 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1704 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1705 return "duplicate username\@domain ". $self->email.
1706 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1707 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1711 foreach my $dup_uid ( @dup_uid ) {
1712 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1713 if ( exists($conflict_user_svcpart{$dup_svcpart})
1714 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1715 return "duplicate uid ". $self->uid.
1716 ": conflicts with svcnum ". $dup_uid->svcnum.
1718 ( $conflict_user_svcpart{$dup_svcpart}
1719 || $conflict_userdomain_svcpart{$dup_svcpart} );
1731 Depriciated, use radius_reply instead.
1736 carp "FS::svc_acct::radius depriciated, use radius_reply";
1737 $_[0]->radius_reply;
1742 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1743 reply attributes of this record.
1745 Note that this is now the preferred method for reading RADIUS attributes -
1746 accessing the columns directly is discouraged, as the column names are
1747 expected to change in the future.
1754 return %{ $self->{'radius_reply'} }
1755 if exists $self->{'radius_reply'};
1760 my($column, $attrib) = ($1, $2);
1761 #$attrib =~ s/_/\-/g;
1762 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1763 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1765 if ( $self->slipip && $self->slipip ne '0e0' ) {
1766 $reply{$radius_ip} = $self->slipip;
1769 if ( $self->seconds !~ /^$/ ) {
1770 $reply{'Session-Timeout'} = $self->seconds;
1773 if ( $conf->exists('radius-chillispot-max') ) {
1774 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1776 #hmm. just because sqlradius.pm says so?
1783 foreach my $what (qw( input output total )) {
1784 my $is = $whatis{$what}.'bytes';
1785 if ( $self->$is() =~ /\d/ ) {
1786 my $big = new Math::BigInt $self->$is();
1787 $big = new Math::BigInt '0' if $big->is_neg();
1788 my $att = "Chillispot-Max-\u$what";
1789 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1790 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1801 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1802 check attributes of this record.
1804 Note that this is now the preferred method for reading RADIUS attributes -
1805 accessing the columns directly is discouraged, as the column names are
1806 expected to change in the future.
1813 return %{ $self->{'radius_check'} }
1814 if exists $self->{'radius_check'};
1819 my($column, $attrib) = ($1, $2);
1820 #$attrib =~ s/_/\-/g;
1821 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1822 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1825 my($pw_attrib, $password) = $self->radius_password;
1826 $check{$pw_attrib} = $password;
1828 my $cust_svc = $self->cust_svc;
1830 my $cust_pkg = $cust_svc->cust_pkg;
1831 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1832 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1835 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1836 "; can't set Expiration\n"
1844 =item radius_password
1846 Returns a key/value pair containing the RADIUS attribute name and value
1851 sub radius_password {
1855 if ( $self->_password_encoding eq 'ldap' ) {
1856 $pw_attrib = 'Password-With-Header';
1857 } elsif ( $self->_password_encoding eq 'crypt' ) {
1858 $pw_attrib = 'Crypt-Password';
1859 } elsif ( $self->_password_encoding eq 'plain' ) {
1860 $pw_attrib = $radius_password;
1862 $pw_attrib = length($self->_password) <= 12
1867 ($pw_attrib, $self->_password);
1873 This method instructs the object to "snapshot" or freeze RADIUS check and
1874 reply attributes to the current values.
1878 #bah, my english is too broken this morning
1879 #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
1880 #the FS::cust_pkg's replace method to trigger the correct export updates when
1881 #package dates change)
1886 $self->{$_} = { $self->$_() }
1887 foreach qw( radius_reply radius_check );
1891 =item forget_snapshot
1893 This methos instructs the object to forget any previously snapshotted
1894 RADIUS check and reply attributes.
1898 sub forget_snapshot {
1902 foreach qw( radius_reply radius_check );
1906 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1908 Returns the domain associated with this account.
1910 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1917 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1918 my $svc_domain = $self->svc_domain(@_)
1919 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1920 $svc_domain->domain;
1925 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1929 #inherited from svc_Common
1931 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1933 Returns an email address associated with the account.
1935 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1942 $self->username. '@'. $self->domain(@_);
1947 Returns an array of FS::acct_snarf records associated with the account.
1954 'table' => 'acct_snarf',
1955 'hashref' => { 'svcnum' => $self->svcnum },
1956 #'order_by' => 'ORDER BY priority ASC',
1960 =item cgp_rpop_hashref
1962 Returns an arrayref of RPOP data suitable for Communigate Pro API commands.
1966 sub cgp_rpop_hashref {
1968 { map { $_->snarfname => $_->cgp_hashref } $self->acct_snarf };
1971 =item decrement_upbytes OCTETS
1973 Decrements the I<upbytes> field of this record by the given amount. If there
1974 is an error, returns the error, otherwise returns false.
1978 sub decrement_upbytes {
1979 shift->_op_usage('-', 'upbytes', @_);
1982 =item increment_upbytes OCTETS
1984 Increments the I<upbytes> field of this record by the given amount. If there
1985 is an error, returns the error, otherwise returns false.
1989 sub increment_upbytes {
1990 shift->_op_usage('+', 'upbytes', @_);
1993 =item decrement_downbytes OCTETS
1995 Decrements the I<downbytes> field of this record by the given amount. If there
1996 is an error, returns the error, otherwise returns false.
2000 sub decrement_downbytes {
2001 shift->_op_usage('-', 'downbytes', @_);
2004 =item increment_downbytes OCTETS
2006 Increments the I<downbytes> field of this record by the given amount. If there
2007 is an error, returns the error, otherwise returns false.
2011 sub increment_downbytes {
2012 shift->_op_usage('+', 'downbytes', @_);
2015 =item decrement_totalbytes OCTETS
2017 Decrements the I<totalbytes> field of this record by the given amount. If there
2018 is an error, returns the error, otherwise returns false.
2022 sub decrement_totalbytes {
2023 shift->_op_usage('-', 'totalbytes', @_);
2026 =item increment_totalbytes OCTETS
2028 Increments the I<totalbytes> field of this record by the given amount. If there
2029 is an error, returns the error, otherwise returns false.
2033 sub increment_totalbytes {
2034 shift->_op_usage('+', 'totalbytes', @_);
2037 =item decrement_seconds SECONDS
2039 Decrements the I<seconds> field of this record by the given amount. If there
2040 is an error, returns the error, otherwise returns false.
2044 sub decrement_seconds {
2045 shift->_op_usage('-', 'seconds', @_);
2048 =item increment_seconds SECONDS
2050 Increments the I<seconds> field of this record by the given amount. If there
2051 is an error, returns the error, otherwise returns false.
2055 sub increment_seconds {
2056 shift->_op_usage('+', 'seconds', @_);
2064 my %op2condition = (
2065 '-' => sub { my($self, $column, $amount) = @_;
2066 $self->$column - $amount <= 0;
2068 '+' => sub { my($self, $column, $amount) = @_;
2069 ($self->$column || 0) + $amount > 0;
2072 my %op2warncondition = (
2073 '-' => sub { my($self, $column, $amount) = @_;
2074 my $threshold = $column . '_threshold';
2075 $self->$column - $amount <= $self->$threshold + 0;
2077 '+' => sub { my($self, $column, $amount) = @_;
2078 ($self->$column || 0) + $amount > 0;
2083 my( $self, $op, $column, $amount ) = @_;
2085 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
2086 ' ('. $self->email. "): $op $amount\n"
2089 return '' unless $amount;
2091 local $SIG{HUP} = 'IGNORE';
2092 local $SIG{INT} = 'IGNORE';
2093 local $SIG{QUIT} = 'IGNORE';
2094 local $SIG{TERM} = 'IGNORE';
2095 local $SIG{TSTP} = 'IGNORE';
2096 local $SIG{PIPE} = 'IGNORE';
2098 my $oldAutoCommit = $FS::UID::AutoCommit;
2099 local $FS::UID::AutoCommit = 0;
2102 my $sql = "UPDATE svc_acct SET $column = ".
2103 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
2104 " $op ? WHERE svcnum = ?";
2108 my $sth = $dbh->prepare( $sql )
2109 or die "Error preparing $sql: ". $dbh->errstr;
2110 my $rv = $sth->execute($amount, $self->svcnum);
2111 die "Error executing $sql: ". $sth->errstr
2112 unless defined($rv);
2113 die "Can't update $column for svcnum". $self->svcnum
2116 #$self->snapshot; #not necessary, we retain the old values
2117 #create an object with the updated usage values
2118 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2120 my $error = $new->replace($self);
2122 $dbh->rollback if $oldAutoCommit;
2123 return "Error replacing: $error";
2126 #overlimit_action eq 'cancel' handling
2127 my $cust_pkg = $self->cust_svc->cust_pkg;
2129 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2130 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2134 my $error = $cust_pkg->cancel; #XXX should have a reason
2136 $dbh->rollback if $oldAutoCommit;
2137 return "Error cancelling: $error";
2140 #nothing else is relevant if we're cancelling, so commit & return success
2141 warn "$me update successful; committing\n"
2143 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2148 my $action = $op2action{$op};
2150 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2151 ( $action eq 'suspend' && !$self->overlimit
2152 || $action eq 'unsuspend' && $self->overlimit )
2155 my $error = $self->_op_overlimit($action);
2157 $dbh->rollback if $oldAutoCommit;
2163 if ( $conf->exists("svc_acct-usage_$action")
2164 && &{$op2condition{$op}}($self, $column, $amount) ) {
2165 #my $error = $self->$action();
2166 my $error = $self->cust_svc->cust_pkg->$action();
2167 # $error ||= $self->overlimit($action);
2169 $dbh->rollback if $oldAutoCommit;
2170 return "Error ${action}ing: $error";
2174 if ($warning_template && &{$op2warncondition{$op}}($self, $column, $amount)) {
2175 my $wqueue = new FS::queue {
2176 'svcnum' => $self->svcnum,
2177 'job' => 'FS::svc_acct::reached_threshold',
2182 $to = $warning_cc if &{$op2condition{$op}}($self, $column, $amount);
2186 my $error = $wqueue->insert(
2187 'svcnum' => $self->svcnum,
2189 'column' => $column,
2193 $dbh->rollback if $oldAutoCommit;
2194 return "Error queuing threshold activity: $error";
2198 warn "$me update successful; committing\n"
2200 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2206 my( $self, $action ) = @_;
2208 local $SIG{HUP} = 'IGNORE';
2209 local $SIG{INT} = 'IGNORE';
2210 local $SIG{QUIT} = 'IGNORE';
2211 local $SIG{TERM} = 'IGNORE';
2212 local $SIG{TSTP} = 'IGNORE';
2213 local $SIG{PIPE} = 'IGNORE';
2215 my $oldAutoCommit = $FS::UID::AutoCommit;
2216 local $FS::UID::AutoCommit = 0;
2219 my $cust_pkg = $self->cust_svc->cust_pkg;
2221 my $conf_overlimit =
2223 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2224 : $conf->config('overlimit_groups');
2226 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2228 my $groups = $conf_overlimit || $part_export->option('overlimit_groups');
2229 next unless $groups;
2231 my $gref = &{ $self->_fieldhandlers->{'usergroup'} }( $self, $groups );
2233 my $other = new FS::svc_acct $self->hashref;
2234 $other->usergroup( $gref );
2237 if ($action eq 'suspend') {
2240 } else { # $action eq 'unsuspend'
2245 my $error = $part_export->export_replace($new, $old)
2246 || $self->overlimit($action);
2249 $dbh->rollback if $oldAutoCommit;
2250 return "Error replacing radius groups: $error";
2255 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2261 my( $self, $valueref, %options ) = @_;
2263 warn "$me set_usage called for svcnum ". $self->svcnum.
2264 ' ('. $self->email. "): ".
2265 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2268 local $SIG{HUP} = 'IGNORE';
2269 local $SIG{INT} = 'IGNORE';
2270 local $SIG{QUIT} = 'IGNORE';
2271 local $SIG{TERM} = 'IGNORE';
2272 local $SIG{TSTP} = 'IGNORE';
2273 local $SIG{PIPE} = 'IGNORE';
2275 local $FS::svc_Common::noexport_hack = 1;
2276 my $oldAutoCommit = $FS::UID::AutoCommit;
2277 local $FS::UID::AutoCommit = 0;
2282 if ( $options{null} ) {
2283 %handyhash = ( map { ( $_ => undef, $_."_threshold" => undef ) }
2284 qw( seconds upbytes downbytes totalbytes )
2287 foreach my $field (keys %$valueref){
2288 $reset = 1 if $valueref->{$field};
2289 $self->setfield($field, $valueref->{$field});
2290 $self->setfield( $field.'_threshold',
2291 int($self->getfield($field)
2292 * ( $conf->exists('svc_acct-usage_threshold')
2293 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2298 $handyhash{$field} = $self->getfield($field);
2299 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2301 #my $error = $self->replace; #NO! we avoid the call to ->check for
2302 #die $error if $error; #services not explicity changed via the UI
2304 my $sql = "UPDATE svc_acct SET " .
2305 join (',', map { "$_ = ?" } (keys %handyhash) ).
2306 " WHERE svcnum = ". $self->svcnum;
2311 if (scalar(keys %handyhash)) {
2312 my $sth = $dbh->prepare( $sql )
2313 or die "Error preparing $sql: ". $dbh->errstr;
2314 my $rv = $sth->execute(values %handyhash);
2315 die "Error executing $sql: ". $sth->errstr
2316 unless defined($rv);
2317 die "Can't update usage for svcnum ". $self->svcnum
2321 #$self->snapshot; #not necessary, we retain the old values
2322 #create an object with the updated usage values
2323 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2324 local($FS::Record::nowarn_identical) = 1;
2325 my $error = $new->replace($self); #call exports
2327 $dbh->rollback if $oldAutoCommit;
2328 return "Error replacing: $error";
2335 $error = $self->_op_overlimit('unsuspend')
2336 if $self->overlimit;;
2338 $error ||= $self->cust_svc->cust_pkg->unsuspend
2339 if $conf->exists("svc_acct-usage_unsuspend");
2342 $dbh->rollback if $oldAutoCommit;
2343 return "Error unsuspending: $error";
2348 warn "$me update successful; committing\n"
2350 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2356 =item recharge HASHREF
2358 Increments usage columns by the amount specified in HASHREF as
2359 column=>amount pairs.
2364 my ($self, $vhash) = @_;
2367 warn "[$me] recharge called on $self: ". Dumper($self).
2368 "\nwith vhash: ". Dumper($vhash);
2371 my $oldAutoCommit = $FS::UID::AutoCommit;
2372 local $FS::UID::AutoCommit = 0;
2376 foreach my $column (keys %$vhash){
2377 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2381 $dbh->rollback if $oldAutoCommit;
2383 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2388 =item is_rechargeable
2390 Returns true if this svc_account can be "recharged" and false otherwise.
2394 sub is_rechargable {
2396 $self->seconds ne ''
2397 || $self->upbytes ne ''
2398 || $self->downbytes ne ''
2399 || $self->totalbytes ne '';
2402 =item seconds_since TIMESTAMP
2404 Returns the number of seconds this account has been online since TIMESTAMP,
2405 according to the session monitor (see L<FS::Session>).
2407 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2408 L<Time::Local> and L<Date::Parse> for conversion functions.
2412 #note: POD here, implementation in FS::cust_svc
2415 $self->cust_svc->seconds_since(@_);
2418 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2420 Returns the numbers of seconds this account has been online between
2421 TIMESTAMP_START (inclusive) and TIMESTAMP_END (exclusive), according to an
2422 external SQL radacct table, specified via sqlradius export. Sessions which
2423 started in the specified range but are still open are counted from session
2424 start to the end of the range (unless they are over 1 day old, in which case
2425 they are presumed missing their stop record and not counted). Also, sessions
2426 which end in the range but started earlier are counted from the start of the
2427 range to session end. Finally, sessions which start before the range but end
2428 after are counted for the entire range.
2430 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2431 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2436 #note: POD here, implementation in FS::cust_svc
2437 sub seconds_since_sqlradacct {
2439 $self->cust_svc->seconds_since_sqlradacct(@_);
2442 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2444 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2445 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2446 TIMESTAMP_END (exclusive).
2448 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2449 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2454 #note: POD here, implementation in FS::cust_svc
2455 sub attribute_since_sqlradacct {
2457 $self->cust_svc->attribute_since_sqlradacct(@_);
2460 =item get_session_history TIMESTAMP_START TIMESTAMP_END
2462 Returns an array of hash references of this customers login history for the
2463 given time range. (document this better)
2467 sub get_session_history {
2469 $self->cust_svc->get_session_history(@_);
2472 =item last_login_text
2474 Returns text describing the time of last login.
2478 sub last_login_text {
2480 $self->last_login ? ctime($self->last_login) : 'unknown';
2483 =item get_cdrs TIMESTAMP_START TIMESTAMP_END [ 'OPTION' => 'VALUE ... ]
2488 my($self, $start, $end, %opt ) = @_;
2490 my $did = $self->username; #yup
2492 my $prefix = $opt{'default_prefix'}; #convergent.au '+61'
2494 my $for_update = $opt{'for_update'} ? 'FOR UPDATE' : '';
2496 #SELECT $for_update * FROM cdr
2497 # WHERE calldate >= $start #need a conversion
2498 # AND calldate < $end #ditto
2499 # AND ( charged_party = "$did"
2500 # OR charged_party = "$prefix$did" #if length($prefix);
2501 # OR ( ( charged_party IS NULL OR charged_party = '' )
2503 # ( src = "$did" OR src = "$prefix$did" ) # if length($prefix)
2506 # AND ( freesidestatus IS NULL OR freesidestatus = '' )
2509 if ( length($prefix) ) {
2511 " AND ( charged_party = '$did'
2512 OR charged_party = '$prefix$did'
2513 OR ( ( charged_party IS NULL OR charged_party = '' )
2515 ( src = '$did' OR src = '$prefix$did' )
2521 " AND ( charged_party = '$did'
2522 OR ( ( charged_party IS NULL OR charged_party = '' )
2532 'select' => "$for_update *",
2535 #( freesidestatus IS NULL OR freesidestatus = '' )
2536 'freesidestatus' => '',
2538 'extra_sql' => $charged_or_src,
2546 Returns all RADIUS groups for this account (see L<FS::radius_usergroup>).
2552 if ( $self->usergroup ) {
2553 confess "explicitly specified usergroup not an arrayref: ". $self->usergroup
2554 unless ref($self->usergroup) eq 'ARRAY';
2555 #when provisioning records, export callback runs in svc_Common.pm before
2556 #radius_usergroup records can be inserted...
2557 @{$self->usergroup};
2559 map { $_->groupname }
2560 qsearch('radius_usergroup', { 'svcnum' => $self->svcnum } );
2564 =item clone_suspended
2566 Constructor used by FS::part_export::_export_suspend fallback. Document
2571 sub clone_suspended {
2573 my %hash = $self->hash;
2574 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2575 new FS::svc_acct \%hash;
2578 =item clone_kludge_unsuspend
2580 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2585 sub clone_kludge_unsuspend {
2587 my %hash = $self->hash;
2588 $hash{_password} = '';
2589 new FS::svc_acct \%hash;
2592 =item check_password
2594 Checks the supplied password against the (possibly encrypted) password in the
2595 database. Returns true for a successful authentication, false for no match.
2597 Currently supported encryptions are: classic DES crypt() and MD5
2601 sub check_password {
2602 my($self, $check_password) = @_;
2604 #remove old-style SUSPENDED kludge, they should be allowed to login to
2605 #self-service and pay up
2606 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2608 if ( $self->_password_encoding eq 'ldap' ) {
2610 my $auth = from_rfc2307 Authen::Passphrase $self->_password;
2611 return $auth->match($check_password);
2613 } elsif ( $self->_password_encoding eq 'crypt' ) {
2615 my $auth = from_crypt Authen::Passphrase $self->_password;
2616 return $auth->match($check_password);
2618 } elsif ( $self->_password_encoding eq 'plain' ) {
2620 return $check_password eq $password;
2624 #XXX this could be replaced with Authen::Passphrase stuff
2626 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2628 } elsif ( length($password) < 13 ) { #plaintext
2629 $check_password eq $password;
2630 } elsif ( length($password) == 13 ) { #traditional DES crypt
2631 crypt($check_password, $password) eq $password;
2632 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2633 unix_md5_crypt($check_password, $password) eq $password;
2634 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2635 warn "Can't check password: Blowfish encryption not yet supported, ".
2636 "svcnum ". $self->svcnum. "\n";
2639 warn "Can't check password: Unrecognized encryption for svcnum ".
2640 $self->svcnum. "\n";
2648 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2650 Returns an encrypted password, either by passing through an encrypted password
2651 in the database or by encrypting a plaintext password from the database.
2653 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2654 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2655 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2656 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2657 encryption type is only used if the password is not already encrypted in the
2662 sub crypt_password {
2665 if ( $self->_password_encoding eq 'ldap' ) {
2667 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2670 #XXX this could be replaced with Authen::Passphrase stuff
2672 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2673 if ( $encryption eq 'crypt' ) {
2676 $saltset[int(rand(64))].$saltset[int(rand(64))]
2678 } elsif ( $encryption eq 'md5' ) {
2679 unix_md5_crypt( $self->_password );
2680 } elsif ( $encryption eq 'blowfish' ) {
2681 croak "unknown encryption method $encryption";
2683 croak "unknown encryption method $encryption";
2686 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2690 } elsif ( $self->_password_encoding eq 'crypt' ) {
2692 return $self->_password;
2694 } elsif ( $self->_password_encoding eq 'plain' ) {
2696 #XXX this could be replaced with Authen::Passphrase stuff
2698 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2699 if ( $encryption eq 'crypt' ) {
2702 $saltset[int(rand(64))].$saltset[int(rand(64))]
2704 } elsif ( $encryption eq 'md5' ) {
2705 unix_md5_crypt( $self->_password );
2706 } elsif ( $encryption eq 'blowfish' ) {
2707 croak "unknown encryption method $encryption";
2709 croak "unknown encryption method $encryption";
2714 if ( length($self->_password) == 13
2715 || $self->_password =~ /^\$(1|2a?)\$/
2716 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2722 #XXX this could be replaced with Authen::Passphrase stuff
2724 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2725 if ( $encryption eq 'crypt' ) {
2728 $saltset[int(rand(64))].$saltset[int(rand(64))]
2730 } elsif ( $encryption eq 'md5' ) {
2731 unix_md5_crypt( $self->_password );
2732 } elsif ( $encryption eq 'blowfish' ) {
2733 croak "unknown encryption method $encryption";
2735 croak "unknown encryption method $encryption";
2744 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2746 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2747 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2748 "{MD5}5426824942db4253f87a1009fd5d2d4".
2750 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2751 to work the same as the B</crypt_password> method.
2757 #eventually should check a "password-encoding" field
2759 if ( $self->_password_encoding eq 'ldap' ) {
2761 return $self->_password;
2763 } elsif ( $self->_password_encoding eq 'crypt' ) {
2765 if ( length($self->_password) == 13 ) { #crypt
2766 return '{CRYPT}'. $self->_password;
2767 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2769 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2770 # die "Blowfish encryption not supported in this context, svcnum ".
2771 # $self->svcnum. "\n";
2773 warn "encryption method not (yet?) supported in LDAP context";
2774 return '{CRYPT}*'; #unsupported, should not auth
2777 } elsif ( $self->_password_encoding eq 'plain' ) {
2779 return '{PLAIN}'. $self->_password;
2781 #return '{CLEARTEXT}'. $self->_password; #?
2785 if ( length($self->_password) == 13 ) { #crypt
2786 return '{CRYPT}'. $self->_password;
2787 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2789 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2790 warn "Blowfish encryption not supported in this context, svcnum ".
2791 $self->svcnum. "\n";
2794 #are these two necessary anymore?
2795 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2796 return '{SSHA}'. $1;
2797 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2798 return '{NS-MTA-MD5}'. $1;
2801 return '{PLAIN}'. $self->_password;
2803 #return '{CLEARTEXT}'. $self->_password; #?
2805 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2806 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2807 #if ( $encryption eq 'crypt' ) {
2808 # return '{CRYPT}'. crypt(
2810 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2812 #} elsif ( $encryption eq 'md5' ) {
2813 # unix_md5_crypt( $self->_password );
2814 #} elsif ( $encryption eq 'blowfish' ) {
2815 # croak "unknown encryption method $encryption";
2817 # croak "unknown encryption method $encryption";
2825 =item domain_slash_username
2827 Returns $domain/$username/
2831 sub domain_slash_username {
2833 $self->domain. '/'. $self->username. '/';
2836 =item virtual_maildir
2838 Returns $domain/maildirs/$username/
2842 sub virtual_maildir {
2844 $self->domain. '/maildirs/'. $self->username. '/';
2849 =head1 CLASS METHODS
2853 =item search HASHREF
2855 Class method which returns a qsearch hash expression to search for parameters
2856 specified in HASHREF. Valid parameters are
2870 Arrayref of pkgparts
2876 Arrayref of additional WHERE clauses, will be ANDed together.
2887 my ($class, $params) = @_;
2892 if ( $params->{'domain'} ) {
2893 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2894 #preserve previous behavior & bubble up an error if $svc_domain not found?
2895 push @where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2899 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2900 push @where, "domsvc = $1";
2904 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
2907 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2908 push @where, "agentnum = $1";
2912 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2913 push @where, "custnum = $1";
2917 if ( $params->{'pkgpart'} && scalar(@{ $params->{'pkgpart'} }) ) {
2918 #XXX untaint or sql quote
2920 'cust_pkg.pkgpart IN ('. join(',', @{ $params->{'pkgpart'} } ). ')';
2924 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2925 push @where, "popnum = $1";
2929 if ( $params->{'svcpart'} =~ /^(\d+)$/ ) {
2930 push @where, "svcpart = $1";
2934 # here is the agent virtualization
2935 #if ($params->{CurrentUser}) {
2937 # qsearchs('access_user', { username => $params->{CurrentUser} });
2939 # if ($access_user) {
2940 # push @where, $access_user->agentnums_sql('table'=>'cust_main');
2942 # push @where, "1=0";
2945 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
2946 'table' => 'cust_main',
2947 'null_right' => 'View/link unlinked services',
2951 push @where, @{ $params->{'where'} } if $params->{'where'};
2953 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2955 my $addl_from = ' LEFT JOIN cust_svc USING ( svcnum ) '.
2956 ' LEFT JOIN part_svc USING ( svcpart ) '.
2957 ' LEFT JOIN cust_pkg USING ( pkgnum ) '.
2958 ' LEFT JOIN cust_main USING ( custnum ) ';
2960 my $count_query = "SELECT COUNT(*) FROM svc_acct $addl_from $extra_sql";
2961 #if ( keys %svc_acct ) {
2962 # $count_query .= ' WHERE '.
2963 # join(' AND ', map "$_ = ". dbh->quote($svc_acct{$_}),
2969 'table' => 'svc_acct',
2970 'hashref' => {}, # \%svc_acct,
2971 'select' => join(', ',
2974 'cust_main.custnum',
2975 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
2977 'addl_from' => $addl_from,
2978 'extra_sql' => $extra_sql,
2979 'order_by' => $params->{'order_by'},
2980 'count_query' => $count_query,
2993 This is the FS::svc_acct job-queue-able version. It still uses
2994 FS::Misc::send_email under-the-hood.
3001 eval "use FS::Misc qw(send_email)";
3004 $opt{mimetype} ||= 'text/plain';
3005 $opt{mimetype} .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
3007 my $error = send_email(
3008 'from' => $opt{from},
3010 'subject' => $opt{subject},
3011 'content-type' => $opt{mimetype},
3012 'body' => [ map "$_\n", split("\n", $opt{body}) ],
3014 die $error if $error;
3017 =item check_and_rebuild_fuzzyfiles
3021 sub check_and_rebuild_fuzzyfiles {
3022 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
3023 -e "$dir/svc_acct.username"
3024 or &rebuild_fuzzyfiles;
3027 =item rebuild_fuzzyfiles
3031 sub rebuild_fuzzyfiles {
3033 use Fcntl qw(:flock);
3035 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
3039 open(USERNAMELOCK,">>$dir/svc_acct.username")
3040 or die "can't open $dir/svc_acct.username: $!";
3041 flock(USERNAMELOCK,LOCK_EX)
3042 or die "can't lock $dir/svc_acct.username: $!";
3044 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
3046 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
3047 or die "can't open $dir/svc_acct.username.tmp: $!";
3048 print USERNAMECACHE join("\n", @all_username), "\n";
3049 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
3051 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
3061 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
3062 open(USERNAMECACHE,"<$dir/svc_acct.username")
3063 or die "can't open $dir/svc_acct.username: $!";
3064 my @array = map { chomp; $_; } <USERNAMECACHE>;
3065 close USERNAMECACHE;
3069 =item append_fuzzyfiles USERNAME
3073 sub append_fuzzyfiles {
3074 my $username = shift;
3076 &check_and_rebuild_fuzzyfiles;
3078 use Fcntl qw(:flock);
3080 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
3082 open(USERNAME,">>$dir/svc_acct.username")
3083 or die "can't open $dir/svc_acct.username: $!";
3084 flock(USERNAME,LOCK_EX)
3085 or die "can't lock $dir/svc_acct.username: $!";
3087 print USERNAME "$username\n";
3089 flock(USERNAME,LOCK_UN)
3090 or die "can't unlock $dir/svc_acct.username: $!";
3098 =item radius_usergroup_selector GROUPS_ARRAYREF [ SELECTNAME ]
3102 sub radius_usergroup_selector {
3103 my $sel_groups = shift;
3104 my %sel_groups = map { $_=>1 } @$sel_groups;
3106 my $selectname = shift || 'radius_usergroup';
3109 my $sth = $dbh->prepare(
3110 'SELECT DISTINCT(groupname) FROM radius_usergroup ORDER BY groupname'
3111 ) or die $dbh->errstr;
3112 $sth->execute() or die $sth->errstr;
3113 my @all_groups = map { $_->[0] } @{$sth->fetchall_arrayref};
3117 function ${selectname}_doadd(object) {
3118 var myvalue = object.${selectname}_add.value;
3119 var optionName = new Option(myvalue,myvalue,false,true);
3120 var length = object.$selectname.length;
3121 object.$selectname.options[length] = optionName;
3122 object.${selectname}_add.value = "";
3125 <SELECT MULTIPLE NAME="$selectname">
3128 foreach my $group ( @all_groups ) {
3129 $html .= qq(<OPTION VALUE="$group");
3130 if ( $sel_groups{$group} ) {
3131 $html .= ' SELECTED';
3132 $sel_groups{$group} = 0;
3134 $html .= ">$group</OPTION>\n";
3136 foreach my $group ( grep { $sel_groups{$_} } keys %sel_groups ) {
3137 $html .= qq(<OPTION VALUE="$group" SELECTED>$group</OPTION>\n);
3139 $html .= '</SELECT>';
3141 $html .= qq!<BR><INPUT TYPE="text" NAME="${selectname}_add">!.
3142 qq!<INPUT TYPE="button" VALUE="Add new group" onClick="${selectname}_doadd(this.form)">!;
3147 =item reached_threshold
3149 Performs some activities when svc_acct thresholds (such as number of seconds
3150 remaining) are reached.
3154 sub reached_threshold {
3157 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
3158 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
3160 if ( $opt{'op'} eq '+' ){
3161 $svc_acct->setfield( $opt{'column'}.'_threshold',
3162 int($svc_acct->getfield($opt{'column'})
3163 * ( $conf->exists('svc_acct-usage_threshold')
3164 ? $conf->config('svc_acct-usage_threshold')/100
3169 my $error = $svc_acct->replace;
3170 die $error if $error;
3171 }elsif ( $opt{'op'} eq '-' ){
3173 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
3174 return '' if ($threshold eq '' );
3176 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
3177 my $error = $svc_acct->replace;
3178 die $error if $error; # email next time, i guess
3180 if ( $warning_template ) {
3181 eval "use FS::Misc qw(send_email)";
3184 my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
3185 my $cust_main = $cust_pkg->cust_main;
3187 my $to = join(', ', grep { $_ !~ /^(POST|FAX)$/ }
3188 $cust_main->invoicing_list,
3189 ($opt{'to'} ? $opt{'to'} : ())
3192 my $mimetype = $warning_mimetype;
3193 $mimetype .= '; charset="iso-8859-1"' unless $opt{mimetype} =~ /charset/;
3195 my $body = $warning_template->fill_in( HASH => {
3196 'custnum' => $cust_main->custnum,
3197 'username' => $svc_acct->username,
3198 'password' => $svc_acct->_password,
3199 'first' => $cust_main->first,
3200 'last' => $cust_main->getfield('last'),
3201 'pkg' => $cust_pkg->part_pkg->pkg,
3202 'column' => $opt{'column'},
3203 'amount' => $opt{'column'} =~/bytes/
3204 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
3205 : $svc_acct->getfield($opt{'column'}),
3206 'threshold' => $opt{'column'} =~/bytes/
3207 ? FS::UI::bytecount::display_bytecount($threshold)
3212 my $error = send_email(
3213 'from' => $warning_from,
3215 'subject' => $warning_subject,
3216 'content-type' => $mimetype,
3217 'body' => [ map "$_\n", split("\n", $body) ],
3219 die $error if $error;
3222 die "unknown op: " . $opt{'op'};
3230 The $recref stuff in sub check should be cleaned up.
3232 The suspend, unsuspend and cancel methods update the database, but not the
3233 current object. This is probably a bug as it's unexpected and
3236 radius_usergroup_selector? putting web ui components in here? they should
3237 probably live somewhere else...
3239 insertion of RADIUS group stuff in insert could be done with child_objects now
3240 (would probably clean up export of them too)
3242 _op_usage and set_usage bypass the history... maybe they shouldn't
3246 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
3247 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
3248 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
3249 L<freeside-queued>), L<FS::svc_acct_pop>,
3250 schema.html from the base documentation.