1 package FS::svc_acct_sm;
4 use vars qw( @ISA $nossh_hack $conf $shellmachine @qmailmachines );
5 use FS::Record qw( fields qsearch qsearchs );
13 @ISA = qw( FS::svc_Common );
15 #ask FS::UID to run this stuff for us later
16 #$FS::UID::callback{'FS::svc_acct_sm'} = sub {
17 # $conf = new FS::Conf;
18 # $shellmachine = $conf->exists('qmailmachines')
19 # ? $conf->config('shellmachine')
25 FS::svc_acct_sm - Object methods for svc_acct_sm records
31 $record = new FS::svc_acct_sm \%hash;
32 $record = new FS::svc_acct_sm { 'column' => 'value' };
34 $error = $record->insert;
36 $error = $new_record->replace($old_record);
38 $error = $record->delete;
40 $error = $record->check;
42 $error = $record->suspend;
44 $error = $record->unsuspend;
46 $error = $record->cancel;
50 FS::svc_acct_sm is B<depreciated>. This class is only included for migration
51 purposes. See L<FS::svc_forward>.
55 An FS::svc_acct_sm object represents a virtual mail alias. FS::svc_acct_sm
56 inherits from FS::Record. The following fields are currently supported:
60 =item svcnum - primary key (assigned automatcially for new accounts)
62 =item domsvc - svcnum of the virtual domain (see L<FS::svc_domain>)
64 =item domuid - uid of the target account (see L<FS::svc_acct>)
66 =item domuser - virtual username
76 Creates a new virtual mail alias. To add the virtual mail alias to the
77 database, see L<"insert">.
81 sub table { 'svc_acct_sm'; }
85 Adds this virtual mail alias to the database. If there is an error, returns
86 the error, otherwise returns false.
88 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
89 defined. An FS::cust_svc record will be created and inserted.
91 #If the configuration values (see L<FS::Conf>) shellmachine and qmailmachines
92 #exist, and domuser is `*' (meaning a catch-all mailbox), the command:
94 # [ -e $dir/.qmail-$qdomain-default ] || {
95 # touch $dir/.qmail-$qdomain-default;
96 # chown $uid:$gid $dir/.qmail-$qdomain-default;
99 #is executed on shellmachine via ssh (see L<dot-qmail/"EXTENSION ADDRESSES">).
100 #This behaviour can be surpressed by setting $FS::svc_acct_sm::nossh_hack true.
108 local $SIG{HUP} = 'IGNORE';
109 local $SIG{INT} = 'IGNORE';
110 local $SIG{QUIT} = 'IGNORE';
111 local $SIG{TERM} = 'IGNORE';
112 local $SIG{TSTP} = 'IGNORE';
113 local $SIG{PIPE} = 'IGNORE';
116 return $error if $error;
118 return "Domain username (domuser) in use for this domain (domsvc)"
119 if qsearchs('svc_acct_sm',{ 'domuser'=> $self->domuser,
120 'domsvc' => $self->domsvc,
123 return "First domain username (domuser) for domain (domsvc) must be " .
125 if $self->domuser ne '*'
126 && ! qsearch('svc_acct_sm',{ 'domsvc' => $self->domsvc } )
127 && ! $conf->exists('maildisablecatchall');
129 $error = $self->SUPER::insert;
130 return $error if $error;
132 #my $svc_domain = qsearchs( 'svc_domain', { 'svcnum' => $self->domsvc } );
133 #my $svc_acct = qsearchs( 'svc_acct', { 'uid' => $self->domuid } );
134 #my ( $uid, $gid, $dir, $domain ) = (
138 # $svc_domain->domain,
140 #my $qdomain = $domain;
141 #$qdomain =~ s/\./:/g; #see manpage for 'dot-qmail': EXTENSION ADDRESSES
142 #ssh("root\@$shellmachine","[ -e $dir/.qmail-$qdomain-default ] || { touch $dir/.qmail-$qdomain-default; chown $uid:$gid $dir/.qmail-$qdomain-default; }")
143 # if ( ! $nossh_hack && $shellmachine && $dir && $self->domuser eq '*' );
151 Deletes this virtual mail alias from the database. If there is an error,
152 returns the error, otherwise returns false.
154 The corresponding FS::cust_svc record will be deleted as well.
156 =item replace OLD_RECORD
158 Replaces OLD_RECORD with this one in the database. If there is an error,
159 returns the error, otherwise returns false.
164 my ( $new, $old ) = ( shift, shift );
167 return "Domain username (domuser) in use for this domain (domsvc)"
168 if ( $old->domuser ne $new->domuser
169 || $old->domsvc != $new->domsvc
170 ) && qsearchs('svc_acct_sm',{
171 'domuser'=> $new->domuser,
172 'domsvc' => $new->domsvc,
176 $new->SUPER::replace($old);
182 Just returns false (no error) for now.
184 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
188 Just returns false (no error) for now.
190 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
194 Just returns false (no error) for now.
196 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
200 Checks all fields to make sure this is a valid virtual mail alias. If there is
201 an error, returns the error, otherwise returns false. Called by the insert and
204 Sets any fixed values; see L<FS::part_svc>.
212 my $x = $self->setfixed;
213 return $x unless ref($x);
216 my($recref) = $self->hashref;
218 $recref->{domuser} =~ /^(\*|[a-z0-9_\-]{2,32})$/
219 or return "Illegal domain username (domuser)";
220 $recref->{domuser} = $1;
222 $recref->{domsvc} =~ /^(\d+)$/ or return "Illegal domsvc";
223 $recref->{domsvc} = $1;
225 return "Unknown domsvc" unless
226 $svc_domain=qsearchs('svc_domain',{'svcnum'=> $recref->{domsvc} } );
228 $recref->{domuid} =~ /^(\d+)$/ or return "Illegal uid";
229 $recref->{domuid} = $1;
231 return "Unknown uid" unless
232 $svc_acct=qsearchs('svc_acct',{'uid'=> $recref->{domuid} } );
241 $Id: svc_acct_sm.pm,v 1.5 2001-09-06 20:41:59 ivan Exp $
245 The remote commands should be configurable.
247 The $recref stuff in sub check should be cleaned up.
253 L<FS::Record>, L<FS::Conf>, L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>,
254 L<FS::svc_acct>, L<FS::svc_domain>, L<Net::SSH>, L<ssh>, L<dot-qmail>,
255 schema.html from the base documentation.