1 package FS::part_export::phone_shellcommands;
4 use vars qw(@ISA %info);
6 use String::ShellQuote;
9 @ISA = qw(FS::part_export);
12 #- modify command (get something from freepbx for changing PINs)
13 #- suspension/unsuspension
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', },
27 'svc' => [qw( svc_phone part_device )],
28 'desc' => 'Run remote commands via SSH, for phone numbers',
29 'options' => \%options,
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:
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)
46 The following variables are available for interpolation (prefixed with new_ or
47 old_ for replace operations):
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 <LI><code>$devicename</code> - Device type (Device type insert and delete commands only)
62 sub rebless { shift; }
66 $self->_export_command('useradd', @_);
71 $self->_export_command('userdel', @_);
76 $self->_export_command('suspend', @_);
79 sub _export_unsuspend {
81 $self->_export_command('unsuspend', @_);
84 sub export_device_insert {
85 my( $self, $svc_phone, $phone_device ) = @_;
86 $self->_export_command('mac_insert', $svc_phone,
87 mac_addr => $phone_device->mac_addr,
88 devicename => $phone_device->part_device->devicename,
92 sub export_device_delete {
93 my( $self, $svc_phone, $phone_device ) = @_;
94 $self->_export_command('mac_delete', $svc_phone,
95 mac_addr => $phone_device->mac_addr,
96 devicename => $phone_device->part_device->devicename,
100 sub _export_command {
101 my ( $self, $action, $svc_phone, %addl_vars) = @_;
102 my $command = $self->option($action);
103 return '' if $command =~ /^\s*$/;
105 #set variable for the command
109 ${$_} = $svc_phone->getfield($_) foreach $svc_phone->fields;
110 ${$_} = $addl_vars{$_} foreach keys %addl_vars;
112 my $cust_pkg = $svc_phone->cust_svc->cust_pkg;
113 my $pkgnum = $cust_pkg ? $cust_pkg->pkgnum : '';
114 my $custnum = $cust_pkg ? $cust_pkg->custnum : '';
115 my $cust_name = $cust_pkg ? $cust_pkg->cust_main->name : '';
116 $cust_name = shell_quote $cust_name;
117 my $sip_password = shell_quote $svc_phone->sip_password;
118 #done setting variables for the command
120 $self->shellcommands_queue( $svc_phone->svcnum,
121 user => $self->option('user')||'root',
122 host => $self->machine,
123 command => eval(qq("$command")),
127 sub _export_replace {
128 my($self, $new, $old ) = (shift, shift, shift);
129 my $command = $self->option('usermod');
131 #set variable for the command
135 ${"old_$_"} = $old->getfield($_) foreach $old->fields;
136 ${"new_$_"} = $new->getfield($_) foreach $new->fields;
139 my $old_cust_pkg = $old->cust_svc->cust_pkg;
140 my $old_pkgnum = $old_cust_pkg ? $old_cust_pkg->pkgnum : '';
141 my $old_custnum = $old_cust_pkg ? $old_cust_pkg->custnum : '';
142 my $cust_pkg = $new->cust_svc->cust_pkg;
143 my $new_pkgnum = $cust_pkg ? $cust_pkg->pkgnum : '';
144 my $new_custnum = $new_cust_pkg ? $new_cust_pkg->custnum : '';
145 my $new_cust_name = $cust_pkg ? $cust_pkg->cust_main->name : '';
146 $new_cust_name = shell_quote $new_cust_name;
147 #done setting variables for the command
149 $self->shellcommands_queue( $new->svcnum,
150 user => $self->option('user')||'root',
151 host => $self->machine,
152 command => eval(qq("$command")),
156 #a good idea to queue anything that could fail or take any time
157 sub shellcommands_queue {
158 my( $self, $svcnum ) = (shift, shift);
159 my $queue = new FS::queue {
161 'job' => "FS::part_export::phone_shellcommands::ssh_cmd",
163 $queue->insert( @_ );
166 sub ssh_cmd { #subroutine, not method
168 &Net::SSH::ssh_cmd( { @_ } );