FS/FS/part_export/domain_shellcommands.pm

   1 package FS::part_export::domain_shellcommands;
   2
   3 use strict;
   4 use vars qw(@ISA %info);
   5 use Tie::IxHash;
   6 use FS::part_export;
   7
   8 @ISA = qw(FS::part_export);
   9
  10 tie my %options, 'Tie::IxHash',
  11   'user' => { label=>'Remote username', default=>'root' },
  12   'useradd' => { label=>'Insert command',
  13                  default=>'',
  14                },
  15   'userdel'  => { label=>'Delete command',
  16                   default=>'',
  17                 },
  18   'usermod'  => { label=>'Modify command',
  19                   default=>'',
  20                 },
  21 ;
  22
  23 %info = (
  24   'svc'     => 'svc_domain',
  25   'desc'    => 'Run remote commands via SSH, for domains (qmail, ISPMan).',
  26   'options' => \%options,
  27   'notes'   => <<'END'
  28 Run remote commands via SSH, for domains.  You will need to
  29 <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.9:Documentation:Administration:SSH_Keys">setup SSH for unattended operation</a>.
  30 <BR><BR>Use these buttons for some useful presets:
  31 <UL>
  32   <LI>
  33     <INPUT TYPE="button" VALUE="qmail catchall .qmail-domain-default maintenance" onClick='
  34       this.form.useradd.value = "[ \"$uid\" -a \"$gid\" -a \"$dir\" -a \"$qdomain\" ] && [ -e $dir/.qmail-$qdomain-default ] || { touch $dir/.qmail-$qdomain-default; chown $uid:$gid $dir/.qmail-$qdomain-default; }";
  35       this.form.userdel.value = "";
  36       this.form.usermod.value = "";
  37     '>
  38   <LI>
  39     <INPUT TYPE="button" VALUE="ISPMan CLI" onClick='
  40       this.form.useradd.value = "/usr/local/ispman/bin/ispman.addDomain -d $domain changeme";
  41       this.form.userdel.value = "/usr/local/ispman/bin/ispman.deleteDomain -d $domain";
  42       this.form.usermod.value = "";
  43     '>
  44 </UL>
  45 The following variables are available for interpolation (prefixed with <code>new_</code> or <code>old_</code> for replace operations):
  46 <UL>
  47   <LI><code>$domain</code>
  48   <LI><code>$qdomain</code> - domain with periods replaced by colons
  49   <LI><code>$uid</code> - of catchall account
  50   <LI><code>$gid</code> - of catchall account
  51   <LI><code>$dir</code> - home directory of catchall account
  52   <LI>All other fields in
  53     <a href="../docs/schema.html#svc_domain">svc_domain</a> are also available.
  54 </UL>
  55 END
  56 );
  57
  58 sub rebless { shift; }
  59
  60 sub _export_insert {
  61   my($self) = shift;
  62   $self->_export_command('useradd', @_);
  63 }
  64
  65 sub _export_delete {
  66   my($self) = shift;
  67   $self->_export_command('userdel', @_);
  68 }
  69
  70 sub _export_command {
  71   my ( $self, $action, $svc_domain) = (shift, shift, shift);
  72   my $command = $self->option($action);
  73   return '' if $command =~ /^\s*$/;
  74
  75   #set variable for the command
  76   no strict 'vars';
  77   {
  78     no strict 'refs';
  79     ${$_} = $svc_domain->getfield($_) foreach $svc_domain->fields;
  80   }
  81   ( $qdomain = $domain ) =~ s/\./:/g; #see dot-qmail(5): EXTENSION ADDRESSES
  82
  83   if ( $svc_domain->catchall ) {
  84     no strict 'refs';
  85     my $svc_acct = $svc_domain->catchall_svc_acct;
  86     ${$_} = $svc_acct->getfield($_) foreach qw(uid gid dir);
  87   } else {
  88     no strict 'refs';
  89     ${$_} = '' foreach qw(uid gid dir);
  90   }
  91
  92   #done setting variables for the command
  93
  94   $self->shellcommands_queue( $svc_domain->svcnum,
  95     user         => $self->option('user')||'root',
  96     host         => $self->machine,
  97     command      => eval(qq("$command")),
  98   );
  99 }
 100
 101 sub _export_replace {
 102   my($self, $new, $old ) = (shift, shift, shift);
 103   my $command = $self->option('usermod');
 104
 105   #set variable for the command
 106   no strict 'vars';
 107   {
 108     no strict 'refs';
 109     ${"old_$_"} = $old->getfield($_) foreach $old->fields;
 110     ${"new_$_"} = $new->getfield($_) foreach $new->fields;
 111   }
 112   ( $old_qdomain = $old_domain ) =~ s/\./:/g; #see dot-qmail(5): EXTENSION ADDRESSES
 113   ( $new_qdomain = $new_domain ) =~ s/\./:/g; #see dot-qmail(5): EXTENSION ADDRESSES
 114
 115   {
 116     no strict 'refs';
 117
 118     if ( $old->catchall ) {
 119       my $svc_acct = $old->catchall_svc_acct;
 120       ${"old_$_"} = $svc_acct->getfield($_) foreach qw(uid gid dir);
 121     } else {
 122       ${"old_$_"} = '' foreach qw(uid gid dir);
 123     }
 124     if ( $new->catchall ) {
 125       my $svc_acct = $new->catchall_svc_acct;
 126       ${"new_$_"} = $svc_acct->getfield($_) foreach qw(uid gid dir);
 127     } else {
 128       ${"new_$_"} = '' foreach qw(uid gid dir);
 129     }
 130
 131   }
 132
 133   #done setting variables for the command
 134
 135   $self->shellcommands_queue( $new->svcnum,
 136     user         => $self->option('user')||'root',
 137     host         => $self->machine,
 138     command      => eval(qq("$command")),
 139   );
 140 }
 141
 142 #a good idea to queue anything that could fail or take any time
 143 sub shellcommands_queue {
 144   my( $self, $svcnum ) = (shift, shift);
 145   my $queue = new FS::queue {
 146     'svcnum' => $svcnum,
 147     'job'    => "FS::part_export::domain_shellcommands::ssh_cmd",
 148   };
 149   $queue->insert( @_ );
 150 }
 151
 152 sub ssh_cmd { #subroutine, not method
 153   use Net::SSH '0.08';
 154   &Net::SSH::ssh_cmd( { @_ } );
 155 }
 156
 157 #sub shellcommands_insert { #subroutine, not method
 158 #}
 159 #sub shellcommands_replace { #subroutine, not method
 160 #}
 161 #sub shellcommands_delete { #subroutine, not method
 162 #}
 163
 164 1;
 165