FS/FS/part_export/phone_shellcommands.pm

   1 package FS::part_export::phone_shellcommands;
   2
   3 use strict;
   4 use vars qw(@ISA %info);
   5 use Tie::IxHash;
   6 use String::ShellQuote;
   7 use FS::part_export;
   8
   9 @ISA = qw(FS::part_export);
  10
  11 #TODO
  12 #- modify command (get something from freepbx for changing PINs)
  13 #- suspension/unsuspension
  14
  15 tie my %options, 'Tie::IxHash',
  16   'user'      => { label=>'Remote username', default=>'root', },
  17   'useradd'   => { label=>'Insert command', },
  18   'userdel'   => { label=>'Delete command', },
  19   'usermod'   => { label=>'Modify command', },
  20   'suspend'   => { label=>'Suspension command', },
  21   'unsuspend' => { label=>'Unsuspension command', },
  22 ;
  23
  24 %info = (
  25   'svc'     => 'svc_phone',
  26   'desc'    => 'Run remote commands via SSH, for phone numbers',
  27   'options' => \%options,
  28   'notes'   => <<'END'
  29 Run remote commands via SSH, for phone numbers.  You will need to
  30 <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.9:Documentation:Administration:SSH_Keys">setup SSH for unattended operation</a>.
  31 <BR><BR>Use these buttons for some useful presets:
  32 <UL>
  33   <LI>
  34     <INPUT TYPE="button" VALUE="FreePBX (build_exten CLI module needed)" onClick='
  35       this.form.user.value = "root";
  36       this.form.useradd.value = "build_exten.php --create --exten $phonenum --directdid 1$phonenum --sip-secret $sip_password --name $cust_name --vm-password $pin && /usr/share/asterisk/bin/module_admin reload";
  37       this.form.userdel.value = "build_exten.php --delete --exten $phonenum && /usr/share/asterisk/bin/module_admin reload";
  38       this.form.usermod.value = "build_exten.php --modify --exten $new_phonenum --directdid 1$new_phonenum --sip-secret $new_sip_password --name $new_cust_name --vm-password $new_pin && /usr/share/asterisk/bin/module_admin reload";
  39       this.form.suspend.value = "";
  40       this.form.unsuspend.value = "";
  41     '> (Important note: Reduce freeside-queued "max_kids" to 1 when using FreePBX integration)
  42   </UL>
  43
  44 The following variables are available for interpolation (prefixed with new_ or
  45 old_ for replace operations):
  46 <UL>
  47   <LI><code>$countrycode</code> - Country code
  48   <LI><code>$phonenum</code> - Phone number
  49   <LI><code>$sip_password</code> - SIP secret (quoted for the shell)
  50   <LI><code>$pin</code> - Personal identification number
  51   <LI><code>$cust_name</code> - Customer name (quoted for the shell)
  52 </UL>
  53 END
  54 );
  55
  56 sub rebless { shift; }
  57
  58 sub _export_insert {
  59   my($self) = shift;
  60   $self->_export_command('useradd', @_);
  61 }
  62
  63 sub _export_delete {
  64   my($self) = shift;
  65   $self->_export_command('userdel', @_);
  66 }
  67
  68 sub _export_suspend {
  69   my($self) = shift;
  70   $self->_export_command('suspend', @_);
  71 }
  72
  73 sub _export_unsuspend {
  74   my($self) = shift;
  75   $self->_export_command('unsuspend', @_);
  76 }
  77
  78 sub _export_command {
  79   my ( $self, $action, $svc_phone) = (shift, shift, shift);
  80   my $command = $self->option($action);
  81   return '' if $command =~ /^\s*$/;
  82
  83   #set variable for the command
  84   no strict 'vars';
  85   {
  86     no strict 'refs';
  87     ${$_} = $svc_phone->getfield($_) foreach $svc_phone->fields;
  88   }
  89   my $cust_pkg = $svc_phone->cust_svc->cust_pkg;
  90   my $cust_name = $cust_pkg ? $cust_pkg->cust_main->name : '';
  91   $cust_name = shell_quote $cust_name;
  92   my $sip_password = shell_quote $svc_phone->sip_password;
  93   #done setting variables for the command
  94
  95   $self->shellcommands_queue( $svc_phone->svcnum,
  96     user         => $self->option('user')||'root',
  97     host         => $self->machine,
  98     command      => eval(qq("$command")),
  99   );
 100 }
 101
 102 sub _export_replace {
 103   my($self, $new, $old ) = (shift, shift, shift);
 104   my $command = $self->option('usermod');
 105
 106   #set variable for the command
 107   no strict 'vars';
 108   {
 109     no strict 'refs';
 110     ${"old_$_"} = $old->getfield($_) foreach $old->fields;
 111     ${"new_$_"} = $new->getfield($_) foreach $new->fields;
 112   }
 113
 114   my $cust_pkg = $new->cust_svc->cust_pkg;
 115   my $new_cust_name = $cust_pkg ? $cust_pkg->cust_main->name : '';
 116   $new_cust_name = shell_quote $new_cust_name;
 117   #done setting variables for the command
 118
 119   $self->shellcommands_queue( $new->svcnum,
 120     user         => $self->option('user')||'root',
 121     host         => $self->machine,
 122     command      => eval(qq("$command")),
 123   );
 124 }
 125
 126 #a good idea to queue anything that could fail or take any time
 127 sub shellcommands_queue {
 128   my( $self, $svcnum ) = (shift, shift);
 129   my $queue = new FS::queue {
 130     'svcnum' => $svcnum,
 131     'job'    => "FS::part_export::phone_shellcommands::ssh_cmd",
 132   };
 133   $queue->insert( @_ );
 134 }
 135
 136 sub ssh_cmd { #subroutine, not method
 137   use Net::SSH '0.08';
 138   &Net::SSH::ssh_cmd( { @_ } );
 139 }
 140