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   'mac_insert' => { label=>'Device MAC address insert command', },
  23   'mac_delete' => { label=>'Device MAC address delete command', },
  24 ;
  25
  26 %info = (
  27   'svc'     => [qw( svc_phone part_device )],
  28   'desc'    => 'Run remote commands via SSH, for phone numbers',
  29   'options' => \%options,
  30   'notes'   => <<'END'
  31 Run remote commands via SSH, for phone numbers.  You will need to
  32 <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.9:Documentation:Administration:SSH_Keys">setup SSH for unattended operation</a>.
  33 <BR><BR>Use these buttons for some useful presets:
  34 <UL>
  35   <LI>
  36     <INPUT TYPE="button" VALUE="FreePBX (build_exten CLI module needed)" onClick='
  37       this.form.user.value = "root";
  38       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";
  39       this.form.userdel.value = "build_exten.php --delete --exten $phonenum && /usr/share/asterisk/bin/module_admin reload";
  40       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";
  41       this.form.suspend.value = "";
  42       this.form.unsuspend.value = "";
  43     '> (Important note: Reduce freeside-queued "max_kids" to 1 when using FreePBX integration)
  44   </UL>
  45
  46 The following variables are available for interpolation (prefixed with new_ or
  47 old_ for replace operations):
  48 <UL>
  49   <LI><code>$countrycode</code> - Country code
  50   <LI><code>$phonenum</code> - Phone number
  51   <LI><code>$sip_password</code> - SIP secret (quoted for the shell)
  52   <LI><code>$pin</code> - Personal identification number
  53   <LI><code>$cust_name</code> - Customer name (quoted for the shell)
  54   <LI><code>$pkgnum</code> - Internal package number
  55   <LI><code>$custnum</code> - Internal customer number
  56   <LI><code>$mac_addr</code> - MAC address (Device MAC address insert and delete commands only)
  57 </UL>
  58 END
  59 );
  60
  61 sub rebless { shift; }
  62
  63 sub _export_insert {
  64   my $self = shift;
  65   $self->_export_command('useradd', @_);
  66 }
  67
  68 sub _export_delete {
  69   my $self = shift;
  70   $self->_export_command('userdel', @_);
  71 }
  72
  73 sub _export_suspend {
  74   my $self = shift;
  75   $self->_export_command('suspend', @_);
  76 }
  77
  78 sub _export_unsuspend {
  79   my $self = shift;
  80   $self->_export_command('unsuspend', @_);
  81 }
  82
  83 sub export_device_insert {
  84   my( $self, $svc_phone, $phone_device ) = @_;
  85   $self->_export_command('mac_insert', $svc_phone,
  86                            'mac_addr'=>$phone_device->mac_addr
  87                         );
  88 }
  89
  90 sub export_device_delete {
  91   my( $self, $svc_phone, $phone_device ) = @_;
  92   $self->_export_command('mac_delete', $svc_phone,
  93                            'mac_addr'=>$phone_device->mac_addr
  94                         );
  95 }
  96
  97 sub _export_command {
  98   my ( $self, $action, $svc_phone, %addl_vars) = @_;
  99   my $command = $self->option($action);
 100   return '' if $command =~ /^\s*$/;
 101
 102   #set variable for the command
 103   no strict 'vars';
 104   {
 105     no strict 'refs';
 106     ${$_} = $svc_phone->getfield($_) foreach $svc_phone->fields;
 107     ${$_} = $addl_vars{$_} foreach keys %addl_vars;
 108   }
 109   my $cust_pkg = $svc_phone->cust_svc->cust_pkg;
 110   my $pkgnum = $cust_pkg ? $cust_pkg->pkgnum : '';
 111   my $custnum = $cust_pkg ? $cust_pkg->custnum : '';
 112   my $cust_name = $cust_pkg ? $cust_pkg->cust_main->name : '';
 113   $cust_name = shell_quote $cust_name;
 114   my $sip_password = shell_quote $svc_phone->sip_password;
 115   #done setting variables for the command
 116
 117   $self->shellcommands_queue( $svc_phone->svcnum,
 118     user         => $self->option('user')||'root',
 119     host         => $self->machine,
 120     command      => eval(qq("$command")),
 121   );
 122 }
 123
 124 sub _export_replace {
 125   my($self, $new, $old ) = (shift, shift, shift);
 126   my $command = $self->option('usermod');
 127
 128   #set variable for the command
 129   no strict 'vars';
 130   {
 131     no strict 'refs';
 132     ${"old_$_"} = $old->getfield($_) foreach $old->fields;
 133     ${"new_$_"} = $new->getfield($_) foreach $new->fields;
 134   }
 135
 136   my $old_cust_pkg = $old->cust_svc->cust_pkg;
 137   my $old_pkgnum = $old_cust_pkg ? $old_cust_pkg->pkgnum : '';
 138   my $old_custnum = $old_cust_pkg ? $old_cust_pkg->custnum : '';
 139   my $cust_pkg = $new->cust_svc->cust_pkg;
 140   my $new_pkgnum = $cust_pkg ? $cust_pkg->pkgnum : '';
 141   my $new_custnum = $new_cust_pkg ? $new_cust_pkg->custnum : '';
 142   my $new_cust_name = $cust_pkg ? $cust_pkg->cust_main->name : '';
 143   $new_cust_name = shell_quote $new_cust_name;
 144   #done setting variables for the command
 145
 146   $self->shellcommands_queue( $new->svcnum,
 147     user         => $self->option('user')||'root',
 148     host         => $self->machine,
 149     command      => eval(qq("$command")),
 150   );
 151 }
 152
 153 #a good idea to queue anything that could fail or take any time
 154 sub shellcommands_queue {
 155   my( $self, $svcnum ) = (shift, shift);
 156   my $queue = new FS::queue {
 157     'svcnum' => $svcnum,
 158     'job'    => "FS::part_export::phone_shellcommands::ssh_cmd",
 159   };
 160   $queue->insert( @_ );
 161 }
 162
 163 sub ssh_cmd { #subroutine, not method
 164   use Net::SSH '0.08';
 165   &Net::SSH::ssh_cmd( { @_ } );
 166 }
 167
 168 1;