4 use vars qw( @ISA $nossh_hack $conf $dir_prefix @shells $usernamemin
5 $usernamemax $passwordmin $passwordmax
6 $username_ampersand $username_letter $username_letterfirst
7 $username_noperiod $username_uppercase
8 $shellmachine $useradd $usermod $userdel $mydomain
9 $cyrus_server $cyrus_admin_user $cyrus_admin_pass
10 $cp_server $cp_user $cp_pass $cp_workgroup
14 $rsync $ssh $exportdir $vpopdir);
18 use FS::UID qw( datasrc );
20 use FS::Record qw( qsearch qsearchs fields dbh );
26 use FS::cust_main_invoice;
31 @ISA = qw( FS::svc_Common );
33 #ask FS::UID to run this stuff for us later
34 $FS::UID::callback{'FS::svc_acct'} = sub {
38 $dir_prefix = $conf->config('home');
39 @shells = $conf->config('shells');
40 $shellmachine = $conf->config('shellmachine');
41 $usernamemin = $conf->config('usernamemin') || 2;
42 $usernamemax = $conf->config('usernamemax');
43 $passwordmin = $conf->config('passwordmin') || 6;
44 $passwordmax = $conf->config('passwordmax') || 8;
45 if ( $shellmachine ) {
46 if ( $conf->exists('shellmachine-useradd') ) {
47 $useradd = join("\n", $conf->config('shellmachine-useradd') )
48 || 'cp -pr /etc/skel $dir; chown -R $uid.$gid $dir';
50 $useradd = 'useradd -d $dir -m -s $shell -u $uid $username';
52 if ( $conf->exists('shellmachine-userdel') ) {
53 $userdel = join("\n", $conf->config('shellmachine-userdel') )
56 $userdel = 'userdel $username';
58 $usermod = join("\n", $conf->config('shellmachine-usermod') )
59 || '[ -d $old_dir ] && mv $old_dir $new_dir || ( '.
60 'chmod u+t $old_dir; mkdir $new_dir; cd $old_dir; '.
61 'find . -depth -print | cpio -pdm $new_dir; '.
62 'chmod u-t $new_dir; chown -R $uid.$gid $new_dir; '.
66 $username_letter = $conf->exists('username-letter');
67 $username_letterfirst = $conf->exists('username-letterfirst');
68 $username_noperiod = $conf->exists('username-noperiod');
69 $username_uppercase = $conf->exists('username-uppercase');
70 $username_ampersand = $conf->exists('username-ampersand');
71 $mydomain = $conf->config('domain');
72 if ( $conf->exists('cyrus') ) {
73 ($cyrus_server, $cyrus_admin_user, $cyrus_admin_pass) =
74 $conf->config('cyrus');
75 eval "use Cyrus::IMAP::Admin;"
78 $cyrus_admin_user = '';
79 $cyrus_admin_pass = '';
81 if ( $conf->exists('cp_app') ) {
82 ($cp_server, $cp_user, $cp_pass, $cp_workgroup) =
83 $conf->config('cp_app');
91 if ( $conf->exists('icradiusmachines') ) {
92 if ( $conf->exists('icradius_secrets') ) {
93 #need some sort of late binding so it's only connected to when
95 $icradius_dbh = DBI->connect($conf->config('icradius_secrets'))
103 $dirhash = $conf->config('dirhash') || 0;
104 $exportdir = "/usr/local/etc/freeside/export." . datasrc;
105 if ( $conf->exists('vpopmailmachines') ) {
106 my (@vpopmailmachines) = $conf->config('vpopmailmachines');
107 my ($machine, $dir, $uid, $gid) = split (/\s+/, $vpopmailmachines[0]);
114 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
115 @pw_set = ( 'a'..'z', 'A'..'Z', '0'..'9', '(', ')', '#', '!', '.', ',' );
117 #not needed in 5.004 #srand($$|time);
121 my ( $hashref, $cache ) = @_;
122 if ( $hashref->{'svc_acct_svcnum'} ) {
123 $self->{'_domsvc'} = FS::svc_domain->new( {
124 'svcnum' => $hashref->{'domsvc'},
125 'domain' => $hashref->{'svc_acct_domain'},
126 'catchall' => $hashref->{'svc_acct_catchall'},
133 FS::svc_acct - Object methods for svc_acct records
139 $record = new FS::svc_acct \%hash;
140 $record = new FS::svc_acct { 'column' => 'value' };
142 $error = $record->insert;
144 $error = $new_record->replace($old_record);
146 $error = $record->delete;
148 $error = $record->check;
150 $error = $record->suspend;
152 $error = $record->unsuspend;
154 $error = $record->cancel;
156 %hash = $record->radius;
158 %hash = $record->radius_reply;
160 %hash = $record->radius_check;
162 $domain = $record->domain;
164 $svc_domain = $record->svc_domain;
166 $email = $record->email;
168 $seconds_since = $record->seconds_since($timestamp);
172 An FS::svc_acct object represents an account. FS::svc_acct inherits from
173 FS::svc_Common. The following fields are currently supported:
177 =item svcnum - primary key (assigned automatcially for new accounts)
181 =item _password - generated if blank
183 =item popnum - Point of presence (see L<FS::svc_acct_pop>)
191 =item dir - set automatically if blank (and uid is not)
195 =item quota - (unimplementd)
197 =item slipip - IP address
201 =item domsvc - svcnum from svc_domain
203 =item radius_I<Radius_Attribute> - I<Radius-Attribute>
205 =item domsvc - service number of svc_domain with which to associate
215 Creates a new account. To add the account to the database, see L<"insert">.
219 sub table { 'svc_acct'; }
223 Adds this account to the database. If there is an error, returns the error,
224 otherwise returns false.
226 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
227 defined. An FS::cust_svc record will be created and inserted.
229 If the configuration value (see L<FS::Conf>) shellmachine exists, and the
230 username, uid, and dir fields are defined, the command(s) specified in
231 the shellmachine-useradd configuration are added to the job queue (see
232 L<FS::queue> and L<freeside-queued>) to be exectued on shellmachine via ssh.
233 This behaviour can be surpressed by setting $FS::svc_acct::nossh_hack true.
234 If the shellmachine-useradd configuration file does not exist,
236 useradd -d $dir -m -s $shell -u $uid $username
238 is the default. If the shellmachine-useradd configuration file exists but
241 cp -pr /etc/skel $dir; chown -R $uid.$gid $dir
243 is the default instead. Otherwise the contents of the file are treated as
244 a double-quoted perl string, with the following variables available:
245 $username, $uid, $gid, $dir, and $shell.
247 (TODOC: cyrus config file, L<FS::queue> and L<freeside-queued>)
255 local $SIG{HUP} = 'IGNORE';
256 local $SIG{INT} = 'IGNORE';
257 local $SIG{QUIT} = 'IGNORE';
258 local $SIG{TERM} = 'IGNORE';
259 local $SIG{TSTP} = 'IGNORE';
260 local $SIG{PIPE} = 'IGNORE';
262 my $oldAutoCommit = $FS::UID::AutoCommit;
263 local $FS::UID::AutoCommit = 0;
268 $error = $self->check;
269 return $error if $error;
271 return "Username ". $self->username. " in use"
272 if qsearchs( 'svc_acct', { 'username' => $self->username,
273 'domsvc' => $self->domsvc,
276 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
277 return "Unknown svcpart" unless $part_svc;
279 if $part_svc->part_svc_column('uid')->columnflag ne 'F'
280 && qsearchs( 'svc_acct', { 'uid' => $self->uid } )
281 && $self->username !~ /^(hyla)?fax$/
284 $error = $self->SUPER::insert;
286 $dbh->rollback if $oldAutoCommit;
290 my( $username, $uid, $gid, $dir, $shell ) = (
297 if ( $username && $uid && $dir && $shellmachine && ! $nossh_hack ) {
298 my $queue = new FS::queue {
299 'svcnum' => $self->svcnum,
300 'job' => 'Net::SSH::ssh_cmd',
302 $error = $queue->insert("root\@$shellmachine", eval qq("$useradd") );
304 $dbh->rollback if $oldAutoCommit;
305 return "queueing job (transaction rolled back): $error";
309 if ( $cyrus_server ) {
310 my $queue = new FS::queue {
311 'svcnum' => $self->svcnum,
312 'job' => 'FS::svc_acct::cyrus_insert',
314 $error = $queue->insert($self->username, $self->quota);
316 $dbh->rollback if $oldAutoCommit;
317 return "queueing job (transaction rolled back): $error";
322 my $queue = new FS::queue {
323 'svcnum' => $self->svcnum,
324 'job' => 'FS::svc_acct::cp_insert'
326 $error = $queue->insert($self->username, $self->_password);
328 $dbh->rollback if $oldAutoCommit;
329 return "queueing job (transaction rolled back): $error";
333 if ( $icradius_dbh ) {
337 'svcnum' => $self->svcnum,
338 'job' => 'FS::svc_acct::icradius_rc_insert'
340 $error = $radcheck_queue->insert( $self->username,
345 $dbh->rollback if $oldAutoCommit;
346 return "queueing job (transaction rolled back): $error";
351 'svcnum' => $self->svcnum,
352 'job' => 'FS::svc_acct::icradius_rr_insert'
354 $error = $radreply_queue->insert( $self->username,
359 $dbh->rollback if $oldAutoCommit;
360 return "queueing job (transaction rolled back): $error";
368 'svcnum' => $self->svcnum,
369 'job' => 'FS::svc_acct::vpopmail_insert'
371 $error = $vpopmail_queue->insert( $self->username,
372 crypt($self->_password,$saltset[int(rand(64))].$saltset[int(rand(64))]),
377 $dbh->rollback if $oldAutoCommit;
378 return "queueing job (transaction rolled back): $error";
384 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
389 my( $username, $quota ) = @_;
391 warn "cyrus_insert: starting for user $username, quota $quota\n";
393 warn "cyrus_insert: connecting to $cyrus_server\n";
394 my $client = Cyrus::IMAP::Admin->new($cyrus_server);
396 warn "cyrus_insert: authentication as $cyrus_admin_user\n";
397 $client->authenticate(
398 -user => $cyrus_admin_user,
399 -mechanism => "login",
400 -password => $cyrus_admin_pass
403 warn "cyrus_insert: creating user.$username\n";
404 my $rc = $client->create("user.$username");
405 my $error = $client->error;
406 die "cyrus_insert: error creating user.$username: $error" if $error;
408 warn "cyrus_insert: setacl user.$username, $username => all\n";
409 $rc = $client->setacl("user.$username", $username => 'all' );
410 $error = $client->error;
411 die "cyrus_insert: error setacl user.$username: $error" if $error;
414 warn "cyrus_insert: setquota user.$username, STORAGE => $quota\n";
415 $rc = $client->setquota("user.$username", 'STORAGE' => $quota );
416 $error = $client->error;
417 die "cyrus_insert: error setquota user.$username: $error" if $error;
424 my( $username, $password ) = @_;
426 my $app = new Net::APP ( $cp_server,
428 Password => $cp_pass,
434 $app->create_mailbox(
435 Mailbox => $username,
436 Password => $password,
437 Workgroup => $cp_workgroup,
441 die $app->message."\n" unless $app->ok;
444 sub icradius_rc_insert {
445 my( $username, $password, %radcheck ) = @_;
447 my $sth = $icradius_dbh->prepare(
448 "INSERT INTO radcheck ( id, UserName, Attribute, Value ) VALUES ( ".
449 join(", ", map { $icradius_dbh->quote($_) } (
456 $sth->execute or die "can't insert into radcheck table: ". $sth->errstr;
458 foreach my $attribute ( keys %radcheck ) {
459 my $sth = $icradius_dbh->prepare(
460 "INSERT INTO radcheck ( id, UserName, Attribute, Value ) VALUES ( ".
461 join(", ", map { $icradius_dbh->quote($_) } (
465 $radcheck{$attribute},
468 $sth->execute or die "can't insert into radcheck table: ". $sth->errstr;
474 sub icradius_rr_insert {
475 my( $username, $password, %radreply ) = @_;
477 foreach my $attribute ( keys %radreply ) {
478 my $sth = $icradius_dbh->prepare(
479 "INSERT INTO radreply ( id, UserName, Attribute, Value ) VALUES ( ".
480 join(", ", map { $icradius_dbh->quote($_) } (
484 $radreply{$attribute},
487 $sth->execute or die "can't insert into radreply table: ". $sth->errstr;
494 sub vpopmail_insert {
495 my( $username, $password, $domain, $vpopdir ) = @_;
497 (open(VPASSWD, ">>$exportdir/domains/$domain/vpasswd")
498 and flock(VPASSWD,LOCK_EX)
499 ) or die "can't open vpasswd file for $username\@$domain: $exportdir/domains/$domain/vpasswd";
500 print VPASSWD join(":",
506 "$vpopdir/domains/$domain/$username",
510 flock(VPASSWD,LOCK_UN);
513 mkdir "$exportdir/domains/$domain/$username", 0700 or die "can't create Maildir";
514 mkdir "$exportdir/domains/$domain/$username/Maildir", 0700 or die "can't create Maildir";
515 mkdir "$exportdir/domains/$domain/$username/Maildir/cur", 0700 or die "can't create Maildir";
516 mkdir "$exportdir/domains/$domain/$username/Maildir/new", 0700 or die "can't create Maildir";
517 mkdir "$exportdir/domains/$domain/$username/Maildir/tmp", 0700 or die "can't create Maildir";
519 my $queue = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_sync' };
520 my $error = $queue->insert;
521 die $error if $error;
528 my (@vpopmailmachines) = $conf->config('vpopmailmachines');
529 my ($machine, $dir, $uid, $gid) = split (/\s+/, $vpopmailmachines[0]);
532 my @args = ("$rsync", "-rlpt", "-e", "$ssh", "domains/", "vpopmail\@$machine:$vpopdir/domains/");
533 system {$args[0]} @args;
539 Deletes this account from the database. If there is an error, returns the
540 error, otherwise returns false.
542 The corresponding FS::cust_svc record will be deleted as well.
544 If the configuration value (see L<FS::Conf>) shellmachine exists, the
545 command(s) specified in the shellmachine-userdel configuration file are
546 added to the job queue (see L<FS::queue> and L<freeside-queued>) to be executed
547 on shellmachine via ssh. This behavior can be surpressed by setting
548 $FS::svc_acct::nossh_hack true. If the shellmachine-userdel configuration
553 is the default. If the shellmachine-userdel configuration file exists but
558 is the default instead. Otherwise the contents of the file are treated as a
559 double-quoted perl string, with the following variables available:
562 (TODOC: cyrus config file)
569 if ( defined( $FS::Record::dbdef->table('svc_acct_sm') ) ) {
570 return "Can't delete an account which has (svc_acct_sm) mail aliases!"
571 if $self->uid && qsearch( 'svc_acct_sm', { 'domuid' => $self->uid } );
574 return "Can't delete an account which is a (svc_forward) source!"
575 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
577 return "Can't delete an account which is a (svc_forward) destination!"
578 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
580 return "Can't delete an account with (svc_www) web service!"
581 if qsearch( 'svc_www', { 'usersvc' => $self->usersvc } );
583 # what about records in session ?
585 local $SIG{HUP} = 'IGNORE';
586 local $SIG{INT} = 'IGNORE';
587 local $SIG{QUIT} = 'IGNORE';
588 local $SIG{TERM} = 'IGNORE';
589 local $SIG{TSTP} = 'IGNORE';
590 local $SIG{PIPE} = 'IGNORE';
592 my $oldAutoCommit = $FS::UID::AutoCommit;
593 local $FS::UID::AutoCommit = 0;
596 foreach my $cust_main_invoice (
597 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
599 unless ( defined($cust_main_invoice) ) {
600 warn "WARNING: something's wrong with qsearch";
603 my %hash = $cust_main_invoice->hash;
604 $hash{'dest'} = $self->email;
605 my $new = new FS::cust_main_invoice \%hash;
606 my $error = $new->replace($cust_main_invoice);
608 $dbh->rollback if $oldAutoCommit;
613 foreach my $svc_domain (
614 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
616 my %hash = new FS::svc_domain->hash;
617 $hash{'catchall'} = '';
618 my $new = new FS::svc_domain \%hash;
619 my $error = $new->replace($svc_domain);
621 $dbh->rollback if $oldAutoCommit;
626 my $error = $self->SUPER::delete;
628 $dbh->rollback if $oldAutoCommit;
632 my( $username, $dir ) = (
636 if ( $username && $shellmachine && ! $nossh_hack ) {
637 my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };
638 $error = $queue->insert("root\@$shellmachine", eval qq("$userdel") );
640 $dbh->rollback if $oldAutoCommit;
641 return "queueing job (transaction rolled back): $error";
646 if ( $cyrus_server ) {
647 my $queue = new FS::queue { 'job' => 'FS::svc_acct::cyrus_delete' };
648 $error = $queue->insert($self->username);
650 $dbh->rollback if $oldAutoCommit;
651 return "queueing job (transaction rolled back): $error";
656 my $queue = new FS::queue { 'job' => 'FS::svc_acct::cp_delete' };
657 $error = $queue->insert($self->username);
659 $dbh->rollback if $oldAutoCommit;
660 return "queueing job (transaction rolled back): $error";
664 if ( $icradius_dbh ) {
667 new FS::queue { 'job' => 'FS::svc_acct::icradius_rc_delete' };
668 $error = $radcheck_queue->insert( $self->username );
670 $dbh->rollback if $oldAutoCommit;
671 return "queueing job (transaction rolled back): $error";
675 new FS::queue { 'job' => 'FS::svc_acct::icradius_rr_delete' };
676 $error = $radreply_queue->insert( $self->username );
678 $dbh->rollback if $oldAutoCommit;
679 return "queueing job (transaction rolled back): $error";
683 my $queue = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_delete' };
684 $error = $queue->insert( $self->username, $self->domain );
686 $dbh->rollback if $oldAutoCommit;
687 return "queueing job (transaction rolled back): $error";
692 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
697 my $username = shift;
699 my $client = Cyrus::IMAP::Admin->new($cyrus_server);
700 $client->authenticate(
701 -user => $cyrus_admin_user,
702 -mechanism => "login",
703 -password => $cyrus_admin_pass
706 my $rc = $client->setacl("user.$username", $cyrus_admin_user => 'all' );
707 my $error = $client->error;
708 die $error if $error;
710 $rc = $client->delete("user.$username");
711 $error = $client->error;
712 die $error if $error;
718 my( $username ) = @_;
719 my $app = new Net::APP ( $cp_server,
721 Password => $cp_pass,
727 $app->delete_mailbox(
728 Mailbox => $username,
732 die $app->message."\n" unless $app->ok;
735 sub icradius_rc_delete {
736 my $username = shift;
738 my $sth = $icradius_dbh->prepare(
739 'DELETE FROM radcheck WHERE UserName = ?'
741 $sth->execute($username)
742 or die "can't delete from radcheck table: ". $sth->errstr;
747 sub icradius_rr_delete {
748 my $username = shift;
750 my $sth = $icradius_dbh->prepare(
751 'DELETE FROM radreply WHERE UserName = ?'
753 $sth->execute($username)
754 or die "can't delete from radreply table: ". $sth->errstr;
759 sub vpopmail_delete {
760 my( $username, $domain ) = @_;
762 (open(VPASSWD, "$exportdir/domains/$domain/vpasswd")
763 and flock(VPASSWD,LOCK_EX)
764 ) or die "can't open $exportdir/domains/$domain/vpasswd: $!";
766 open(VPASSWDTMP, ">$exportdir/domains/$domain/vpasswd.tmp")
767 or die "Can't open $exportdir/domains/$domain/vpasswd.tmp: $!";
770 my ($mailbox, $rest) = split(':', $_);
771 print VPASSWDTMP $_ unless $username eq $mailbox;
776 rename "$exportdir/domains/$domain/vpasswd.tmp", "$exportdir/domains/$domain/vpasswd"
777 or die "Can't rename $exportdir/domains/$domain/vpasswd.tmp: $!";
779 flock(VPASSWD,LOCK_UN);
782 rmtree "$exportdir/domains/$domain/$username" or die "can't destroy Maildir";+
786 =item replace OLD_RECORD
788 Replaces OLD_RECORD with this one in the database. If there is an error,
789 returns the error, otherwise returns false.
791 If the configuration value (see L<FS::Conf>) shellmachine exists, and the
792 dir field has changed, the command(s) specified in the shellmachine-usermod
793 configuraiton file are added to the job queue (see L<FS::queue> and
794 L<freeside-queued>) to be executed on shellmachine via ssh. This behavior can
795 be surpressed by setting $FS::svc-acct::nossh_hack true. If the
796 shellmachine-userdel configuration file does not exist or is empty,
798 [ -d $old_dir ] && mv $old_dir $new_dir || (
802 find . -depth -print | cpio -pdm $new_dir;
804 chown -R $uid.$gid $new_dir;
808 is the default. This behaviour can be surpressed by setting
809 $FS::svc_acct::nossh_hack true.
814 my ( $new, $old ) = ( shift, shift );
817 return "Username in use"
818 if $old->username ne $new->username &&
819 qsearchs( 'svc_acct', { 'username' => $new->username,
820 'domsvc' => $new->domsvc,
823 #no warnings 'numeric'; #alas, a 5.006-ism
825 return "Can't change uid!" if $old->uid != $new->uid;
828 return "can't change username using Cyrus"
829 if $cyrus_server && $old->username ne $new->username;
831 #change homdir when we change username
832 $new->setfield('dir', '') if $old->username ne $new->username;
834 local $SIG{HUP} = 'IGNORE';
835 local $SIG{INT} = 'IGNORE';
836 local $SIG{QUIT} = 'IGNORE';
837 local $SIG{TERM} = 'IGNORE';
838 local $SIG{TSTP} = 'IGNORE';
839 local $SIG{PIPE} = 'IGNORE';
841 my $oldAutoCommit = $FS::UID::AutoCommit;
842 local $FS::UID::AutoCommit = 0;
845 $error = $new->SUPER::replace($old);
847 $dbh->rollback if $oldAutoCommit;
848 return $error if $error;
851 my ( $old_dir, $new_dir, $uid, $gid ) = (
852 $old->getfield('dir'),
853 $new->getfield('dir'),
854 $new->getfield('uid'),
855 $new->getfield('gid'),
857 if ( $old_dir && $new_dir && $old_dir ne $new_dir && ! $nossh_hack ) {
858 my $queue = new FS::queue {
859 'svcnum' => $new->svcnum,
860 'job' => 'Net::SSH::ssh_cmd'
862 $error = $queue->insert("root\@$shellmachine", eval qq("$usermod") );
864 $dbh->rollback if $oldAutoCommit;
865 return "queueing job (transaction rolled back): $error";
869 if ( $cp_server && $old->username ne $new->username ) {
870 my $queue = new FS::queue {
871 'svcnum' => $new->svcnum,
872 'job' => 'FS::svc_acct::cp_rename'
874 $error = $queue->insert( $old->username, $new->username );
876 $dbh->rollback if $oldAutoCommit;
877 return "queueing job (transaction rolled back): $error";
881 if ( $cp_server && $old->_password ne $new->_password ) {
882 my $queue = new FS::queue {
883 'svcnum' => $new->svcnum,
884 'job' => 'FS::svc_acct::cp_change'
886 $error = $queue->insert( $new->username, $new->_password );
888 $dbh->rollback if $oldAutoCommit;
889 return "queueing job (transaction rolled back): $error";
893 if ( $icradius_dbh ) {
894 my $queue = new FS::queue {
895 'svcnum' => $new->svcnum,
896 'job' => 'FS::svc_acct::icradius_rc_replace'
898 $error = $queue->insert( $new->username,
902 $dbh->rollback if $oldAutoCommit;
903 return "queueing job (transaction rolled back): $error";
907 my $cpassword = crypt(
908 $new->_password,$saltset[int(rand(64))].$saltset[int(rand(64))]
911 if ($old->username ne $new->username || $old->domain ne $new->domain ) {
912 my $queue = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_delete' };
913 $error = $queue->insert( $old->username, $old->domain );
914 my $queue2 = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_insert' };
915 $error = $queue2->insert( $new->username,
921 } elsif ($old->_password ne $new->_password) {
922 my $queue = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_replace_password' };
923 $error = $queue->insert( $new->username, $cpassword, $new->domain );
926 $dbh->rollback if $oldAutoCommit;
927 return "queueing job (transaction rolled back): $error";
932 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
936 sub icradius_rc_replace {
937 my( $username, $new_password ) = @_;
939 my $sth = $icradius_dbh->prepare(
940 "UPDATE radcheck SET Value = ? WHERE UserName = ? and Attribute = ?"
942 $sth->execute($new_password, $username, 'Password' )
943 or die "can't update radcheck table: ". $sth->errstr;
949 my ( $old_username, $new_username ) = @_;
951 my $app = new Net::APP ( $cp_server,
953 Password => $cp_pass,
959 $app->rename_mailbox(
961 Old_Mailbox => $old_username,
962 New_Mailbox => $new_username,
965 die $app->message."\n" unless $app->ok;
970 my ( $username, $password ) = @_;
972 my $app = new Net::APP ( $cp_server,
974 Password => $cp_pass,
980 if ( $password =~ /^\*SUSPENDED\* (.*)$/ ) {
982 $app->set_mailbox_status(
984 Mailbox => $username,
989 $app->set_mailbox_status(
991 Mailbox => $username,
996 die $app->message."\n" unless $app->ok;
998 $app->change_mailbox(
1000 Mailbox => $username,
1001 Password => $password,
1003 die $app->message."\n" unless $app->ok;
1007 sub vpopmail_replace_password {
1008 my( $username, $password, $domain ) = @_;
1010 (open(VPASSWD, "$exportdir/domains/$domain/vpasswd")
1011 and flock(VPASSWD,LOCK_EX)
1012 ) or die "can't open $exportdir/domains/$domain/vpasswd: $!";
1014 open(VPASSWDTMP, ">$exportdir/domains/$domain/vpasswd.tmp")
1015 or die "Can't open $exportdir/domains/$domain/vpasswd.tmp: $!";
1018 my ($mailbox, $pw, @rest) = split(':', $_);
1019 print VPASSWDTMP $_ unless $username eq $mailbox;
1020 print VPASSWDTMP join (':', ($mailbox, $password, @rest))
1021 if $username eq $mailbox;
1026 rename "$exportdir/domains/$domain/vpasswd.tmp", "$exportdir/domains/$domain/vpasswd"
1027 or die "Can't rename $exportdir/domains/$domain/vpasswd.tmp: $!";
1029 flock(VPASSWD,LOCK_UN);
1032 my $queue = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_sync' };
1033 my $error = $queue->insert;
1034 die $error if $error;
1042 Suspends this account by prefixing *SUSPENDED* to the password. If there is an
1043 error, returns the error, otherwise returns false.
1045 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1051 my %hash = $self->hash;
1052 unless ( $hash{_password} =~ /^\*SUSPENDED\* /
1053 || $hash{_password} eq '*'
1055 $hash{_password} = '*SUSPENDED* '.$hash{_password};
1056 my $new = new FS::svc_acct ( \%hash );
1057 $new->replace($self);
1059 ''; #no error (already suspended)
1065 Unsuspends this account by removing *SUSPENDED* from the password. If there is
1066 an error, returns the error, otherwise returns false.
1068 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1074 my %hash = $self->hash;
1075 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1076 $hash{_password} = $1;
1077 my $new = new FS::svc_acct ( \%hash );
1078 $new->replace($self);
1080 ''; #no error (already unsuspended)
1086 Just returns false (no error) for now.
1088 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1092 Checks all fields to make sure this is a valid service. If there is an error,
1093 returns the error, otherwise returns false. Called by the insert and replace
1096 Sets any fixed values; see L<FS::part_svc>.
1103 my($recref) = $self->hashref;
1105 my $x = $self->setfixed;
1106 return $x unless ref($x);
1109 my $error = $self->ut_numbern('svcnum')
1110 || $self->ut_number('domsvc')
1112 return $error if $error;
1114 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1115 if ( $username_uppercase ) {
1116 $recref->{username} =~ /^([a-z0-9_\-\.\&]{$usernamemin,$ulen})$/i
1117 or return "Illegal username: ". $recref->{username};
1118 $recref->{username} = $1;
1120 $recref->{username} =~ /^([a-z0-9_\-\.\&]{$usernamemin,$ulen})$/
1121 or return "Illegal username: ". $recref->{username};
1122 $recref->{username} = $1;
1125 if ( $username_letterfirst ) {
1126 $recref->{username} =~ /^[a-z]/ or return "Illegal username";
1127 } elsif ( $username_letter ) {
1128 $recref->{username} =~ /[a-z]/ or return "Illegal username";
1130 if ( $username_noperiod ) {
1131 $recref->{username} =~ /\./ and return "Illegal username";
1133 unless ( $username_ampersand ) {
1134 $recref->{username} =~ /\&/ and return "Illegal username";
1137 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1138 $recref->{popnum} = $1;
1139 return "Unknown popnum" unless
1140 ! $recref->{popnum} ||
1141 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1143 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1145 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1146 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1148 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1149 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1150 #not all systems use gid=uid
1151 #you can set a fixed gid in part_svc
1153 return "Only root can have uid 0"
1154 if $recref->{uid} == 0 && $recref->{username} ne 'root';
1156 # $error = $self->ut_textn('finger');
1157 # return $error if $error;
1158 $self->getfield('finger') =~
1159 /^([\w \t\!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\*\<\>]*)$/
1160 or return "Illegal finger: ". $self->getfield('finger');
1161 $self->setfield('finger', $1);
1163 $recref->{dir} =~ /^([\/\w\-\.\&]*)$/
1164 or return "Illegal directory";
1165 $recref->{dir} = $1;
1166 return "Illegal directory"
1167 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1168 return "Illegal directory"
1169 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1170 unless ( $recref->{dir} ) {
1171 $recref->{dir} = $dir_prefix . '/';
1172 if ( $dirhash > 0 ) {
1173 for my $h ( 1 .. $dirhash ) {
1174 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1176 } elsif ( $dirhash < 0 ) {
1177 for my $h ( reverse $dirhash .. -1 ) {
1178 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1181 $recref->{dir} .= $recref->{username};
1185 unless ( $recref->{username} eq 'sync' ) {
1186 if ( grep $_ eq $recref->{shell}, @shells ) {
1187 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1189 return "Illegal shell \`". $self->shell. "\'; ".
1190 $conf->dir. "/shells contains: @shells";
1193 $recref->{shell} = '/bin/sync';
1196 $recref->{quota} =~ /^(\d*)$/ or return "Illegal quota (unimplemented)";
1197 $recref->{quota} = $1;
1200 $recref->{gid} ne '' ?
1201 return "Can't have gid without uid" : ( $recref->{gid}='' );
1202 $recref->{finger} ne '' ?
1203 return "Can't have finger-name without uid" : ( $recref->{finger}='' );
1204 $recref->{dir} ne '' ?
1205 return "Can't have directory without uid" : ( $recref->{dir}='' );
1206 $recref->{shell} ne '' ?
1207 return "Can't have shell without uid" : ( $recref->{shell}='' );
1208 $recref->{quota} ne '' ?
1209 return "Can't have quota without uid" : ( $recref->{quota}='' );
1212 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1213 unless ( $recref->{slipip} eq '0e0' ) {
1214 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1215 or return "Illegal slipip". $self->slipip;
1216 $recref->{slipip} = $1;
1218 $recref->{slipip} = '0e0';
1223 #arbitrary RADIUS stuff; allow ut_textn for now
1224 foreach ( grep /^radius_/, fields('svc_acct') ) {
1225 $self->ut_textn($_);
1228 #generate a password if it is blank
1229 $recref->{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) )
1230 unless ( $recref->{_password} );
1232 #if ( $recref->{_password} =~ /^((\*SUSPENDED\* )?)([^\t\n]{4,16})$/ ) {
1233 if ( $recref->{_password} =~ /^((\*SUSPENDED\* )?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1234 $recref->{_password} = $1.$3;
1235 #uncomment this to encrypt password immediately upon entry, or run
1236 #bin/crypt_pw in cron to give new users a window during which their
1237 #password is available to techs, for faxing, etc. (also be aware of
1239 #$recref->{password} = $1.
1240 # crypt($3,$saltset[int(rand(64))].$saltset[int(rand(64))]
1242 } elsif ( $recref->{_password} =~ /^((\*SUSPENDED\* )?)([\w\.\/\$]{13,34})$/ ) {
1243 $recref->{_password} = $1.$3;
1244 } elsif ( $recref->{_password} eq '*' ) {
1245 $recref->{_password} = '*';
1246 } elsif ( $recref->{_password} eq '!!' ) {
1247 $recref->{_password} = '!!';
1249 #return "Illegal password";
1250 return "Illegal password: ". $recref->{_password};
1258 Depriciated, use radius_reply instead.
1263 carp "FS::svc_acct::radius depriciated, use radius_reply";
1264 $_[0]->radius_reply;
1269 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1270 reply attributes of this record.
1272 Note that this is now the preferred method for reading RADIUS attributes -
1273 accessing the columns directly is discouraged, as the column names are
1274 expected to change in the future.
1283 my($column, $attrib) = ($1, $2);
1284 #$attrib =~ s/_/\-/g;
1285 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1286 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1287 if ( $self->ip && $self->ip ne '0e0' ) {
1288 $reply{'Framed-IP-Address'} = $self->ip;
1295 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1296 check attributes of this record.
1298 Accessing RADIUS attributes directly is not supported and will break in the
1307 my($column, $attrib) = ($1, $2);
1308 #$attrib =~ s/_/\-/g;
1309 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1310 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1315 Returns the domain associated with this account.
1321 if ( $self->domsvc ) {
1322 #$self->svc_domain->domain;
1323 my $svc_domain = $self->svc_domain
1324 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1325 $svc_domain->domain;
1327 $mydomain or die "svc_acct.domsvc is null and no legacy domain config file";
1333 Returns the FS::svc_domain record for this account's domain (see
1341 ? $self->{'_domsvc'}
1342 : qsearchs( 'svc_domain', { 'svcnum' => $self->domsvc } );
1347 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1351 qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } );
1356 Returns an email address associated with the account.
1362 $self->username. '@'. $self->domain;
1365 =item seconds_since TIMESTAMP
1367 Returns the number of seconds this account has been online since TIMESTAMP.
1370 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1371 L<Time::Local> and L<Date::Parse> for conversion functions.
1375 #note: POD here, implementation in FS::cust_svc
1378 $self->cust_svc->seconds_since(@_);
1385 The $recref stuff in sub check should be cleaned up.
1387 The suspend, unsuspend and cancel methods update the database, but not the
1388 current object. This is probably a bug as it's unexpected and
1393 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
1394 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
1395 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
1396 L<freeside-queued>), L<Net::SSH>, L<ssh>, L<FS::svc_acct_pop>,
1397 schema.html from the base documentation.