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', },
26 'desc' => 'Run remote commands via SSH, for phone numbers',
27 'options' => \%options,
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:
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)
44 The following variables are available for interpolation (prefixed with new_ or
45 old_ for replace operations):
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 <LI><code>$pkgnum</code> - Internal package number
57 sub rebless { shift; }
61 $self->_export_command('useradd', @_);
66 $self->_export_command('userdel', @_);
71 $self->_export_command('suspend', @_);
74 sub _export_unsuspend {
76 $self->_export_command('unsuspend', @_);
80 my ( $self, $action, $svc_phone) = (shift, shift, shift);
81 my $command = $self->option($action);
82 return '' if $command =~ /^\s*$/;
84 #set variable for the command
88 ${$_} = $svc_phone->getfield($_) foreach $svc_phone->fields;
90 my $cust_pkg = $svc_phone->cust_svc->cust_pkg;
91 my $pkgnum = $cust_pkg ? $cust_pkg->pkgnum : '';
92 my $cust_name = $cust_pkg ? $cust_pkg->cust_main->name : '';
93 $cust_name = shell_quote $cust_name;
94 my $sip_password = shell_quote $svc_phone->sip_password;
95 #done setting variables for the command
97 $self->shellcommands_queue( $svc_phone->svcnum,
98 user => $self->option('user')||'root',
99 host => $self->machine,
100 command => eval(qq("$command")),
104 sub _export_replace {
105 my($self, $new, $old ) = (shift, shift, shift);
106 my $command = $self->option('usermod');
108 #set variable for the command
112 ${"old_$_"} = $old->getfield($_) foreach $old->fields;
113 ${"new_$_"} = $new->getfield($_) foreach $new->fields;
116 my $old_cust_pkg = $old->cust_svc->cust_pkg;
117 my $old_pkgnum = $old_cust_pkg ? $old_cust_pkg->pkgnum : '';
118 my $cust_pkg = $new->cust_svc->cust_pkg;
119 my $new_pkgnum = $cust_pkg ? $cust_pkg->pkgnum : '';
120 my $new_cust_name = $cust_pkg ? $cust_pkg->cust_main->name : '';
121 $new_cust_name = shell_quote $new_cust_name;
122 #done setting variables for the command
124 $self->shellcommands_queue( $new->svcnum,
125 user => $self->option('user')||'root',
126 host => $self->machine,
127 command => eval(qq("$command")),
131 #a good idea to queue anything that could fail or take any time
132 sub shellcommands_queue {
133 my( $self, $svcnum ) = (shift, shift);
134 my $queue = new FS::queue {
136 'job' => "FS::part_export::phone_shellcommands::ssh_cmd",
138 $queue->insert( @_ );
141 sub ssh_cmd { #subroutine, not method
143 &Net::SSH::ssh_cmd( { @_ } );