package FS::svc_forward;
use strict;
-use vars qw( @ISA $nossh_hack $conf $shellmachine @qmailmachines
- @vpopmailmachines );
-use Net::SSH qw(ssh);
+use vars qw( @ISA );
use FS::Conf;
-use FS::Record qw( fields qsearch qsearchs );
+use FS::Record qw( fields qsearch qsearchs dbh );
use FS::svc_Common;
use FS::cust_svc;
use FS::svc_acct;
@ISA = qw( FS::svc_Common );
-#ask FS::UID to run this stuff for us later
-$FS::UID::callback{'FS::svc_forward'} = sub {
- $conf = new FS::Conf;
- if ( $conf->exists('qmailmachines') ) {
- $shellmachine = $conf->config('shellmachine')
- } else {
- $shellmachine = '';
- }
- if ( $conf->exists('vpopmailmachines') ) {
- @vpopmailmachines = $conf->config('vpopmailmachines');
- } else {
- @vpopmailmachines = ();
- }
-};
-
=head1 NAME
FS::svc_forward - Object methods for svc_forward records
=item srcsvc - svcnum of the source of the forward (see L<FS::svc_acct>)
+=item src - literal source (username or full email address)
+
=item dstsvc - svcnum of the destination of the forward (see L<FS::svc_acct>)
-=item dst - foreign destination (email address) - forward not local to freeside
+=item dst - literal destination (username or full email address)
=back
=cut
+
+sub table_info {
+ {
+ 'name' => 'Forward',
+ 'name_plural' => 'Mail forwards',
+ 'display_weight' => 30,
+ 'cancel_weight' => 30,
+ 'fields' => {
+ 'srcsvc' => 'service from which mail is to be forwarded',
+ 'dstsvc' => 'service to which mail is to be forwarded',
+ 'dst' => 'someone@another.domain.com to use when dstsvc is 0',
+ },
+ };
+}
+
sub table { 'svc_forward'; }
-=item insert
+=item search_sql STRING
-Adds this mail forwarding alias to the database. If there is an error, returns
-the error, otherwise returns false.
+Class method which returns an SQL fragment to search for the given string.
-The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
-defined. An FS::cust_svc record will be created and inserted.
+=cut
-If the configuration value (see L<FS::Conf>) vpopmailmachines exists, then
-the command:
+sub search_sql {
+ my( $class, $string ) = @_;
+ $class->search_sql_field('src', $string);
+}
- [ -d $vpopdir/$domain/$source ] || {
- echo "$destination" >> $vpopdir/$domain/$username/.$qmail
- chown $vpopuid:$vpopgid $vpopdir/$domain/$username/.$qmail
- }
+=item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
-is executed on each vpopmailmachine via ssh (see the vpopmail documentation).
-This behaviour can be supressed by setting $FS::svc_forward::nossh_hack true.
+Returns a text string representing this forward.
+
+END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
+history records.
=cut
-sub insert {
+sub label {
my $self = shift;
- my $error;
+ my $tag = '';
- local $SIG{HUP} = 'IGNORE';
- local $SIG{INT} = 'IGNORE';
- local $SIG{QUIT} = 'IGNORE';
- local $SIG{TERM} = 'IGNORE';
- local $SIG{TSTP} = 'IGNORE';
- local $SIG{PIPE} = 'IGNORE';
+ if ( $self->srcsvc ) {
+ my $svc_acct = $self->srcsvc_acct(@_);
+ $tag = $svc_acct->email(@_);
+ } else {
+ $tag = $self->src;
+ }
- $error = $self->check;
- return $error if $error;
+ $tag .= ' -> ';
- $error = $self->SUPER::insert;
- return $error if $error;
-
- my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $self->srcsvc } );
- my $username = $svc_acct->username;
- my $domain = $svc_acct->domain;
- my $destination;
- if ($self->dstsvc) {
- my $dst_svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $self->dstsvc } );
- $destination = $dst_svc_acct->email;
+ if ( $self->dstsvc ) {
+ my $svc_acct = $self->dstsvc_acct(@_);
+ $tag .= $svc_acct->email(@_);
} else {
- $destination = $self->dst;
- }
-
- foreach my $vpopmailmachine ( @vpopmailmachines ) {
- my($machine, $vpopdir, $vpopuid, $vpopgid) = split(/\s+/, $vpopmailmachine);
- ssh("root\@$machine","[ -d $vpopdir/$domain/$username ] || { echo \"$destination\" >> $vpopdir/$domain/$username/.qmail; chown $vpopuid:$vpopgid $vpopdir/$domain/$username/.qmail; }")
- unless $nossh_hack;
+ $tag .= $self->dst;
}
- ''; #no error
-
+ $tag;
}
+
+=item insert [ , OPTION => VALUE ... ]
+
+Adds this mail forwarding alias to the database. If there is an error, returns
+the error, otherwise returns false.
+
+The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
+defined. An FS::cust_svc record will be created and inserted.
+
+Currently available options are: I<depend_jobnum>
+
+If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
+jobnums), all provisioning jobs will have a dependancy on the supplied
+jobnum(s) (they will not run until the specific job(s) complete(s)).
+
=item delete
Deletes this mail forwarding alias from the database. If there is an error,
Replaces OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
-If srcsvc changes, and the configuration value vpopmailmachines exists, then
-the command:
-
- rm $vpopdir/$domain/$username/.qmail
-
-is executed on each vpopmailmachine via ssh. This behaviour can be supressed
-by setting $FS::svc_forward_nossh_hack true.
-
-If dstsvc changes (or dstsvc is 0 and dst changes), and the configuration value
-vpopmailmachines exists, then the command:
-
- [ -d $vpopdir/$domain/$source ] || {
- echo "$destination" >> $vpopdir/$domain/$username/.$qmail
- chown $vpopuid:$vpopgid $vpopdir/$domain/$username/.$qmail
- }
-
-is executed on each vpopmailmachine via ssh. This behaviour can be supressed
-by setting $FS::svc_forward_nossh_hack true.
-
=cut
sub replace {
return "Can't change both source and destination of a mail forward!"
}
- local $SIG{HUP} = 'IGNORE';
- local $SIG{INT} = 'IGNORE';
- local $SIG{QUIT} = 'IGNORE';
- local $SIG{TERM} = 'IGNORE';
- local $SIG{TSTP} = 'IGNORE';
- local $SIG{PIPE} = 'IGNORE';
-
- my $error = $new->SUPER::replace($old);
- return $error if $error;
-
- if ( $new->srcsvc != $old->srcsvc ) {
- my $old_svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $old->srcsvc } );
- my $old_username = $old_svc_acct->username;
- my $old_domain = $old_svc_acct->domain;
- foreach my $vpopmailmachine ( @vpopmailmachines ) {
- my($machine, $vpopdir, $vpopuid, $vpopgid) =
- split(/\s+/, $vpopmailmachine);
- ssh("root\@$machine","rm $vpopdir/$old_domain/$old_username/.qmail")
- unless $nossh_hack;
- }
- }
-
- #false laziness with stuff in insert, should subroutine
- my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $new->srcsvc } );
- my $username = $svc_acct->username;
- my $domain = $svc_acct->domain;
- my $destination;
- if ($new->dstsvc) {
- my $dst_svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $new->dstsvc } );
- $destination = $dst_svc_acct->email;
- } else {
- $destination = $new->dst;
- }
-
- foreach my $vpopmailmachine ( @vpopmailmachines ) {
- my($machine, $vpopdir, $vpopuid, $vpopgid) = split(/\s+/, $vpopmailmachine);
- ssh("root\@$machine","[ -d $vpopdir/$domain/$username ] || { echo \"$destination\" >> $vpopdir/$domain/$username/.qmail; chown $vpopuid:$vpopgid $vpopdir/$domain/$username/.qmail; }")
- unless $nossh_hack;
- }
- #end subroutinable bits
-
- '';
+ $new->SUPER::replace($old, @_);
}
=item suspend
#my $part_svc = $x;
my $error = $self->ut_numbern('svcnum')
- || $self->ut_number('srcsvc')
+ || $self->ut_numbern('srcsvc')
|| $self->ut_numbern('dstsvc')
;
return $error if $error;
- return "Unknown srcsvc" unless $self->srcsvc_acct;
+ return "Both srcsvc and src were defined; only one can be specified"
+ if $self->srcsvc && $self->src;
- return "Both dstsvc and dst were defined; one one can be specified"
+ return "one of srcsvc or src is required"
+ unless $self->srcsvc || $self->src;
+
+ return "Unknown srcsvc: ". $self->srcsvc
+ unless ! $self->srcsvc || $self->srcsvc_acct;
+
+ return "Both dstsvc and dst were defined; only one can be specified"
if $self->dstsvc && $self->dst;
return "one of dstsvc or dst is required"
unless $self->dstsvc || $self->dst;
- return "Unknown dstsvc" unless $self->dstsvc_acct || ! $self->dstsvc;
+ return "Unknown dstsvc: ". $self->dstsvc
+ unless ! $self->dstsvc || $self->dstsvc_acct;
+ #return "Unknown dstsvc"
+ # unless qsearchs('svc_acct', { 'svcnum' => $self->dstsvc } )
+ # || ! $self->dstsvc;
+
+ if ( $self->src ) {
+ $self->src =~ /^([\w\.\-\&]*)(\@([\w\-]+\.)+\w+)$/
+ or return "Illegal src: ". $self->src;
+ $self->src("$1$2");
+ } else {
+ $self->src('');
+ }
if ( $self->dst ) {
- $self->dst =~ /^([\w\.\-]+)\@(([\w\-]+\.)+\w+)$/
- or return "Illegal dst: ". $self->dst;
- $self->dst("$1\@$2");
+ my $conf = new FS::Conf;
+ if ( $conf->exists('svc_forward-arbitrary_dst') ) {
+ my $error = $self->ut_textn('dst');
+ return $error if $error;
+ } else {
+ $self->dst =~ /^([\w\.\-\&]*)(\@([\w\-]+\.)+\w+)$/
+ or return "Illegal dst: ". $self->dst;
+ $self->dst("$1$2");
+ }
} else {
$self->dst('');
}
- ''; #no error
+ $self->SUPER::check;
}
=item srcsvc_acct
-Returns the FS::svc_acct object referenced by the srcsvc column.
+Returns the FS::svc_acct object referenced by the srcsvc column, or false for
+literally specified forwards.
=cut
=item dstsvc_acct
Returns the FS::svc_acct object referenced by the srcsvc column, or false for
-forwards not local to freeside.
+literally specified forwards.
-=back
+=cut
sub dstsvc_acct {
my $self = shift;
qsearchs('svc_acct', { 'svcnum' => $self->dstsvc } );
}
-=head1 VERSION
+=item src_email
-$Id: svc_forward.pm,v 1.8 2001-10-29 20:53:38 ivan Exp $
+Returns the email address to be forwarded regardless of weither it is local
+or remote
-=head1 BUGS
+=cut
+
+sub src_email {
+my $self = shift;
+
+if ($self->srcsvc eq '0'){
+ return $self->src;
+} else {
+ my $svc_acct = $self->srcsvc_acct;
+ return $svc_acct->email;
+}}
+
+=item dst_email
+
+Returns the email address which gets forwarded to regardless of weither it is local
+or remote
+
+=cut
+
+sub dst_email {
+my $self = shift;
+
+if ($self->dstsvc eq '0'){
+ return $self->dst;
+} else {
+ my $svc_acct = $self->dstsvc_acct;
+ return $svc_acct->email;
+}}
+
+=item srcsvc_acct_domain
-The remote commands should be configurable.
+Returns the domain of the srcsvc_acct
+
+=cut
+
+sub srcsvc_acct_domain {
+my $self = shift;
+
+ my $svc_acct = $self->srcsvc_acct;
+ return $svc_acct->domain;
+}
+
+
+=back
+
+=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, L<FS::Conf>, L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>,
-L<FS::svc_acct>, L<FS::svc_domain>, L<Net::SSH>, L<ssh>, L<dot-qmail>,
-schema.html from the base documentation.
+L<FS::svc_acct>, L<FS::svc_domain>, schema.html from the base documentation.
=cut
projects / freeside.git / blobdiff