queue svc_forward remote commands; better commands too
[freeside.git] / FS / FS / svc_forward.pm
index db9180d..7e0a4fd 100644 (file)
@@ -1,12 +1,13 @@
 package FS::svc_forward;
 
 use strict;
-use vars qw( @ISA $nossh_hack $conf $shellmachine @qmailmachines @vpopmailmachines);
-use FS::Record qw( fields qsearch qsearchs );
-use FS::svc_Common;
-use FS::cust_svc;
+use vars qw( @ISA $nossh_hack $conf $shellmachine @qmailmachines
+             @vpopmailmachines );
 use Net::SSH qw(ssh);
 use FS::Conf;
+use FS::Record qw( fields qsearch qsearchs dbh );
+use FS::svc_Common;
+use FS::cust_svc;
 use FS::svc_acct;
 use FS::svc_domain;
 
@@ -15,11 +16,15 @@ use FS::svc_domain;
 #ask FS::UID to run this stuff for us later
 $FS::UID::callback{'FS::svc_forward'} = sub { 
   $conf = new FS::Conf;
-  $shellmachine = $conf->exists('qmailmachines')
-                  ? $conf->config('shellmachine')
-                  : '';
+  if ( $conf->exists('qmailmachines') ) {
+    $shellmachine = $conf->config('shellmachine')
+  } else {
+    $shellmachine = '';
+  }
   if ( $conf->exists('vpopmailmachines') ) {
     @vpopmailmachines = $conf->config('vpopmailmachines');
+  } else {
+    @vpopmailmachines = ();
   }
 };
 
@@ -86,16 +91,16 @@ 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.
 
-If the configuration values (see L<FS::Conf>) vpopmailmachines exist, then
+If the configuration value (see L<FS::Conf>) vpopmailmachines exists, then
 the command:
 
-  [ -d /home/vpopmail/$vdomain/$source ] || {
-    echo "$destination" >> /home/vpopmail/$vdomain/$source/.$qmail
-    chown $vpopuid:$vpopgid /home/vpopmail/$vdomain/$source/.$qmail
+  [ -d $vpopdir/domains/$domain/$source ] && {
+    echo "$destination" >> $vpopdir/domains/$domain/$username/.$qmail
+    chown $vpopuid:$vpopgid $vpopdir/domains/$domain/$username/.$qmail
   }
 
-is executed on each vpopmailmachine via ssh (see L<dot-qmail/"EXTENSION ADDRESSES">).
-This behaviour can be surpressed by setting $FS::svc_forward::nossh_hack true.
+is executed on each vpopmailmachine via ssh (see the vpopmail documentation).
+This behaviour can be supressed by setting $FS::svc_forward::nossh_hack true.
 
 =cut
 
@@ -110,33 +115,42 @@ sub insert {
   local $SIG{TSTP} = 'IGNORE';
   local $SIG{PIPE} = 'IGNORE';
 
-  $error=$self->check;
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  $error = $self->check;
   return $error if $error;
 
   $error = $self->SUPER::insert;
-  return $error if $error;
+  if ($error) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
 
   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 $username = $svc_acct->username;
+  my $domain = $svc_acct->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) {
+    $destination = $self->dstsvc_acct->email;
   } else {
     $destination = $self->dst;
   }
     
-  my $vdomain = $svc_acct->domain;
-
   foreach my $vpopmailmachine ( @vpopmailmachines ) {
-    my ($machine, $vpopdir, $vpopuid, $vpopgid) = split (/\s+/, $vpopmailmachine);
+    my($machine, $vpopdir, $vpopuid, $vpopgid) = split(/\s+/, $vpopmailmachine);
+    my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };  # should be neater
+    my $error = $queue->insert("root\@$machine","[ -d $vpopdir/domains/$domain/$username ] && { echo \"$destination\" >> $vpopdir/domains/$domain/$username/.qmail; chown $vpopuid:$vpopgid $vpopdir/domains/$domain/$username/.qmail; }") 
+      unless $nossh_hack;
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return "queueing job (transaction rolled back): $error";
+    }
 
