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',
333 label => 'RADIUS groups',
334 type => 'select-radius_group.html',
335 disable_inventory => 1,
339 'seconds' => { label => 'Seconds',
340 label_sort => 'with Time Remaining',
342 disable_inventory => 1,
344 disable_part_svc_column => 1,
346 'upbytes' => { label => 'Upload',
348 disable_inventory => 1,
350 'format' => \&FS::UI::bytecount::display_bytecount,
351 'parse' => \&FS::UI::bytecount::parse_bytecount,
352 disable_part_svc_column => 1,
354 'downbytes' => { label => 'Download',
356 disable_inventory => 1,
358 'format' => \&FS::UI::bytecount::display_bytecount,
359 'parse' => \&FS::UI::bytecount::parse_bytecount,
360 disable_part_svc_column => 1,
362 'totalbytes'=> { label => 'Total up and download',
364 disable_inventory => 1,
366 'format' => \&FS::UI::bytecount::display_bytecount,
367 'parse' => \&FS::UI::bytecount::parse_bytecount,
368 disable_part_svc_column => 1,
370 'seconds_threshold' => { label => 'Seconds threshold',
372 disable_inventory => 1,
374 disable_part_svc_column => 1,
376 'upbytes_threshold' => { label => 'Upload threshold',
378 disable_inventory => 1,
380 'format' => \&FS::UI::bytecount::display_bytecount,
381 'parse' => \&FS::UI::bytecount::parse_bytecount,
382 disable_part_svc_column => 1,
384 'downbytes_threshold' => { label => 'Download threshold',
386 disable_inventory => 1,
388 'format' => \&FS::UI::bytecount::display_bytecount,
389 'parse' => \&FS::UI::bytecount::parse_bytecount,
390 disable_part_svc_column => 1,
392 'totalbytes_threshold'=> { label => 'Total up and download threshold',
394 disable_inventory => 1,
396 'format' => \&FS::UI::bytecount::display_bytecount,
397 'parse' => \&FS::UI::bytecount::parse_bytecount,
398 disable_part_svc_column => 1,
401 label => 'Last login',
405 label => 'Last logout',
410 label => 'Communigate aliases',
412 disable_inventory => 1,
417 label => 'Communigate account type',
419 select_list => [qw( MultiMailbox TextMailbox MailDirMailbox AGrade BGrade CGrade )],
420 disable_inventory => 1,
423 'cgp_accessmodes' => {
424 label => 'Communigate enabled services',
425 type => 'communigate_pro-accessmodes',
426 disable_inventory => 1,
429 'cgp_rulesallowed' => {
430 label => 'Allowed mail rules',
432 select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ],
433 disable_inventory => 1,
436 'cgp_rpopallowed' => { label => 'RPOP modifications',
439 'cgp_mailtoall' => { label => 'Accepts mail to "all"',
442 'cgp_addmailtrailer' => { label => 'Add trailer to sent mail',
445 'cgp_archiveafter' => {
446 label => 'Archive messages after',
449 -2 => 'default(730 days)',
456 1209600 => '2 weeks',
457 2592000 => '30 days',
458 7776000 => '90 days',
459 15552000 => '180 days',
460 31536000 => '365 days',
461 63072000 => '730 days',
463 disable_inventory => 1,
469 'cgp_deletemode' => {
470 label => 'Communigate message delete method',
472 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
473 disable_inventory => 1,
476 'cgp_emptytrash' => {
477 label => 'Communigate on logout remove trash',
479 select_list => __PACKAGE__->cgp_emptytrash_values,
480 disable_inventory => 1,
484 label => 'Communigate language',
486 select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ],
487 disable_inventory => 1,
491 label => 'Communigate time zone',
493 select_list => __PACKAGE__->cgp_timezone_values,
494 disable_inventory => 1,
498 label => 'Communigate layout',
500 select_list => [ '', '***', 'GoldFleece', 'Skin2' ],
501 disable_inventory => 1,
504 'cgp_prontoskinname' => {
505 label => 'Communigate Pronto style',
507 select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ],
508 disable_inventory => 1,
511 'cgp_sendmdnmode' => {
512 label => 'Communigate send read receipts',
514 select_list => [ '', 'Never', 'Manually', 'Automatically' ],
515 disable_inventory => 1,
526 sub table { 'svc_acct'; }
528 sub table_dupcheck_fields { ( 'username', 'domsvc' ); }
531 shift->_lastlog('in', @_);
535 shift->_lastlog('out', @_);
539 my( $self, $op, $time ) = @_;
541 if ( defined($time) ) {
542 warn "$me last_log$op called on svcnum ". $self->svcnum.
543 ' ('. $self->email. "): $time\n"
548 my $sql = "UPDATE svc_acct SET last_log$op = ? WHERE svcnum = ?";
552 my $sth = $dbh->prepare( $sql )
553 or die "Error preparing $sql: ". $dbh->errstr;
554 my $rv = $sth->execute($time, $self->svcnum);
555 die "Error executing $sql: ". $sth->errstr
557 die "Can't update last_log$op for svcnum". $self->svcnum
560 $self->{'Hash'}->{"last_log$op"} = $time;
562 $self->getfield("last_log$op");
566 =item search_sql STRING
568 Class method which returns an SQL fragment to search for the given string.
573 my( $class, $string ) = @_;
574 if ( $string =~ /^([^@]+)@([^@]+)$/ ) {
575 my( $username, $domain ) = ( $1, $2 );
576 my $q_username = dbh->quote($username);
577 my @svc_domain = qsearch('svc_domain', { 'domain' => $domain } );
579 "svc_acct.username = $q_username AND ( ".
580 join( ' OR ', map { "svc_acct.domsvc = ". $_->svcnum; } @svc_domain ).
585 } elsif ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
587 $class->search_sql_field('slipip', $string ).
589 $class->search_sql_field('username', $string ).
592 $class->search_sql_field('username', $string);
596 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
598 Returns the "username@domain" string for this account.
600 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
610 =item label_long [ END_TIMESTAMP [ START_TIMESTAMP ] ]
612 Returns a longer string label for this acccount ("Real Name <username@domain>"
613 if available, or "username@domain").
615 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
622 my $label = $self->label(@_);
623 my $finger = $self->finger;
624 return $label unless $finger =~ /\S/;
625 my $maxlen = 40 - length($label) - length($self->cust_svc->part_svc->svc);
626 $finger = substr($finger, 0, $maxlen-3).'...' if length($finger) > $maxlen;
630 =item insert [ , OPTION => VALUE ... ]
632 Adds this account to the database. If there is an error, returns the error,
633 otherwise returns false.
635 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
636 defined. An FS::cust_svc record will be created and inserted.
638 The additional field I<usergroup> can optionally be defined; if so it should
639 contain an arrayref of group names. See L<FS::radius_usergroup>.
641 The additional field I<child_objects> can optionally be defined; if so it
642 should contain an arrayref of FS::tablename objects. They will have their
643 svcnum fields set and will be inserted after this record, but before any
644 exports are run. Each element of the array can also optionally be a
645 two-element array reference containing the child object and the name of an
646 alternate field to be filled in with the newly-inserted svcnum, for example
647 C<[ $svc_forward, 'srcsvc' ]>
649 Currently available options are: I<depend_jobnum>
651 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
652 jobnums), all provisioning jobs will have a dependancy on the supplied
653 jobnum(s) (they will not run until the specific job(s) complete(s)).
655 (TODOC: L<FS::queue> and L<freeside-queued>)
657 (TODOC: new exports!)
666 warn "[$me] insert called on $self: ". Dumper($self).
667 "\nwith options: ". Dumper(%options);
670 local $SIG{HUP} = 'IGNORE';
671 local $SIG{INT} = 'IGNORE';
672 local $SIG{QUIT} = 'IGNORE';
673 local $SIG{TERM} = 'IGNORE';
674 local $SIG{TSTP} = 'IGNORE';
675 local $SIG{PIPE} = 'IGNORE';
677 my $oldAutoCommit = $FS::UID::AutoCommit;
678 local $FS::UID::AutoCommit = 0;
682 my $error = $self->SUPER::insert( # usergroup is here
683 'jobnums' => \@jobnums,
684 'child_objects' => $self->child_objects,
688 $error ||= $self->insert_password_history;
691 $dbh->rollback if $oldAutoCommit;
695 unless ( $skip_fuzzyfiles ) {
696 $error = $self->queue_fuzzyfiles_update;
698 $dbh->rollback if $oldAutoCommit;
699 return "updating fuzzy search cache: $error";
703 my $cust_pkg = $self->cust_svc->cust_pkg;
706 my $cust_main = $cust_pkg->cust_main;
707 my $agentnum = $cust_main->agentnum;
709 if ( $conf->exists('emailinvoiceautoalways')
710 || $conf->exists('emailinvoiceauto')
711 && ! $cust_main->invoicing_list_emailonly
714 # slight false laziness w/ edit/process/cust_main.cgi...
715 # and also slightly arbitrary behavior.
717 # this will never happen but check it anyway
718 my ($contact) = map { $_->contact }
719 qsearch('contact_email', { emailaddress => $self->email });
722 # if the "real name" of this account matches the first + last name
723 # of a contact, attach the email address to that person.
724 my @contacts = map { $_->contact } $cust_main->cust_contact;
725 my $myname = $self->get('finger');
727 grep { $_->get('first') . ' ' . $_->get('last') eq $myname } @contacts;
728 # otherwise just pick the first one
729 $contact = $contacts[0];
732 $contact ||= FS::contact->new({
733 'custnum' => $cust_main->get('custnum'),
734 'locationnum' => $cust_main->get('bill_locationnum'),
735 'last' => $cust_main->get('last'),
736 'first' => $cust_main->get('first'),
738 $contact->set('emailaddress', $self->email);
739 $contact->set('invoice_dest', 'Y');
741 if ( $contact->get('contactnum') ) {
742 $error = $contact->replace;
744 $error = $contact->insert;
748 $dbh->rollback if $oldAutoCommit;
749 return "creating invoice destination contact: $error";
755 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
759 # set usage fields and thresholds if unset but set in a package def
760 # AND the package already has a last bill date (otherwise they get double added)
761 sub preinsert_hook_first {
764 return '' unless $self->pkgnum;
766 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
767 return '' unless $cust_pkg && $cust_pkg->last_bill;
769 my $part_pkg = $cust_pkg->part_pkg;
770 return '' unless $part_pkg && $part_pkg->can('usage_valuehash');
772 my %values = $part_pkg->usage_valuehash;
773 my $multiplier = $conf->exists('svc_acct-usage_threshold')
774 ? 1 - $conf->config('svc_acct-usage_threshold')/100
775 : 0.20; #doesn't matter
777 foreach ( keys %values ) {
778 next if $self->getfield($_);
779 $self->setfield( $_, $values{$_} );
780 $self->setfield( $_. '_threshold', int( $values{$_} * $multiplier ) )
781 if $conf->exists('svc_acct-usage_threshold');
789 Deletes this account from the database. If there is an error, returns the
790 error, otherwise returns false.
792 The corresponding FS::cust_svc record will be deleted as well.
794 (TODOC: new exports!)
801 return "can't delete system account" if $self->_check_system;
803 return "Can't delete an account which is a (svc_forward) source!"
804 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
806 return "Can't delete an account which is a (svc_forward) destination!"
807 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
809 return "Can't delete an account with (svc_www) web service!"
810 if qsearch( 'svc_www', { 'usersvc' => $self->svcnum } );
812 # what about records in session ? (they should refer to history table)
814 local $SIG{HUP} = 'IGNORE';
815 local $SIG{INT} = 'IGNORE';
816 local $SIG{QUIT} = 'IGNORE';
817 local $SIG{TERM} = 'IGNORE';
818 local $SIG{TSTP} = 'IGNORE';
819 local $SIG{PIPE} = 'IGNORE';
821 my $oldAutoCommit = $FS::UID::AutoCommit;
822 local $FS::UID::AutoCommit = 0;
825 foreach my $svc_domain (
826 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
828 my %hash = new FS::svc_domain->hash;
829 $hash{'catchall'} = '';
830 my $new = new FS::svc_domain \%hash;
831 my $error = $new->replace($svc_domain);
833 $dbh->rollback if $oldAutoCommit;
838 foreach my $svc_phone (
839 qsearch( 'svc_phone', { 'forward_svcnum' => $self->svcnum })
841 $svc_phone->set('forward_svcnum', '');
842 my $error = $svc_phone->replace;
844 $dbh->rollback if $oldAutoCommit;
849 my $error = $self->delete_password_history
850 || $self->SUPER::delete; # usergroup here
852 $dbh->rollback if $oldAutoCommit;
856 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
860 =item replace OLD_RECORD
862 Replaces OLD_RECORD with this one in the database. If there is an error,
863 returns the error, otherwise returns false.
865 The additional field I<usergroup> can optionally be defined; if so it should
866 contain an arrayref of group names. See L<FS::radius_usergroup>.
874 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
878 warn "$me replacing $old with $new\n" if $DEBUG;
882 return "can't modify system account" if $old->_check_system;
885 #no warnings 'numeric'; #alas, a 5.006-ism
888 foreach my $xid (qw( uid gid )) {
890 return "Can't change $xid!"
891 if ! $conf->exists("svc_acct-edit_$xid")
892 && $old->$xid() != $new->$xid()
893 && $new->cust_svc->part_svc->part_svc_column($xid)->columnflag ne 'F'
898 return "can't change username"
899 if $old->username ne $new->username
900 && $conf->exists('svc_acct-no_edit_username');
902 #change homdir when we change username
903 $new->setfield('dir', '') if $old->username ne $new->username;
905 local $SIG{HUP} = 'IGNORE';
906 local $SIG{INT} = 'IGNORE';
907 local $SIG{QUIT} = 'IGNORE';
908 local $SIG{TERM} = 'IGNORE';
909 local $SIG{TSTP} = 'IGNORE';
910 local $SIG{PIPE} = 'IGNORE';
912 my $oldAutoCommit = $FS::UID::AutoCommit;
913 local $FS::UID::AutoCommit = 0;
916 $error = $new->SUPER::replace($old, @_); # usergroup here
918 # don't need to record this unless the password was changed
919 if ( $old->_password ne $new->_password ) {
920 $error ||= $new->insert_password_history;
924 $dbh->rollback if $oldAutoCommit;
925 return $error if $error;
928 if ( $new->username ne $old->username && ! $skip_fuzzyfiles ) {
929 $error = $new->queue_fuzzyfiles_update;
931 $dbh->rollback if $oldAutoCommit;
932 return "updating fuzzy search cache: $error";
936 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
940 =item queue_fuzzyfiles_update
942 Used by insert & replace to update the fuzzy search cache
946 sub queue_fuzzyfiles_update {
949 local $SIG{HUP} = 'IGNORE';
950 local $SIG{INT} = 'IGNORE';
951 local $SIG{QUIT} = 'IGNORE';
952 local $SIG{TERM} = 'IGNORE';
953 local $SIG{TSTP} = 'IGNORE';
954 local $SIG{PIPE} = 'IGNORE';
956 my $oldAutoCommit = $FS::UID::AutoCommit;
957 local $FS::UID::AutoCommit = 0;
960 my $queue = new FS::queue {
961 'svcnum' => $self->svcnum,
962 'job' => 'FS::svc_acct::append_fuzzyfiles'
964 my $error = $queue->insert($self->username);
966 $dbh->rollback if $oldAutoCommit;
967 return "queueing job (transaction rolled back): $error";
970 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
978 Suspends this account by calling export-specific suspend hooks. If there is
979 an error, returns the error, otherwise returns false.
981 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
987 return "can't suspend system account" if $self->_check_system;
988 $self->SUPER::suspend(@_);
993 Unsuspends this account by by calling export-specific suspend hooks. If there
994 is an error, returns the error, otherwise returns false.
996 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1002 my %hash = $self->hash;
1003 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1004 $hash{_password} = $1;
1005 my $new = new FS::svc_acct ( \%hash );
1006 my $error = $new->replace($self);
1007 return $error if $error;
1010 $self->SUPER::unsuspend(@_);
1015 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1017 If the B<auto_unset_catchall> configuration option is set, this method will
1018 automatically remove any references to the canceled service in the catchall
1019 field of svc_domain. This allows packages that contain both a svc_domain and
1020 its catchall svc_acct to be canceled in one step.
1025 # Only one thing to do at this level
1027 foreach my $svc_domain (
1028 qsearch( 'svc_domain', { catchall => $self->svcnum } ) ) {
1029 if($conf->exists('auto_unset_catchall')) {
1030 my %hash = $svc_domain->hash;
1031 $hash{catchall} = '';
1032 my $new = new FS::svc_domain ( \%hash );
1033 my $error = $new->replace($svc_domain);
1034 return $error if $error;
1036 return "cannot unprovision svc_acct #".$self->svcnum.
1037 " while assigned as catchall for svc_domain #".$svc_domain->svcnum;
1041 $self->SUPER::cancel(@_);
1047 Checks all fields to make sure this is a valid service. If there is an error,
1048 returns the error, otherwise returns false. Called by the insert and replace
1051 Sets any fixed values; see L<FS::part_svc>.
1058 my($recref) = $self->hashref;
1060 my $x = $self->setfixed;
1061 return $x unless ref($x);
1064 my $error = $self->ut_numbern('svcnum')
1065 #|| $self->ut_number('domsvc')
1066 || $self->ut_foreign_key( 'domsvc', 'svc_domain', 'svcnum' )
1067 || $self->ut_foreign_keyn('pbxsvc', 'svc_pbx', 'svcnum' )
1068 || $self->ut_foreign_keyn('sectornum','tower_sector','sectornum')
1069 || $self->ut_foreign_keyn('routernum','router','routernum')
1070 || $self->ut_foreign_keyn('blocknum','addr_block','blocknum')
1071 || $self->ut_textn('sec_phrase')
1072 || $self->ut_snumbern('seconds')
1073 || $self->ut_snumbern('upbytes')
1074 || $self->ut_snumbern('downbytes')
1075 || $self->ut_snumbern('totalbytes')
1076 || $self->ut_snumbern('seconds_threshold')
1077 || $self->ut_snumbern('upbytes_threshold')
1078 || $self->ut_snumbern('downbytes_threshold')
1079 || $self->ut_snumbern('totalbytes_threshold')
1080 || $self->ut_enum('_password_encoding', ['',qw(plain crypt ldap)])
1081 || $self->ut_enum('password_selfchange', [ '', 'Y' ])
1082 || $self->ut_enum('password_recover', [ '', 'Y' ])
1084 || $self->ut_anything('cf_privatekey')
1086 || $self->ut_textn('cgp_accessmodes')
1087 || $self->ut_alphan('cgp_type')
1088 || $self->ut_textn('cgp_aliases' ) #well
1090 || $self->ut_alphasn('cgp_rulesallowed')
1091 || $self->ut_enum('cgp_rpopallowed', [ '', 'Y' ])
1092 || $self->ut_enum('cgp_mailtoall', [ '', 'Y' ])
1093 || $self->ut_enum('cgp_addmailtrailer', [ '', 'Y' ])
1094 || $self->ut_snumbern('cgp_archiveafter')
1096 || $self->ut_alphasn('cgp_deletemode')
1097 || $self->ut_enum('cgp_emptytrash', $self->cgp_emptytrash_values)
1098 || $self->ut_alphan('cgp_language')
1099 || $self->ut_textn('cgp_timezone')
1100 || $self->ut_textn('cgp_skinname')
1101 || $self->ut_textn('cgp_prontoskinname')
1102 || $self->ut_alphan('cgp_sendmdnmode')
1104 return $error if $error;
1106 # assign IP address, etc.
1107 if ( $conf->exists('svc_acct-ip_addr') ) {
1108 my $error = $self->svc_ip_check;
1109 return $error if $error;
1110 } else { # I think this is correct
1111 $self->routernum('');
1112 $self->blocknum('');
1116 local $username_letter = $username_letter;
1117 local $username_uppercase = $username_uppercase;
1118 if ($self->svcnum) {
1119 my $cust_svc = $self->cust_svc
1120 or return "no cust_svc record found for svcnum ". $self->svcnum;
1121 my $cust_pkg = $cust_svc->cust_pkg;
1123 if ($self->pkgnum) {
1124 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );#complain?
1128 $conf->exists('username-letter', $cust_pkg->cust_main->agentnum);
1129 $username_uppercase =
1130 $conf->exists('username-uppercase', $cust_pkg->cust_main->agentnum);
1133 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1135 $recref->{username} =~ /^([a-z0-9_\-\.\&\%\:\/\=\#\!]{$usernamemin,$ulen})$/i
1136 or return gettext('illegal_username'). " ($usernamemin-$ulen): ". $recref->{username};
1137 $recref->{username} = $1;
1139 my $uerror = gettext('illegal_username'). ': '. $recref->{username};
1141 unless ( $username_uppercase ) {
1142 $recref->{username} =~ /[A-Z]/ and return $uerror;
1144 if ( $username_letterfirst ) {
1145 $recref->{username} =~ /^[a-z]/ or return $uerror;
1146 } elsif ( $username_letter ) {
1147 $recref->{username} =~ /[a-z]/ or return $uerror;
1149 if ( $username_noperiod ) {
1150 $recref->{username} =~ /\./ and return $uerror;
1152 if ( $username_nounderscore ) {
1153 $recref->{username} =~ /_/ and return $uerror;
1155 if ( $username_nodash ) {
1156 $recref->{username} =~ /\-/ and return $uerror;
1158 unless ( $username_ampersand ) {
1159 $recref->{username} =~ /\&/ and return $uerror;
1161 unless ( $username_percent ) {
1162 $recref->{username} =~ /\%/ and return $uerror;
1164 unless ( $username_colon ) {
1165 $recref->{username} =~ /\:/ and return $uerror;
1167 unless ( $username_slash ) {
1168 $recref->{username} =~ /\// and return $uerror;
1170 unless ( $username_equals ) {
1171 $recref->{username} =~ /\=/ and return $uerror;
1173 unless ( $username_pound ) {
1174 $recref->{username} =~ /\#/ and return $uerror;
1176 unless ( $username_exclamation ) {
1177 $recref->{username} =~ /\!/ and return $uerror;
1181 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1182 $recref->{popnum} = $1;
1183 return "Unknown popnum" unless
1184 ! $recref->{popnum} ||
1185 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1187 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1189 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1190 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1192 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1193 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1194 #not all systems use gid=uid
1195 #you can set a fixed gid in part_svc
1197 return "Only root can have uid 0"
1198 if $recref->{uid} == 0
1199 && $recref->{username} !~ /^(root|toor|smtp)$/;
1201 unless ( $recref->{username} eq 'sync' ) {
1202 if ( grep $_ eq $recref->{shell}, @shells ) {
1203 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1205 return "Illegal shell \`". $self->shell. "\'; ".
1206 "shells configuration value contains: @shells";
1209 $recref->{shell} = '/bin/sync';
1213 $recref->{gid} ne '' ?
1214 return "Can't have gid without uid" : ( $recref->{gid}='' );
1215 #$recref->{dir} ne '' ?
1216 # return "Can't have directory without uid" : ( $recref->{dir}='' );
1217 $recref->{shell} ne '' ?
1218 return "Can't have shell without uid" : ( $recref->{shell}='' );
1221 unless ( $part_svc->part_svc_column('dir')->columnflag eq 'F' ) {
1223 $recref->{dir} =~ /^([\/\w\-\.\&\:\#]*)$/
1224 or return "Illegal directory: ". $recref->{dir};
1225 $recref->{dir} = $1;
1226 return "Illegal directory"
1227 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1228 return "Illegal directory"
1229 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1230 unless ( $recref->{dir} ) {
1231 $recref->{dir} = $dir_prefix . '/';
1232 if ( $dirhash > 0 ) {
1233 for my $h ( 1 .. $dirhash ) {
1234 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1236 } elsif ( $dirhash < 0 ) {
1237 for my $h ( reverse $dirhash .. -1 ) {
1238 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1241 $recref->{dir} .= $recref->{username};
1247 if ( $self->getfield('finger') eq '' ) {
1248 my $cust_pkg = $self->svcnum
1249 ? $self->cust_svc->cust_pkg
1250 : qsearchs('cust_pkg', { 'pkgnum' => $self->getfield('pkgnum') } );
1252 my $cust_main = $cust_pkg->cust_main;
1253 $self->setfield('finger', $cust_main->first.' '.$cust_main->get('last') );
1256 # $error = $self->ut_textn('finger');
1257 # return $error if $error;
1258 $self->getfield('finger') =~ /^([\w \,\.\-\'\&\t\!\@\#\$\%\(\)\+\;\"\?\/\*\<\>]*)$/
1259 or return "Illegal finger: ". $self->getfield('finger');
1260 $self->setfield('finger', $1);
1262 for (qw( quota file_quota file_maxsize )) {
1263 $recref->{$_} =~ /^(\w*)$/ or return "Illegal $_";
1266 $recref->{file_maxnum} =~ /^\s*(\d*)\s*$/ or return "Illegal file_maxnum";
1267 $recref->{file_maxnum} = $1;
1269 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1270 if ( $recref->{slipip} eq '' ) {
1271 $recref->{slipip} = ''; # eh?
1272 } elsif ( $recref->{slipip} eq '0e0' ) {
1273 $recref->{slipip} = '0e0';
1275 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1276 or return "Illegal slipip: ". $self->slipip;
1277 $recref->{slipip} = $1;
1281 #arbitrary RADIUS stuff; allow ut_textn for now
1282 foreach ( grep /^radius_/, fields('svc_acct') ) {
1283 $self->ut_textn($_);
1286 # First, if _password is blank, generate one and set default encoding.
1287 if ( ! $recref->{_password} ) {
1288 $error = $self->set_password('');
1290 # But if there's a _password but no encoding, assume it's plaintext and
1291 # set it to default encoding.
1292 elsif ( ! $recref->{_password_encoding} ) {
1293 $error = $self->set_password($recref->{_password});
1295 return $error if $error;
1297 # Next, check _password to ensure compliance with the encoding.
1298 if ( $recref->{_password_encoding} eq 'ldap' ) {
1300 if ( $recref->{_password} =~ /^(\{[\w\-]+\})(!?.{0,64})$/ ) {
1301 $recref->{_password} = uc($1).$2;
1303 return 'Illegal (ldap-encoded) password: '. $recref->{_password};
1306 } elsif ( $recref->{_password_encoding} eq 'crypt' ) {
1308 if ( $recref->{_password} =~
1309 #/^(\$\w+\$.*|[\w\+\/]{13}|_[\w\+\/]{19}|\*)$/
1310 /^(!!?)?(\$\w+\$.*|[\w\+\/\.]{13}|_[\w\+\/\.]{19}|\*)$/
1313 $recref->{_password} = ( defined($1) ? $1 : '' ). $2;
1316 return 'Illegal (crypt-encoded) password: '. $recref->{_password};
1319 } elsif ( $recref->{_password_encoding} eq 'plain' ) {
1320 # Password randomization is now in set_password.
1321 # Strip whitespace characters, check length requirements, etc.
1322 if ( $recref->{_password} =~ /^([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1323 $recref->{_password} = $1;
1325 return gettext('illegal_password'). " $passwordmin-$passwordmax ".
1326 FS::Msgcat::_gettext('illegal_password_characters');
1329 if ( $password_noampersand ) {
1330 $recref->{_password} =~ /\&/ and return gettext('illegal_password');
1332 if ( $password_noexclamation ) {
1333 $recref->{_password} =~ /\!/ and return gettext('illegal_password');
1337 return "invalid password encoding ('".$recref->{_password_encoding}."'";
1340 $self->SUPER::check;
1345 sub _password_encryption {
1347 my $encoding = lc($self->_password_encoding);
1348 return if !$encoding;
1349 return 'plain' if $encoding eq 'plain';
1350 if($encoding eq 'crypt') {
1351 my $pass = $self->_password;
1352 $pass =~ s/^\*SUSPENDED\* //;
1354 return 'md5' if $pass =~ /^\$1\$/;
1355 #return 'blowfish' if $self->_password =~ /^\$2\$/;
1356 return 'des' if length($pass) == 13;
1359 if($encoding eq 'ldap') {
1360 uc($self->_password) =~ /^\{([\w-]+)\}/;
1361 return 'crypt' if $1 eq 'CRYPT' or $1 eq 'DES';
1362 return 'plain' if $1 eq 'PLAIN' or $1 eq 'CLEARTEXT';
1363 return 'md5' if $1 eq 'MD5';
1364 return 'sha1' if $1 eq 'SHA' or $1 eq 'SHA-1';
1371 sub get_cleartext_password {
1373 if($self->_password_encryption eq 'plain') {
1374 if($self->_password_encoding eq 'ldap') {
1375 $self->_password =~ /\{\w+\}(.*)$/;
1379 return $self->_password;
1388 Set the cleartext password for the account. If _password_encoding is set, the
1389 new password will be encoded according to the existing method (including
1390 encryption mode, if it can be determined). Otherwise,
1391 config('default-password-encoding') is used.
1393 If no password is supplied (or a zero-length password when minimum password length
1394 is >0), one will be generated randomly.
1399 my( $self, $pass ) = ( shift, shift );
1401 warn "[$me] set_password (to $pass) called on $self: ". Dumper($self)
1404 my $failure = gettext('illegal_password'). " $passwordmin-$passwordmax ".
1405 FS::Msgcat::_gettext('illegal_password_characters').
1408 my( $encoding, $encryption ) = ('', '');
1410 if ( $self->_password_encoding ) {
1411 $encoding = $self->_password_encoding;
1412 # identify existing encryption method, try to use it.
1413 $encryption = $self->_password_encryption;
1415 # use the system default
1421 # set encoding to system default
1422 ($encoding, $encryption) =
1423 split(/-/, lc($conf->config('default-password-encoding') || ''));
1424 $encoding ||= 'legacy';
1425 $self->_password_encoding($encoding);
1428 if ( $encoding eq 'legacy' ) {
1430 # The legacy behavior from check():
1431 # If the password is blank, randomize it and set encoding to 'plain'.
1432 if(!defined($pass) or (length($pass) == 0 and $passwordmin)) {
1433 $pass = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
1434 $self->_password_encoding('plain');
1436 # Prefix + valid-length password
1437 if ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1439 $self->_password_encoding('plain');
1440 # Prefix + crypt string
1441 } elsif ( $pass =~ /^((\*SUSPENDED\* |!!?)?)([\w\.\/\$\;\+]{13,64})$/ ) {
1443 $self->_password_encoding('crypt');
1444 # Various disabled crypt passwords
1445 } elsif ( $pass eq '*' || $pass eq '!' || $pass eq '!!' ) {
1446 $self->_password_encoding('crypt');
1452 $self->_password($pass);
1458 if $passwordmin && length($pass) < $passwordmin
1459 or $passwordmax && length($pass) > $passwordmax;
1461 if ( $encoding eq 'crypt' ) {
1462 if ($encryption eq 'md5') {
1463 $pass = unix_md5_crypt($pass);
1464 } elsif ($encryption eq 'des') {
1465 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1468 } elsif ( $encoding eq 'ldap' ) {
1469 if ($encryption eq 'md5') {
1470 $pass = md5_base64($pass);
1471 } elsif ($encryption eq 'sha1') {
1472 $pass = sha1_base64($pass);
1473 } elsif ($encryption eq 'crypt') {
1474 $pass = crypt($pass, $saltset[int(rand(64))].$saltset[int(rand(64))]);
1476 # else $encryption eq 'plain', do nothing
1477 $pass .= '=' x (4 - length($pass) % 4) #properly padded base64
1478 if $encryption eq 'md5' || $encryption eq 'sha1';
1479 $pass = '{'.uc($encryption).'}'.$pass;
1481 # else encoding eq 'plain'
1483 $self->_password($pass);
1489 Internal function to check the username against the list of system usernames
1490 from the I<system_usernames> configuration value. Returns true if the username
1491 is listed on the system username list.
1497 scalar( grep { $self->username eq $_ || $self->email eq $_ }
1498 $conf->config('system_usernames')
1502 =item _check_duplicate
1504 Internal method to check for duplicates usernames, username@domain pairs and
1507 If the I<global_unique-username> configuration value is set to B<username> or
1508 B<username@domain>, enforces global username or username@domain uniqueness.
1510 In all cases, check for duplicate uids and usernames or username@domain pairs
1511 per export and with identical I<svcpart> values.
1515 sub _check_duplicate {
1518 my $global_unique = $conf->config('global_unique-username') || 'none';
1519 return '' if $global_unique eq 'disabled';
1523 my $part_svc = qsearchs('part_svc', { 'svcpart' => $self->svcpart } );
1524 unless ( $part_svc ) {
1525 return 'unknown svcpart '. $self->svcpart;
1528 my @dup_user = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1529 qsearch( 'svc_acct', { 'username' => $self->username } );
1530 return gettext('username_in_use')
1531 if $global_unique eq 'username' && @dup_user;
1533 my @dup_userdomain = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1534 qsearch( 'svc_acct', { 'username' => $self->username,
1535 'domsvc' => $self->domsvc } );
1536 return gettext('username_in_use')
1537 if $global_unique eq 'username@domain' && @dup_userdomain;
1540 if ( $part_svc->part_svc_column('uid')->columnflag ne 'F'
1541 && $self->username !~ /^(toor|(hyla)?fax)$/ ) {
1542 @dup_uid = grep { !$self->svcnum || $_->svcnum != $self->svcnum }
1543 qsearch( 'svc_acct', { 'uid' => $self->uid } );
1548 if ( @dup_user || @dup_userdomain || @dup_uid ) {
1549 my $exports = FS::part_export::export_info('svc_acct');
1550 my %conflict_user_svcpart;
1551 my %conflict_userdomain_svcpart = ( $self->svcpart => 'SELF', );
1553 foreach my $part_export ( $part_svc->part_export ) {
1555 #this will catch to the same exact export
1556 my @svcparts = map { $_->svcpart } $part_export->export_svc;
1558 #this will catch to exports w/same exporthost+type ???
1559 #my @other_part_export = qsearch('part_export', {
1560 # 'machine' => $part_export->machine,
1561 # 'exporttype' => $part_export->exporttype,
1563 #foreach my $other_part_export ( @other_part_export ) {
1564 # push @svcparts, map { $_->svcpart }
1565 # qsearch('export_svc', { 'exportnum' => $part_export->exportnum });
1568 #my $nodomain = $exports->{$part_export->exporttype}{'nodomain'};
1569 #silly kludge to avoid uninitialized value errors
1570 my $nodomain = exists( $exports->{$part_export->exporttype}{'nodomain'} )
1571 ? $exports->{$part_export->exporttype}{'nodomain'}
1573 if ( $nodomain =~ /^Y/i ) {
1574 $conflict_user_svcpart{$_} = $part_export->exportnum
1577 $conflict_userdomain_svcpart{$_} = $part_export->exportnum
1582 foreach my $dup_user ( @dup_user ) {
1583 my $dup_svcpart = $dup_user->cust_svc->svcpart;
1584 if ( exists($conflict_user_svcpart{$dup_svcpart}) ) {
1585 return "duplicate username ". $self->username.
1586 ": conflicts with svcnum ". $dup_user->svcnum.
1587 " via exportnum ". $conflict_user_svcpart{$dup_svcpart};
1591 foreach my $dup_userdomain ( @dup_userdomain ) {
1592 my $dup_svcpart = $dup_userdomain->cust_svc->svcpart;
1593 if ( exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1594 return "duplicate username\@domain ". $self->email.
1595 ": conflicts with svcnum ". $dup_userdomain->svcnum.
1596 " via exportnum ". $conflict_userdomain_svcpart{$dup_svcpart};
1600 foreach my $dup_uid ( @dup_uid ) {
1601 my $dup_svcpart = $dup_uid->cust_svc->svcpart;
1602 if ( exists($conflict_user_svcpart{$dup_svcpart})
1603 || exists($conflict_userdomain_svcpart{$dup_svcpart}) ) {
1604 return "duplicate uid ". $self->uid.
1605 ": conflicts with svcnum ". $dup_uid->svcnum.
1607 ( $conflict_user_svcpart{$dup_svcpart}
1608 || $conflict_userdomain_svcpart{$dup_svcpart} );
1620 Depriciated, use radius_reply instead.
1625 carp "FS::svc_acct::radius depriciated, use radius_reply";
1626 $_[0]->radius_reply;
1631 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1632 reply attributes of this record.
1634 Note that this is now the preferred method for reading RADIUS attributes -
1635 accessing the columns directly is discouraged, as the column names are
1636 expected to change in the future.
1643 return %{ $self->{'radius_reply'} }
1644 if exists $self->{'radius_reply'};
1649 my($column, $attrib) = ($1, $2);
1650 #$attrib =~ s/_/\-/g;
1651 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1652 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1654 if ( $self->slipip && $self->slipip ne '0e0' ) {
1655 $reply{$radius_ip} = $self->slipip;
1658 if ( $self->seconds !~ /^$/ ) {
1659 $reply{'Session-Timeout'} = $self->seconds;
1662 if ( $conf->exists('radius-chillispot-max') ) {
1663 #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1665 #hmm. just because sqlradius.pm says so?
1672 foreach my $what (qw( input output total )) {
1673 my $is = $whatis{$what}.'bytes';
1674 if ( $self->$is() =~ /\d/ ) {
1675 my $big = new Math::BigInt $self->$is();
1676 $big = new Math::BigInt '0' if $big->is_neg();
1677 my $att = "Chillispot-Max-\u$what";
1678 $reply{"$att-Octets"} = $big->copy->band(0xffffffff)->bstr;
1679 $reply{"$att-Gigawords"} = $big->copy->brsft(32)->bstr;
1690 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1691 check attributes of this record.
1693 Note that this is now the preferred method for reading RADIUS attributes -
1694 accessing the columns directly is discouraged, as the column names are
1695 expected to change in the future.
1702 return %{ $self->{'radius_check'} }
1703 if exists $self->{'radius_check'};
1708 my($column, $attrib) = ($1, $2);
1709 #$attrib =~ s/_/\-/g;
1710 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1711 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1714 my($pw_attrib, $password) = $self->radius_password;
1715 $check{$pw_attrib} = $password;
1717 my $cust_svc = $self->cust_svc;
1719 my $cust_pkg = $cust_svc->cust_pkg;
1720 if ( $cust_pkg && $cust_pkg->part_pkg->is_prepaid && $cust_pkg->bill ) {
1721 $check{'Expiration'} = time2str('%B %e %Y %T', $cust_pkg->bill ); #http://lists.cistron.nl/pipermail/freeradius-users/2005-January/040184.html
1724 warn "WARNING: no cust_svc record for svc_acct.svcnum ". $self->svcnum.
1725 "; can't set Expiration\n"
1733 =item radius_password
1735 Returns a key/value pair containing the RADIUS attribute name and value
1740 sub radius_password {
1744 if ( $self->_password_encoding eq 'ldap' ) {
1745 $pw_attrib = 'Password-With-Header';
1746 } elsif ( $self->_password_encoding eq 'crypt' ) {
1747 $pw_attrib = 'Crypt-Password';
1748 } elsif ( $self->_password_encoding eq 'plain' ) {
1749 $pw_attrib = $radius_password;
1751 $pw_attrib = length($self->_password) <= 12
1756 ($pw_attrib, $self->_password);
1762 This method instructs the object to "snapshot" or freeze RADIUS check and
1763 reply attributes to the current values.
1767 #bah, my english is too broken this morning
1768 #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
1769 #the FS::cust_pkg's replace method to trigger the correct export updates when
1770 #package dates change)
1775 $self->{$_} = { $self->$_() }
1776 foreach qw( radius_reply radius_check );
1780 =item forget_snapshot
1782 This methos instructs the object to forget any previously snapshotted
1783 RADIUS check and reply attributes.
1787 sub forget_snapshot {
1791 foreach qw( radius_reply radius_check );
1795 =item domain [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1797 Returns the domain associated with this account.
1799 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1806 die "svc_acct.domsvc is null for svcnum ". $self->svcnum unless $self->domsvc;
1807 my $svc_domain = $self->svc_domain(@_)
1808 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1809 $svc_domain->domain;
1814 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1818 #inherited from svc_Common
1820 =item email [ END_TIMESTAMP [ START_TIMESTAMP ] ]
1822 Returns an email address associated with the account.
1824 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
1831 $self->username. '@'. $self->domain(@_);
1837 Returns an array of FS::acct_snarf records associated with the account.
1841 # unused as originally intended, but now by Communigate Pro "RPOP"
1843 =item cgp_rpop_hashref
1845 Returns an arrayref of RPOP data suitable for Communigate Pro API commands.
1849 sub cgp_rpop_hashref {
1851 { map { $_->snarfname => $_->cgp_hashref } $self->acct_snarf };
1854 =item decrement_upbytes OCTETS
1856 Decrements the I<upbytes> field of this record by the given amount. If there
1857 is an error, returns the error, otherwise returns false.
1861 sub decrement_upbytes {
1862 shift->_op_usage('-', 'upbytes', @_);
1865 =item increment_upbytes OCTETS
1867 Increments the I<upbytes> field of this record by the given amount. If there
1868 is an error, returns the error, otherwise returns false.
1872 sub increment_upbytes {
1873 shift->_op_usage('+', 'upbytes', @_);
1876 =item decrement_downbytes OCTETS
1878 Decrements the I<downbytes> field of this record by the given amount. If there
1879 is an error, returns the error, otherwise returns false.
1883 sub decrement_downbytes {
1884 shift->_op_usage('-', 'downbytes', @_);
1887 =item increment_downbytes OCTETS
1889 Increments the I<downbytes> field of this record by the given amount. If there
1890 is an error, returns the error, otherwise returns false.
1894 sub increment_downbytes {
1895 shift->_op_usage('+', 'downbytes', @_);
1898 =item decrement_totalbytes OCTETS
1900 Decrements the I<totalbytes> field of this record by the given amount. If there
1901 is an error, returns the error, otherwise returns false.
1905 sub decrement_totalbytes {
1906 shift->_op_usage('-', 'totalbytes', @_);
1909 =item increment_totalbytes OCTETS
1911 Increments the I<totalbytes> field of this record by the given amount. If there
1912 is an error, returns the error, otherwise returns false.
1916 sub increment_totalbytes {
1917 shift->_op_usage('+', 'totalbytes', @_);
1920 =item decrement_seconds SECONDS
1922 Decrements the I<seconds> field of this record by the given amount. If there
1923 is an error, returns the error, otherwise returns false.
1927 sub decrement_seconds {
1928 shift->_op_usage('-', 'seconds', @_);
1931 =item increment_seconds SECONDS
1933 Increments the I<seconds> field of this record by the given amount. If there
1934 is an error, returns the error, otherwise returns false.
1938 sub increment_seconds {
1939 shift->_op_usage('+', 'seconds', @_);
1947 my %op2condition = (
1948 '-' => sub { my($self, $column, $amount) = @_;
1949 $self->$column - $amount <= 0;
1951 '+' => sub { my($self, $column, $amount) = @_;
1952 ($self->$column || 0) + $amount > 0;
1955 my %op2warncondition = (
1956 '-' => sub { my($self, $column, $amount) = @_;
1957 my $threshold = $column . '_threshold';
1958 $self->$column - $amount <= $self->$threshold + 0;
1960 '+' => sub { my($self, $column, $amount) = @_;
1961 ($self->$column || 0) + $amount > 0;
1966 my( $self, $op, $column, $amount ) = @_;
1968 warn "$me _op_usage called for $column on svcnum ". $self->svcnum.
1969 ' ('. $self->email. "): $op $amount\n"
1972 return '' unless $amount;
1974 local $SIG{HUP} = 'IGNORE';
1975 local $SIG{INT} = 'IGNORE';
1976 local $SIG{QUIT} = 'IGNORE';
1977 local $SIG{TERM} = 'IGNORE';
1978 local $SIG{TSTP} = 'IGNORE';
1979 local $SIG{PIPE} = 'IGNORE';
1981 my $oldAutoCommit = $FS::UID::AutoCommit;
1982 local $FS::UID::AutoCommit = 0;
1985 my $sql = "UPDATE svc_acct SET $column = ".
1986 " CASE WHEN $column IS NULL THEN 0 ELSE $column END ". #$column||0
1987 " $op ? WHERE svcnum = ?";
1991 my $sth = $dbh->prepare( $sql )
1992 or die "Error preparing $sql: ". $dbh->errstr;
1993 my $rv = $sth->execute($amount, $self->svcnum);
1994 die "Error executing $sql: ". $sth->errstr
1995 unless defined($rv);
1996 die "Can't update $column for svcnum". $self->svcnum
1999 #$self->snapshot; #not necessary, we retain the old values
2000 #create an object with the updated usage values
2001 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2003 my $error = $new->replace($self);
2005 $dbh->rollback if $oldAutoCommit;
2006 return "Error replacing: $error";
2009 #overlimit_action eq 'cancel' handling
2010 my $cust_pkg = $self->cust_svc->cust_pkg;
2012 && $cust_pkg->part_pkg->option('overlimit_action', 1) eq 'cancel'
2013 && $op eq '-' && &{$op2condition{$op}}($self, $column, $amount)
2017 my $error = $cust_pkg->cancel; #XXX should have a reason
2019 $dbh->rollback if $oldAutoCommit;
2020 return "Error cancelling: $error";
2023 #nothing else is relevant if we're cancelling, so commit & return success
2024 warn "$me update successful; committing\n"
2026 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2031 my $action = $op2action{$op};
2033 if ( &{$op2condition{$op}}($self, $column, $amount) &&
2034 ( $action eq 'suspend' && !$self->overlimit
2035 || $action eq 'unsuspend' && $self->overlimit )
2038 my $error = $self->_op_overlimit($action);
2040 $dbh->rollback if $oldAutoCommit;
2046 if ( $conf->exists("svc_acct-usage_$action")
2047 && &{$op2condition{$op}}($self, $column, $amount) ) {
2048 #my $error = $self->$action();
2049 my $error = $self->cust_svc->cust_pkg->$action();
2050 # $error ||= $self->overlimit($action);
2052 $dbh->rollback if $oldAutoCommit;
2053 return "Error ${action}ing: $error";
2057 if ($warning_msgnum && &{$op2warncondition{$op}}($self, $column, $amount)) {
2058 my $wqueue = new FS::queue {
2059 'svcnum' => $self->svcnum,
2060 'job' => 'FS::svc_acct::reached_threshold',
2064 my $error = $wqueue->insert(
2065 'svcnum' => $self->svcnum,
2070 $dbh->rollback if $oldAutoCommit;
2071 return "Error queuing threshold activity: $error";
2075 warn "$me update successful; committing\n"
2077 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2083 my( $self, $action ) = @_;
2085 local $SIG{HUP} = 'IGNORE';
2086 local $SIG{INT} = 'IGNORE';
2087 local $SIG{QUIT} = 'IGNORE';
2088 local $SIG{TERM} = 'IGNORE';
2089 local $SIG{TSTP} = 'IGNORE';
2090 local $SIG{PIPE} = 'IGNORE';
2092 my $oldAutoCommit = $FS::UID::AutoCommit;
2093 local $FS::UID::AutoCommit = 0;
2096 my $cust_pkg = $self->cust_svc->cust_pkg;
2098 my @conf_overlimit =
2100 ? $conf->config('overlimit_groups', $cust_pkg->cust_main->agentnum )
2101 : $conf->config('overlimit_groups');
2103 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
2105 my @groups = scalar(@conf_overlimit) ? @conf_overlimit
2106 : split(' ',$part_export->option('overlimit_groups'));
2107 next unless scalar(@groups);
2109 my $other = new FS::svc_acct $self->hashref;
2110 $other->usergroup(\@groups);
2113 if ($action eq 'suspend') {
2116 } else { # $action eq 'unsuspend'
2121 my $error = $part_export->export_replace($new, $old)
2122 || $self->overlimit($action);
2125 $dbh->rollback if $oldAutoCommit;
2126 return "Error replacing radius groups: $error";
2131 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2137 my( $self, $valueref, %options ) = @_;
2139 warn "$me set_usage called for svcnum ". $self->svcnum.
2140 ' ('. $self->email. "): ".
2141 join(', ', map { "$_ => " . $valueref->{$_}} keys %$valueref) . "\n"
2144 local $SIG{HUP} = 'IGNORE';
2145 local $SIG{INT} = 'IGNORE';
2146 local $SIG{QUIT} = 'IGNORE';
2147 local $SIG{TERM} = 'IGNORE';
2148 local $SIG{TSTP} = 'IGNORE';
2149 local $SIG{PIPE} = 'IGNORE';
2151 local $FS::svc_Common::noexport_hack = 1;
2152 my $oldAutoCommit = $FS::UID::AutoCommit;
2153 local $FS::UID::AutoCommit = 0;
2158 if ( $options{null} ) {
2159 %handyhash = ( map { ( $_ => undef, $_."_threshold" => undef ) }
2160 qw( seconds upbytes downbytes totalbytes )
2163 foreach my $field (keys %$valueref){
2164 $reset = 1 if $valueref->{$field};
2165 $self->setfield($field, $valueref->{$field});
2166 $self->setfield( $field.'_threshold',
2167 int($self->getfield($field)
2168 * ( $conf->exists('svc_acct-usage_threshold')
2169 ? 1 - $conf->config('svc_acct-usage_threshold')/100
2174 $handyhash{$field} = $self->getfield($field);
2175 $handyhash{$field.'_threshold'} = $self->getfield($field.'_threshold');
2177 #my $error = $self->replace; #NO! we avoid the call to ->check for
2178 #die $error if $error; #services not explicity changed via the UI
2180 my $sql = "UPDATE svc_acct SET " .
2181 join (',', map { "$_ = ?" } (keys %handyhash) ).
2182 " WHERE svcnum = ". $self->svcnum;
2187 if (scalar(keys %handyhash)) {
2188 my $sth = $dbh->prepare( $sql )
2189 or die "Error preparing $sql: ". $dbh->errstr;
2190 my $rv = $sth->execute(values %handyhash);
2191 die "Error executing $sql: ". $sth->errstr
2192 unless defined($rv);
2193 die "Can't update usage for svcnum ". $self->svcnum
2197 #$self->snapshot; #not necessary, we retain the old values
2198 #create an object with the updated usage values
2199 my $new = qsearchs('svc_acct', { 'svcnum' => $self->svcnum });
2200 local($FS::Record::nowarn_identical) = 1;
2201 my $error = $new->replace($self); #call exports
2203 $dbh->rollback if $oldAutoCommit;
2204 return "Error replacing: $error";
2211 $error = $self->_op_overlimit('unsuspend')
2212 if $self->overlimit;;
2214 $error ||= $self->cust_svc->cust_pkg->unsuspend
2215 if $conf->exists("svc_acct-usage_unsuspend");
2218 $dbh->rollback if $oldAutoCommit;
2219 return "Error unsuspending: $error";
2224 warn "$me update successful; committing\n"
2226 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2232 =item recharge HASHREF
2234 Increments usage columns by the amount specified in HASHREF as
2235 column=>amount pairs.
2240 my ($self, $vhash) = @_;
2243 warn "[$me] recharge called on $self: ". Dumper($self).
2244 "\nwith vhash: ". Dumper($vhash);
2247 my $oldAutoCommit = $FS::UID::AutoCommit;
2248 local $FS::UID::AutoCommit = 0;
2252 foreach my $column (keys %$vhash){
2253 $error ||= $self->_op_usage('+', $column, $vhash->{$column});
2257 $dbh->rollback if $oldAutoCommit;
2259 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2264 =item is_rechargeable
2266 Returns true if this svc_account can be "recharged" and false otherwise.
2270 sub is_rechargable {
2272 $self->seconds ne ''
2273 || $self->upbytes ne ''
2274 || $self->downbytes ne ''
2275 || $self->totalbytes ne '';
2278 =item seconds_since TIMESTAMP
2280 Returns the number of seconds this account has been online since TIMESTAMP,
2281 according to the session monitor (see L<FS::Session>).
2283 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2284 L<Time::Local> and L<Date::Parse> for conversion functions.
2288 #note: POD here, implementation in FS::cust_svc
2291 $self->cust_svc->seconds_since(@_);
2294 =item last_login_text
2296 Returns text describing the time of last login.
2300 sub last_login_text {
2302 $self->last_login ? ctime($self->last_login) : 'unknown';
2305 =item psearch_cdrs OPTIONS
2307 Returns a paged search (L<FS::PagedSearch>) for Call Detail Records
2308 associated with this service. For svc_acct, "associated with" means that
2309 either the "src" or the "charged_party" field of the CDR matches either
2310 the "username" field of the service or the username@domain label.
2315 my($self, %options) = @_;
2320 my $did = dbh->quote($self->username);
2321 my $diddomain = dbh->quote($self->label);
2323 my $prefix = $options{'default_prefix'} || ''; #convergent.au '+61'
2324 my $prefixdid = dbh->quote($prefix . $self->username);
2326 my $for_update = $options{'for_update'} ? 'FOR UPDATE' : '';
2328 if ( $options{inbound} ) {
2329 # these will be selected under their DIDs
2330 push @where, "FALSE";
2334 if (!$options{'disable_charged_party'}) {
2336 "charged_party = $did",
2337 "charged_party = $prefixdid",
2338 "charged_party = $diddomain"
2341 if (!$options{'disable_src'}) {
2343 "src = $did AND charged_party IS NULL",
2344 "src = $prefixdid AND charged_party IS NULL",
2345 "src = $diddomain AND charged_party IS NULL"
2348 push @where, '(' . join(' OR ', @orwhere) . ')';
2350 # $options{'status'} = '' is meaningful; for the rest of them it's not
2351 if ( exists $options{'status'} ) {
2352 $hash{'freesidestatus'} = $options{'status'};
2354 if ( $options{'cdrtypenum'} ) {
2355 $hash{'cdrtypenum'} = $options{'cdrtypenum'};
2357 if ( $options{'calltypenum'} ) {
2358 $hash{'calltypenum'} = $options{'calltypenum'};
2360 if ( $options{'begin'} ) {
2361 push @where, 'startdate >= '. $options{'begin'};
2363 if ( $options{'end'} ) {
2364 push @where, 'startdate < '. $options{'end'};
2366 if ( $options{'nonzero'} ) {
2367 push @where, 'duration > 0';
2370 my $extra_sql = join(' AND ', @where);
2373 $extra_sql = " AND ".$extra_sql;
2375 $extra_sql = " WHERE ".$extra_sql;
2381 'hashref' => \%hash,
2382 'extra_sql' => $extra_sql,
2383 'order_by' => "ORDER BY startdate $for_update",
2387 =item get_cdrs (DEPRECATED)
2389 Like psearch_cdrs, but returns all the L<FS::cdr> objects at once, in a
2390 single list. Arguments are the same as for psearch_cdrs.
2396 my $psearch = $self->psearch_cdrs(@_);
2397 qsearch ( $psearch->{query} )
2400 # sub radius_groups has moved to svc_Radius_Mixin
2402 =item clone_suspended
2404 Constructor used by FS::part_export::_export_suspend fallback. Document
2409 sub clone_suspended {
2411 my %hash = $self->hash;
2412 $hash{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) );
2413 new FS::svc_acct \%hash;
2416 =item clone_kludge_unsuspend
2418 Constructor used by FS::part_export::_export_unsuspend fallback. Document
2423 sub clone_kludge_unsuspend {
2425 my %hash = $self->hash;
2426 $hash{_password} = '';
2427 new FS::svc_acct \%hash;
2430 =item check_password
2432 Checks the supplied password against the (possibly encrypted) password in the
2433 database. Returns true for a successful authentication, false for no match.
2435 Currently supported encryptions are: classic DES crypt() and MD5
2439 sub check_password {
2440 my($self, $check_password) = @_;
2442 #remove old-style SUSPENDED kludge, they should be allowed to login to
2443 #self-service and pay up
2444 ( my $password = $self->_password ) =~ s/^\*SUSPENDED\* //;
2446 if ( $self->_password_encoding eq 'ldap' ) {
2448 $password =~ s/^{PLAIN}/{CLEARTEXT}/;
2449 my $auth = from_rfc2307 Authen::Passphrase $password;
2450 return $auth->match($check_password);
2452 } elsif ( $self->_password_encoding eq 'crypt' ) {
2454 my $auth = from_crypt Authen::Passphrase $self->_password;
2455 return $auth->match($check_password);
2457 } elsif ( $self->_password_encoding eq 'plain' ) {
2459 return $check_password eq $password;
2463 #XXX this could be replaced with Authen::Passphrase stuff
2465 if ( $password =~ /^(\*|!!?)$/ ) { #no self-service login
2467 } elsif ( length($password) < 13 ) { #plaintext
2468 $check_password eq $password;
2469 } elsif ( length($password) == 13 ) { #traditional DES crypt
2470 crypt($check_password, $password) eq $password;
2471 } elsif ( $password =~ /^\$1\$/ ) { #MD5 crypt
2472 unix_md5_crypt($check_password, $password) eq $password;
2473 } elsif ( $password =~ /^\$2a?\$/ ) { #Blowfish
2474 warn "Can't check password: Blowfish encryption not yet supported, ".
2475 "svcnum ". $self->svcnum. "\n";
2478 warn "Can't check password: Unrecognized encryption for svcnum ".
2479 $self->svcnum. "\n";
2487 =item crypt_password [ DEFAULT_ENCRYPTION_TYPE ]
2489 Returns an encrypted password, either by passing through an encrypted password
2490 in the database or by encrypting a plaintext password from the database.
2492 The optional DEFAULT_ENCRYPTION_TYPE parameter can be set to I<crypt> (classic
2493 UNIX DES crypt), I<md5> (md5 crypt supported by most modern Linux and BSD
2494 distrubtions), or (eventually) I<blowfish> (blowfish hashing supported by
2495 OpenBSD, SuSE, other Linux distibutions with pam_unix2, etc.). The default
2496 encryption type is only used if the password is not already encrypted in the
2501 sub crypt_password {
2504 if ( $self->_password_encoding eq 'ldap' ) {
2506 if ( $self->_password =~ /^\{(PLAIN|CLEARTEXT)\}(.+)$/ ) {
2509 #XXX this could be replaced with Authen::Passphrase stuff
2511 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2512 if ( $encryption eq 'crypt' ) {
2515 $saltset[int(rand(64))].$saltset[int(rand(64))]
2517 } elsif ( $encryption eq 'md5' ) {
2518 return unix_md5_crypt( $self->_password );
2519 } elsif ( $encryption eq 'blowfish' ) {
2520 croak "unknown encryption method $encryption";
2522 croak "unknown encryption method $encryption";
2525 } elsif ( $self->_password =~ /^\{CRYPT\}(.+)$/ ) {
2529 } elsif ( $self->_password_encoding eq 'crypt' ) {
2531 return $self->_password;
2533 } elsif ( $self->_password_encoding eq 'plain' ) {
2535 #XXX this could be replaced with Authen::Passphrase stuff
2537 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2538 if ( $encryption eq 'crypt' ) {
2541 $saltset[int(rand(64))].$saltset[int(rand(64))]
2543 } elsif ( $encryption eq 'md5' ) {
2544 return unix_md5_crypt( $self->_password );
2545 } elsif ( $encryption eq 'sha1_base64' ) { #for acct_sql
2546 my $pass = sha1_base64( $self->_password );
2547 $pass .= '=' x (4 - length($pass) % 4); #properly padded base64
2549 } elsif ( $encryption eq 'blowfish' ) {
2550 croak "unknown encryption method $encryption";
2552 croak "unknown encryption method $encryption";
2557 if ( length($self->_password) == 13
2558 || $self->_password =~ /^\$(1|2a?)\$/
2559 || $self->_password =~ /^(\*|NP|\*LK\*|!!?)$/
2565 #XXX this could be replaced with Authen::Passphrase stuff
2567 my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2568 if ( $encryption eq 'crypt' ) {
2571 $saltset[int(rand(64))].$saltset[int(rand(64))]
2573 } elsif ( $encryption eq 'md5' ) {
2574 return unix_md5_crypt( $self->_password );
2575 } elsif ( $encryption eq 'blowfish' ) {
2576 croak "unknown encryption method $encryption";
2578 croak "unknown encryption method $encryption";
2587 =item ldap_password [ DEFAULT_ENCRYPTION_TYPE ]
2589 Returns an encrypted password in "LDAP" format, with a curly-bracked prefix
2590 describing the format, for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or
2591 "{MD5}5426824942db4253f87a1009fd5d2d4".
2593 The optional DEFAULT_ENCRYPTION_TYPE is not yet used, but the idea is for it
2594 to work the same as the B</crypt_password> method.
2600 #eventually should check a "password-encoding" field
2602 if ( $self->_password_encoding eq 'ldap' ) {
2604 return $self->_password;
2606 } elsif ( $self->_password_encoding eq 'crypt' ) {
2608 if ( length($self->_password) == 13 ) { #crypt
2609 return '{CRYPT}'. $self->_password;
2610 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2612 #} elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2613 # die "Blowfish encryption not supported in this context, svcnum ".
2614 # $self->svcnum. "\n";
2616 warn "encryption method not (yet?) supported in LDAP context";
2617 return '{CRYPT}*'; #unsupported, should not auth
2620 } elsif ( $self->_password_encoding eq 'plain' ) {
2622 return '{PLAIN}'. $self->_password;
2624 #return '{CLEARTEXT}'. $self->_password; #?
2628 if ( length($self->_password) == 13 ) { #crypt
2629 return '{CRYPT}'. $self->_password;
2630 } elsif ( $self->_password =~ /^\$1\$(.*)$/ && length($1) == 31 ) { #passwdMD5
2632 } elsif ( $self->_password =~ /^\$2a?\$(.*)$/ ) { #Blowfish
2633 warn "Blowfish encryption not supported in this context, svcnum ".
2634 $self->svcnum. "\n";
2637 #are these two necessary anymore?
2638 } elsif ( $self->_password =~ /^(\w{48})$/ ) { #LDAP SSHA
2639 return '{SSHA}'. $1;
2640 } elsif ( $self->_password =~ /^(\w{64})$/ ) { #LDAP NS-MTA-MD5
2641 return '{NS-MTA-MD5}'. $1;
2644 return '{PLAIN}'. $self->_password;
2646 #return '{CLEARTEXT}'. $self->_password; #?
2648 #XXX this could be replaced with Authen::Passphrase stuff if it gets used
2649 #my $encryption = ( scalar(@_) && $_[0] ) ? shift : 'crypt';
2650 #if ( $encryption eq 'crypt' ) {
2651 # return '{CRYPT}'. crypt(
2653 # $saltset[int(rand(64))].$saltset[int(rand(64))]
2655 #} elsif ( $encryption eq 'md5' ) {
2656 # unix_md5_crypt( $self->_password );
2657 #} elsif ( $encryption eq 'blowfish' ) {
2658 # croak "unknown encryption method $encryption";
2660 # croak "unknown encryption method $encryption";
2668 =item domain_slash_username
2670 Returns $domain/$username/
2674 sub domain_slash_username {
2676 $self->domain. '/'. $self->username. '/';
2679 =item virtual_maildir
2681 Returns $domain/maildirs/$username/
2685 sub virtual_maildir {
2687 $self->domain. '/maildirs/'. $self->username. '/';
2690 =item password_svc_check
2692 Override, for L<FS::Password_Mixin>. Not really intended for other use.
2696 sub password_svc_check {
2697 my ($self, $password) = @_;
2698 foreach my $field ( qw(username finger) ) {
2699 foreach my $word (split(/\W+/,$self->get($field))) {
2700 next unless length($word) > 2;
2701 if ($password =~ /$word/i) {
2702 return qq(Password contains account information '$word');
2711 =head1 CLASS METHODS
2715 =item search HASHREF
2717 Class method which returns a qsearch hash expression to search for parameters
2718 specified in HASHREF. Valid parameters are
2732 Arrayref of pkgparts
2738 Arrayref of additional WHERE clauses, will be ANDed together.
2749 my( $class, $params, $from, $where ) = @_;
2751 #these two should probably move to svc_Domain_Mixin ?
2754 if ( $params->{'domain'} ) {
2755 my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
2756 #preserve previous behavior & bubble up an error if $svc_domain not found?
2757 push @$where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
2761 if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
2762 push @$where, "domsvc = $1";
2767 if ( $params->{'popnum'} =~ /^(\d+)$/ ) {
2768 push @$where, "popnum = $1";
2772 #and these in svc_Tower_Mixin, or maybe we never should have done svc_acct
2773 # towers (or, as mark thought, never should have done svc_broadband)
2776 my @where_sector = $class->tower_sector_sql($params);
2777 if ( @where_sector ) {
2778 push @$where, @where_sector;
2779 push @$from, ' LEFT JOIN tower_sector USING ( sectornum )';
2790 =item check_and_rebuild_fuzzyfiles
2794 sub check_and_rebuild_fuzzyfiles {
2795 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2796 -e "$dir/svc_acct.username"
2797 or &rebuild_fuzzyfiles;
2800 =item rebuild_fuzzyfiles
2804 sub rebuild_fuzzyfiles {
2806 use Fcntl qw(:flock);
2808 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2812 open(USERNAMELOCK,">>$dir/svc_acct.username")
2813 or die "can't open $dir/svc_acct.username: $!";
2814 flock(USERNAMELOCK,LOCK_EX)
2815 or die "can't lock $dir/svc_acct.username: $!";
2817 my @all_username = map $_->getfield('username'), qsearch('svc_acct', {});
2819 open (USERNAMECACHE,">$dir/svc_acct.username.tmp")
2820 or die "can't open $dir/svc_acct.username.tmp: $!";
2821 print USERNAMECACHE join("\n", @all_username), "\n";
2822 close USERNAMECACHE or die "can't close $dir/svc_acct.username.tmp: $!";
2824 rename "$dir/svc_acct.username.tmp", "$dir/svc_acct.username";
2834 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2835 open(USERNAMECACHE,"<$dir/svc_acct.username")
2836 or die "can't open $dir/svc_acct.username: $!";
2837 my @array = map { chomp; $_; } <USERNAMECACHE>;
2838 close USERNAMECACHE;
2842 =item append_fuzzyfiles USERNAME
2846 sub append_fuzzyfiles {
2847 my $username = shift;
2849 &check_and_rebuild_fuzzyfiles;
2851 use Fcntl qw(:flock);
2853 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2855 open(USERNAME,">>$dir/svc_acct.username")
2856 or die "can't open $dir/svc_acct.username: $!";
2857 flock(USERNAME,LOCK_EX)
2858 or die "can't lock $dir/svc_acct.username: $!";
2860 print USERNAME "$username\n";
2862 flock(USERNAME,LOCK_UN)
2863 or die "can't unlock $dir/svc_acct.username: $!";
2870 =item reached_threshold
2872 Performs some activities when svc_acct thresholds (such as number of seconds
2873 remaining) are reached.
2877 sub reached_threshold {
2880 my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $opt{'svcnum'} } );
2881 die "Cannot find svc_acct with svcnum " . $opt{'svcnum'} unless $svc_acct;
2883 if ( $opt{'op'} eq '+' ){
2884 $svc_acct->setfield( $opt{'column'}.'_threshold',
2885 int($svc_acct->getfield($opt{'column'})
2886 * ( $conf->exists('svc_acct-usage_threshold')
2887 ? $conf->config('svc_acct-usage_threshold')/100
2892 my $error = $svc_acct->replace;
2893 die $error if $error;
2894 }elsif ( $opt{'op'} eq '-' ){
2896 my $threshold = $svc_acct->getfield( $opt{'column'}.'_threshold' );
2897 return '' if ($threshold eq '' );
2899 $svc_acct->setfield( $opt{'column'}.'_threshold', 0 );
2900 my $error = $svc_acct->replace;
2901 die $error if $error; # email next time, i guess
2903 if ( $warning_msgnum ) {
2905 my $msg_template = qsearchs('msg_template',{ msgnum => $warning_msgnum });
2906 die "Could not load template for threshold_warning_msgnum ($warning_msgnum)" unless $msg_template;
2908 my $cust_main = $svc_acct->cust_svc->cust_pkg->cust_main;
2910 my $to = join(', ', $cust_main->invoicing_list_emailonly );
2912 my $error = $msg_template->send(
2913 cust_main => $cust_main,
2914 object => $svc_acct,
2917 # have to override these, because we changed threshold above
2918 'column' => $opt{'column'},
2919 'amount' => $opt{'column'} =~/bytes/
2920 ? FS::UI::bytecount::display_bytecount($svc_acct->getfield($opt{'column'}))
2921 : $svc_acct->getfield($opt{'column'}),
2922 'threshold' => $opt{'column'} =~/bytes/
2923 ? FS::UI::bytecount::display_bytecount($threshold)
2928 die "Error sending threshold warning email: $error" if $error;
2932 die "unknown op: " . $opt{'op'};
2940 The $recref stuff in sub check should be cleaned up.
2942 The suspend, unsuspend and cancel methods update the database, but not the
2943 current object. This is probably a bug as it's unexpected and
2946 insertion of RADIUS group stuff in insert could be done with child_objects now
2947 (would probably clean up export of them too)
2949 _op_usage and set_usage bypass the history... maybe they shouldn't
2953 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
2954 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
2955 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
2956 L<freeside-queued>), L<FS::svc_acct_pop>,
2957 schema.html from the base documentation.