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');
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)',
320 select_table => 'svc_domain',
321 select_key => 'svcnum',
322 select_label => 'domain',
323 disable_inventory => 1,
326 'pbxsvc' => { label => 'PBX',
327 type => 'select-svc_pbx.html',
328 disable_inventory => 1,
329 disable_select => 1, #UI wonky, pry works otherwise
331 'sectornum' => 'Tower sector',
332 'routernum' => 'Router/block',
334 'label' => 'Address block',
336 'select_table' => 'addr_block',
337 'select_key' => 'blocknum',
338 'select_label' => 'cidr',
339 'disable_inventory' => 1,
342 label => 'RADIUS groups',
343 type => 'select-radius_group.html',
344 disable_inventory => 1,
348 'seconds' => { label => 'Seconds',
349 label_sort => 'with Time Remaining',
351 disable_inventory => 1,
353 #disable_part_svc_column => 1,
355 'upbytes' => { label => 'Upload',
357 disable_inventory => 1,
359 'format' => \&FS::UI::bytecount::display_bytecount,
360 'parse' => \&FS::UI::bytecount::parse_bytecount,
361 disable_part_svc_column => 1,
363 'downbytes' => { label => 'Download',
365 disable_inventory => 1,
367 'format' => \&FS::UI::bytecount::display_bytecount,
368 'parse' => \&FS::UI::bytecount::parse_bytecount,
369 disable_part_svc_column => 1,
371 'totalbytes'=> { label => 'Total up and download',
373 disable_inventory => 1,
375 'format' => \&FS::UI::bytecount::display_bytecount,
376 'parse' => \&FS::UI::bytecount::parse_bytecount,
377 disable_part_svc_column => 1,
379 'seconds_threshold' => { label => 'Seconds threshold',
381 disable_inventory => 1,
383 disable_part_svc_column => 1,
385 'upbytes_threshold' => { label => 'Upload threshold',
387 disable_inventory => 1,
389 'format' => \&FS::UI::bytecount::display_bytecount,
390 'parse' => \&FS::UI::bytecount::parse_bytecount,
391 disable_part_svc_column => 1,
393 'downbytes_threshold' => { label => 'Download threshold',
395 disable_inventory => 1,
397 'format' => \&FS::UI::bytecount::display_bytecount,
398 'parse' => \&FS::UI::bytecount::parse_bytecount,
399 disable_part_svc_column => 1,
401 'totalbytes_threshold'=> { label => 'Total up and download threshold',
403 disable_inventory => 1,
405 'format' => \&FS::UI::bytecount::display_bytecount,
406 'parse' => \&FS::UI::bytecount::parse_bytecount,
407 disable_part_svc_column => 1,
410 label => 'Last login',
414 label => 'Last logout',
419 label => 'Communigate aliases',
421 disable_inventory => 1,
426 label => 'Communigate account type',
428 select_list => [qw( MultiMailbox TextMailbox MailDirMailbox AGrade BGrade CGrade )],
429 disable_inventory => 1,
432 'cgp_accessmodes' => {
433 label => 'Communigate enabled services',
434 type => 'communigate_pro-accessmodes',
435 disable_inventory => 1,
438 'cgp_rulesallowed' => {
439 label => 'Allowed mail rules',
441 select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ],
442 disable_inventory => 1,
445 'cgp_rpopallowed' => { label => 'RPOP modifications',
448 'cgp_mailtoall' => { label => 'Accepts mail to "all"',
451 'cgp_addmailtrailer' => { label => 'Add trailer to sent mail',
454 'cgp_archiveafter' => {
455 label => 'Archive messages after',
458 -2 => 'default(730 days)',
465 1209600 => '2 weeks',
466 2592000 => '30 days',
467 7776000 => '90 days',
468 15552000 => '180 days',
469 31536000 => '365 days',
470 63072000 => '730 days',
472 disable_inventory => 1,
478 'cgp_deletemode' => {
479 label => 'Communigate message delete method',
481 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
482 disable_inventory => 1,
485 'cgp_emptytrash' => {
486 label => 'Communigate on logout remove trash',
488 select_list => __PACKAGE__->cgp_emptytrash_values,
489 disable_inventory => 1,
493 label => 'Communigate language',
495 select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ],
496 disable_inventory => 1,
500 label => 'Communigate time zone',
502 select_list => __PACKAGE__->cgp_timezone_values,
503 disable_inventory => 1,
507 label => 'Communigate layout',
509 select_list => [ '', '***', 'GoldFleece', 'Skin2' ],
510 disable_inventory => 1,
513 'cgp_prontoskinname' => {
514 label => 'Communigate Pronto style',
516 select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ],
517 disable_inventory => 1,
520 'cgp_sendmdnmode' => {
521 label => 'Communigate send read receipts',
523 select_list => [ '', 'Never', 'Manually', 'Automatically' ],
524 disable_inventory => 1,
535 sub table { 'svc_acct'; }
537 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
540 shift->_lastlog('in', @_);
544 shift->_lastlog('out', @_);
548 my( $self, $op, $time ) = @_;
550 if ( defined($time) ) {
551 warn "$me last_log$op called on svcnum ". $self->svcnum.
552 ' ('. $self->email. "): $time\n"
557 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
561 my $sth = $dbh->prepare( $sql )
562 or die "Error preparing $sql: ". $dbh->errstr;
563 my $rv = $sth->execute($time, $self->svcnum);
564 die "Error executing $sql: ". $sth->errstr
566 die "Can't update last_log$op for svcnum". $self->svcnum
569 $self->{'Hash'}->{"last_log$op"} = $time;
571 $self->getfield("last_log$op");
575 =item search_sql STRING
577 Class method which returns an SQL fragment to search for the given string.
582 my( $class, $string ) = @_;
583 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
584 my( $username, $domain ) = ( $1, $2 );
585 my $q_username = dbh->quote($username);
586 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
588 "svc_acct.username = $q_username AND ( ".
589 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
594 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
596 $class->search_sql_field('slipip', $string ).
598 $class->search_sql_field('username', $string ).
601 $class->search_sql_field('username', $string);
605 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
607 Returns the "username@domain" string for this account.
609 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
619 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
621 Returns a longer string label for this acccount ("Real Name <username@domain>"
622 if available, or "username@domain").
624 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
631 my $label = $self->label(@_);
632 my $finger = $self->finger;
633 return $label unless $finger =~ /\S/;
634 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
635 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
639 =item insert [ , OPTION => VALUE ... ]
641 Adds this account to the database. If there is an error, returns the error,
642 otherwise returns false.
644 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
645 defined. An FS::cust_svc record will be created and inserted.
647 The additional field I<usergroup> can optionally be defined; if so it should
648 contain an arrayref of group names. See L<FS::radius_usergroup>.
650 The additional field I<child_objects> can optionally be defined; if so it
651 should contain an arrayref of FS::tablename objects. They will have their
652 svcnum fields set and will be inserted after this record, but before any
653 exports are run. Each element of the array can also optionally be a
654 two-element array reference containing the child object and the name of an
655 alternate field to be filled in with the newly-inserted svcnum, for example
656 C<[ $svc_forward, 'srcsvc' ]>
658 Currently available options are: I<depend_jobnum>
660 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
661 jobnums), all provisioning jobs will have a dependancy on the supplied
662 jobnum(s) (they will not run until the specific job(s) complete(s)).
664 (TODOC: L<FS::queue> and L<freeside-queued>)
666 (TODOC: new exports!)
675 warn "[$me] insert called on $self: ". Dumper($self).
676 "\nwith options: ". Dumper(%options);
679 local $SIG{HUP} = 'IGNORE';
680 local $SIG{INT} = 'IGNORE';
681 local $SIG{QUIT} = 'IGNORE';
682 local $SIG{TERM} = 'IGNORE';
683 local $SIG{TSTP} = 'IGNORE';
684 local $SIG{PIPE} = 'IGNORE';
686 my $oldAutoCommit = $FS::UID::AutoCommit;
687 local $FS::UID::AutoCommit = 0;
691 my $error = $self->SUPER::insert( # usergroup is here
692 'jobnums' => \@jobnums,
693 'child_objects' => $self->child_objects,
697 $error ||= $self->insert_password_history;
700 $dbh->rollback if $oldAutoCommit;
704 unless ( $skip_fuzzyfiles ) {
705 $error = $self->queue_fuzzyfiles_update;
707 $dbh->rollback if $oldAutoCommit;
708 return "updating fuzzy search cache: $error";
712 my $cust_pkg = $self->cust_svc->cust_pkg;
715 my $cust_main = $cust_pkg->cust_main;
716 my $agentnum = $cust_main->agentnum;
718 if ( $conf->exists('emailinvoiceautoalways')
719 || $conf->exists('emailinvoiceauto')
720 && ! $cust_main->invoicing_list_emailonly
723 # slight false laziness w/ edit/process/cust_main.cgi...
724 # and also slightly arbitrary behavior.
726 # this will never happen but check it anyway
727 my ($contact) = map { $_->contact }
728 qsearch('contact_email', { emailaddress => $self->email });
731 # if the "real name" of this account matches the first + last name
732 # of a contact, attach the email address to that person.
733 my @contacts = map { $_->contact } $cust_main->cust_contact;
734 my $myname = $self->get('finger');
736 grep { $_->get('first') . ' ' . $_->get('last') eq $myname } @contacts;
737 # otherwise just pick the first one
738 $contact = $contacts[0];
741 $contact ||= FS::contact->new({
742 'custnum' => $cust_main->get('custnum'),
743 'locationnum' => $cust_main->get('bill_locationnum'),
744 'last' => $cust_main->get('last'),
745 'first' => $cust_main->get('first'),
747 $contact->set('emailaddress', $self->email);
748 $contact->set('invoice_dest', 'Y');
750 if ( $contact->get('contactnum') ) {
751 $error = $contact->replace;
753 $error = $contact->insert;
757 $dbh->rollback if $oldAutoCommit;
758 return "creating invoice destination contact: $error";
764 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
768 # set usage fields and thresholds if unset but set in a package def
769 # AND the package already has a last bill date (otherwise they get double added)
770 sub preinsert_hook_first {
773 return '' unless $self->pkgnum;
775 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
776 return '' unless $cust_pkg && $cust_pkg->last_bill;
778 my $part_pkg = $cust_pkg->part_pkg;
779 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
781 my %values = $part_pkg->usage_valuehash;
782 my $multiplier = $conf->exists('svc_acct-usage_threshold')
783 ? 1 - $conf->config('svc_acct-usage_threshold')/100
784 : 0.20; #doesn't matter
786 foreach ( keys %values ) {
787 next if $self->getfield($_);
788 $self->setfield( $_, $values{$_} );
789 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
790 if $conf->exists('svc_acct-usage_threshold');
798 Deletes this account from the database. If there is an error, returns the
799 error, otherwise returns false.
801 The corresponding FS::cust_svc record will be deleted as well.
803 (TODOC: new exports!)
810 return "can't delete system account" if $self->_check_system;
812 return "Can't delete an account which is a (svc_forward) source!"
813 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
815 return "Can't delete an account which is a (svc_forward) destination!"
816 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
818 return "Can't delete an account with (svc_www) web service!"
819 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
821 # what about records in session ? (they should refer to history table)
823 local $SIG{HUP} = 'IGNORE';
824 local $SIG{INT} = 'IGNORE';
825 local $SIG{QUIT} = 'IGNORE';
826 local $SIG{TERM} = 'IGNORE';
827 local $SIG{TSTP} = 'IGNORE';
828 local $SIG{PIPE} = 'IGNORE';
830 my $oldAutoCommit = $FS::UID::AutoCommit;
831 local $FS::UID::AutoCommit = 0;
834 foreach my $svc_domain (
835 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
837 my %hash = new FS::svc_domain->hash;
838 $hash{'catchall'} = '';
839 my $new = new FS::svc_domain \%hash;
840 my $error = $new->replace($svc_domain);
842 $dbh->rollback if $oldAutoCommit;
847 foreach my $svc_phone (
848 qsearch( 'svc_phone', { 'forward_svcnum' => $self->svcnum })
850 $svc_phone->set('forward_svcnum', '');
851 my $error = $svc_phone->replace;
853 $dbh->rollback if $oldAutoCommit;
858 my $error = $self->delete_password_history
859 || $self->SUPER::delete; # usergroup here
861 $dbh->rollback if $oldAutoCommit;
865 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
869 =item replace OLD_RECORD
871 Replaces OLD_RECORD with this one in the database. If there is an error,
872 returns the error, otherwise returns false.
874 The additional field I<usergroup> can optionally be defined; if so it should
875 contain an arrayref of group names. See L<FS::radius_usergroup>.
883 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
887 warn "$me replacing $old with $new\n" if $DEBUG;
891 return "can't modify system account" if $old->_check_system;
894 #no warnings 'numeric'; #alas, a 5.006-ism
897 foreach my $xid (qw( uid gid )) {
899 return "Can't change $xid!"
900 if ! $conf->exists("svc_acct-edit_$xid")
901 && $old->$xid() != $new->$xid()
902 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
907 return "can't change username"
908 if $old->username ne $new->username
909 && $conf->exists('svc_acct-no_edit_username');
911 #change homdir when we change username
912 $new->setfield('dir', '') if $old->username ne $new->username;
914 local $SIG{HUP} = 'IGNORE';
915 local $SIG{INT} = 'IGNORE';
916 local $SIG{QUIT} = 'IGNORE';
917 local $SIG{TERM} = 'IGNORE';
918 local $SIG{TSTP} = 'IGNORE';
919 local $SIG{PIPE} = 'IGNORE';
921 my $oldAutoCommit = $FS::UID::AutoCommit;
922 local $FS::UID::AutoCommit = 0;
925 $error = $new->SUPER::replace($old, @_); # usergroup here
927 # don't need to record this unless the password was changed
928 if ( $old->_password ne $new->_password ) {
929 $error ||= $new->insert_password_history;
933 $dbh->rollback if $oldAutoCommit;
934 return $error if $error;
937 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
938 $error = $new->queue_fuzzyfiles_update;
940 $dbh->rollback if $oldAutoCommit;
941 return "updating fuzzy search cache: $error";
945 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
949 =item queue_fuzzyfiles_update
951 Used by insert & replace to update the fuzzy search cache
955 sub queue_fuzzyfiles_update {
958 local $SIG{HUP} = 'IGNORE';
959 local $SIG{INT} = 'IGNORE';
960 local $SIG{QUIT} = 'IGNORE';
961 local $SIG{TERM} = 'IGNORE';
962 local $SIG{TSTP} = 'IGNORE';
963 local $SIG{PIPE} = 'IGNORE';
965 my $oldAutoCommit = $FS::UID::AutoCommit;
966 local $FS::UID::AutoCommit = 0;
969 my $queue = new FS::queue {
970 'svcnum' => $self->svcnum,
971 'job' => 'FS::svc_acct::append_fuzzyfiles'
973 my $error = $queue->insert($self->username);
975 $dbh->rollback if $oldAutoCommit;
976 return "queueing job (transaction rolled back): $error";
979 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
987 Suspends this account by calling export-specific suspend hooks. If there is
988 an error, returns the error, otherwise returns false.
990 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
996 return "can't suspend system account" if $self->_check_system;
997 $self->SUPER::suspend(@_);
1002 Unsuspends this account by by calling export-specific suspend hooks. If there
1003 is an error, returns the error, otherwise returns false.
1005 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1011 my %hash = $self->hash;
1012 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1013 $hash{_password} = $1;
1014 my $new = new FS::svc_acct ( \%hash );
1015 my $error = $new->replace($self);
1016 return $error if $error;
1019 $self->SUPER::unsuspend(@_);
1024 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1026 If the B<auto_unset_catchall> configuration option is set, this method will
1027 automatically remove any references to the canceled service in the catchall
1028 field of svc_domain. This allows packages that contain both a svc_domain and
1029 its catchall svc_acct to be canceled in one step.
1034 # Only one thing to do at this level
1036 foreach my $svc_domain (
1037 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1038 if($conf->exists('auto_unset_catchall')) {
1039 my %hash = $svc_domain->hash;
1040 $hash{catchall} = '';
1041 my $new = new FS::svc_domain ( \%hash );
1042 my $error = $new->replace($svc_domain);
1043 return $error if $error;
1045 return "cannot unprovision svc_acct #".$self->svcnum.
1046 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1050 $self->SUPER::cancel(@_);
1056 Checks all fields to make sure this is a valid service. If there is an error,
1057 returns the error, otherwise returns false. Called by the insert and replace
1060 Sets any fixed values; see L<FS::part_svc>.
1067 my($recref) = $self->hashref;
1069 my $x = $self->setfixed;
1070 return $x unless ref($x);
1073 my $error = $self->ut_numbern('svcnum')
1074 #|| $self->ut_number('domsvc')
1075 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1076 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1077 || $self->ut_foreign_keyn('sectornum','tower_sector','sectornum')
1078 || $self->ut_foreign_keyn('routernum','router','routernum')
1079 || $self->ut_foreign_keyn('blocknum','addr_block','blocknum')
1080 || $self->ut_textn('sec_phrase')
1081 || $self->ut_snumbern('seconds')
1082 || $self->ut_snumbern('upbytes')
1083 || $self->ut_snumbern('downbytes')
1084 || $self->ut_snumbern('totalbytes')
1085 || $self->ut_snumbern('seconds_threshold')
1086 || $self->ut_snumbern('upbytes_threshold')
1087 || $self->ut_snumbern('downbytes_threshold')
1088 || $self->ut_snumbern('totalbytes_threshold')
1089 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1090 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1091 || $self->ut_enum('password_recover', [ '', 'Y' ])
1093 || $self->ut_anything('cf_privatekey')
1095 || $self->ut_textn('cgp_accessmodes')
1096 || $self->ut_alphan('cgp_type')
1097 || $self->ut_textn('cgp_aliases' ) #well
1099 || $self->ut_alphasn('cgp_rulesallowed')
1100 || $self->ut_enum('cgp_rpopallowed', [ '', 'Y' ])
1101 || $self->ut_enum('cgp_mailtoall', [ '', 'Y' ])
1102 || $self->ut_enum('cgp_addmailtrailer', [ '', 'Y' ])
1103 || $self->ut_snumbern('cgp_archiveafter')
1105 || $self->ut_alphasn('cgp_deletemode')
1106 || $self->ut_enum('cgp_emptytrash', $self->cgp_emptytrash_values)
1107 || $self->ut_alphan('cgp_language')
1108 || $self->ut_textn('cgp_timezone')
1109 || $self->ut_textn('cgp_skinname')
1110 || $self->ut_textn('cgp_prontoskinname')
1111 || $self->ut_alphan('cgp_sendmdnmode')
1113 return $error if $error;
1115 # assign IP address, etc.
1116 if ( $conf->exists('svc_acct-ip_addr') ) {
1117 my $error = $self->svc_ip_check;
1118 return $error if $error;
1119 } else { # I think this is correct
1120 $self->routernum('');
1121 $self->blocknum('');
1125 local $username_letter = $username_letter;
1126 local $username_uppercase = $username_uppercase;
1127 if ($self->svcnum) {
1128 my $cust_svc = $self->cust_svc
1129 or return "no cust_svc record found for svcnum ". $self->svcnum;
1130 my $cust_pkg = $cust_svc->cust_pkg;
1132 if ($self->pkgnum) {
1133 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1137 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1138 $username_uppercase =
1139 $conf->exists('username-uppercase', $cust_pkg->cust_main->agentnum);
1142 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1144 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:\/\=\#\!]{$usernamemin,$ulen})$/i
1145 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1146 $recref->{username} = $1;
1148 my $uerror = gettext('illegal_username'). ': '. $recref->{username};
1150 unless ( $username_uppercase ) {
1151 $recref->{username} =~ /[A-Z]/ and return $uerror;
1153 if ( $username_letterfirst ) {
1154 $recref->{username} =~ /^[a-z]/ or return $uerror;
1155 } elsif ( $username_letter ) {
1156 $recref->{username} =~ /[a-z]/ or return $uerror;
1158 if ( $username_noperiod ) {
1159 $recref->{username} =~ /\./ and return $uerror;
1161 if ( $username_nounderscore ) {
1162 $recref->{username} =~ /_/ and return $uerror;
1164 if ( $username_nodash ) {
1165 $recref->{username} =~ /\-/ and return $uerror;
1167 unless ( $username_ampersand ) {
1168 $recref->{username} =~ /\&/ and return $uerror;
1170 unless ( $username_percent ) {
1171 $recref->{username} =~ /\%/ and return $uerror;
1173 unless ( $username_colon ) {
1174 $recref->{username} =~ /\:/ and return $uerror;
1176 unless ( $username_slash ) {
1177 $recref->{username} =~ /\// and return $uerror;
1179 unless ( $username_equals ) {
1180 $recref->{username} =~ /\=/ and return $uerror;
1182 unless ( $username_pound ) {
1183 $recref->{username} =~ /\#/ and return $uerror;
1185 unless ( $username_exclamation ) {
1186 $recref->{username} =~ /\!/ and return $uerror;
1190 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1191 $recref->{popnum} = $1;
1192 return "Unknown popnum" unless
1193 ! $recref->{popnum} ||
1194 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1196 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1198 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1199 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1201 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1202 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1203 #not all systems use gid=uid
1204 #you can set a fixed gid in part_svc
1206 return "Only root can have uid 0"
1207 if $recref->{uid} == 0
1208 && $recref->{username} !~ /^(root|toor|smtp)$/;
1210 unless ( $recref->{username} eq 'sync' ) {
1211 if ( grep $_ eq $recref->{shell}, @shells ) {
1212 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1214 return "Illegal shell \`". $self->shell. "\'; ".
1215 "shells configuration value contains: @shells";
1218 $recref->{shell} = '/bin/sync';
1222 $recref->{gid} ne '' ?
1223 return "Can't have gid without uid" : ( $recref->{gid}='' );
1224 #$recref->{dir} ne '' ?
1225 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1226 $recref->{shell} ne '' ?
1227 return "Can't have shell without uid" : ( $recref->{shell}='' );
1230 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1232 $recref->{dir} =~ /^([\/\w\-\.\&\:\#]*)$/
1233 or return "Illegal directory: ". $recref->{dir};
1234 $recref->{dir} = $1;
1235 return "Illegal directory"
1236 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1237 return "Illegal directory"
1238 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1239 unless ( $recref->{dir} ) {
1240 $recref->{dir} = $dir_prefix . '/';
1241 if ( $dirhash > 0 ) {
1242 for my $h ( 1 .. $dirhash ) {
1243 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1245 } elsif ( $dirhash < 0 ) {
1246 for my $h ( reverse $dirhash .. -1 ) {
1247 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1250 $recref->{dir} .= $recref->{username};
1256 if ( $self->getfield('finger') eq '' ) {
1257 my $cust_pkg = $self->svcnum
1258 ? $self->cust_svc->cust_pkg
1259 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1261 my $cust_main = $cust_pkg->cust_main;
1262 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1265 # $error = $self->ut_textn('finger');
1266 # return $error if $error;
1267 $self->getfield('finger') =~ /^([\w \,\.\-\'\&\t\!\@\#\$\%\(\)\+\;\"\?\/\*\<\>]*)$/
1268 or return "Illegal finger: ". $self->getfield('finger');
1269 $self->setfield('finger', $1);
1271 for (qw( quota file_quota file_maxsize )) {
1272 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1275 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1276 $recref->{file_maxnum} = $1;
1278 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1279 if ( $recref->{slipip} eq '' ) {
1280 $recref->{slipip} = ''; # eh?
1281 } elsif ( $recref->{slipip} eq '0e0' ) {
1282 $recref->{slipip} = '0e0';
1284 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1285 or return "Illegal slipip: ". $self->slipip;
1286 $recref->{slipip} = $1;
1290 #arbitrary RADIUS stuff; allow ut_textn for now
1291 foreach ( grep /^radius_/, fields('svc_acct') ) {
1292 $self->ut_textn($_);
1295 # First, if _password is blank, generate one and set default encoding.
1296 if ( ! $recref->{_password} ) {
1297 $error = $self->set_password('');
1299 # But if there's a _password but no encoding, assume it's plaintext and
1300 # set it to default encoding.
1301 elsif ( ! $recref->{_password_encoding} ) {
1302 $error = $self->set_password($recref->{_password});
1304 return $error if $error;
1306 # Next, check _password to ensure compliance with the encoding.
1307 if ( $recref->{_password_encoding} eq 'ldap' ) {
1309 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1310 $recref->{_password} = uc($1).$2;
1312 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1315 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1317 if ( $recref->{_password} =~
1318 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1319 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1322 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1325 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1328 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1329 # Password randomization is now in set_password.
1330 # Strip whitespace characters, check length requirements, etc.
1331 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1332 $recref->{_password} = $1;
1334 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1335 FS::Msgcat::_gettext('illegal_password_characters');
1338 if ( $password_noampersand ) {
1339 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1341 if ( $password_noexclamation ) {
1342 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1346 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1349 $self->SUPER::check;
1354 sub _password_encryption {
1356 my $encoding = lc($self->_password_encoding);
1357 return if !$encoding;
1358 return 'plain' if $encoding eq 'plain';
1359 if($encoding eq 'crypt') {
1360 my $pass = $self->_password;
1361 $pass =~ s/^\*SUSPENDED\* //;
1363 return 'md5' if $pass =~ /^\$1\$/;
1364 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1365 return 'des' if length($pass) == 13;
1368 if($encoding eq 'ldap') {
1369 uc($self->_password) =~ /^\{([\w-]+)\}/;
1370 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1371 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1372 return 'md5' if $1 eq 'MD5';
1373 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1380 sub get_cleartext_password {
1382 if($self->_password_encryption eq 'plain') {
1383 if($self->_password_encoding eq 'ldap') {
1384 $self->_password =~ /\{\w+\}(.*)$/;
1388 return $self->_password;
1397 Set the cleartext password for the account. If _password_encoding is set, the
1398 new password will be encoded according to the existing method (including
1399 encryption mode, if it can be determined). Otherwise,
1400 config('default-password-encoding') is used.
1402 If no password is supplied (or a zero-length password when minimum password length
1403 is >0), one will be generated randomly.
1408 my( $self, $pass ) = ( shift, shift );
1410 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1413 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1414 FS::Msgcat::_gettext('illegal_password_characters').
1417 my( $encoding, $encryption ) = ('', '');
1419 if ( $self->_password_encoding ) {
1420 $encoding = $self->_password_encoding;
1421 # identify existing encryption method, try to use it.
1422 $encryption = $self->_password_encryption;
1424 # use the system default
1430 # set encoding to system default
1431 ($encoding, $encryption) =
1432 split(/-/, lc($conf->config('default-password-encoding') || ''));
1433 $encoding ||= 'legacy';
1434 $self->_password_encoding($encoding);
1437 if ( $encoding eq 'legacy' ) {
1439 # The legacy behavior from check():
1440 # If the password is blank, randomize it and set encoding to 'plain'.
1441 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1442 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1443 $self->_password_encoding('plain');
1445 # Prefix + valid-length password
1446 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1448 $self->_password_encoding('plain');
1449 # Prefix + crypt string
1450 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1452 $self->_password_encoding('crypt');
1453 # Various disabled crypt passwords
1454 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1455 $self->_password_encoding('crypt');
1461 $self->_password($pass);
1467 if $passwordmin && length($pass) < $passwordmin
1468 or $passwordmax && length($pass) > $passwordmax;
1470 if ( $encoding eq 'crypt' ) {
1471 if ($encryption eq 'md5') {
1472 $pass = unix_md5_crypt($pass);
1473 } elsif ($encryption eq 'des') {
1474 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1477 } elsif ( $encoding eq 'ldap' ) {
1478 if ($encryption eq 'md5') {
1479 $pass = md5_base64($pass);
1480 } elsif ($encryption eq 'sha1') {
1481 $pass = sha1_base64($pass);
1482 } elsif ($encryption eq 'crypt') {
1483 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1485 # else $encryption eq 'plain', do nothing
1486 $pass .= '=' x (4 - length($pass) % 4) #properly padded base64
1487 if $encryption eq 'md5' || $encryption eq 'sha1';
1488 $pass = '{'.uc($encryption).'}'.$pass;
1490 # else encoding eq 'plain'
1492 $self->_password($pass);
1498 Internal function to check the username against the list of system usernames
1499 from the I<system_usernames> configuration value. Returns true if the username
1500 is listed on the system username list.
1506 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1507 $conf->config('system_usernames')
1511 =item _check_duplicate
1513 Internal method to check for duplicates usernames, username@domain pairs and
1516 If the I<global_unique-username> configuration value is set to B<username> or
1517 B<username@domain>, enforces global username or username@domain uniqueness.
1519 In all cases, check for duplicate uids and usernames or username@domain pairs
1520 per export and with identical I<svcpart> values.
1524 sub _check_duplicate {
1527 my $global_unique = $conf->config('global_unique-username') || 'none';
1528 return '' if $global_unique eq 'disabled';
1532 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1533 unless ( $part_svc ) {
1534 return 'unknown svcpart '. $self->svcpart;
1537 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1538 qsearch( 'svc_acct', { 'username' => $self->username } );
1539 return gettext('username_in_use')
1540 if $global_unique eq 'username' && @dup_user;
1542 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1543 qsearch( 'svc_acct', { 'username' => $self->username,
1544 'domsvc' => $self->domsvc } );
1545 return gettext('username_in_use')
1546 if $global_unique eq 'username@domain' && @dup_userdomain;
1549 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1550 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1551 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1552 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1557 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1558 my $exports = FS::part_export::export_info('svc_acct');
1559 my %conflict_user_svcpart;
1560 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1562 foreach my $part_export ( $part_svc->part_export ) {
1564 #this will catch to the same exact export
1565 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1567 #this will catch to exports w/same exporthost+type ???
1568 #my @other_part_export = qsearch('part_export', {
1569 # 'machine' => $part_export->machine,
1570 # 'exporttype' => $part_export->exporttype,
1572 #foreach my $other_part_export ( @other_part_export ) {
1573 # push @svcparts, map { $_->svcpart }
1574 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1577 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1578 #silly kludge to avoid uninitialized value errors
1579 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1580 ? $exports->{$part_export->exporttype}{'nodomain'}
1582 if ( $nodomain =~ /^Y/i ) {
1583 $conflict_user_svcpart{$_} = $part_export->exportnum
1586 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1591 foreach my $dup_user ( @dup_user ) {
1592 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1593 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1594 return "duplicate username ". $self->username.
1595 ": conflicts with svcnum ". $dup_user->svcnum.
1596 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1600 foreach my $dup_userdomain ( @dup_userdomain ) {
1601 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1602 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1603 return "duplicate username\@domain ". $self->email.
1604 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1605 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1609 foreach my $dup_uid ( @dup_uid ) {
1610 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1611 if ( exists($conflict_user_svcpart{$dup_svcpart})
1612 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1613 return "duplicate uid ". $self->uid.
1614 ": conflicts with svcnum ". $dup_uid->svcnum.
1616 ( $conflict_user_svcpart{$dup_svcpart}
1617 || $conflict_userdomain_svcpart{$dup_svcpart} );
1629 Depriciated, use radius_reply instead.
1634 carp "FS::svc_acct::radius depriciated, use radius_reply";
1635 $_[0]->radius_reply;
1640 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1641 reply attributes of this record.
1643 Note that this is now the preferred method for reading RADIUS attributes -
1644 accessing the columns directly is discouraged, as the column names are
1645 expected to change in the future.
1652 return %{ $self->{'radius_reply'} }
1653 if exists $self->{'radius_reply'};
1658 my($column, $attrib) = ($1, $2);
1659 #$attrib =~ s/_/\-/g;
1660 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1661 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1663 if ( $self->slipip && $self->slipip ne '0e0' ) {
1664 $reply{$radius_ip} = $self->slipip;
1667 if ( $self->seconds !~ /^$/ ) {
1668 $reply{'Session-Timeout'} = $self->seconds;
1671 if ( $conf->exists('radius-chillispot-max') ) {
1672 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1674 #hmm. just because sqlradius.pm says so?
1681 foreach my $what (qw( input output total )) {
1682 my $is = $whatis{$what}.'bytes';
1683 if ( $self->$is() =~ /\d/ ) {
1684 my $big = new Math::BigInt $self->$is();
1685 $big = new Math::BigInt '0' if $big->is_neg();
1686 my $att = "Chillispot-Max-\u$what";
1687 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1688 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1699 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1700 check attributes of this record.
1702 Note that this is now the preferred method for reading RADIUS attributes -
1703 accessing the columns directly is discouraged, as the column names are
1704 expected to change in the future.
1711 return %{ $self->{'radius_check'} }
1712 if exists $self->{'radius_check'};
1717 my($column, $attrib) = ($1, $2);
1718 #$attrib =~ s/_/\-/g;
1719 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1720 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1723 my($pw_attrib, $password) = $self->radius_password;
1724 $check{$pw_attrib} = $password;
1726 my $cust_svc = $self->cust_svc;
1728 my $cust_pkg = $cust_svc->cust_pkg;
1729 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1730 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1733 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1734 "; can't set Expiration\n"
1742 =item radius_password
1744 Returns a key/value pair containing the RADIUS attribute name and value
1749 sub radius_password {
1753 if ( $self->_password_encoding eq 'ldap' ) {
1754 $pw_attrib = 'Password-With-Header';
1755 } elsif ( $self->_password_encoding eq 'crypt' ) {
1756 $pw_attrib = 'Crypt-Password';
1757 } elsif ( $self->_password_encoding eq 'plain' ) {
1758 $pw_attrib = $radius_password;
1760 $pw_attrib = length($self->_password) <= 12
1765 ($pw_attrib, $self->_password);
1771 This method instructs the object to "snapshot" or freeze RADIUS check and
1772 reply attributes to the current values.
1776 #bah, my english is too broken this morning
1777 #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
1778 #the FS::cust_pkg's replace method to trigger the correct export updates when
1779 #package dates change)
1784 $self->{$_} = { $self->$_() }
1785 foreach qw( radius_reply radius_check );
1789 =item forget_snapshot
1791 This methos instructs the object to forget any previously snapshotted
1792 RADIUS check and reply attributes.
1796 sub forget_snapshot {
1800 foreach qw( radius_reply radius_check );
1804 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1806 Returns the domain associated with this account.
1808 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1815 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1816 my $svc_domain = $self->svc_domain(@_)
1817 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1818 $svc_domain->domain;
1823 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1827 #inherited from svc_Common
1829 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1831 Returns an email address associated with the account.
1833 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1840 $self->username. '@'. $self->domain(@_);
1846 Returns an array of FS::acct_snarf records associated with the account.
1850 # unused as originally intended, but now by Communigate Pro "RPOP"
1852 =item cgp_rpop_hashref
1854 Returns an arrayref of RPOP data suitable for Communigate Pro API commands.
1858 sub cgp_rpop_hashref {
1860 { map { $_->snarfname => $_->cgp_hashref } $self->acct_snarf };
1863 =item decrement_upbytes OCTETS
1865 Decrements the I<upbytes> field of this record by the given amount. If there
1866 is an error, returns the error, otherwise returns false.
1870 sub decrement_upbytes {
1871 shift->_op_usage('-', 'upbytes', @_);
1874 =item increment_upbytes OCTETS
1876 Increments the I<upbytes> field of this record by the given amount. If there
1877 is an error, returns the error, otherwise returns false.
1881 sub increment_upbytes {
1882 shift->_op_usage('+', 'upbytes', @_);
1885 =item decrement_downbytes OCTETS
1887 Decrements the I<downbytes> field of this record by the given amount. If there
1888 is an error, returns the error, otherwise returns false.
1892 sub decrement_downbytes {
1893 shift->_op_usage('-', 'downbytes', @_);
1896 =item increment_downbytes OCTETS
1898 Increments the I<downbytes> field of this record by the given amount. If there
1899 is an error, returns the error, otherwise returns false.
1903 sub increment_downbytes {
1904 shift->_op_usage('+', 'downbytes', @_);
1907 =item decrement_totalbytes OCTETS
1909 Decrements the I<totalbytes> field of this record by the given amount. If there
1910 is an error, returns the error, otherwise returns false.
1914 sub decrement_totalbytes {
1915 shift->_op_usage('-', 'totalbytes', @_);
1918 =item increment_totalbytes OCTETS
1920 Increments the I<totalbytes> field of this record by the given amount. If there
1921 is an error, returns the error, otherwise returns false.
1925 sub increment_totalbytes {
1926 shift->_op_usage('+', 'totalbytes', @_);
1929 =item decrement_seconds SECONDS
1931 Decrements the I<seconds> field of this record by the given amount. If there
1932 is an error, returns the error, otherwise returns false.
1936 sub decrement_seconds {
1937 shift->_op_usage('-', 'seconds', @_);
1940 =item increment_seconds SECONDS
1942 Increments the I<seconds> field of this record by the given amount. If there
1943 is an error, returns the error, otherwise returns false.
1947 sub increment_seconds {
1948 shift->_op_usage('+', 'seconds', @_);
1956 my %op2condition = (
1957 '-' => sub { my($self, $column, $amount) = @_;
1958 $self->$column - $amount <= 0;
1960 '+' => sub { my($self, $column, $amount) = @_;
1961 ($self->$column || 0) + $amount > 0;
1964 my %op2warncondition = (
1965 '-' => sub { my($self, $column, $amount) = @_;
1966 my $threshold = $column . '_threshold';
1967 $self->$column - $amount <= $self->$threshold + 0;
1969 '+' => sub { my($self, $column, $amount) = @_;
1970 ($self->$column || 0) + $amount > 0;
1975 my( $self, $op, $column, $amount ) = @_;
1977 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
1978 ' ('. $self->email. "): $op $amount\n"
1981 return '' unless $amount;
1984 if $self->cust_svc->part_svc->part_svc_column($column)->columnflag eq 'F';
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 if ( $conf->exists('radius-chillispot-max') ) {
2012 #$self->snapshot; #not necessary, we retain the old values
2013 #create an object with the updated usage values
2014 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2016 my $error = $new->replace($self);
2018 $dbh->rollback if $oldAutoCommit;
2019 return "Error replacing: $error";
2023 #overlimit_action eq 'cancel' handling
2024 my $cust_pkg = $self->cust_svc->cust_pkg;
2026 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2027 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2031 my $error = $cust_pkg->cancel; #XXX should have a reason
2033 $dbh->rollback if $oldAutoCommit;
2034 return "Error cancelling: $error";
2037 #nothing else is relevant if we're cancelling, so commit & return success
2038 warn "$me update successful; committing\n"
2040 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2045 my $action = $op2action{$op};
2047 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2048 ( $action eq 'suspend' && !$self->overlimit
2049 || $action eq 'unsuspend' && $self->overlimit )
2052 my $error = $self->_op_overlimit($action);
2054 $dbh->rollback if $oldAutoCommit;
2060 if ( $conf->exists("svc_acct-usage_$action")
2061 && &{$op2condition{$op}}($self, $column, $amount) ) {
2062 #my $error = $self->$action();
2063 my $error = $self->cust_svc->cust_pkg->$action();
2064 # $error ||= $self->overlimit($action);
2066 $dbh->rollback if $oldAutoCommit;
2067 return "Error ${action}ing: $error";
2071 if ($warning_msgnum && &{$op2warncondition{$op}}($self, $column, $amount)) {
2072 my $wqueue = new FS::queue {
2073 'svcnum' => $self->svcnum,
2074 'job' => 'FS::svc_acct::reached_threshold',
2078 my $error = $wqueue->insert(
2079 'svcnum' => $self->svcnum,
2084 $dbh->rollback if $oldAutoCommit;
2085 return "Error queuing threshold activity: $error";
2089 warn "$me update successful; committing\n"
2091 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2097 my( $self, $action ) = @_;
2099 local $SIG{HUP} = 'IGNORE';
2100 local $SIG{INT} = 'IGNORE';
2101 local $SIG{QUIT} = 'IGNORE';
2102 local $SIG{TERM} = 'IGNORE';
2103 local $SIG{TSTP} = 'IGNORE';
2104 local $SIG{PIPE} = 'IGNORE';
2106 my $oldAutoCommit = $FS::UID::AutoCommit;
2107 local $FS::UID::AutoCommit = 0;
2110 my $cust_pkg = $self->cust_svc->cust_pkg;
2112 my @conf_overlimit =
2114 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2115 : $conf->config('overlimit_groups');
2117 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2119 my @groups = scalar(@conf_overlimit) ? @conf_overlimit
2120 : split(' ',$part_export->option('overlimit_groups'));
2121 next unless scalar(@groups);
2123 my $other = new FS::svc_acct $self->hashref;
2124 $other->usergroup(\@groups);
2127 if ($action eq 'suspend') {
2130 } else { # $action eq 'unsuspend'
2135 my $error = $part_export->export_replace($new, $old)
2136 || $self->overlimit($action);
2139 $dbh->rollback if $oldAutoCommit;
2140 return "Error replacing radius groups: $error";
2145 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2151 my( $self, $valueref, %options ) = @_;
2153 warn "$me set_usage called for svcnum ". $self->svcnum.
2154 ' ('. $self->email. "): ".
2155 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2158 local $SIG{HUP} = 'IGNORE';
2159 local $SIG{INT} = 'IGNORE';
2160 local $SIG{QUIT} = 'IGNORE';
2161 local $SIG{TERM} = 'IGNORE';
2162 local $SIG{TSTP} = 'IGNORE';
2163 local $SIG{PIPE} = 'IGNORE';
2165 local $FS::svc_Common::noexport_hack = 1;
2166 my $oldAutoCommit = $FS::UID::AutoCommit;
2167 local $FS::UID::AutoCommit = 0;
2172 if ( $options{null} ) {
2173 %handyhash = ( map { ( $_ => undef, $_."_threshold" => undef ) }
2174 qw( seconds upbytes downbytes totalbytes )
2177 foreach my $field (keys %$valueref){
2178 $reset = 1 if $valueref->{$field};
2179 $self->setfield($field, $valueref->{$field});
2180 $self->setfield( $field.'_threshold',
2181 int($self->getfield($field)
2182 * ( $conf->exists('svc_acct-usage_threshold')
2183 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2188 $handyhash{$field} = $self->getfield($field);
2189 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2191 #my $error = $self->replace; #NO! we avoid the call to ->check for
2192 #die $error if $error; #services not explicity changed via the UI
2194 my $sql = "UPDATE svc_acct SET " .
2195 join (',', map { "$_ = ?" } (keys %handyhash) ).
2196 " WHERE svcnum = ". $self->svcnum;
2201 if (scalar(keys %handyhash)) {
2202 my $sth = $dbh->prepare( $sql )
2203 or die "Error preparing $sql: ". $dbh->errstr;
2204 my $rv = $sth->execute(values %handyhash);
2205 die "Error executing $sql: ". $sth->errstr
2206 unless defined($rv);
2207 die "Can't update usage for svcnum ". $self->svcnum
2211 if ( $conf->exists('radius-chillispot-max') ) {
2212 #$self->snapshot; #not necessary, we retain the old values
2213 #create an object with the updated usage values
2214 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2215 local($FS::Record::nowarn_identical) = 1;
2216 my $error = $new->replace($self); #call exports
2218 $dbh->rollback if $oldAutoCommit;
2219 return "Error replacing: $error";
2227 $error = $self->_op_overlimit('unsuspend')
2228 if $self->overlimit;;
2230 $error ||= $self->cust_svc->cust_pkg->unsuspend
2231 if $conf->exists("svc_acct-usage_unsuspend");
2234 $dbh->rollback if $oldAutoCommit;
2235 return "Error unsuspending: $error";
2240 warn "$me update successful; committing\n"
2242 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2248 =item recharge HASHREF
2250 Increments usage columns by the amount specified in HASHREF as
2251 column=>amount pairs.
2256 my ($self, $vhash) = @_;
2259 warn "[$me] recharge called on $self: ". Dumper($self).
2260 "\nwith vhash: ". Dumper($vhash);
2263 my $oldAutoCommit = $FS::UID::AutoCommit;
2264 local $FS::UID::AutoCommit = 0;
2268 foreach my $column (keys %$vhash){
2269 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2273 $dbh->rollback if $oldAutoCommit;
2275 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2280 =item is_rechargeable
2282 Returns true if this svc_account can be "recharged" and false otherwise.
2286 sub is_rechargable {
2288 $self->seconds ne ''
2289 || $self->upbytes ne ''
2290 || $self->downbytes ne ''
2291 || $self->totalbytes ne '';
2294 =item seconds_since TIMESTAMP
2296 Returns the number of seconds this account has been online since TIMESTAMP,
2297 according to the session monitor (see L<FS::session>).
2299 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2300 L<Time::Local> and L<Date::Parse> for conversion functions.
2304 #note: POD here, implementation in FS::cust_svc
2307 $self->cust_svc->seconds_since(@_);
2310 =item last_login_text
2312 Returns text describing the time of last login.
2316 sub last_login_text {
2318 $self->last_login ? ctime($self->last_login) : 'unknown';
2321 =item psearch_cdrs OPTIONS
2323 Returns a paged search (L<FS::PagedSearch>) for Call Detail Records
2324 associated with this service. For svc_acct, "associated with" means that
2325 either the "src" or the "charged_party" field of the CDR matches either
2326 the "username" field of the service or the username@domain label.
2331 my($self, %options) = @_;
2336 my $did = dbh->quote($self->username);
2337 my $diddomain = dbh->quote($self->label);
2339 my $prefix = $options{'default_prefix'} || ''; #convergent.au '+61'
2340 my $prefixdid = dbh->quote($prefix . $self->username);
2342 my $for_update = $options{'for_update'} ? 'FOR UPDATE' : '';
2344 if ( $options{inbound} ) {
2345 # these will be selected under their DIDs
2346 push @where, "FALSE";
2350 if (!$options{'disable_charged_party'}) {
2352 "charged_party = $did",
2353 "charged_party = $prefixdid",
2354 "charged_party = $diddomain"
2357 if (!$options{'disable_src'}) {
2359 "src = $did AND charged_party IS NULL",
2360 "src = $prefixdid AND charged_party IS NULL",
2361 "src = $diddomain AND charged_party IS NULL"
2364 push @where, '(' . join(' OR ', @orwhere) . ')';
2366 # $options{'status'} = '' is meaningful; for the rest of them it's not
2367 if ( exists $options{'status'} ) {
2368 $hash{'freesidestatus'} = $options{'status'};
2370 if ( $options{'cdrtypenum'} ) {
2371 $hash{'cdrtypenum'} = $options{'cdrtypenum'};
2373 if ( $options{'calltypenum'} ) {
2374 $hash{'calltypenum'} = $options{'calltypenum'};
2376 if ( $options{'begin'} ) {
2377 push @where, 'startdate >= '. $options{'begin'};
2379 if ( $options{'end'} ) {
2380 push @where, 'startdate < '. $options{'end'};
2382 if ( $options{'nonzero'} ) {
2383 push @where, 'duration > 0';
2386 my $extra_sql = join(' AND ', @where);
2389 $extra_sql = " AND ".$extra_sql;
2391 $extra_sql = " WHERE ".$extra_sql;
2397 'hashref' => \%hash,
2398 'extra_sql' => $extra_sql,
2399 'order_by' => "ORDER BY startdate $for_update",
2403 =item get_cdrs (DEPRECATED)
2405 Like psearch_cdrs, but returns all the L<FS::cdr> objects at once, in a
2406 single list. Arguments are the same as for psearch_cdrs.
2412 my $psearch = $self->psearch_cdrs(@_);
2413 qsearch ( $psearch->{query} )
2416 # sub radius_groups has moved to svc_Radius_Mixin
2418 =item clone_suspended
2420 Constructor used by FS::part_export::_export_suspend fallback. Document
2425 sub clone_suspended {
2427 my %hash = $self->hash;
2428 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2429 new FS::svc_acct \%hash;
2432 =item clone_kludge_unsuspend
2434 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2439 sub clone_kludge_unsuspend {
2441 my %hash = $self->hash;
2442 $hash{_password} = '';
2443 new FS::svc_acct \%hash;
2446 =item check_password
2448 Checks the supplied password against the (possibly encrypted) password in the
2449 database. Returns true for a successful authentication, false for no match.
2451 Currently supported encryptions are: classic DES crypt() and MD5
2455 sub check_password {
2456 my($self, $check_password) = @_;
2458 #remove old-style SUSPENDED kludge, they should be allowed to login to
2459 #self-service and pay up
2460 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2462 if ( $self->_password_encoding eq 'ldap' ) {
2464 $password =~ s/^{PLAIN}/{CLEARTEXT}/;
2465 my $auth = from_rfc2307 Authen::Passphrase $password;
2466 return $auth->match($check_password);
2468 } elsif ( $self->_password_encoding eq 'crypt' ) {
2470 my $auth = from_crypt Authen::Passphrase $self->_password;
2471 return $auth->match($check_password);
2473 } elsif ( $self->_password_encoding eq 'plain' ) {
2475 return $check_password eq $password;
2479 #XXX this could be replaced with Authen::Passphrase stuff
2481 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2483 } elsif ( length($password) < 13 ) { #plaintext
2484 $check_password eq $password;
2485 } elsif ( length($password) == 13 ) { #traditional DES crypt
2486 crypt($check_password, $password) eq $password;
2487 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2488 unix_md5_crypt($check_password, $password) eq $password;
2489 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2490 warn "Can't check password: Blowfish encryption not yet supported, ".
2491 "svcnum ". $self->svcnum. "\n";
2494 warn "Can't check password: Unrecognized encryption for svcnum ".
2495 $self->svcnum. "\n";
2503 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2505 Returns an encrypted password, either by passing through an encrypted password
2506 in the database or by encrypting a plaintext password from the database.
2508 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2509 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2510 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2511 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2512 encryption type is only used if the password is not already encrypted in the
2517 sub crypt_password {
2520 if ( $self->_password_encoding eq 'ldap' ) {
2522 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2525 #XXX this could be replaced with Authen::Passphrase stuff
2527 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2528 if ( $encryption eq 'crypt' ) {
2531 $saltset[int(rand(64))].$saltset[int(rand(64))]
2533 } elsif ( $encryption eq 'md5' ) {
2534 return unix_md5_crypt( $self->_password );
2535 } elsif ( $encryption eq 'blowfish' ) {
2536 croak "unknown encryption method $encryption";
2538 croak "unknown encryption method $encryption";
2541 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2545 } elsif ( $self->_password_encoding eq 'crypt' ) {
2547 return $self->_password;
2549 } elsif ( $self->_password_encoding eq 'plain' ) {
2551 #XXX this could be replaced with Authen::Passphrase stuff
2553 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2554 if ( $encryption eq 'crypt' ) {
2557 $saltset[int(rand(64))].$saltset[int(rand(64))]
2559 } elsif ( $encryption eq 'md5' ) {
2560 return unix_md5_crypt( $self->_password );
2561 } elsif ( $encryption eq 'sha512' ) {
2564 '$6$rounds=15420$'. join('', map $saltset[int(rand(64))], (1..16) )
2566 } elsif ( $encryption eq 'sha1_base64' ) { #for acct_sql
2567 my $pass = sha1_base64( $self->_password );
2568 $pass .= '=' x (4 - length($pass) % 4); #properly padded base64
2570 } elsif ( $encryption eq 'blowfish' ) {
2571 croak "unknown encryption method $encryption";
2573 croak "unknown encryption method $encryption";
2578 if ( length($self->_password) == 13
2579 || $self->_password =~ /^\$(1|2a?)\$/
2580 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2586 #XXX this could be replaced with Authen::Passphrase stuff
2588 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2589 if ( $encryption eq 'crypt' ) {
2592 $saltset[int(rand(64))].$saltset[int(rand(64))]
2594 } elsif ( $encryption eq 'md5' ) {
2595 return unix_md5_crypt( $self->_password );
2596 } elsif ( $encryption eq 'blowfish' ) {
2597 croak "unknown encryption method $encryption";
2599 croak "unknown encryption method $encryption";
2608 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2610 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2611 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2612 "{MD5}5426824942db4253f87a1009fd5d2d4".
2614 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2615 to work the same as the B</crypt_password> method.
2621 #eventually should check a "password-encoding" field
2623 if ( $self->_password_encoding eq 'ldap' ) {
2625 return $self->_password;
2627 } elsif ( $self->_password_encoding eq 'crypt' ) {
2629 if ( length($self->_password) == 13 ) { #crypt
2630 return '{CRYPT}'. $self->_password;
2631 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2633 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2634 # die "Blowfish encryption not supported in this context, svcnum ".
2635 # $self->svcnum. "\n";
2637 warn "encryption method not (yet?) supported in LDAP context";
2638 return '{CRYPT}*'; #unsupported, should not auth
2641 } elsif ( $self->_password_encoding eq 'plain' ) {
2643 return '{PLAIN}'. $self->_password;
2645 #return '{CLEARTEXT}'. $self->_password; #?
2649 if ( length($self->_password) == 13 ) { #crypt
2650 return '{CRYPT}'. $self->_password;
2651 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2653 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2654 warn "Blowfish encryption not supported in this context, svcnum ".
2655 $self->svcnum. "\n";
2658 #are these two necessary anymore?
2659 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2660 return '{SSHA}'. $1;
2661 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2662 return '{NS-MTA-MD5}'. $1;
2665 return '{PLAIN}'. $self->_password;
2667 #return '{CLEARTEXT}'. $self->_password; #?
2669 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2670 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2671 #if ( $encryption eq 'crypt' ) {
2672 # return '{CRYPT}'. crypt(
2674 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2676 #} elsif ( $encryption eq 'md5' ) {
2677 # unix_md5_crypt( $self->_password );
2678 #} elsif ( $encryption eq 'blowfish' ) {
2679 # croak "unknown encryption method $encryption";
2681 # croak "unknown encryption method $encryption";
2689 =item domain_slash_username
2691 Returns $domain/$username/
2695 sub domain_slash_username {
2697 $self->domain. '/'. $self->username. '/';
2700 =item virtual_maildir
2702 Returns $domain/maildirs/$username/
2706 sub virtual_maildir {
2708 $self->domain. '/maildirs/'. $self->username. '/';
2711 =item password_svc_check
2713 Override, for L<FS::Password_Mixin>. Not really intended for other use.
2717 sub password_svc_check {
2718 my ($self, $password) = @_;
2719 foreach my $field ( qw(username finger) ) {
2720 foreach my $word (split(/\W+/,$self->get($field))) {
2721 next unless length($word) > 2;
2722 if ($password =~ /$word/i) {
2723 return qq(Password contains account information '$word');
2732 =head1 CLASS METHODS
2736 =item search HASHREF
2738 Class method which returns a qsearch hash expression to search for parameters
2739 specified in HASHREF. Valid parameters are
2753 Arrayref of pkgparts
2759 Arrayref of additional WHERE clauses, will be ANDed together.
2770 my( $class, $params, $from, $where ) = @_;
2772 #these two should probably move to svc_Domain_Mixin ?
2775 if ( $params->{'domain'} ) {
2776 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2777 #preserve previous behavior & bubble up an error if $svc_domain not found?
2778 push @$where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2782 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2783 push @$where, "domsvc = $1";
2788 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2789 push @$where, "popnum = $1";
2793 #and these in svc_Tower_Mixin, or maybe we never should have done svc_acct
2794 # towers (or, as mark thought, never should have done svc_broadband)
2797 my @where_sector = $class->tower_sector_sql($params);
2798 if ( @where_sector ) {
2799 push @$where, @where_sector;
2800 push @$from, ' LEFT JOIN tower_sector USING ( sectornum )';
2811 =item check_and_rebuild_fuzzyfiles
2815 sub check_and_rebuild_fuzzyfiles {
2816 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2817 -e "$dir/svc_acct.username"
2818 or &rebuild_fuzzyfiles;
2821 =item rebuild_fuzzyfiles
2825 sub rebuild_fuzzyfiles {
2827 use Fcntl qw(:flock);
2829 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2833 open(USERNAMELOCK,">>$dir/svc_acct.username")
2834 or die "can't open $dir/svc_acct.username: $!";
2835 flock(USERNAMELOCK,LOCK_EX)
2836 or die "can't lock $dir/svc_acct.username: $!";
2838 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2840 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2841 or die "can't open $dir/svc_acct.username.tmp: $!";
2842 print USERNAMECACHE join("\n", @all_username), "\n";
2843 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2845 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2855 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2856 open(USERNAMECACHE,"<$dir/svc_acct.username")
2857 or die "can't open $dir/svc_acct.username: $!";
2858 my @array = map { chomp; $_; } <USERNAMECACHE>;
2859 close USERNAMECACHE;
2863 =item append_fuzzyfiles USERNAME
2867 sub append_fuzzyfiles {
2868 my $username = shift;
2870 &check_and_rebuild_fuzzyfiles;
2872 use Fcntl qw(:flock);
2874 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2876 open(USERNAME,">>$dir/svc_acct.username")
2877 or die "can't open $dir/svc_acct.username: $!";
2878 flock(USERNAME,LOCK_EX)
2879 or die "can't lock $dir/svc_acct.username: $!";
2881 print USERNAME "$username\n";
2883 flock(USERNAME,LOCK_UN)
2884 or die "can't unlock $dir/svc_acct.username: $!";
2891 =item reached_threshold
2893 Performs some activities when svc_acct thresholds (such as number of seconds
2894 remaining) are reached.
2898 sub reached_threshold {
2901 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
2902 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
2904 if ( $opt{'op'} eq '+' ){
2905 $svc_acct->setfield( $opt{'column'}.'_threshold',
2906 int($svc_acct->getfield($opt{'column'})
2907 * ( $conf->exists('svc_acct-usage_threshold')
2908 ? $conf->config('svc_acct-usage_threshold')/100
2913 my $error = $svc_acct->replace;
2914 die $error if $error;
2915 }elsif ( $opt{'op'} eq '-' ){
2917 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
2918 return '' if ($threshold eq '' );
2920 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
2921 my $error = $svc_acct->replace;
2922 die $error if $error; # email next time, i guess
2924 if ( $warning_msgnum ) {
2926 my $msg_template = qsearchs('msg_template',{ msgnum => $warning_msgnum });
2927 die "Could not load template for threshold_warning_msgnum ($warning_msgnum)" unless $msg_template;
2929 my $cust_main = $svc_acct->cust_svc->cust_pkg->cust_main;
2931 my $to = join(', ', $cust_main->invoicing_list_emailonly );
2933 my $error = $msg_template->send(
2934 cust_main => $cust_main,
2935 object => $svc_acct,
2938 # have to override these, because we changed threshold above
2939 'column' => $opt{'column'},
2940 'amount' => $opt{'column'} =~/bytes/
2941 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
2942 : $svc_acct->getfield($opt{'column'}),
2943 'threshold' => $opt{'column'} =~/bytes/
2944 ? FS::UI::bytecount::display_bytecount($threshold)
2949 die "Error sending threshold warning email: $error" if $error;
2953 die "unknown op: " . $opt{'op'};
2961 The $recref stuff in sub check should be cleaned up.
2963 The suspend, unsuspend and cancel methods update the database, but not the
2964 current object. This is probably a bug as it's unexpected and
2967 insertion of RADIUS group stuff in insert could be done with child_objects now
2968 (would probably clean up export of them too)
2970 _op_usage and set_usage bypass the history... maybe they shouldn't
2974 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
2975 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
2976 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
2977 L<freeside-queued>), L<FS::svc_acct_pop>,
2978 schema.html from the base documentation.