X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fsvc_forward.pm;h=044e41da9cb27e0903b009989680cf9469615c2c;hp=b82ed2b8560f602802424ccf834283ccd6eb1001;hb=8f1500df332a86f1abe55a046778e42b21459430;hpb=c6708c86785662d8f0c12e23936bf7b1916f411c diff --git a/FS/FS/svc_forward.pm b/FS/FS/svc_forward.pm index b82ed2b85..044e41da9 100644 --- a/FS/FS/svc_forward.pm +++ b/FS/FS/svc_forward.pm @@ -1,11 +1,9 @@ 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; @@ -13,21 +11,6 @@ use FS::svc_domain; @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 @@ -64,9 +47,11 @@ inherits from FS::Record. The following fields are currently supported: =item srcsvc - svcnum of the source of the forward (see L) +=item src - literal source (username or full email address) + =item dstsvc - svcnum of the destination of the forward (see L) -=item dst - foreign destination (email address) - forward not local to freeside +=item dst - literal destination (username or full email address) =back @@ -81,70 +66,80 @@ database, see L<"insert">. =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) should be -defined. An FS::cust_svc record will be created and inserted. +=cut -If the configuration values (see L) vpopmailmachines exist, then -the command: +sub search_sql { + my( $class, $string ) = @_; + $class->search_sql_field('src', $string); +} - [ -d /home/vpopmail/$vdomain/$source ] || { - echo "$destination" >> /home/vpopmail/$vdomain/$source/.$qmail - chown $vpopuid:$vpopgid /home/vpopmail/$vdomain/$source/.$qmail - } +=item label [ END_TIMESTAMP [ START_TIMESTAMP ] ] -is executed on each vpopmailmachine via ssh (see L). -This behaviour can be surpressed 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; - - 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 $tag = ''; - $error=$self->check; - return $error if $error; + if ( $self->srcsvc ) { + my $svc_acct = $self->srcsvc_acct(@_); + $tag = $svc_acct->email(@_); + } else { + $tag = $self->src; + } - $error = $self->SUPER::insert; - return $error if $error; + $tag .= ' -> '; - my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $self->srcsvc } ); - my $svc_domain = qsearchs( 'svc_domain', { 'svcnum' => $svc_acct->domsvc } ); - my $source = $svc_acct->username . $svc_domain->domain; - my $destination; - if ($self->dstdvc) { - my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $self->dstsvc } ); - my $svc_domain = qsearchs( 'svc_domain', { 'svcnum' => $svc_acct->domsvc } ); - $destination = $svc_acct->username . $svc_domain->domain; + if ( $self->dstsvc ) { + my $svc_acct = $self->dstsvc_acct(@_); + $tag .= $svc_acct->email(@_); } else { - $destination = $self->dst; + $tag .= $self->dst; } - - my $vdomain = $svc_acct->domain; - foreach my $vpopmailmachine ( @vpopmailmachines ) { - my ($machine, $vpopdir, $vpopuid, $vpopgid) = split (/\s+/, $vpopmailmachine); + $tag; +} - ssh("root\@$machine","[ -d $vpopdir/$vdomain/$source ] || { echo $destination >> $vpopdir/$vdomain/$source/.qmail; chown $vpopuid:$vpopgid $vpopdir/$vdomain/$source/.qmail; }") - if ( ! $nossh_hack && $machine); - } - ''; #no error +=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) should be +defined. An FS::cust_svc record will be created and inserted. + +Currently available options are: I + +If I 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 @@ -162,10 +157,16 @@ returns the error, otherwise returns false. sub replace { my ( $new, $old ) = ( shift, shift ); - my $error; - $new->SUPER::replace($old); + if ( $new->srcsvc != $old->srcsvc + && ( $new->dstsvc != $old->dstsvc + || ! $new->dstsvc && $new->dst ne $old->dst + ) + ) { + return "Can't change both source and destination of a mail forward!" + } + $new->SUPER::replace($old, @_); } =item suspend @@ -198,60 +199,143 @@ Sets any fixed values; see L. sub check { my $self = shift; - my $error; my $x = $self->setfixed; return $x unless ref($x); - my $part_svc = $x; + #my $part_svc = $x; + + my $error = $self->ut_numbern('svcnum') + || $self->ut_numbern('srcsvc') + || $self->ut_numbern('dstsvc') + ; + return $error if $error; + + return "Both srcsvc and src were defined; only one can be specified" + if $self->srcsvc && $self->src; - my($recref) = $self->hashref; + return "one of srcsvc or src is required" + unless $self->srcsvc || $self->src; - $recref->{srcsvc} =~ /^(\d+)$/ or return "Illegal srcsvc"; - $recref->{srcsvc} = $1; - my($svc_acct); - return "Unknown srcsvc" unless - $svc_acct=qsearchs('svc_acct',{'svcnum'=> $recref->{srcsvc} } ); + return "Unknown srcsvc: ". $self->srcsvc + unless ! $self->srcsvc || $self->srcsvc_acct; - return "Illegal use of dstsvc and dst" if - ($recref->{dstsvc} && $recref->{dst}); + return "Both dstsvc and dst were defined; only one can be specified" + if $self->dstsvc && $self->dst; - return "Illegal use of dstsvc and dst" if - (! $recref->{dstsvc} && ! $recref->{dst}); + return "one of dstsvc or dst is required" + unless $self->dstsvc || $self->dst; - $recref->{dstsvc} =~ /^(\d+)$/ or return "Illegal dstsvc"; - $recref->{dstsvc} = $1; + return "Unknown dstsvc: ". $self->dstsvc + unless ! $self->dstsvc || $self->dstsvc_acct; + #return "Unknown dstsvc" + # unless qsearchs('svc_acct', { 'svcnum' => $self->dstsvc } ) + # || ! $self->dstsvc; - if ($recref->{dstsvc}) { - my($svc_acct); - return "Unknown dstsvc" unless - my $svc_domain=qsearchs('svc_acct',{'svcnum'=> $recref->{dstsvc} } ); + if ( $self->src ) { + $self->src =~ /^([\w\.\-\&]*)(\@([\w\-]+\.)+\w+)$/ + or return "Illegal src: ". $self->src; + $self->src("$1$2"); + } else { + $self->src(''); } - if ($recref->{dst}) { - $recref->{dst} =~ /^([\w\.\-]+)\@(([\w\.\-]+\.)+\w+)$/ - or return "Illegal dst"; + if ( $self->dst ) { + 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; } -=back +=item srcsvc_acct -=head1 VERSION +Returns the FS::svc_acct object referenced by the srcsvc column, or false for +literally specified forwards. -$Id: svc_forward.pm,v 1.4 2001-08-20 09:41:52 ivan Exp $ +=cut -=head1 BUGS +sub srcsvc_acct { + my $self = shift; + qsearchs('svc_acct', { 'svcnum' => $self->srcsvc } ); +} + +=item dstsvc_acct + +Returns the FS::svc_acct object referenced by the srcsvc column, or false for +literally specified forwards. + +=cut + +sub dstsvc_acct { + my $self = shift; + qsearchs('svc_acct', { 'svcnum' => $self->dstsvc } ); +} + +=item src_email + +Returns the email address to be forwarded regardless of weither it is local +or remote + +=cut -The remote commands should be configurable. +sub src_email { +my $self = shift; -The $recref stuff in sub check should be cleaned up. +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 + +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, L, L, L, L, -L, L, L, L, L, -schema.html from the base documentation. +L, L, schema.html from the base documentation. =cut