point to wiki docs

[freeside.git] / FS / FS / part_export / forward_shellcommands.pm

diff --git a/FS/FS/part_export/forward_shellcommands.pm b/FS/FS/part_export/forward_shellcommands.pm
index 5d31457..0f79ede 100644 (file)
--- a/FS/FS/part_export/forward_shellcommands.pm
+++ b/FS/FS/part_export/forward_shellcommands.pm
@@ -1,11 +1,59 @@
 package FS::part_export::forward_shellcommands;
 
 use strict;
-use vars qw(@ISA);
+use vars qw(@ISA %info);
+use Tie::IxHash;
 use FS::part_export;
 
 @ISA = qw(FS::part_export);
 
+tie my %options, 'Tie::IxHash',
+  'user' => { label=>'Remote username', default=>'root' },
+  'useradd' => { label=>'Insert command',
+                 default=>'',
+               },
+  'userdel'  => { label=>'Delete command',
+                  default=>'',
+                },
+  'usermod'  => { label=>'Modify command',
+                  default=>'',
+                },
+;
+
+%info = (
+  'svc'     => 'svc_forward',
+  'desc'    => 'Run remote commands via SSH, for forwards',
+  'options' => \%options,
+  'notes'   => <<'END'
+Run remote commands via SSH, for forwards.  You will need to
+<a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.9:Documentation:Administration:SSH_Keys">setup SSH for unattended operation</a>.
+<BR><BR>Use these buttons for some useful presets:
+<UL>
+  <LI>
+    <INPUT TYPE="button" VALUE="text vpopmail maintenance" onClick='
+      this.form.useradd.value = "[ -d /home/vpopmail/domains/$domain/$username ] && { echo \"$destination\" > /home/vpopmail/domains/$domain/$username/.qmail; chown vpopmail:vchkpw /home/vpopmail/domains/$domain/$username/.qmail; }";
+      this.form.userdel.value = "rm /home/vpopmail/domains/$domain/$username/.qmail";
+      this.form.usermod.value = "mv /home/vpopmail/domains/$old_domain/$old_username/.qmail /home/vpopmail/domains/$new_domain/$new_username; [ \"$old_destination\" != \"$new_destination\" ] && { echo \"$new_destination\" > /home/vpopmail/domains/$new_domain/$new_username/.qmail; chown vpopmail:vchkpw /home/vpopmail/domains/$new_domain/$new_username/.qmail; }";
+    '>
+  <LI>
+    <INPUT TYPE="button" VALUE="ISPMan CLI" onClick='
+      this.form.useradd.value = "";
+      this.form.userdel.value = "";
+      this.form.usermod.value = "";
+    '>
+</UL>
+The following variables are available for interpolation (prefixed with
+<code>new_</code> or <code>old_</code> for replace operations):
+<UL>
+  <LI><code>$username</code> - username of forward source
+  <LI><code>$domain</code> - domain of forward source
+  <LI><code>$source</code> - forward source ($username@$domain)
+  <LI><code>$destination</code> - forward destination
+  <LI>All other fields in <a href="../docs/schema.html#svc_forward">svc_forward</a> are also available.
+</UL>
+END
+);
+
 sub rebless { shift; }
 
 sub _export_insert {
@@ -21,6 +69,7 @@ sub _export_delete {
 sub _export_command {
   my ( $self, $action, $svc_forward ) = (shift, shift, shift);
   my $command = $self->option($action);
+  return '' if $command =~ /^\s*$/;
 
   #set variable for the command
   no strict 'vars';
@@ -29,10 +78,17 @@ sub _export_command {
     ${$_} = $svc_forward->getfield($_) foreach $svc_forward->fields;
   }
 
-  my $svc_acct = $svc_forward->srcsvc_acct;
-  $username = $svc_acct->username;
-  $domain = $svc_acct->domain;
-  if ($svc_forward->dstsvc_acct) {
+  if ( $svc_forward->srcsvc ) {
+    my $srcsvc_acct = $svc_forward->srcsvc_acct;
+    $username = $srcsvc_acct->username;
+    $domain   = $srcsvc_acct->domain;
+    $source   = $srcsvc_acct->email;
+  } else {
+    $source = $svc_forward->src;
+    ( $username, $domain ) = split(/\@/, $source);
+  }
+
+  if ($svc_forward->dstsvc) {
     $destination = $svc_forward->dstsvc_acct->email;
   } else {
     $destination = $svc_forward->dst;
@@ -59,19 +115,33 @@ sub _export_replace {
     ${"new_$_"} = $new->getfield($_) foreach $new->fields;
   }
 
-  my $old_svc_acct = $old->srcsvc_acct;
-  $old_username = $old_svc_acct->username;
-  $old_domain = $old_svc_acct->domain;
-  if ($old->dstsvc_acct) {
+  if ( $old->srcsvc ) {
+    my $srcsvc_acct = $old->srcsvc_acct;
+    $old_username = $srcsvc_acct->username;
+    $old_domain   = $srcsvc_acct->domain;
+    $old_source   = $srcsvc_acct->email;
+  } else {
+    $old_source = $old->src;
+    ( $old_username, $old_domain ) = split(/\@/, $old_source);
+  }
+
+  if ( $old->dstsvc ) {
     $old_destination = $old->dstsvc_acct->email;
   } else {
     $old_destination = $old->dst;
   }
 
-  my $new_svc_acct = $new->srcsvc_acct;
-  $new_username = $new_svc_acct->username;
-  $new_domain = $new_svc_acct->domain;
-  if ($new->dstsvc) {
+  if ( $new->srcsvc ) {
+    my $srcsvc_acct = $new->srcsvc_acct;
+    $new_username = $srcsvc_acct->username;
+    $new_domain   = $srcsvc_acct->domain;
+    $new_source   = $srcsvc_acct->email;
+  } else {
+    $new_source = $new->src;
+    ( $new_username, $new_domain ) = split(/\@/, $new_source);
+  }
+
+  if ( $new->dstsvc ) {
     $new_destination = $new->dstsvc_acct->email;
   } else {
     $new_destination = $new->dst;
@@ -108,3 +178,5 @@ sub ssh_cmd { #subroutine, not method
 #sub shellcommands_delete { #subroutine, not method
 #}
 
+1;
+