-    ssh("root\@$machine","[ -d $vpopdir/$vdomain/$source ] || { echo $destination >> $vpopdir/$vdomain/$source/.qmail; chown $vpopuid:$vpopgid $vpopdir/$vdomain/$source/.qmail; }")  
-      if ( ! $nossh_hack && $machine);
   }
 
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
   ''; #no error
 
 }
@@ -148,19 +162,188 @@ returns the error, otherwise returns false.
 
 The corresponding FS::cust_svc record will be deleted as well.
 
+If the configuration value vpopmailmachines exists, then the command:
+
+  { sed -e '/^$destination/d' < 
+      $vpopdir/domains/$srcdomain/$srcusername/.qmail >
+      $vpopdir/domains/$srcdomain/$srcusername/.qmail.temp;
+    mv $vpopdir/domains/$srcdomain/$srcusername/.qmail.temp
+      $vpopdir/domains/$srcdomain/$srcusername/.qmail;
+    chown $vpopuid.$vpopgid $vpopdir/domains/$srcdomain/$srcusername/.qmail; }
+    
+
+is executed on each vpopmailmachine via ssh.  This behaviour can be supressed
+by setting $FS::svc_forward_nossh_hack true.
+
+=cut
+
+sub delete {
+  my $self = shift;
+
+  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 $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::Autocommit = 0;
+  my $dbh = dbh;
+
+  my $error = $self->SUPER::delete;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  my $svc_acct = $self->srcsvc_acct;
+  my $username = $svc_acct->username;
+  my $domain = $svc_acct->domain;
+  my $destination;
+  if ($self->dstsvc) {
+    $destination = $self->dstsvc_acct->email;
+  } else {
+    $destination = $self->dst;
+  }
+  foreach my $vpopmailmachine ( @vpopmailmachines ) {
+    my($machine, $vpopdir, $vpopuid, $vpopgid) =
+      split(/\s+/, $vpopmailmachine);
+    my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };  # should be neater
+    my $error = $queue->insert("root\@$machine",
+      "sed -e '/^$destination/d' " .
+        "< $vpopdir/domains/$domain/$username/.qmail" .
+        "> $vpopdir/domains/$domain/$username/.qmail.temp; " .
+      "mv $vpopdir/domains/$domain/$username/.qmail.temp " .
+        "$vpopdir/domains/$domain/$username/.qmail; " .
+      "chown $vpopuid.$vpopgid $vpopdir/domains/$domain/$username/.qmail;"
+    )
+      unless $nossh_hack;
+
+    if ($error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return "queueing job (transaction rolled back): $error";
+    }
+
+  }
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+  '';
+}
+
+
 =item replace OLD_RECORD
 
 Replaces OLD_RECORD with this one in the database.  If there is an error,
 returns the error, otherwise returns false.
 
