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 if ( $self->svcnum ) {
277 my $cust_svc = qsearchs('cust_svc',{'svcnum'=>$self->svcnum});
278 unless ( $cust_svc ) {
279 $dbh->rollback if $oldAutoCommit;
280 return "no cust_svc record found for svcnum ". $self->svcnum;
282 $self->pkgnum($cust_svc->pkgnum);
283 $self->svcpart($cust_svc->svcpart);
286 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
287 return "Unknown svcpart" unless $part_svc;
289 if $part_svc->part_svc_column('uid')->columnflag ne 'F'
290 && qsearchs( 'svc_acct', { 'uid' => $self->uid } )
291 && $self->username !~ /^(hyla)?fax$/
294 $error = $self->SUPER::insert;
296 $dbh->rollback if $oldAutoCommit;
300 my( $username, $uid, $gid, $dir, $shell ) = (
307 if ( $username && $uid && $dir && $shellmachine && ! $nossh_hack ) {
308 my $queue = new FS::queue {
309 'svcnum' => $self->svcnum,
310 'job' => 'Net::SSH::ssh_cmd',
312 $error = $queue->insert("root\@$shellmachine", eval qq("$useradd") );
314 $dbh->rollback if $oldAutoCommit;
315 return "queueing job (transaction rolled back): $error";
319 if ( $cyrus_server ) {
320 my $queue = new FS::queue {
321 'svcnum' => $self->svcnum,
322 'job' => 'FS::svc_acct::cyrus_insert',
324 $error = $queue->insert($self->username, $self->quota);
326 $dbh->rollback if $oldAutoCommit;
327 return "queueing job (transaction rolled back): $error";
332 my $queue = new FS::queue {
333 'svcnum' => $self->svcnum,
334 'job' => 'FS::svc_acct::cp_insert'
336 $error = $queue->insert($self->username, $self->_password);
338 $dbh->rollback if $oldAutoCommit;
339 return "queueing job (transaction rolled back): $error";
343 if ( $icradius_dbh ) {
347 'svcnum' => $self->svcnum,
348 'job' => 'FS::svc_acct::icradius_rc_insert'
350 $error = $radcheck_queue->insert( $self->username,
355 $dbh->rollback if $oldAutoCommit;
356 return "queueing job (transaction rolled back): $error";
361 'svcnum' => $self->svcnum,
362 'job' => 'FS::svc_acct::icradius_rr_insert'
364 $error = $radreply_queue->insert( $self->username,
369 $dbh->rollback if $oldAutoCommit;
370 return "queueing job (transaction rolled back): $error";
378 'svcnum' => $self->svcnum,
379 'job' => 'FS::svc_acct::vpopmail_insert'
381 $error = $vpopmail_queue->insert( $self->username,
382 crypt($self->_password,$saltset[int(rand(64))].$saltset[int(rand(64))]),
387 $dbh->rollback if $oldAutoCommit;
388 return "queueing job (transaction rolled back): $error";
394 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
399 my( $username, $quota ) = @_;
401 warn "cyrus_insert: starting for user $username, quota $quota\n";
403 warn "cyrus_insert: connecting to $cyrus_server\n";
404 my $client = Cyrus::IMAP::Admin->new($cyrus_server);
406 warn "cyrus_insert: authentication as $cyrus_admin_user\n";
407 $client->authenticate(
408 -user => $cyrus_admin_user,
409 -mechanism => "login",
410 -password => $cyrus_admin_pass
413 warn "cyrus_insert: creating user.$username\n";
414 my $rc = $client->create("user.$username");
415 my $error = $client->error;
416 die "cyrus_insert: error creating user.$username: $error" if $error;
418 warn "cyrus_insert: setacl user.$username, $username => all\n";
419 $rc = $client->setacl("user.$username", $username => 'all' );
420 $error = $client->error;
421 die "cyrus_insert: error setacl user.$username: $error" if $error;
424 warn "cyrus_insert: setquota user.$username, STORAGE => $quota\n";
425 $rc = $client->setquota("user.$username", 'STORAGE' => $quota );
426 $error = $client->error;
427 die "cyrus_insert: error setquota user.$username: $error" if $error;
434 my( $username, $password ) = @_;
436 my $app = new Net::APP ( $cp_server,
438 Password => $cp_pass,
444 $app->create_mailbox(
445 Mailbox => $username,
446 Password => $password,
447 Workgroup => $cp_workgroup,
451 die $app->message."\n" unless $app->ok;
454 sub icradius_rc_insert {
455 my( $username, $password, %radcheck ) = @_;
457 my $sth = $icradius_dbh->prepare(
458 "INSERT INTO radcheck ( id, UserName, Attribute, Value ) VALUES ( ".
459 join(", ", map { $icradius_dbh->quote($_) } (
466 $sth->execute or die "can't insert into radcheck table: ". $sth->errstr;
468 foreach my $attribute ( keys %radcheck ) {
469 my $sth = $icradius_dbh->prepare(
470 "INSERT INTO radcheck ( id, UserName, Attribute, Value ) VALUES ( ".
471 join(", ", map { $icradius_dbh->quote($_) } (
475 $radcheck{$attribute},
478 $sth->execute or die "can't insert into radcheck table: ". $sth->errstr;
484 sub icradius_rr_insert {
485 my( $username, $password, %radreply ) = @_;
487 foreach my $attribute ( keys %radreply ) {
488 my $sth = $icradius_dbh->prepare(
489 "INSERT INTO radreply ( id, UserName, Attribute, Value ) VALUES ( ".
490 join(", ", map { $icradius_dbh->quote($_) } (
494 $radreply{$attribute},
497 $sth->execute or die "can't insert into radreply table: ". $sth->errstr;
504 sub vpopmail_insert {
505 my( $username, $password, $domain, $vpopdir ) = @_;
507 (open(VPASSWD, ">>$exportdir/domains/$domain/vpasswd")
508 and flock(VPASSWD,LOCK_EX)
509 ) or die "can't open vpasswd file for $username\@$domain: $exportdir/domains/$domain/vpasswd";
510 print VPASSWD join(":",
516 "$vpopdir/domains/$domain/$username",
520 flock(VPASSWD,LOCK_UN);
523 mkdir "$exportdir/domains/$domain/$username", 0700 or die "can't create Maildir";
524 mkdir "$exportdir/domains/$domain/$username/Maildir", 0700 or die "can't create Maildir";
525 mkdir "$exportdir/domains/$domain/$username/Maildir/cur", 0700 or die "can't create Maildir";
526 mkdir "$exportdir/domains/$domain/$username/Maildir/new", 0700 or die "can't create Maildir";
527 mkdir "$exportdir/domains/$domain/$username/Maildir/tmp", 0700 or die "can't create Maildir";
529 my $queue = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_sync' };
530 my $error = $queue->insert;
531 die $error if $error;
538 my (@vpopmailmachines) = $conf->config('vpopmailmachines');
539 my ($machine, $dir, $uid, $gid) = split (/\s+/, $vpopmailmachines[0]);
542 my @args = ("$rsync", "-rlpt", "-e", "$ssh", "domains/", "vpopmail\@$machine:$vpopdir/domains/");
543 system {$args[0]} @args;
549 Deletes this account from the database. If there is an error, returns the
550 error, otherwise returns false.
552 The corresponding FS::cust_svc record will be deleted as well.
554 If the configuration value (see L<FS::Conf>) shellmachine exists, the
555 command(s) specified in the shellmachine-userdel configuration file are
556 added to the job queue (see L<FS::queue> and L<freeside-queued>) to be executed
557 on shellmachine via ssh. This behavior can be surpressed by setting
558 $FS::svc_acct::nossh_hack true. If the shellmachine-userdel configuration
563 is the default. If the shellmachine-userdel configuration file exists but
568 is the default instead. Otherwise the contents of the file are treated as a
569 double-quoted perl string, with the following variables available:
572 (TODOC: cyrus config file)
579 if ( defined( $FS::Record::dbdef->table('svc_acct_sm') ) ) {
580 return "Can't delete an account which has (svc_acct_sm) mail aliases!"
581 if $self->uid && qsearch( 'svc_acct_sm', { 'domuid' => $self->uid } );
584 return "Can't delete an account which is a (svc_forward) source!"
585 if qsearch( 'svc_forward', { 'srcsvc' => $self->svcnum } );
587 return "Can't delete an account which is a (svc_forward) destination!"
588 if qsearch( 'svc_forward', { 'dstsvc' => $self->svcnum } );
590 return "Can't delete an account with (svc_www) web service!"
591 if qsearch( 'svc_www', { 'usersvc' => $self->usersvc } );
593 # what about records in session ?
595 local $SIG{HUP} = 'IGNORE';
596 local $SIG{INT} = 'IGNORE';
597 local $SIG{QUIT} = 'IGNORE';
598 local $SIG{TERM} = 'IGNORE';
599 local $SIG{TSTP} = 'IGNORE';
600 local $SIG{PIPE} = 'IGNORE';
602 my $oldAutoCommit = $FS::UID::AutoCommit;
603 local $FS::UID::AutoCommit = 0;
606 foreach my $cust_main_invoice (
607 qsearch( 'cust_main_invoice', { 'dest' => $self->svcnum } )
609 unless ( defined($cust_main_invoice) ) {
610 warn "WARNING: something's wrong with qsearch";
613 my %hash = $cust_main_invoice->hash;
614 $hash{'dest'} = $self->email;
615 my $new = new FS::cust_main_invoice \%hash;
616 my $error = $new->replace($cust_main_invoice);
618 $dbh->rollback if $oldAutoCommit;
623 foreach my $svc_domain (
624 qsearch( 'svc_domain', { 'catchall' => $self->svcnum } )
626 my %hash = new FS::svc_domain->hash;
627 $hash{'catchall'} = '';
628 my $new = new FS::svc_domain \%hash;
629 my $error = $new->replace($svc_domain);
631 $dbh->rollback if $oldAutoCommit;
636 my $error = $self->SUPER::delete;
638 $dbh->rollback if $oldAutoCommit;
642 my( $username, $dir ) = (
646 if ( $username && $shellmachine && ! $nossh_hack ) {
647 my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };
648 $error = $queue->insert("root\@$shellmachine", eval qq("$userdel") );
650 $dbh->rollback if $oldAutoCommit;
651 return "queueing job (transaction rolled back): $error";
656 if ( $cyrus_server ) {
657 my $queue = new FS::queue { 'job' => 'FS::svc_acct::cyrus_delete' };
658 $error = $queue->insert($self->username);
660 $dbh->rollback if $oldAutoCommit;
661 return "queueing job (transaction rolled back): $error";
666 my $queue = new FS::queue { 'job' => 'FS::svc_acct::cp_delete' };
667 $error = $queue->insert($self->username);
669 $dbh->rollback if $oldAutoCommit;
670 return "queueing job (transaction rolled back): $error";
674 if ( $icradius_dbh ) {
677 new FS::queue { 'job' => 'FS::svc_acct::icradius_rc_delete' };
678 $error = $radcheck_queue->insert( $self->username );
680 $dbh->rollback if $oldAutoCommit;
681 return "queueing job (transaction rolled back): $error";
685 new FS::queue { 'job' => 'FS::svc_acct::icradius_rr_delete' };
686 $error = $radreply_queue->insert( $self->username );
688 $dbh->rollback if $oldAutoCommit;
689 return "queueing job (transaction rolled back): $error";
693 my $queue = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_delete' };
694 $error = $queue->insert( $self->username, $self->domain );
696 $dbh->rollback if $oldAutoCommit;
697 return "queueing job (transaction rolled back): $error";
702 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
707 my $username = shift;
709 my $client = Cyrus::IMAP::Admin->new($cyrus_server);
710 $client->authenticate(
711 -user => $cyrus_admin_user,
712 -mechanism => "login",
713 -password => $cyrus_admin_pass
716 my $rc = $client->setacl("user.$username", $cyrus_admin_user => 'all' );
717 my $error = $client->error;
718 die $error if $error;
720 $rc = $client->delete("user.$username");
721 $error = $client->error;
722 die $error if $error;
728 my( $username ) = @_;
729 my $app = new Net::APP ( $cp_server,
731 Password => $cp_pass,
737 $app->delete_mailbox(
738 Mailbox => $username,
742 die $app->message."\n" unless $app->ok;
745 sub icradius_rc_delete {
746 my $username = shift;
748 my $sth = $icradius_dbh->prepare(
749 'DELETE FROM radcheck WHERE UserName = ?'
751 $sth->execute($username)
752 or die "can't delete from radcheck table: ". $sth->errstr;
757 sub icradius_rr_delete {
758 my $username = shift;
760 my $sth = $icradius_dbh->prepare(
761 'DELETE FROM radreply WHERE UserName = ?'
763 $sth->execute($username)
764 or die "can't delete from radreply table: ". $sth->errstr;
769 sub vpopmail_delete {
770 my( $username, $domain ) = @_;
772 (open(VPASSWD, "$exportdir/domains/$domain/vpasswd")
773 and flock(VPASSWD,LOCK_EX)
774 ) or die "can't open $exportdir/domains/$domain/vpasswd: $!";
776 open(VPASSWDTMP, ">$exportdir/domains/$domain/vpasswd.tmp")
777 or die "Can't open $exportdir/domains/$domain/vpasswd.tmp: $!";
780 my ($mailbox, $rest) = split(':', $_);
781 print VPASSWDTMP $_ unless $username eq $mailbox;
786 rename "$exportdir/domains/$domain/vpasswd.tmp", "$exportdir/domains/$domain/vpasswd"
787 or die "Can't rename $exportdir/domains/$domain/vpasswd.tmp: $!";
789 flock(VPASSWD,LOCK_UN);
792 rmtree "$exportdir/domains/$domain/$username" or die "can't destroy Maildir";+
796 =item replace OLD_RECORD
798 Replaces OLD_RECORD with this one in the database. If there is an error,
799 returns the error, otherwise returns false.
801 If the configuration value (see L<FS::Conf>) shellmachine exists, and the
802 dir field has changed, the command(s) specified in the shellmachine-usermod
803 configuraiton file are added to the job queue (see L<FS::queue> and
804 L<freeside-queued>) to be executed on shellmachine via ssh. This behavior can
805 be surpressed by setting $FS::svc-acct::nossh_hack true. If the
806 shellmachine-userdel configuration file does not exist or is empty,
808 [ -d $old_dir ] && mv $old_dir $new_dir || (
812 find . -depth -print | cpio -pdm $new_dir;
814 chown -R $uid.$gid $new_dir;
818 is the default. This behaviour can be surpressed by setting
819 $FS::svc_acct::nossh_hack true.
824 my ( $new, $old ) = ( shift, shift );
827 return "Username in use"
828 if $old->username ne $new->username &&
829 qsearchs( 'svc_acct', { 'username' => $new->username,
830 'domsvc' => $new->domsvc,
833 #no warnings 'numeric'; #alas, a 5.006-ism
835 return "Can't change uid!" if $old->uid != $new->uid;
838 return "can't change username using Cyrus"
839 if $cyrus_server && $old->username ne $new->username;
841 #change homdir when we change username
842 $new->setfield('dir', '') if $old->username ne $new->username;
844 local $SIG{HUP} = 'IGNORE';
845 local $SIG{INT} = 'IGNORE';
846 local $SIG{QUIT} = 'IGNORE';
847 local $SIG{TERM} = 'IGNORE';
848 local $SIG{TSTP} = 'IGNORE';
849 local $SIG{PIPE} = 'IGNORE';
851 my $oldAutoCommit = $FS::UID::AutoCommit;
852 local $FS::UID::AutoCommit = 0;
855 $error = $new->SUPER::replace($old);
857 $dbh->rollback if $oldAutoCommit;
858 return $error if $error;
861 my ( $old_dir, $new_dir, $uid, $gid ) = (
862 $old->getfield('dir'),
863 $new->getfield('dir'),
864 $new->getfield('uid'),
865 $new->getfield('gid'),
867 if ( $old_dir && $new_dir && $old_dir ne $new_dir && ! $nossh_hack ) {
868 my $queue = new FS::queue {
869 'svcnum' => $new->svcnum,
870 'job' => 'Net::SSH::ssh_cmd'
872 $error = $queue->insert("root\@$shellmachine", eval qq("$usermod") );
874 $dbh->rollback if $oldAutoCommit;
875 return "queueing job (transaction rolled back): $error";
879 if ( $cp_server && $old->username ne $new->username ) {
880 my $queue = new FS::queue {
881 'svcnum' => $new->svcnum,
882 'job' => 'FS::svc_acct::cp_rename'
884 $error = $queue->insert( $old->username, $new->username );
886 $dbh->rollback if $oldAutoCommit;
887 return "queueing job (transaction rolled back): $error";
891 if ( $cp_server && $old->_password ne $new->_password ) {
892 my $queue = new FS::queue {
893 'svcnum' => $new->svcnum,
894 'job' => 'FS::svc_acct::cp_change'
896 $error = $queue->insert( $new->username, $new->_password );
898 $dbh->rollback if $oldAutoCommit;
899 return "queueing job (transaction rolled back): $error";
903 if ( $icradius_dbh ) {
904 my $queue = new FS::queue {
905 'svcnum' => $new->svcnum,
906 'job' => 'FS::svc_acct::icradius_rc_replace'
908 $error = $queue->insert( $new->username,
912 $dbh->rollback if $oldAutoCommit;
913 return "queueing job (transaction rolled back): $error";
917 my $cpassword = crypt(
918 $new->_password,$saltset[int(rand(64))].$saltset[int(rand(64))]
921 if ($old->username ne $new->username || $old->domain ne $new->domain ) {
922 my $queue = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_delete' };
923 $error = $queue->insert( $old->username, $old->domain );
924 my $queue2 = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_insert' };
925 $error = $queue2->insert( $new->username,
931 } elsif ($old->_password ne $new->_password) {
932 my $queue = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_replace_password' };
933 $error = $queue->insert( $new->username, $cpassword, $new->domain );
936 $dbh->rollback if $oldAutoCommit;
937 return "queueing job (transaction rolled back): $error";
942 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
946 sub icradius_rc_replace {
947 my( $username, $new_password ) = @_;
949 my $sth = $icradius_dbh->prepare(
950 "UPDATE radcheck SET Value = ? WHERE UserName = ? and Attribute = ?"
952 $sth->execute($new_password, $username, 'Password' )
953 or die "can't update radcheck table: ". $sth->errstr;
959 my ( $old_username, $new_username ) = @_;
961 my $app = new Net::APP ( $cp_server,
963 Password => $cp_pass,
969 $app->rename_mailbox(
971 Old_Mailbox => $old_username,
972 New_Mailbox => $new_username,
975 die $app->message."\n" unless $app->ok;
980 my ( $username, $password ) = @_;
982 my $app = new Net::APP ( $cp_server,
984 Password => $cp_pass,
990 if ( $password =~ /^\*SUSPENDED\* (.*)$/ ) {
992 $app->set_mailbox_status(
994 Mailbox => $username,
999 $app->set_mailbox_status(
1000 Domain => $mydomain,
1001 Mailbox => $username,
1003 Other_Bounce => 'F',
1006 die $app->message."\n" unless $app->ok;
1008 $app->change_mailbox(
1009 Domain => $mydomain,
1010 Mailbox => $username,
1011 Password => $password,
1013 die $app->message."\n" unless $app->ok;
1017 sub vpopmail_replace_password {
1018 my( $username, $password, $domain ) = @_;
1020 (open(VPASSWD, "$exportdir/domains/$domain/vpasswd")
1021 and flock(VPASSWD,LOCK_EX)
1022 ) or die "can't open $exportdir/domains/$domain/vpasswd: $!";
1024 open(VPASSWDTMP, ">$exportdir/domains/$domain/vpasswd.tmp")
1025 or die "Can't open $exportdir/domains/$domain/vpasswd.tmp: $!";
1028 my ($mailbox, $pw, @rest) = split(':', $_);
1029 print VPASSWDTMP $_ unless $username eq $mailbox;
1030 print VPASSWDTMP join (':', ($mailbox, $password, @rest))
1031 if $username eq $mailbox;
1036 rename "$exportdir/domains/$domain/vpasswd.tmp", "$exportdir/domains/$domain/vpasswd"
1037 or die "Can't rename $exportdir/domains/$domain/vpasswd.tmp: $!";
1039 flock(VPASSWD,LOCK_UN);
1042 my $queue = new FS::queue { 'job' => 'FS::svc_acct::vpopmail_sync' };
1043 my $error = $queue->insert;
1044 die $error if $error;
1052 Suspends this account by prefixing *SUSPENDED* to the password. If there is an
1053 error, returns the error, otherwise returns false.
1055 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1061 my %hash = $self->hash;
1062 unless ( $hash{_password} =~ /^\*SUSPENDED\* /
1063 || $hash{_password} eq '*'
1065 $hash{_password} = '*SUSPENDED* '.$hash{_password};
1066 my $new = new FS::svc_acct ( \%hash );
1067 $new->replace($self);
1069 ''; #no error (already suspended)
1075 Unsuspends this account by removing *SUSPENDED* from the password. If there is
1076 an error, returns the error, otherwise returns false.
1078 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
1084 my %hash = $self->hash;
1085 if ( $hash{_password} =~ /^\*SUSPENDED\* (.*)$/ ) {
1086 $hash{_password} = $1;
1087 my $new = new FS::svc_acct ( \%hash );
1088 $new->replace($self);
1090 ''; #no error (already unsuspended)
1096 Just returns false (no error) for now.
1098 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1102 Checks all fields to make sure this is a valid service. If there is an error,
1103 returns the error, otherwise returns false. Called by the insert and replace
1106 Sets any fixed values; see L<FS::part_svc>.
1113 my($recref) = $self->hashref;
1115 my $x = $self->setfixed;
1116 return $x unless ref($x);
1119 my $error = $self->ut_numbern('svcnum')
1120 || $self->ut_number('domsvc')
1122 return $error if $error;
1124 my $ulen = $usernamemax || $self->dbdef_table->column('username')->length;
1125 if ( $username_uppercase ) {
1126 $recref->{username} =~ /^([a-z0-9_\-\.\&]{$usernamemin,$ulen})$/i
1127 or return "Illegal username: ". $recref->{username};
1128 $recref->{username} = $1;
1130 $recref->{username} =~ /^([a-z0-9_\-\.\&]{$usernamemin,$ulen})$/
1131 or return "Illegal username: ". $recref->{username};
1132 $recref->{username} = $1;
1135 if ( $username_letterfirst ) {
1136 $recref->{username} =~ /^[a-z]/ or return "Illegal username";
1137 } elsif ( $username_letter ) {
1138 $recref->{username} =~ /[a-z]/ or return "Illegal username";
1140 if ( $username_noperiod ) {
1141 $recref->{username} =~ /\./ and return "Illegal username";
1143 unless ( $username_ampersand ) {
1144 $recref->{username} =~ /\&/ and return "Illegal username";
1147 $recref->{popnum} =~ /^(\d*)$/ or return "Illegal popnum: ".$recref->{popnum};
1148 $recref->{popnum} = $1;
1149 return "Unknown popnum" unless
1150 ! $recref->{popnum} ||
1151 qsearchs('svc_acct_pop',{'popnum'=> $recref->{popnum} } );
1153 unless ( $part_svc->part_svc_column('uid')->columnflag eq 'F' ) {
1155 $recref->{uid} =~ /^(\d*)$/ or return "Illegal uid";
1156 $recref->{uid} = $1 eq '' ? $self->unique('uid') : $1;
1158 $recref->{gid} =~ /^(\d*)$/ or return "Illegal gid";
1159 $recref->{gid} = $1 eq '' ? $recref->{uid} : $1;
1160 #not all systems use gid=uid
1161 #you can set a fixed gid in part_svc
1163 return "Only root can have uid 0"
1164 if $recref->{uid} == 0 && $recref->{username} ne 'root';
1166 # $error = $self->ut_textn('finger');
1167 # return $error if $error;
1168 $self->getfield('finger') =~
1169 /^([\w \t\!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\*\<\>]*)$/
1170 or return "Illegal finger: ". $self->getfield('finger');
1171 $self->setfield('finger', $1);
1173 $recref->{dir} =~ /^([\/\w\-\.\&]*)$/
1174 or return "Illegal directory";
1175 $recref->{dir} = $1;
1176 return "Illegal directory"
1177 if $recref->{dir} =~ /(^|\/)\.+(\/|$)/; #no .. component
1178 return "Illegal directory"
1179 if $recref->{dir} =~ /\&/ && ! $username_ampersand;
1180 unless ( $recref->{dir} ) {
1181 $recref->{dir} = $dir_prefix . '/';
1182 if ( $dirhash > 0 ) {
1183 for my $h ( 1 .. $dirhash ) {
1184 $recref->{dir} .= substr($recref->{username}, $h-1, 1). '/';
1186 } elsif ( $dirhash < 0 ) {
1187 for my $h ( reverse $dirhash .. -1 ) {
1188 $recref->{dir} .= substr($recref->{username}, $h, 1). '/';
1191 $recref->{dir} .= $recref->{username};
1195 unless ( $recref->{username} eq 'sync' ) {
1196 if ( grep $_ eq $recref->{shell}, @shells ) {
1197 $recref->{shell} = (grep $_ eq $recref->{shell}, @shells)[0];
1199 return "Illegal shell \`". $self->shell. "\'; ".
1200 $conf->dir. "/shells contains: @shells";
1203 $recref->{shell} = '/bin/sync';
1206 $recref->{quota} =~ /^(\d*)$/ or return "Illegal quota (unimplemented)";
1207 $recref->{quota} = $1;
1210 $recref->{gid} ne '' ?
1211 return "Can't have gid without uid" : ( $recref->{gid}='' );
1212 $recref->{finger} ne '' ?
1213 return "Can't have finger-name without uid" : ( $recref->{finger}='' );
1214 $recref->{dir} ne '' ?
1215 return "Can't have directory without uid" : ( $recref->{dir}='' );
1216 $recref->{shell} ne '' ?
1217 return "Can't have shell without uid" : ( $recref->{shell}='' );
1218 $recref->{quota} ne '' ?
1219 return "Can't have quota without uid" : ( $recref->{quota}='' );
1222 unless ( $part_svc->part_svc_column('slipip')->columnflag eq 'F' ) {
1223 unless ( $recref->{slipip} eq '0e0' ) {
1224 $recref->{slipip} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/
1225 or return "Illegal slipip". $self->slipip;
1226 $recref->{slipip} = $1;
1228 $recref->{slipip} = '0e0';
1233 #arbitrary RADIUS stuff; allow ut_textn for now
1234 foreach ( grep /^radius_/, fields('svc_acct') ) {
1235 $self->ut_textn($_);
1238 #generate a password if it is blank
1239 $recref->{_password} = join('',map($pw_set[ int(rand $#pw_set) ], (0..7) ) )
1240 unless ( $recref->{_password} );
1242 #if ( $recref->{_password} =~ /^((\*SUSPENDED\* )?)([^\t\n]{4,16})$/ ) {
1243 if ( $recref->{_password} =~ /^((\*SUSPENDED\* )?)([^\t\n]{$passwordmin,$passwordmax})$/ ) {
1244 $recref->{_password} = $1.$3;
1245 #uncomment this to encrypt password immediately upon entry, or run
1246 #bin/crypt_pw in cron to give new users a window during which their
1247 #password is available to techs, for faxing, etc. (also be aware of
1249 #$recref->{password} = $1.
1250 # crypt($3,$saltset[int(rand(64))].$saltset[int(rand(64))]
1252 } elsif ( $recref->{_password} =~ /^((\*SUSPENDED\* )?)([\w\.\/\$]{13,34})$/ ) {
1253 $recref->{_password} = $1.$3;
1254 } elsif ( $recref->{_password} eq '*' ) {
1255 $recref->{_password} = '*';
1256 } elsif ( $recref->{_password} eq '!!' ) {
1257 $recref->{_password} = '!!';
1259 #return "Illegal password";
1260 return "Illegal password: ". $recref->{_password};
1268 Depriciated, use radius_reply instead.
1273 carp "FS::svc_acct::radius depriciated, use radius_reply";
1274 $_[0]->radius_reply;
1279 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1280 reply attributes of this record.
1282 Note that this is now the preferred method for reading RADIUS attributes -
1283 accessing the columns directly is discouraged, as the column names are
1284 expected to change in the future.
1293 my($column, $attrib) = ($1, $2);
1294 #$attrib =~ s/_/\-/g;
1295 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1296 } grep { /^radius_/ && $self->getfield($_) } fields( $self->table );
1297 if ( $self->ip && $self->ip ne '0e0' ) {
1298 $reply{'Framed-IP-Address'} = $self->ip;
1305 Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
1306 check attributes of this record.
1308 Accessing RADIUS attributes directly is not supported and will break in the
1317 my($column, $attrib) = ($1, $2);
1318 #$attrib =~ s/_/\-/g;
1319 ( $FS::raddb::attrib{lc($attrib)}, $self->getfield($column) );
1320 } grep { /^rc_/ && $self->getfield($_) } fields( $self->table );
1325 Returns the domain associated with this account.
1331 if ( $self->domsvc ) {
1332 #$self->svc_domain->domain;
1333 my $svc_domain = $self->svc_domain
1334 or die "no svc_domain.svcnum for svc_acct.domsvc ". $self->domsvc;
1335 $svc_domain->domain;
1337 $mydomain or die "svc_acct.domsvc is null and no legacy domain config file";
1343 Returns the FS::svc_domain record for this account's domain (see
1351 ? $self->{'_domsvc'}
1352 : qsearchs( 'svc_domain', { 'svcnum' => $self->domsvc } );
1357 Returns the FS::cust_svc record for this account (see L<FS::cust_svc>).
1361 qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } );
1366 Returns an email address associated with the account.
1372 $self->username. '@'. $self->domain;
1375 =item seconds_since TIMESTAMP
1377 Returns the number of seconds this account has been online since TIMESTAMP.
1380 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1381 L<Time::Local> and L<Date::Parse> for conversion functions.
1385 #note: POD here, implementation in FS::cust_svc
1388 $self->cust_svc->seconds_since(@_);
1395 The $recref stuff in sub check should be cleaned up.
1397 The suspend, unsuspend and cancel methods update the database, but not the
1398 current object. This is probably a bug as it's unexpected and
1403 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
1404 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
1405 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
1406 L<freeside-queued>), L<Net::SSH>, L<ssh>, L<FS::svc_acct_pop>,
1407 schema.html from the base documentation.