2 use base qw( FS::svc_Domain_Mixin FS::svc_PBX_Mixin
3 FS::svc_CGP_Mixin FS::svc_CGPRule_Mixin
12 use vars qw( $DEBUG $me $conf $skip_fuzzyfiles
13 $dir_prefix @shells $usernamemin
14 $usernamemax $passwordmin $passwordmax
15 $username_ampersand $username_letter $username_letterfirst
16 $username_noperiod $username_nounderscore $username_nodash
17 $username_uppercase $username_percent $username_colon
18 $username_slash $username_equals $username_pound
20 $password_noampersand $password_noexclamation
23 $radius_password $radius_ip
26 use Scalar::Util qw( blessed );
31 use Crypt::PasswdMD5 1.2;
32 use Digest::SHA 'sha1_base64';
33 use Digest::MD5 'md5_base64';
36 use Authen::Passphrase;
37 use FS::UID qw( datasrc driver_name );
39 use FS::Record qw( qsearch qsearchs fields dbh dbdef );
40 use FS::Msgcat qw(gettext);
41 use FS::UI::bytecount;
43 use FS::PagedSearch qw( psearch ); # XXX in v4, replace with FS::Cursor
51 use FS::radius_usergroup;
61 $me = '[FS::svc_acct]';
63 #ask FS::UID to run this stuff for us later
64 FS::UID->install_callback( sub {
66 $dir_prefix = $conf->config('home');
67 @shells = $conf->config('shells');
68 $usernamemin = $conf->config('usernamemin') || 2;
69 $usernamemax = $conf->config('usernamemax');
70 $passwordmin = $conf->config('passwordmin'); # || 6;
72 $passwordmin = ( defined($passwordmin) && $passwordmin =~ /\d+/ )
75 $passwordmax = $conf->config('passwordmax') || 12;
76 $username_letter = $conf->exists('username-letter');
77 $username_letterfirst = $conf->exists('username-letterfirst');
78 $username_noperiod = $conf->exists('username-noperiod');
79 $username_nounderscore = $conf->exists('username-nounderscore');
80 $username_nodash = $conf->exists('username-nodash');
81 $username_uppercase = $conf->exists('username-uppercase');
82 $username_ampersand = $conf->exists('username-ampersand');
83 $username_percent = $conf->exists('username-percent');
84 $username_colon = $conf->exists('username-colon');
85 $username_slash = $conf->exists('username-slash');
86 $username_equals = $conf->exists('username-equals');
87 $username_pound = $conf->exists('username-pound');
88 $username_exclamation = $conf->exists('username-exclamation');
89 $password_noampersand = $conf->exists('password-noexclamation');
90 $password_noexclamation = $conf->exists('password-noexclamation');
91 $dirhash = $conf->config('dirhash') || 0;
92 $warning_msgnum = $conf->config('threshold_warning_msgnum');
93 $smtpmachine = $conf->config('smtpmachine');
94 $radius_password = $conf->config('radius-password') || 'Password';
95 $radius_ip = $conf->config('radius-ip') || 'Framed-IP-Address';
96 @pw_set = FS::svc_acct->pw_set;
100 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
104 my ( $hashref, $cache ) = @_;
105 if ( $hashref->{'svc_acct_svcnum'} ) {
106 $self->{'_domsvc'} = FS::svc_domain->new( {
107 'svcnum' => $hashref->{'domsvc'},
108 'domain' => $hashref->{'svc_acct_domain'},
109 'catchall' => $hashref->{'svc_acct_catchall'},
116 FS::svc_acct - Object methods for svc_acct records
122 $record = new FS::svc_acct \%hash;
123 $record = new FS::svc_acct { 'column' => 'value' };
125 $error = $record->insert;
127 $error = $new_record->replace($old_record);
129 $error = $record->delete;
131 $error = $record->check;
133 $error = $record->suspend;
135 $error = $record->unsuspend;
137 $error = $record->cancel;
139 %hash = $record->radius;
141 %hash = $record->radius_reply;
143 %hash = $record->radius_check;
145 $domain = $record->domain;
147 $svc_domain = $record->svc_domain;
149 $email = $record->email;
151 $seconds_since = $record->seconds_since($timestamp);
155 An FS::svc_acct object represents an account. FS::svc_acct inherits from
156 FS::svc_Common. The following fields are currently supported:
162 Primary key (assigned automatcially for new accounts)
170 =item _password_encoding
172 plain, crypt, ldap (or empty for autodetection)
180 Point of presence (see L<FS::svc_acct_pop>)
192 set automatically if blank (and uid is not)
212 svcnum from svc_domain
216 Optional svcnum from svc_pbx
218 =item radius_I<Radius_Attribute>
220 I<Radius-Attribute> (reply)
222 =item rc_I<Radius_Attribute>
224 I<Radius-Attribute> (check)
234 Creates a new account. To add the account to the database, see L<"insert">.
241 'longname_plural' => 'Access accounts and mailboxes',
242 'sorts' => [ 'username', 'uid', 'seconds', 'last_login' ],
243 'display_weight' => 10,
244 'cancel_weight' => 50,
245 'ip_field' => 'slipip',
246 'manual_require' => 1,
248 'dir' => 'Home directory',
251 def_info => 'set to fixed and blank for no UIDs',
254 'slipip' => 'IP address',
255 # 'popnum' => qq!<A HREF="$p/browse/svc_acct_pop.cgi/">POP number</A>!,
257 label => 'Access number',
259 select_table => 'svc_acct_pop',
260 select_key => 'popnum',
261 select_label => 'city',
267 disable_default => 1,
272 'password_selfchange' => { label => 'Password modification',
275 'password_recover' => { label => 'Password recovery',
279 label => 'Quota', #Mail storage limit
281 disable_inventory => 1,
284 label => 'File storage limit',
286 disable_inventory => 1,
289 label => 'Number of files limit',
291 disable_inventory => 1,
294 label => 'File size limit',
296 disable_inventory => 1,
298 '_password' => { label => 'Password',
303 def_info => 'when blank, defaults to UID',
308 def_info => 'set to blank for no shell tracking',
310 #select_list => [ $conf->config('shells') ],
311 select_list => [ $conf ? $conf->config('shells') : () ],
312 disable_inventory => 1,
315 'finger' => 'Real name', # (GECOS)',
319 select_table => 'svc_domain',
320 select_key => 'svcnum',
321 select_label => 'domain',
322 disable_inventory => 1,
325 'pbxsvc' => { label => 'PBX',
326 type => 'select-svc_pbx.html',
327 disable_inventory => 1,
328 disable_select => 1, #UI wonky, pry works otherwise
330 'sectornum' => 'Tower sector',
332 label => 'RADIUS groups',
333 type => 'select-radius_group.html',
334 disable_inventory => 1,
338 'seconds' => { label => 'Seconds',
339 label_sort => 'with Time Remaining',
341 disable_inventory => 1,
343 disable_part_svc_column => 1,
345 'upbytes' => { label => 'Upload',
347 disable_inventory => 1,
349 'format' => \&FS::UI::bytecount::display_bytecount,
350 'parse' => \&FS::UI::bytecount::parse_bytecount,
351 disable_part_svc_column => 1,
353 'downbytes' => { label => 'Download',
355 disable_inventory => 1,
357 'format' => \&FS::UI::bytecount::display_bytecount,
358 'parse' => \&FS::UI::bytecount::parse_bytecount,
359 disable_part_svc_column => 1,
361 'totalbytes'=> { label => 'Total up and download',
363 disable_inventory => 1,
365 'format' => \&FS::UI::bytecount::display_bytecount,
366 'parse' => \&FS::UI::bytecount::parse_bytecount,
367 disable_part_svc_column => 1,
369 'seconds_threshold' => { label => 'Seconds threshold',
371 disable_inventory => 1,
373 disable_part_svc_column => 1,
375 'upbytes_threshold' => { label => 'Upload threshold',
377 disable_inventory => 1,
379 'format' => \&FS::UI::bytecount::display_bytecount,
380 'parse' => \&FS::UI::bytecount::parse_bytecount,
381 disable_part_svc_column => 1,
383 'downbytes_threshold' => { label => 'Download threshold',
385 disable_inventory => 1,
387 'format' => \&FS::UI::bytecount::display_bytecount,
388 'parse' => \&FS::UI::bytecount::parse_bytecount,
389 disable_part_svc_column => 1,
391 'totalbytes_threshold'=> { label => 'Total up and download threshold',
393 disable_inventory => 1,
395 'format' => \&FS::UI::bytecount::display_bytecount,
396 'parse' => \&FS::UI::bytecount::parse_bytecount,
397 disable_part_svc_column => 1,
400 label => 'Last login',
404 label => 'Last logout',
409 label => 'Communigate aliases',
411 disable_inventory => 1,
416 label => 'Communigate account type',
418 select_list => [qw( MultiMailbox TextMailbox MailDirMailbox AGrade BGrade CGrade )],
419 disable_inventory => 1,
422 'cgp_accessmodes' => {
423 label => 'Communigate enabled services',
424 type => 'communigate_pro-accessmodes',
425 disable_inventory => 1,
428 'cgp_rulesallowed' => {
429 label => 'Allowed mail rules',
431 select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ],
432 disable_inventory => 1,
435 'cgp_rpopallowed' => { label => 'RPOP modifications',
438 'cgp_mailtoall' => { label => 'Accepts mail to "all"',
441 'cgp_addmailtrailer' => { label => 'Add trailer to sent mail',
444 'cgp_archiveafter' => {
445 label => 'Archive messages after',
448 -2 => 'default(730 days)',
455 1209600 => '2 weeks',
456 2592000 => '30 days',
457 7776000 => '90 days',
458 15552000 => '180 days',
459 31536000 => '365 days',
460 63072000 => '730 days',
462 disable_inventory => 1,
468 'cgp_deletemode' => {
469 label => 'Communigate message delete method',
471 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
472 disable_inventory => 1,
475 'cgp_emptytrash' => {
476 label => 'Communigate on logout remove trash',
478 select_list => __PACKAGE__->cgp_emptytrash_values,
479 disable_inventory => 1,
483 label => 'Communigate language',
485 select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ],
486 disable_inventory => 1,
490 label => 'Communigate time zone',
492 select_list => __PACKAGE__->cgp_timezone_values,
493 disable_inventory => 1,
497 label => 'Communigate layout',
499 select_list => [ '', '***', 'GoldFleece', 'Skin2' ],
500 disable_inventory => 1,
503 'cgp_prontoskinname' => {
504 label => 'Communigate Pronto style',
506 select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ],
507 disable_inventory => 1,
510 'cgp_sendmdnmode' => {
511 label => 'Communigate send read receipts',
513 select_list => [ '', 'Never', 'Manually', 'Automatically' ],
514 disable_inventory => 1,
525 sub table { 'svc_acct'; }
527 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
530 shift->_lastlog('in', @_);
534 shift->_lastlog('out', @_);
538 my( $self, $op, $time ) = @_;
540 if ( defined($time) ) {
541 warn "$me last_log$op called on svcnum ". $self->svcnum.
542 ' ('. $self->email. "): $time\n"
547 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
551 my $sth = $dbh->prepare( $sql )
552 or die "Error preparing $sql: ". $dbh->errstr;
553 my $rv = $sth->execute($time, $self->svcnum);
554 die "Error executing $sql: ". $sth->errstr
556 die "Can't update last_log$op for svcnum". $self->svcnum
559 $self->{'Hash'}->{"last_log$op"} = $time;
561 $self->getfield("last_log$op");
565 =item search_sql STRING
567 Class method which returns an SQL fragment to search for the given string.
572 my( $class, $string ) = @_;
573 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
574 my( $username, $domain ) = ( $1, $2 );
575 my $q_username = dbh->quote($username);
576 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
578 "svc_acct.username = $q_username AND ( ".
579 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
584 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
586 $class->search_sql_field('slipip', $string ).
588 $class->search_sql_field('username', $string ).
591 $class->search_sql_field('username', $string);
595 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
597 Returns the "username@domain" string for this account.
599 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
609 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
611 Returns a longer string label for this acccount ("Real Name <username@domain>"
612 if available, or "username@domain").
614 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
621 my $label = $self->label(@_);
622 my $finger = $self->finger;
623 return $label unless $finger =~ /\S/;
624 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
625 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
629 =item insert [ , OPTION => VALUE ... ]
631 Adds this account to the database. If there is an error, returns the error,
632 otherwise returns false.
634 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
635 defined. An FS::cust_svc record will be created and inserted.
637 The additional field I<usergroup> can optionally be defined; if so it should
638 contain an arrayref of group names. See L<FS::radius_usergroup>.
640 The additional field I<child_objects> can optionally be defined; if so it
641 should contain an arrayref of FS::tablename objects. They will have their
642 svcnum fields set and will be inserted after this record, but before any
643 exports are run. Each element of the array can also optionally be a
644 two-element array reference containing the child object and the name of an
645 alternate field to be filled in with the newly-inserted svcnum, for example
646 C<[ $svc_forward, 'srcsvc' ]>
648 Currently available options are: I<depend_jobnum>
650 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
651 jobnums), all provisioning jobs will have a dependancy on the supplied
652 jobnum(s) (they will not run until the specific job(s) complete(s)).
654 (TODOC: L<FS::queue> and L<freeside-queued>)
656 (TODOC: new exports!)
665 warn "[$me] insert called on $self: ". Dumper($self).
666 "\nwith options: ". Dumper(%options);
669 local $SIG{HUP} = 'IGNORE';
670 local $SIG{INT} = 'IGNORE';
671 local $SIG{QUIT} = 'IGNORE';
672 local $SIG{TERM} = 'IGNORE';
673 local $SIG{TSTP} = 'IGNORE';
674 local $SIG{PIPE} = 'IGNORE';
676 my $oldAutoCommit = $FS::UID::AutoCommit;
677 local $FS::UID::AutoCommit = 0;
681 my $error = $self->SUPER::insert( # usergroup is here
682 'jobnums' => \@jobnums,
683 'child_objects' => $self->child_objects,
687 $error ||= $self->insert_password_history;
690 $dbh->rollback if $oldAutoCommit;
694 unless ( $skip_fuzzyfiles ) {
695 $error = $self->queue_fuzzyfiles_update;
697 $dbh->rollback if $oldAutoCommit;
698 return "updating fuzzy search cache: $error";
702 my $cust_pkg = $self->cust_svc->cust_pkg;
705 my $cust_main = $cust_pkg->cust_main;
706 my $agentnum = $cust_main->agentnum;
708 if ( $conf->exists('emailinvoiceautoalways')
709 || $conf->exists('emailinvoiceauto')
710 && ! $cust_main->invoicing_list_emailonly
713 # slight false laziness w/ edit/process/cust_main.cgi...
714 # and also slightly arbitrary behavior.
716 # this will never happen but check it anyway
717 my ($contact) = map { $_->contact }
718 qsearch('contact_email', { emailaddress => $self->email });
721 # if the "real name" of this account matches the first + last name
722 # of a contact, attach the email address to that person.
723 my @contacts = map { $_->contact } $cust_main->cust_contact;
724 my $myname = $self->get('finger');
726 grep { $_->get('first') . ' ' . $_->get('last') eq $myname } @contacts;
727 # otherwise just pick the first one
728 $contact = $contacts[0];
731 $contact ||= FS::contact->new({
732 'custnum' => $cust_main->get('custnum'),
733 'locationnum' => $cust_main->get('bill_locationnum'),
734 'last' => $cust_main->get('last'),
735 'first' => $cust_main->get('first'),
737 $contact->set('emailaddress', $self->email);
738 $contact->set('invoice_dest', 'Y');
740 if ( $contact->get('contactnum') ) {
741 $error = $contact->replace;
743 $error = $contact->insert;
747 $dbh->rollback if $oldAutoCommit;
748 return "creating invoice destination contact: $error";
753 my @welcome_exclude_svcparts = $conf->config('svc_acct_welcome_exclude');
754 unless ( grep { $_ eq $self->svcpart } @welcome_exclude_svcparts ) {
756 my $msgnum = $conf->config('welcome_msgnum', $agentnum);
758 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
759 $error = $msg_template->send('cust_main' => $cust_main,
761 #should this do something on error?
766 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
770 # set usage fields and thresholds if unset but set in a package def
771 # AND the package already has a last bill date (otherwise they get double added)
772 sub preinsert_hook_first {
775 return '' unless $self->pkgnum;
777 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
778 return '' unless $cust_pkg && $cust_pkg->last_bill;
780 my $part_pkg = $cust_pkg->part_pkg;
781 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
783 my %values = $part_pkg->usage_valuehash;
784 my $multiplier = $conf->exists('svc_acct-usage_threshold')
785 ? 1 - $conf->config('svc_acct-usage_threshold')/100
786 : 0.20; #doesn't matter
788 foreach ( keys %values ) {
789 next if $self->getfield($_);
790 $self->setfield( $_, $values{$_} );
791 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
792 if $conf->exists('svc_acct-usage_threshold');
800 Deletes this account from the database. If there is an error, returns the
801 error, otherwise returns false.
803 The corresponding FS::cust_svc record will be deleted as well.
805 (TODOC: new exports!)
812 return "can't delete system account" if $self->_check_system;
814 return "Can't delete an account which is a (svc_forward) source!"
815 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
817 return "Can't delete an account which is a (svc_forward) destination!"
818 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
820 return "Can't delete an account with (svc_www) web service!"
821 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
823 # what about records in session ? (they should refer to history table)
825 local $SIG{HUP} = 'IGNORE';
826 local $SIG{INT} = 'IGNORE';
827 local $SIG{QUIT} = 'IGNORE';
828 local $SIG{TERM} = 'IGNORE';
829 local $SIG{TSTP} = 'IGNORE';
830 local $SIG{PIPE} = 'IGNORE';
832 my $oldAutoCommit = $FS::UID::AutoCommit;
833 local $FS::UID::AutoCommit = 0;
836 foreach my $svc_domain (
837 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
839 my %hash = new FS::svc_domain->hash;
840 $hash{'catchall'} = '';
841 my $new = new FS::svc_domain \%hash;
842 my $error = $new->replace($svc_domain);
844 $dbh->rollback if $oldAutoCommit;
849 foreach my $svc_phone (
850 qsearch( 'svc_phone', { 'forward_svcnum' => $self->svcnum })
852 $svc_phone->set('forward_svcnum', '');
853 my $error = $svc_phone->replace;
855 $dbh->rollback if $oldAutoCommit;
860 my $error = $self->delete_password_history
861 || $self->SUPER::delete; # usergroup here
863 $dbh->rollback if $oldAutoCommit;
867 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
871 =item replace OLD_RECORD
873 Replaces OLD_RECORD with this one in the database. If there is an error,
874 returns the error, otherwise returns false.
876 The additional field I<usergroup> can optionally be defined; if so it should
877 contain an arrayref of group names. See L<FS::radius_usergroup>.
885 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
889 warn "$me replacing $old with $new\n" if $DEBUG;
893 return "can't modify system account" if $old->_check_system;
896 #no warnings 'numeric'; #alas, a 5.006-ism
899 foreach my $xid (qw( uid gid )) {
901 return "Can't change $xid!"
902 if ! $conf->exists("svc_acct-edit_$xid")
903 && $old->$xid() != $new->$xid()
904 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
909 return "can't change username"
910 if $old->username ne $new->username
911 && $conf->exists('svc_acct-no_edit_username');
913 #change homdir when we change username
914 $new->setfield('dir', '') if $old->username ne $new->username;
916 local $SIG{HUP} = 'IGNORE';
917 local $SIG{INT} = 'IGNORE';
918 local $SIG{QUIT} = 'IGNORE';
919 local $SIG{TERM} = 'IGNORE';
920 local $SIG{TSTP} = 'IGNORE';
921 local $SIG{PIPE} = 'IGNORE';
923 my $oldAutoCommit = $FS::UID::AutoCommit;
924 local $FS::UID::AutoCommit = 0;
927 $error = $new->SUPER::replace($old, @_); # usergroup here
929 # don't need to record this unless the password was changed
930 if ( $old->_password ne $new->_password ) {
931 $error ||= $new->insert_password_history;
935 $dbh->rollback if $oldAutoCommit;
936 return $error if $error;
939 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
940 $error = $new->queue_fuzzyfiles_update;
942 $dbh->rollback if $oldAutoCommit;
943 return "updating fuzzy search cache: $error";
947 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
951 =item queue_fuzzyfiles_update
953 Used by insert & replace to update the fuzzy search cache
957 sub queue_fuzzyfiles_update {
960 local $SIG{HUP} = 'IGNORE';
961 local $SIG{INT} = 'IGNORE';
962 local $SIG{QUIT} = 'IGNORE';
963 local $SIG{TERM} = 'IGNORE';
964 local $SIG{TSTP} = 'IGNORE';
965 local $SIG{PIPE} = 'IGNORE';
967 my $oldAutoCommit = $FS::UID::AutoCommit;
968 local $FS::UID::AutoCommit = 0;
971 my $queue = new FS::queue {
972 'svcnum' => $self->svcnum,
973 'job' => 'FS::svc_acct::append_fuzzyfiles'
975 my $error = $queue->insert($self->username);
977 $dbh->rollback if $oldAutoCommit;
978 return "queueing job (transaction rolled back): $error";
981 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
989 Suspends this account by calling export-specific suspend hooks. If there is
990 an error, returns the error, otherwise returns false.
992 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
998 return "can't suspend system account" if $self->_check_system;
999 $self->SUPER::suspend(@_);
1004 Unsuspends this account by by calling export-specific suspend hooks. If there
1005 is an error, returns the error, otherwise returns false.
1007 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1013 my %hash = $self->hash;
1014 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1015 $hash{_password} = $1;
1016 my $new = new FS::svc_acct ( \%hash );
1017 my $error = $new->replace($self);
1018 return $error if $error;
1021 $self->SUPER::unsuspend(@_);
1026 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1028 If the B<auto_unset_catchall> configuration option is set, this method will
1029 automatically remove any references to the canceled service in the catchall
1030 field of svc_domain. This allows packages that contain both a svc_domain and
1031 its catchall svc_acct to be canceled in one step.
1036 # Only one thing to do at this level
1038 foreach my $svc_domain (
1039 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1040 if($conf->exists('auto_unset_catchall')) {
1041 my %hash = $svc_domain->hash;
1042 $hash{catchall} = '';
1043 my $new = new FS::svc_domain ( \%hash );
1044 my $error = $new->replace($svc_domain);
1045 return $error if $error;
1047 return "cannot unprovision svc_acct #".$self->svcnum.
1048 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1052 $self->SUPER::cancel(@_);
1058 Checks all fields to make sure this is a valid service. If there is an error,
1059 returns the error, otherwise returns false. Called by the insert and replace
1062 Sets any fixed values; see L<FS::part_svc>.
1069 my($recref) = $self->hashref;
1071 my $x = $self->setfixed;
1072 return $x unless ref($x);
1075 my $error = $self->ut_numbern('svcnum')
1076 #|| $self->ut_number('domsvc')
1077 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1078 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1079 || $self->ut_foreign_keyn('sectornum','tower_sector','sectornum')
1080 || $self->ut_foreign_keyn('routernum','router','routernum')
1081 || $self->ut_foreign_keyn('blocknum','addr_block','blocknum')
1082 || $self->ut_textn('sec_phrase')
1083 || $self->ut_snumbern('seconds')
1084 || $self->ut_snumbern('upbytes')
1085 || $self->ut_snumbern('downbytes')
1086 || $self->ut_snumbern('totalbytes')
1087 || $self->ut_snumbern('seconds_threshold')
1088 || $self->ut_snumbern('upbytes_threshold')
1089 || $self->ut_snumbern('downbytes_threshold')
1090 || $self->ut_snumbern('totalbytes_threshold')
1091 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1092 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1093 || $self->ut_enum('password_recover', [ '', 'Y' ])
1095 || $self->ut_anything('cf_privatekey')
1097 || $self->ut_textn('cgp_accessmodes')
1098 || $self->ut_alphan('cgp_type')
1099 || $self->ut_textn('cgp_aliases' ) #well
1101 || $self->ut_alphasn('cgp_rulesallowed')
1102 || $self->ut_enum('cgp_rpopallowed', [ '', 'Y' ])
1103 || $self->ut_enum('cgp_mailtoall', [ '', 'Y' ])
1104 || $self->ut_enum('cgp_addmailtrailer', [ '', 'Y' ])
1105 || $self->ut_snumbern('cgp_archiveafter')
1107 || $self->ut_alphasn('cgp_deletemode')
1108 || $self->ut_enum('cgp_emptytrash', $self->cgp_emptytrash_values)
1109 || $self->ut_alphan('cgp_language')
1110 || $self->ut_textn('cgp_timezone')
1111 || $self->ut_textn('cgp_skinname')
1112 || $self->ut_textn('cgp_prontoskinname')
1113 || $self->ut_alphan('cgp_sendmdnmode')
1115 return $error if $error;
1117 # assign IP address, etc.
1118 if ( $conf->exists('svc_acct-ip_addr') ) {
1119 my $error = $self->svc_ip_check;
1120 return $error if $error;
1121 } else { # I think this is correct
1122 $self->routernum('');
1123 $self->blocknum('');
1127 local $username_letter = $username_letter;
1128 local $username_uppercase = $username_uppercase;
1129 if ($self->svcnum) {
1130 my $cust_svc = $self->cust_svc
1131 or return "no cust_svc record found for svcnum ". $self->svcnum;
1132 my $cust_pkg = $cust_svc->cust_pkg;
1134 if ($self->pkgnum) {
1135 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1139 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1140 $username_uppercase =
1141 $conf->exists('username-uppercase', $cust_pkg->cust_main->agentnum);
1144 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1146 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:\/\=\#\!]{$usernamemin,$ulen})$/i
1147 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1148 $recref->{username} = $1;
1150 my $uerror = gettext('illegal_username'). ': '. $recref->{username};
1152 unless ( $username_uppercase ) {
1153 $recref->{username} =~ /[A-Z]/ and return $uerror;
1155 if ( $username_letterfirst ) {
1156 $recref->{username} =~ /^[a-z]/ or return $uerror;
1157 } elsif ( $username_letter ) {
1158 $recref->{username} =~ /[a-z]/ or return $uerror;
1160 if ( $username_noperiod ) {
1161 $recref->{username} =~ /\./ and return $uerror;
1163 if ( $username_nounderscore ) {
1164 $recref->{username} =~ /_/ and return $uerror;
1166 if ( $username_nodash ) {
1167 $recref->{username} =~ /\-/ and return $uerror;
1169 unless ( $username_ampersand ) {
1170 $recref->{username} =~ /\&/ and return $uerror;
1172 unless ( $username_percent ) {
1173 $recref->{username} =~ /\%/ and return $uerror;
1175 unless ( $username_colon ) {
1176 $recref->{username} =~ /\:/ and return $uerror;
1178 unless ( $username_slash ) {
1179 $recref->{username} =~ /\// and return $uerror;
1181 unless ( $username_equals ) {
1182 $recref->{username} =~ /\=/ and return $uerror;
1184 unless ( $username_pound ) {
1185 $recref->{username} =~ /\#/ and return $uerror;
1187 unless ( $username_exclamation ) {
1188 $recref->{username} =~ /\!/ and return $uerror;
1192 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1193 $recref->{popnum} = $1;
1194 return "Unknown popnum" unless
1195 ! $recref->{popnum} ||
1196 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1198 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1200 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1201 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1203 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1204 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1205 #not all systems use gid=uid
1206 #you can set a fixed gid in part_svc
1208 return "Only root can have uid 0"
1209 if $recref->{uid} == 0
1210 && $recref->{username} !~ /^(root|toor|smtp)$/;
1212 unless ( $recref->{username} eq 'sync' ) {
1213 if ( grep $_ eq $recref->{shell}, @shells ) {
1214 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1216 return "Illegal shell \`". $self->shell. "\'; ".
1217 "shells configuration value contains: @shells";
1220 $recref->{shell} = '/bin/sync';
1224 $recref->{gid} ne '' ?
1225 return "Can't have gid without uid" : ( $recref->{gid}='' );
1226 #$recref->{dir} ne '' ?
1227 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1228 $recref->{shell} ne '' ?
1229 return "Can't have shell without uid" : ( $recref->{shell}='' );
1232 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1234 $recref->{dir} =~ /^([\/\w\-\.\&\:\#]*)$/
1235 or return "Illegal directory: ". $recref->{dir};
1236 $recref->{dir} = $1;
1237 return "Illegal directory"
1238 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1239 return "Illegal directory"
1240 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1241 unless ( $recref->{dir} ) {
1242 $recref->{dir} = $dir_prefix . '/';
1243 if ( $dirhash > 0 ) {
1244 for my $h ( 1 .. $dirhash ) {
1245 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1247 } elsif ( $dirhash < 0 ) {
1248 for my $h ( reverse $dirhash .. -1 ) {
1249 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1252 $recref->{dir} .= $recref->{username};
1258 if ( $self->getfield('finger') eq '' ) {
1259 my $cust_pkg = $self->svcnum
1260 ? $self->cust_svc->cust_pkg
1261 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1263 my $cust_main = $cust_pkg->cust_main;
1264 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1267 # $error = $self->ut_textn('finger');
1268 # return $error if $error;
1269 $self->getfield('finger') =~ /^([\w \,\.\-\'\&\t\!\@\#\$\%\(\)\+\;\"\?\/\*\<\>]*)$/
1270 or return "Illegal finger: ". $self->getfield('finger');
1271 $self->setfield('finger', $1);
1273 for (qw( quota file_quota file_maxsize )) {
1274 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1277 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1278 $recref->{file_maxnum} = $1;
1280 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1281 if ( $recref->{slipip} eq '' ) {
1282 $recref->{slipip} = ''; # eh?
1283 } elsif ( $recref->{slipip} eq '0e0' ) {
1284 $recref->{slipip} = '0e0';
1286 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1287 or return "Illegal slipip: ". $self->slipip;
1288 $recref->{slipip} = $1;
1292 #arbitrary RADIUS stuff; allow ut_textn for now
1293 foreach ( grep /^radius_/, fields('svc_acct') ) {
1294 $self->ut_textn($_);
1297 # First, if _password is blank, generate one and set default encoding.
1298 if ( ! $recref->{_password} ) {
1299 $error = $self->set_password('');
1301 # But if there's a _password but no encoding, assume it's plaintext and
1302 # set it to default encoding.
1303 elsif ( ! $recref->{_password_encoding} ) {
1304 $error = $self->set_password($recref->{_password});
1306 return $error if $error;
1308 # Next, check _password to ensure compliance with the encoding.
1309 if ( $recref->{_password_encoding} eq 'ldap' ) {
1311 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1312 $recref->{_password} = uc($1).$2;
1314 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1317 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1319 if ( $recref->{_password} =~
1320 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1321 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1324 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1327 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1330 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1331 # Password randomization is now in set_password.
1332 # Strip whitespace characters, check length requirements, etc.
1333 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1334 $recref->{_password} = $1;
1336 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1337 FS::Msgcat::_gettext('illegal_password_characters').
1338 ": ". $recref->{_password};
1341 if ( $password_noampersand ) {
1342 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1344 if ( $password_noexclamation ) {
1345 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1349 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1352 $self->SUPER::check;
1357 sub _password_encryption {
1359 my $encoding = lc($self->_password_encoding);
1360 return if !$encoding;
1361 return 'plain' if $encoding eq 'plain';
1362 if($encoding eq 'crypt') {
1363 my $pass = $self->_password;
1364 $pass =~ s/^\*SUSPENDED\* //;
1366 return 'md5' if $pass =~ /^\$1\$/;
1367 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1368 return 'des' if length($pass) == 13;
1371 if($encoding eq 'ldap') {
1372 uc($self->_password) =~ /^\{([\w-]+)\}/;
1373 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1374 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1375 return 'md5' if $1 eq 'MD5';
1376 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1383 sub get_cleartext_password {
1385 if($self->_password_encryption eq 'plain') {
1386 if($self->_password_encoding eq 'ldap') {
1387 $self->_password =~ /\{\w+\}(.*)$/;
1391 return $self->_password;
1400 Set the cleartext password for the account. If _password_encoding is set, the
1401 new password will be encoded according to the existing method (including
1402 encryption mode, if it can be determined). Otherwise,
1403 config('default-password-encoding') is used.
1405 If no password is supplied (or a zero-length password when minimum password length
1406 is >0), one will be generated randomly.
1411 my( $self, $pass ) = ( shift, shift );
1413 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1416 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1417 FS::Msgcat::_gettext('illegal_password_characters').
1420 my( $encoding, $encryption ) = ('', '');
1422 if ( $self->_password_encoding ) {
1423 $encoding = $self->_password_encoding;
1424 # identify existing encryption method, try to use it.
1425 $encryption = $self->_password_encryption;
1427 # use the system default
1433 # set encoding to system default
1434 ($encoding, $encryption) =
1435 split(/-/, lc($conf->config('default-password-encoding') || ''));
1436 $encoding ||= 'legacy';
1437 $self->_password_encoding($encoding);
1440 if ( $encoding eq 'legacy' ) {
1442 # The legacy behavior from check():
1443 # If the password is blank, randomize it and set encoding to 'plain'.
1444 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1445 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1446 $self->_password_encoding('plain');
1448 # Prefix + valid-length password
1449 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1451 $self->_password_encoding('plain');
1452 # Prefix + crypt string
1453 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1455 $self->_password_encoding('crypt');
1456 # Various disabled crypt passwords
1457 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1458 $self->_password_encoding('crypt');
1464 $self->_password($pass);
1470 if $passwordmin && length($pass) < $passwordmin
1471 or $passwordmax && length($pass) > $passwordmax;
1473 if ( $encoding eq 'crypt' ) {
1474 if ($encryption eq 'md5') {
1475 $pass = unix_md5_crypt($pass);
1476 } elsif ($encryption eq 'des') {
1477 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1480 } elsif ( $encoding eq 'ldap' ) {
1481 if ($encryption eq 'md5') {
1482 $pass = md5_base64($pass);
1483 } elsif ($encryption eq 'sha1') {
1484 $pass = sha1_base64($pass);
1485 } elsif ($encryption eq 'crypt') {
1486 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1488 # else $encryption eq 'plain', do nothing
1489 $pass .= '=' x (4 - length($pass) % 4) #properly padded base64
1490 if $encryption eq 'md5' || $encryption eq 'sha1';
1491 $pass = '{'.uc($encryption).'}'.$pass;
1493 # else encoding eq 'plain'
1495 $self->_password($pass);
1501 Internal function to check the username against the list of system usernames
1502 from the I<system_usernames> configuration value. Returns true if the username
1503 is listed on the system username list.
1509 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1510 $conf->config('system_usernames')
1514 =item _check_duplicate
1516 Internal method to check for duplicates usernames, username@domain pairs and
1519 If the I<global_unique-username> configuration value is set to B<username> or
1520 B<username@domain>, enforces global username or username@domain uniqueness.
1522 In all cases, check for duplicate uids and usernames or username@domain pairs
1523 per export and with identical I<svcpart> values.
1527 sub _check_duplicate {
1530 my $global_unique = $conf->config('global_unique-username') || 'none';
1531 return '' if $global_unique eq 'disabled';
1535 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1536 unless ( $part_svc ) {
1537 return 'unknown svcpart '. $self->svcpart;
1540 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1541 qsearch( 'svc_acct', { 'username' => $self->username } );
1542 return gettext('username_in_use')
1543 if $global_unique eq 'username' && @dup_user;
1545 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1546 qsearch( 'svc_acct', { 'username' => $self->username,
1547 'domsvc' => $self->domsvc } );
1548 return gettext('username_in_use')
1549 if $global_unique eq 'username@domain' && @dup_userdomain;
1552 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1553 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1554 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1555 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1560 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1561 my $exports = FS::part_export::export_info('svc_acct');
1562 my %conflict_user_svcpart;
1563 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1565 foreach my $part_export ( $part_svc->part_export ) {
1567 #this will catch to the same exact export
1568 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1570 #this will catch to exports w/same exporthost+type ???
1571 #my @other_part_export = qsearch('part_export', {
1572 # 'machine' => $part_export->machine,
1573 # 'exporttype' => $part_export->exporttype,
1575 #foreach my $other_part_export ( @other_part_export ) {
1576 # push @svcparts, map { $_->svcpart }
1577 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1580 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1581 #silly kludge to avoid uninitialized value errors
1582 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1583 ? $exports->{$part_export->exporttype}{'nodomain'}
1585 if ( $nodomain =~ /^Y/i ) {
1586 $conflict_user_svcpart{$_} = $part_export->exportnum
1589 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1594 foreach my $dup_user ( @dup_user ) {
1595 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1596 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1597 return "duplicate username ". $self->username.
1598 ": conflicts with svcnum ". $dup_user->svcnum.
1599 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1603 foreach my $dup_userdomain ( @dup_userdomain ) {
1604 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1605 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1606 return "duplicate username\@domain ". $self->email.
1607 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1608 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1612 foreach my $dup_uid ( @dup_uid ) {
1613 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1614 if ( exists($conflict_user_svcpart{$dup_svcpart})
1615 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1616 return "duplicate uid ". $self->uid.
1617 ": conflicts with svcnum ". $dup_uid->svcnum.
1619 ( $conflict_user_svcpart{$dup_svcpart}
1620 || $conflict_userdomain_svcpart{$dup_svcpart} );
1632 Depriciated, use radius_reply instead.
1637 carp "FS::svc_acct::radius depriciated, use radius_reply";
1638 $_[0]->radius_reply;
1643 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1644 reply attributes of this record.
1646 Note that this is now the preferred method for reading RADIUS attributes -
1647 accessing the columns directly is discouraged, as the column names are
1648 expected to change in the future.
1655 return %{ $self->{'radius_reply'} }
1656 if exists $self->{'radius_reply'};
1661 my($column, $attrib) = ($1, $2);
1662 #$attrib =~ s/_/\-/g;
1663 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1664 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1666 if ( $self->slipip && $self->slipip ne '0e0' ) {
1667 $reply{$radius_ip} = $self->slipip;
1670 if ( $self->seconds !~ /^$/ ) {
1671 $reply{'Session-Timeout'} = $self->seconds;
1674 if ( $conf->exists('radius-chillispot-max') ) {
1675 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1677 #hmm. just because sqlradius.pm says so?
1684 foreach my $what (qw( input output total )) {
1685 my $is = $whatis{$what}.'bytes';
1686 if ( $self->$is() =~ /\d/ ) {
1687 my $big = new Math::BigInt $self->$is();
1688 $big = new Math::BigInt '0' if $big->is_neg();
1689 my $att = "Chillispot-Max-\u$what";
1690 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1691 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1702 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1703 check attributes of this record.
1705 Note that this is now the preferred method for reading RADIUS attributes -
1706 accessing the columns directly is discouraged, as the column names are
1707 expected to change in the future.
1714 return %{ $self->{'radius_check'} }
1715 if exists $self->{'radius_check'};
1720 my($column, $attrib) = ($1, $2);
1721 #$attrib =~ s/_/\-/g;
1722 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1723 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1726 my($pw_attrib, $password) = $self->radius_password;
1727 $check{$pw_attrib} = $password;
1729 my $cust_svc = $self->cust_svc;
1731 my $cust_pkg = $cust_svc->cust_pkg;
1732 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1733 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1736 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1737 "; can't set Expiration\n"
1745 =item radius_password
1747 Returns a key/value pair containing the RADIUS attribute name and value
1752 sub radius_password {
1756 if ( $self->_password_encoding eq 'ldap' ) {
1757 $pw_attrib = 'Password-With-Header';
1758 } elsif ( $self->_password_encoding eq 'crypt' ) {
1759 $pw_attrib = 'Crypt-Password';
1760 } elsif ( $self->_password_encoding eq 'plain' ) {
1761 $pw_attrib = $radius_password;
1763 $pw_attrib = length($self->_password) <= 12
1768 ($pw_attrib, $self->_password);
1774 This method instructs the object to "snapshot" or freeze RADIUS check and
1775 reply attributes to the current values.
1779 #bah, my english is too broken this morning
1780 #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
1781 #the FS::cust_pkg's replace method to trigger the correct export updates when
1782 #package dates change)
1787 $self->{$_} = { $self->$_() }
1788 foreach qw( radius_reply radius_check );
1792 =item forget_snapshot
1794 This methos instructs the object to forget any previously snapshotted
1795 RADIUS check and reply attributes.
1799 sub forget_snapshot {
1803 foreach qw( radius_reply radius_check );
1807 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1809 Returns the domain associated with this account.
1811 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1818 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1819 my $svc_domain = $self->svc_domain(@_)
1820 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1821 $svc_domain->domain;
1826 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1830 #inherited from svc_Common
1832 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1834 Returns an email address associated with the account.
1836 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1843 $self->username. '@'. $self->domain(@_);
1849 Returns an array of FS::acct_snarf records associated with the account.
1853 # unused as originally intended, but now by Communigate Pro "RPOP"
1855 =item cgp_rpop_hashref
1857 Returns an arrayref of RPOP data suitable for Communigate Pro API commands.
1861 sub cgp_rpop_hashref {
1863 { map { $_->snarfname => $_->cgp_hashref } $self->acct_snarf };
1866 =item decrement_upbytes OCTETS
1868 Decrements the I<upbytes> field of this record by the given amount. If there
1869 is an error, returns the error, otherwise returns false.
1873 sub decrement_upbytes {
1874 shift->_op_usage('-', 'upbytes', @_);
1877 =item increment_upbytes OCTETS
1879 Increments the I<upbytes> field of this record by the given amount. If there
1880 is an error, returns the error, otherwise returns false.
1884 sub increment_upbytes {
1885 shift->_op_usage('+', 'upbytes', @_);
1888 =item decrement_downbytes OCTETS
1890 Decrements the I<downbytes> field of this record by the given amount. If there
1891 is an error, returns the error, otherwise returns false.
1895 sub decrement_downbytes {
1896 shift->_op_usage('-', 'downbytes', @_);
1899 =item increment_downbytes OCTETS
1901 Increments the I<downbytes> field of this record by the given amount. If there
1902 is an error, returns the error, otherwise returns false.
1906 sub increment_downbytes {
1907 shift->_op_usage('+', 'downbytes', @_);
1910 =item decrement_totalbytes OCTETS
1912 Decrements the I<totalbytes> field of this record by the given amount. If there
1913 is an error, returns the error, otherwise returns false.
1917 sub decrement_totalbytes {
1918 shift->_op_usage('-', 'totalbytes', @_);
1921 =item increment_totalbytes OCTETS
1923 Increments the I<totalbytes> field of this record by the given amount. If there
1924 is an error, returns the error, otherwise returns false.
1928 sub increment_totalbytes {
1929 shift->_op_usage('+', 'totalbytes', @_);
1932 =item decrement_seconds SECONDS
1934 Decrements the I<seconds> field of this record by the given amount. If there
1935 is an error, returns the error, otherwise returns false.
1939 sub decrement_seconds {
1940 shift->_op_usage('-', 'seconds', @_);
1943 =item increment_seconds SECONDS
1945 Increments the I<seconds> field of this record by the given amount. If there
1946 is an error, returns the error, otherwise returns false.
1950 sub increment_seconds {
1951 shift->_op_usage('+', 'seconds', @_);
1959 my %op2condition = (
1960 '-' => sub { my($self, $column, $amount) = @_;
1961 $self->$column - $amount <= 0;
1963 '+' => sub { my($self, $column, $amount) = @_;
1964 ($self->$column || 0) + $amount > 0;
1967 my %op2warncondition = (
1968 '-' => sub { my($self, $column, $amount) = @_;
1969 my $threshold = $column . '_threshold';
1970 $self->$column - $amount <= $self->$threshold + 0;
1972 '+' => sub { my($self, $column, $amount) = @_;
1973 ($self->$column || 0) + $amount > 0;
1978 my( $self, $op, $column, $amount ) = @_;
1980 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
1981 ' ('. $self->email. "): $op $amount\n"
1984 return '' unless $amount;
1986 local $SIG{HUP} = 'IGNORE';
1987 local $SIG{INT} = 'IGNORE';
1988 local $SIG{QUIT} = 'IGNORE';
1989 local $SIG{TERM} = 'IGNORE';
1990 local $SIG{TSTP} = 'IGNORE';
1991 local $SIG{PIPE} = 'IGNORE';
1993 my $oldAutoCommit = $FS::UID::AutoCommit;
1994 local $FS::UID::AutoCommit = 0;
1997 my $sql = "UPDATE svc_acct SET $column = ".
1998 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
1999 " $op ? WHERE svcnum = ?";
2003 my $sth = $dbh->prepare( $sql )
2004 or die "Error preparing $sql: ". $dbh->errstr;
2005 my $rv = $sth->execute($amount, $self->svcnum);
2006 die "Error executing $sql: ". $sth->errstr
2007 unless defined($rv);
2008 die "Can't update $column for svcnum". $self->svcnum
2011 #$self->snapshot; #not necessary, we retain the old values
2012 #create an object with the updated usage values
2013 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2015 my $error = $new->replace($self);
2017 $dbh->rollback if $oldAutoCommit;
2018 return "Error replacing: $error";
2021 #overlimit_action eq 'cancel' handling
2022 my $cust_pkg = $self->cust_svc->cust_pkg;
2024 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2025 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2029 my $error = $cust_pkg->cancel; #XXX should have a reason
2031 $dbh->rollback if $oldAutoCommit;
2032 return "Error cancelling: $error";
2035 #nothing else is relevant if we're cancelling, so commit & return success
2036 warn "$me update successful; committing\n"
2038 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2043 my $action = $op2action{$op};
2045 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2046 ( $action eq 'suspend' && !$self->overlimit
2047 || $action eq 'unsuspend' && $self->overlimit )
2050 my $error = $self->_op_overlimit($action);
2052 $dbh->rollback if $oldAutoCommit;
2058 if ( $conf->exists("svc_acct-usage_$action")
2059 && &{$op2condition{$op}}($self, $column, $amount) ) {
2060 #my $error = $self->$action();
2061 my $error = $self->cust_svc->cust_pkg->$action();
2062 # $error ||= $self->overlimit($action);
2064 $dbh->rollback if $oldAutoCommit;
2065 return "Error ${action}ing: $error";
2069 if ($warning_msgnum && &{$op2warncondition{$op}}($self, $column, $amount)) {
2070 my $wqueue = new FS::queue {
2071 'svcnum' => $self->svcnum,
2072 'job' => 'FS::svc_acct::reached_threshold',
2076 my $error = $wqueue->insert(
2077 'svcnum' => $self->svcnum,
2082 $dbh->rollback if $oldAutoCommit;
2083 return "Error queuing threshold activity: $error";
2087 warn "$me update successful; committing\n"
2089 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2095 my( $self, $action ) = @_;
2097 local $SIG{HUP} = 'IGNORE';
2098 local $SIG{INT} = 'IGNORE';
2099 local $SIG{QUIT} = 'IGNORE';
2100 local $SIG{TERM} = 'IGNORE';
2101 local $SIG{TSTP} = 'IGNORE';
2102 local $SIG{PIPE} = 'IGNORE';
2104 my $oldAutoCommit = $FS::UID::AutoCommit;
2105 local $FS::UID::AutoCommit = 0;
2108 my $cust_pkg = $self->cust_svc->cust_pkg;
2110 my @conf_overlimit =
2112 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2113 : $conf->config('overlimit_groups');
2115 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2117 my @groups = scalar(@conf_overlimit) ? @conf_overlimit
2118 : split(' ',$part_export->option('overlimit_groups'));
2119 next unless scalar(@groups);
2121 my $other = new FS::svc_acct $self->hashref;
2122 $other->usergroup(\@groups);
2125 if ($action eq 'suspend') {
2128 } else { # $action eq 'unsuspend'
2133 my $error = $part_export->export_replace($new, $old)
2134 || $self->overlimit($action);
2137 $dbh->rollback if $oldAutoCommit;
2138 return "Error replacing radius groups: $error";
2143 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2149 my( $self, $valueref, %options ) = @_;
2151 warn "$me set_usage called for svcnum ". $self->svcnum.
2152 ' ('. $self->email. "): ".
2153 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2156 local $SIG{HUP} = 'IGNORE';
2157 local $SIG{INT} = 'IGNORE';
2158 local $SIG{QUIT} = 'IGNORE';
2159 local $SIG{TERM} = 'IGNORE';
2160 local $SIG{TSTP} = 'IGNORE';
2161 local $SIG{PIPE} = 'IGNORE';
2163 local $FS::svc_Common::noexport_hack = 1;
2164 my $oldAutoCommit = $FS::UID::AutoCommit;
2165 local $FS::UID::AutoCommit = 0;
2170 if ( $options{null} ) {
2171 %handyhash = ( map { ( $_ => undef, $_."_threshold" => undef ) }
2172 qw( seconds upbytes downbytes totalbytes )
2175 foreach my $field (keys %$valueref){
2176 $reset = 1 if $valueref->{$field};
2177 $self->setfield($field, $valueref->{$field});
2178 $self->setfield( $field.'_threshold',
2179 int($self->getfield($field)
2180 * ( $conf->exists('svc_acct-usage_threshold')
2181 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2186 $handyhash{$field} = $self->getfield($field);
2187 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2189 #my $error = $self->replace; #NO! we avoid the call to ->check for
2190 #die $error if $error; #services not explicity changed via the UI
2192 my $sql = "UPDATE svc_acct SET " .
2193 join (',', map { "$_ = ?" } (keys %handyhash) ).
2194 " WHERE svcnum = ". $self->svcnum;
2199 if (scalar(keys %handyhash)) {
2200 my $sth = $dbh->prepare( $sql )
2201 or die "Error preparing $sql: ". $dbh->errstr;
2202 my $rv = $sth->execute(values %handyhash);
2203 die "Error executing $sql: ". $sth->errstr
2204 unless defined($rv);
2205 die "Can't update usage for svcnum ". $self->svcnum
2209 #$self->snapshot; #not necessary, we retain the old values
2210 #create an object with the updated usage values
2211 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2212 local($FS::Record::nowarn_identical) = 1;
2213 my $error = $new->replace($self); #call exports
2215 $dbh->rollback if $oldAutoCommit;
2216 return "Error replacing: $error";
2223 $error = $self->_op_overlimit('unsuspend')
2224 if $self->overlimit;;
2226 $error ||= $self->cust_svc->cust_pkg->unsuspend
2227 if $conf->exists("svc_acct-usage_unsuspend");
2230 $dbh->rollback if $oldAutoCommit;
2231 return "Error unsuspending: $error";
2236 warn "$me update successful; committing\n"
2238 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2244 =item recharge HASHREF
2246 Increments usage columns by the amount specified in HASHREF as
2247 column=>amount pairs.
2252 my ($self, $vhash) = @_;
2255 warn "[$me] recharge called on $self: ". Dumper($self).
2256 "\nwith vhash: ". Dumper($vhash);
2259 my $oldAutoCommit = $FS::UID::AutoCommit;
2260 local $FS::UID::AutoCommit = 0;
2264 foreach my $column (keys %$vhash){
2265 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2269 $dbh->rollback if $oldAutoCommit;
2271 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2276 =item is_rechargeable
2278 Returns true if this svc_account can be "recharged" and false otherwise.
2282 sub is_rechargable {
2284 $self->seconds ne ''
2285 || $self->upbytes ne ''
2286 || $self->downbytes ne ''
2287 || $self->totalbytes ne '';
2290 =item seconds_since TIMESTAMP
2292 Returns the number of seconds this account has been online since TIMESTAMP,
2293 according to the session monitor (see L<FS::Session>).
2295 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2296 L<Time::Local> and L<Date::Parse> for conversion functions.
2300 #note: POD here, implementation in FS::cust_svc
2303 $self->cust_svc->seconds_since(@_);
2306 =item last_login_text
2308 Returns text describing the time of last login.
2312 sub last_login_text {
2314 $self->last_login ? ctime($self->last_login) : 'unknown';
2317 =item psearch_cdrs OPTIONS
2319 Returns a paged search (L<FS::PagedSearch>) for Call Detail Records
2320 associated with this service. For svc_acct, "associated with" means that
2321 either the "src" or the "charged_party" field of the CDR matches either
2322 the "username" field of the service or the username@domain label.
2327 my($self, %options) = @_;
2332 my $did = dbh->quote($self->username);
2333 my $diddomain = dbh->quote($self->label);
2335 my $prefix = $options{'default_prefix'} || ''; #convergent.au '+61'
2336 my $prefixdid = dbh->quote($prefix . $self->username);
2338 my $for_update = $options{'for_update'} ? 'FOR UPDATE' : '';
2340 if ( $options{inbound} ) {
2341 # these will be selected under their DIDs
2342 push @where, "FALSE";
2346 if (!$options{'disable_charged_party'}) {
2348 "charged_party = $did",
2349 "charged_party = $prefixdid",
2350 "charged_party = $diddomain"
2353 if (!$options{'disable_src'}) {
2355 "src = $did AND charged_party IS NULL",
2356 "src = $prefixdid AND charged_party IS NULL",
2357 "src = $diddomain AND charged_party IS NULL"
2360 push @where, '(' . join(' OR ', @orwhere) . ')';
2362 # $options{'status'} = '' is meaningful; for the rest of them it's not
2363 if ( exists $options{'status'} ) {
2364 $hash{'freesidestatus'} = $options{'status'};
2366 if ( $options{'cdrtypenum'} ) {
2367 $hash{'cdrtypenum'} = $options{'cdrtypenum'};
2369 if ( $options{'calltypenum'} ) {
2370 $hash{'calltypenum'} = $options{'calltypenum'};
2372 if ( $options{'begin'} ) {
2373 push @where, 'startdate >= '. $options{'begin'};
2375 if ( $options{'end'} ) {
2376 push @where, 'startdate < '. $options{'end'};
2378 if ( $options{'nonzero'} ) {
2379 push @where, 'duration > 0';
2382 my $extra_sql = join(' AND ', @where);
2385 $extra_sql = " AND ".$extra_sql;
2387 $extra_sql = " WHERE ".$extra_sql;
2393 'hashref' => \%hash,
2394 'extra_sql' => $extra_sql,
2395 'order_by' => "ORDER BY startdate $for_update",
2399 =item get_cdrs (DEPRECATED)
2401 Like psearch_cdrs, but returns all the L<FS::cdr> objects at once, in a
2402 single list. Arguments are the same as for psearch_cdrs.
2408 my $psearch = $self->psearch_cdrs(@_);
2409 qsearch ( $psearch->{query} )
2412 # sub radius_groups has moved to svc_Radius_Mixin
2414 =item clone_suspended
2416 Constructor used by FS::part_export::_export_suspend fallback. Document
2421 sub clone_suspended {
2423 my %hash = $self->hash;
2424 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2425 new FS::svc_acct \%hash;
2428 =item clone_kludge_unsuspend
2430 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2435 sub clone_kludge_unsuspend {
2437 my %hash = $self->hash;
2438 $hash{_password} = '';
2439 new FS::svc_acct \%hash;
2442 =item check_password
2444 Checks the supplied password against the (possibly encrypted) password in the
2445 database. Returns true for a successful authentication, false for no match.
2447 Currently supported encryptions are: classic DES crypt() and MD5
2451 sub check_password {
2452 my($self, $check_password) = @_;
2454 #remove old-style SUSPENDED kludge, they should be allowed to login to
2455 #self-service and pay up
2456 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2458 if ( $self->_password_encoding eq 'ldap' ) {
2460 $password =~ s/^{PLAIN}/{CLEARTEXT}/;
2461 my $auth = from_rfc2307 Authen::Passphrase $password;
2462 return $auth->match($check_password);
2464 } elsif ( $self->_password_encoding eq 'crypt' ) {
2466 my $auth = from_crypt Authen::Passphrase $self->_password;
2467 return $auth->match($check_password);
2469 } elsif ( $self->_password_encoding eq 'plain' ) {
2471 return $check_password eq $password;
2475 #XXX this could be replaced with Authen::Passphrase stuff
2477 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2479 } elsif ( length($password) < 13 ) { #plaintext
2480 $check_password eq $password;
2481 } elsif ( length($password) == 13 ) { #traditional DES crypt
2482 crypt($check_password, $password) eq $password;
2483 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2484 unix_md5_crypt($check_password, $password) eq $password;
2485 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2486 warn "Can't check password: Blowfish encryption not yet supported, ".
2487 "svcnum ". $self->svcnum. "\n";
2490 warn "Can't check password: Unrecognized encryption for svcnum ".
2491 $self->svcnum. "\n";
2499 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2501 Returns an encrypted password, either by passing through an encrypted password
2502 in the database or by encrypting a plaintext password from the database.
2504 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2505 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2506 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2507 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2508 encryption type is only used if the password is not already encrypted in the
2513 sub crypt_password {
2516 if ( $self->_password_encoding eq 'ldap' ) {
2518 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2521 #XXX this could be replaced with Authen::Passphrase stuff
2523 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2524 if ( $encryption eq 'crypt' ) {
2527 $saltset[int(rand(64))].$saltset[int(rand(64))]
2529 } elsif ( $encryption eq 'md5' ) {
2530 return unix_md5_crypt( $self->_password );
2531 } elsif ( $encryption eq 'blowfish' ) {
2532 croak "unknown encryption method $encryption";
2534 croak "unknown encryption method $encryption";
2537 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2541 } elsif ( $self->_password_encoding eq 'crypt' ) {
2543 return $self->_password;
2545 } elsif ( $self->_password_encoding eq 'plain' ) {
2547 #XXX this could be replaced with Authen::Passphrase stuff
2549 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2550 if ( $encryption eq 'crypt' ) {
2553 $saltset[int(rand(64))].$saltset[int(rand(64))]
2555 } elsif ( $encryption eq 'md5' ) {
2556 return unix_md5_crypt( $self->_password );
2557 } elsif ( $encryption eq 'sha1_base64' ) { #for acct_sql
2558 my $pass = sha1_base64( $self->_password );
2559 $pass .= '=' x (4 - length($pass) % 4); #properly padded base64
2561 } elsif ( $encryption eq 'blowfish' ) {
2562 croak "unknown encryption method $encryption";
2564 croak "unknown encryption method $encryption";
2569 if ( length($self->_password) == 13
2570 || $self->_password =~ /^\$(1|2a?)\$/
2571 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2577 #XXX this could be replaced with Authen::Passphrase stuff
2579 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2580 if ( $encryption eq 'crypt' ) {
2583 $saltset[int(rand(64))].$saltset[int(rand(64))]
2585 } elsif ( $encryption eq 'md5' ) {
2586 return unix_md5_crypt( $self->_password );
2587 } elsif ( $encryption eq 'blowfish' ) {
2588 croak "unknown encryption method $encryption";
2590 croak "unknown encryption method $encryption";
2599 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2601 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2602 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2603 "{MD5}5426824942db4253f87a1009fd5d2d4".
2605 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2606 to work the same as the B</crypt_password> method.
2612 #eventually should check a "password-encoding" field
2614 if ( $self->_password_encoding eq 'ldap' ) {
2616 return $self->_password;
2618 } elsif ( $self->_password_encoding eq 'crypt' ) {
2620 if ( length($self->_password) == 13 ) { #crypt
2621 return '{CRYPT}'. $self->_password;
2622 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2624 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2625 # die "Blowfish encryption not supported in this context, svcnum ".
2626 # $self->svcnum. "\n";
2628 warn "encryption method not (yet?) supported in LDAP context";
2629 return '{CRYPT}*'; #unsupported, should not auth
2632 } elsif ( $self->_password_encoding eq 'plain' ) {
2634 return '{PLAIN}'. $self->_password;
2636 #return '{CLEARTEXT}'. $self->_password; #?
2640 if ( length($self->_password) == 13 ) { #crypt
2641 return '{CRYPT}'. $self->_password;
2642 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2644 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2645 warn "Blowfish encryption not supported in this context, svcnum ".
2646 $self->svcnum. "\n";
2649 #are these two necessary anymore?
2650 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2651 return '{SSHA}'. $1;
2652 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2653 return '{NS-MTA-MD5}'. $1;
2656 return '{PLAIN}'. $self->_password;
2658 #return '{CLEARTEXT}'. $self->_password; #?
2660 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2661 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2662 #if ( $encryption eq 'crypt' ) {
2663 # return '{CRYPT}'. crypt(
2665 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2667 #} elsif ( $encryption eq 'md5' ) {
2668 # unix_md5_crypt( $self->_password );
2669 #} elsif ( $encryption eq 'blowfish' ) {
2670 # croak "unknown encryption method $encryption";
2672 # croak "unknown encryption method $encryption";
2680 =item domain_slash_username
2682 Returns $domain/$username/
2686 sub domain_slash_username {
2688 $self->domain. '/'. $self->username. '/';
2691 =item virtual_maildir
2693 Returns $domain/maildirs/$username/
2697 sub virtual_maildir {
2699 $self->domain. '/maildirs/'. $self->username. '/';
2702 =item password_svc_check
2704 Override, for L<FS::Password_Mixin>. Not really intended for other use.
2708 sub password_svc_check {
2709 my ($self, $password) = @_;
2710 foreach my $field ( qw(username finger) ) {
2711 foreach my $word (split(/\W+/,$self->get($field))) {
2712 next unless length($word) > 2;
2713 if ($password =~ /$word/i) {
2714 return qq(Password contains account information '$word');
2723 =head1 CLASS METHODS
2727 =item search HASHREF
2729 Class method which returns a qsearch hash expression to search for parameters
2730 specified in HASHREF. Valid parameters are
2744 Arrayref of pkgparts
2750 Arrayref of additional WHERE clauses, will be ANDed together.
2761 my( $class, $params, $from, $where ) = @_;
2763 #these two should probably move to svc_Domain_Mixin ?
2766 if ( $params->{'domain'} ) {
2767 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2768 #preserve previous behavior & bubble up an error if $svc_domain not found?
2769 push @$where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2773 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2774 push @$where, "domsvc = $1";
2779 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2780 push @$where, "popnum = $1";
2784 #and these in svc_Tower_Mixin, or maybe we never should have done svc_acct
2785 # towers (or, as mark thought, never should have done svc_broadband)
2788 my @where_sector = $class->tower_sector_sql($params);
2789 if ( @where_sector ) {
2790 push @$where, @where_sector;
2791 push @$from, ' LEFT JOIN tower_sector USING ( sectornum )';
2802 =item check_and_rebuild_fuzzyfiles
2806 sub check_and_rebuild_fuzzyfiles {
2807 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2808 -e "$dir/svc_acct.username"
2809 or &rebuild_fuzzyfiles;
2812 =item rebuild_fuzzyfiles
2816 sub rebuild_fuzzyfiles {
2818 use Fcntl qw(:flock);
2820 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2824 open(USERNAMELOCK,">>$dir/svc_acct.username")
2825 or die "can't open $dir/svc_acct.username: $!";
2826 flock(USERNAMELOCK,LOCK_EX)
2827 or die "can't lock $dir/svc_acct.username: $!";
2829 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2831 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2832 or die "can't open $dir/svc_acct.username.tmp: $!";
2833 print USERNAMECACHE join("\n", @all_username), "\n";
2834 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2836 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2846 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2847 open(USERNAMECACHE,"<$dir/svc_acct.username")
2848 or die "can't open $dir/svc_acct.username: $!";
2849 my @array = map { chomp; $_; } <USERNAMECACHE>;
2850 close USERNAMECACHE;
2854 =item append_fuzzyfiles USERNAME
2858 sub append_fuzzyfiles {
2859 my $username = shift;
2861 &check_and_rebuild_fuzzyfiles;
2863 use Fcntl qw(:flock);
2865 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2867 open(USERNAME,">>$dir/svc_acct.username")
2868 or die "can't open $dir/svc_acct.username: $!";
2869 flock(USERNAME,LOCK_EX)
2870 or die "can't lock $dir/svc_acct.username: $!";
2872 print USERNAME "$username\n";
2874 flock(USERNAME,LOCK_UN)
2875 or die "can't unlock $dir/svc_acct.username: $!";
2882 =item reached_threshold
2884 Performs some activities when svc_acct thresholds (such as number of seconds
2885 remaining) are reached.
2889 sub reached_threshold {
2892 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
2893 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
2895 if ( $opt{'op'} eq '+' ){
2896 $svc_acct->setfield( $opt{'column'}.'_threshold',
2897 int($svc_acct->getfield($opt{'column'})
2898 * ( $conf->exists('svc_acct-usage_threshold')
2899 ? $conf->config('svc_acct-usage_threshold')/100
2904 my $error = $svc_acct->replace;
2905 die $error if $error;
2906 }elsif ( $opt{'op'} eq '-' ){
2908 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
2909 return '' if ($threshold eq '' );
2911 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
2912 my $error = $svc_acct->replace;
2913 die $error if $error; # email next time, i guess
2915 if ( $warning_msgnum ) {
2917 my $msg_template = qsearchs('msg_template',{ msgnum => $warning_msgnum });
2918 die "Could not load template for threshold_warning_msgnum ($warning_msgnum)" unless $msg_template;
2920 my $cust_main = $svc_acct->cust_svc->cust_pkg->cust_main;
2922 my $to = join(', ', $cust_main->invoicing_list_emailonly );
2924 my $error = $msg_template->send(
2925 cust_main => $cust_main,
2926 object => $svc_acct,
2929 # have to override these, because we changed threshold above
2930 'column' => $opt{'column'},
2931 'amount' => $opt{'column'} =~/bytes/
2932 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
2933 : $svc_acct->getfield($opt{'column'}),
2934 'threshold' => $opt{'column'} =~/bytes/
2935 ? FS::UI::bytecount::display_bytecount($threshold)
2940 die "Error sending threshold warning email: $error" if $error;
2944 die "unknown op: " . $opt{'op'};
2952 The $recref stuff in sub check should be cleaned up.
2954 The suspend, unsuspend and cancel methods update the database, but not the
2955 current object. This is probably a bug as it's unexpected and
2958 insertion of RADIUS group stuff in insert could be done with child_objects now
2959 (would probably clean up export of them too)
2961 _op_usage and set_usage bypass the history... maybe they shouldn't
2965 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
2966 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
2967 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
2968 L<freeside-queued>), L<FS::svc_acct_pop>,
2969 schema.html from the base documentation.