+If the configuration value vpopmailmachines exists, then the command:
+
+  { sed -e '/^$destination/d' < 
+      $vpopdir/domains/$srcdomain/$srcusername/.qmail >
+      $vpopdir/domains/$srcdomain/$srcusername/.qmail.temp;
+    mv $vpopdir/domains/$srcdomain/$srcusername/.qmail.temp
+      $vpopdir/domains/$srcdomain/$srcusername/.qmail; 
+    chown $vpopuid.$vpopgid $vpopdir/domains/$srcdomain/$srcusername/.qmail; }
+    
+
+is executed on each vpopmailmachine via ssh.  This behaviour can be supressed
+by setting $FS::svc_forward_nossh_hack true.
+
+Also, if the configuration value vpopmailmachines exists, then the command:
+
+  [ -d $vpopdir/domains/$domain/$source ] && {
+    echo "$destination" >> $vpopdir/domains/$domain/$username/.$qmail
+    chown $vpopuid:$vpopgid $vpopdir/domains/$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 {
   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!"
+  }
+
+  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 $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  my $error = $new->SUPER::replace($old);
+  if ($error) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  my $old_svc_acct = $old->srcsvc_acct;
+  my $old_username = $old_svc_acct->username;
+  my $old_domain = $old_svc_acct->domain;
+  my $destination;
+  if ($old->dstsvc) {
+    $destination = $old->dstsvc_acct->email;
+  } else {
+    $destination = $old->dst;
+  }
+  foreach my $vpopmailmachine ( @vpopmailmachines ) {
+    my($machine, $vpopdir, $vpopuid, $vpopgid) =
+      split(/\s+/, $vpopmailmachine);
+    my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };  # should be neater
+    my $error = $queue->insert("root\@$machine",
+      "sed -e '/^$destination/d' " .
+        "< $vpopdir/domains/$old_domain/$old_username/.qmail" .
+        "> $vpopdir/domains/$old_domain/$old_username/.qmail.temp; " .
+      "mv $vpopdir/domains/$old_domain/$old_username/.qmail.temp " .
+        "$vpopdir/domains/$old_domain/$old_username/.qmail; " .
+      "chown $vpopuid.$vpopgid " .
+        "$vpopdir/domains/$old_domain/$old_username/.qmail;"
+    )
+      unless $nossh_hack;
+
+    if ( $error ) {
+       $dbh->rollback if $oldAutoCommit;
+       return "queueing job (transaction rolled back): $error";
+    }
+  }
+
+  #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;
+  if ($new->dstsvc) {
+    $destination = $new->dstsvc_acct->email;
+  } else {
+    $destination = $new->dst;
+  }
+  
+  foreach my $vpopmailmachine ( @vpopmailmachines ) {
+    my($machine, $vpopdir, $vpopuid, $vpopgid) = split(/\s+/, $vpopmailmachine);
+    my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };  # should be neater
+    my $error = $queue->insert("root\@$machine","[ -d $vpopdir/domains/$domain/$username ] && { echo \"$destination\" >> $vpopdir/domains/$domain/$username/.qmail; chown $vpopuid:$vpopgid $vpopdir/domains/$domain/$username/.qmail; }") 
+      unless $nossh_hack;
+    if ( $error ) {
+       $dbh->rollback if $oldAutoCommit;
+       return "queueing job (transaction rolled back): $error";
+    }
+  }
+  #end subroutinable bits
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+  '';
 }
 
 =item suspend
@@ -193,55 +376,75 @@ Sets any fixed values; see L<FS::part_svc>.
 
 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($recref) = $self->hashref;
+  my $error = $self->ut_numbern('svcnum')
+              || $self->ut_number('srcsvc')
+              || $self->ut_numbern('dstsvc')
+  ;
+  return $error if $error;
 
-  $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" unless $self->srcsvc_acct;
 
-  return "Illegal use of dstsvc and dst" if
-    ($recref->{dstsvc} && $recref->{dst});
+  return "Both dstsvc and dst were defined; one 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: $dstsvc" unless $self->dstsvc_acct || ! $self->dstsvc;
+  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 ($recref->{dst}) {
-    $recref->{dst} =~ /^([\w\.\-]+)\@(([\w\.\-]+\.)+\w+)$/
-       or return "Illegal dst";
+  if ( $self->dst ) {
+    $self->dst =~ /^([\w\.\-]+)\@(([\w\-]+\.)+\w+)$/
+       or return "Illegal dst: ". $self->dst;
+    $self->dst("$1\@$2");
+  } else {
+    $self->dst('');
   }
 
   ''; #no error
 }
 
+=item srcsvc_acct
+
+Returns the FS::svc_acct object referenced by the srcsvc column.
+
+=cut
+
+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
+forwards not local to freeside.
+
+=cut
+
+sub dstsvc_acct {
+  my $self = shift;
+  qsearchs('svc_acct', { 'svcnum' => $self->dstsvc } );
+}
+
 =back
 
 =head1 VERSION
 
-$Id: svc_forward.pm,v 1.3 2001-08-19 15:53:35 jeff Exp $
+$Id: svc_forward.pm,v 1.10 2002-02-17 19:07:32 jeff Exp $
 
 =head1 BUGS
 
 The remote commands should be configurable.
 
-The $recref stuff in sub check should be cleaned up.
-
 =head1 SEE ALSO
 
 L<FS::Record>, L<FS::Conf>, L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>,