FS/FS/part_export/shellcommands.pm

   1 package FS::part_export::shellcommands;
   2
   3 use vars qw(@ISA %info);
   4 use Tie::IxHash;
   5 use Date::Format;
   6 use String::ShellQuote;
   7 use FS::part_export;
   8 use FS::Record qw( qsearch qsearchs );
   9
  10 @ISA = qw(FS::part_export);
  11
  12 tie my %options, 'Tie::IxHash',
  13
  14   'user' => { label=>'Remote username', default=>'root' },
  15
  16   'useradd' => { label=>'Insert command',
  17                  default=>'useradd -c $finger -d $dir -m -s $shell -u $uid -p $crypt_password $username'
  18                 #default=>'cp -pr /etc/skel $dir; chown -R $uid.$gid $dir'
  19                },
  20   'useradd_no_queue' => { label=>'Run immediately',
  21                           type => 'checkbox',
  22                         },
  23   'useradd_stdin' => { label=>'Insert command STDIN',
  24                        type =>'textarea',
  25                        default=>'',
  26                      },
  27
  28   'userdel' => { label=>'Delete command',
  29                  default=>'userdel -r $username',
  30                  #default=>'rm -rf $dir',
  31                },
  32   'userdel_no_queue' => { label=>'Run immediately',
  33                           type =>'checkbox',
  34                         },
  35   'userdel_stdin' => { label=>'Delete command STDIN',
  36                        type =>'textarea',
  37                        default=>'',
  38                      },
  39
  40   'usermod' => { label=>'Modify command',
  41                  default=>'usermod -c $new_finger -d $new_dir -m -l $new_username -s $new_shell -u $new_uid -g $new_gid -p $new_crypt_password $old_username',
  42                 #default=>'[ -d $old_dir ] && mv $old_dir $new_dir || ( '.
  43                  #  'chmod u+t $old_dir; mkdir $new_dir; cd $old_dir; '.
  44                  #  'find . -depth -print | cpio -pdm $new_dir; '.
  45                  #  'chmod u-t $new_dir; chown -R $uid.$gid $new_dir; '.
  46                  #  'rm -rf $old_dir'.
  47                  #')'
  48                },
  49   'usermod_no_queue' => { label=>'Run immediately',
  50                           type =>'checkbox',
  51                         },
  52   'usermod_stdin' => { label=>'Modify command STDIN',
  53                        type =>'textarea',
  54                        default=>'',
  55                      },
  56   'usermod_pwonly' => { label=>'Disallow username, domain, uid, gid, and dir changes', #and RADIUS group changes',
  57                         type =>'checkbox',
  58                       },
  59   'usermod_nousername' => { label=>'Disallow just username changes',
  60                             type =>'checkbox',
  61                           },
  62
  63   'suspend' => { label=>'Suspension command',
  64                  default=>'usermod -L $username',
  65                },
  66   'suspend_no_queue' => { label=>'Run immediately',
  67                           type =>'checkbox',
  68                         },
  69   'suspend_stdin' => { label=>'Suspension command STDIN',
  70                        default=>'',
  71                      },
  72
  73   'unsuspend' => { label=>'Unsuspension command',
  74                    default=>'usermod -U $username',
  75                  },
  76   'unsuspend_no_queue' => { label=>'Run immediately',
  77                             type =>'checkbox',
  78                           },
  79   'unsuspend_stdin' => { label=>'Unsuspension command STDIN',
  80                          default=>'',
  81                        },
  82
  83   'pkg_change' => { label=>'Package changed command',
  84                     default=>'',
  85                   },
  86
  87   # run commands on package change for multiple services and roll back the
  88   #  package change transaciton if one fails?  yuck. no.
  89   #  if this was really needed, would need to restrict to a single service with
  90   #  this kind of export configured.
  91   #'pkg_change_no_queue' => { label=>'Run immediately',
  92   #                           type =>'checkbox',
  93   #                         },
  94   'pkg_change_stdin' => { label=>'Package changed command STDIN',
  95                           default=>'',
  96                         },
  97
  98   'crypt' => { label   => 'Default password encryption',
  99                type=>'select', options=>[qw(crypt md5)],
 100                default => 'crypt',
 101              },
 102   'groups_susp_reason' => { label =>
 103                              'Radius group mapping to reason (via template user)',
 104                              type  => 'textarea',
 105                           },
 106   'fail_on_output' => {
 107       label => 'Treat any output from the command as an error',
 108       type  => 'checkbox',
 109   },
 110   'ignore_all_errors' => {
 111       label => 'Ignore all errors from the command',
 112       type  => 'checkbox',
 113   },
 114   'ignored_errors' => { label   => 'Regexes of specific errors to ignore, separated by newlines',
 115                         type    => 'textarea'
 116                       },
 117 #  'no_queue' => { label => 'Run command immediately',
 118 #                   type  => 'checkbox',
 119 #                },
 120 ;
 121
 122 %info = (
 123   'svc'         => 'svc_acct',
 124   'desc'        => 'Real-time export via remote SSH (i.e. useradd, userdel, etc.)',
 125   'options'     => \%options,
 126   'nodomain'    => 'Y',
 127   'svc_machine' => 1,
 128   'notes'       => <<'END'
 129 Run remote commands via SSH.  Usernames are considered unique (also see
 130 shellcommands_withdomain).  You probably want this if the commands you are
 131 running will not accept a domain as a parameter.  You will need to
 132 <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.9:Documentation:Administration:SSH_Keys">setup SSH for unattended operation</a>.
 133
 134 <BR><BR>Use these buttons for some useful presets:
 135 <UL>
 136   <LI>
 137     <INPUT TYPE="button" VALUE="Linux" onClick='
 138       this.form.useradd.value = "useradd -c $finger -d $dir -m -s $shell -u $uid -p $crypt_password $username";
 139       this.form.useradd_stdin.value = "";
 140       this.form.userdel.value = "userdel -r $username";
 141       this.form.userdel_stdin.value="";
 142       this.form.usermod.value = "usermod -c $new_finger -d $new_dir -m -l $new_username -s $new_shell -u $new_uid -g $new_gid -p $new_crypt_password $old_username";
 143       this.form.usermod_stdin.value = "";
 144       this.form.suspend.value = "usermod -L $username";
 145       this.form.suspend_stdin.value="";
 146       this.form.unsuspend.value = "usermod -U $username";
 147       this.form.unsuspend_stdin.value="";
 148     '>
 149   <LI>
 150     <INPUT TYPE="button" VALUE="FreeBSD" onClick='
 151       this.form.useradd.value = "pw useradd $username -d $dir -m -s $shell -u $uid -g $gid -c $finger -h 0";
 152       this.form.useradd_stdin.value = "$_password\n";
 153       this.form.userdel.value = "pw userdel $username -r";
 154       this.form.userdel_stdin.value="";
 155       this.form.usermod.value = "pw usermod $old_username -d $new_dir -m -l $new_username -s $new_shell -u $new_uid -g $new_gid -c $new_finger -h 0";
 156       this.form.usermod_stdin.value = "$new__password\n";
 157       this.form.suspend.value = "pw lock $username";
 158       this.form.suspend_stdin.value="";
 159       this.form.unsuspend.value = "pw unlock $username";
 160       this.form.unsuspend_stdin.value="";
 161     '>
 162   <LI>
 163     <INPUT TYPE="button" VALUE="NetBSD/OpenBSD" onClick='
 164       this.form.useradd.value = "useradd -c $finger -d $dir -m -s $shell -u $uid -p $crypt_password $username";
 165       this.form.useradd_stdin.value = "";
 166       this.form.userdel.value = "userdel -r $username";
 167       this.form.userdel_stdin.value="";
 168       this.form.usermod.value = "usermod -c $new_finger -d $new_dir -m -l $new_username -s $new_shell -u $new_uid -g $new_gid -p $new_crypt_password $old_username";
 169       this.form.usermod_stdin.value = "";
 170       this.form.suspend.value = "";
 171       this.form.suspend_stdin.value="";
 172       this.form.unsuspend.value = "";
 173       this.form.unsuspend_stdin.value="";
 174     '>
 175   <LI>
 176     <INPUT TYPE="button" VALUE="Just maintain directories (use with sysvshell or bsdshell)" onClick='
 177       this.form.useradd.value = "cp -pr /etc/skel $dir; chown -R $uid.$gid $dir"; this.form.useradd_stdin.value = "";
 178       this.form.usermod.value = "[ -d $old_dir ] && mv $old_dir $new_dir || ( chmod u+t $old_dir; mkdir $new_dir; cd $old_dir; find . -depth -print | cpio -pdm $new_dir; chmod u-t $new_dir; chown -R $new_uid.$new_gid $new_dir; rm -rf $old_dir )";
 179       this.form.usermod_stdin.value = "";
 180       this.form.userdel.value = "rm -rf $dir";
 181       this.form.userdel_stdin.value="";
 182       this.form.suspend.value = "";
 183       this.form.suspend_stdin.value="";
 184       this.form.unsuspend.value = "";
 185       this.form.unsuspend_stdin.value="";
 186     '>
 187 </UL>
 188
 189 The following variables are available for interpolation (prefixed with new_ or
 190 old_ for replace operations):
 191 <UL>
 192   <LI><code>$username</code>
 193   <LI><code>$_password</code>
 194   <LI><code>$quoted_password</code> - unencrypted password, already quoted for the shell (do not add additional quotes).
 195   <LI><code>$crypt_password</code> - encrypted password.  When used on the command line (rather than STDIN), it will be quoted for the shell already (do not add additional quotes).
 196   <LI><code>$ldap_password</code> - Password in LDAP/RFC2307 format (for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or "{MD5}5426824942db4253f87a1009fd5d2d4").  When used on the command line (rather than STDIN), it will be quoted for the shell already (do not add additional quotes).
 197   <LI><code>$uid</code>
 198   <LI><code>$gid</code>
 199   <LI><code>$finger</code> - GECOS.  When used on the command line (rather than STDIN), it will be quoted for the shell already (do not add additional quotes).
 200   <LI><code>$first</code> - First name of GECOS.  When used on the command line (rather than STDIN), it will be quoted for the shell already (do not add additional quotes).
 201   <LI><code>$last</code> - Last name of GECOS.  When used on the command line (rather than STDIN), it will be quoted for the shell already (do not add additional quotes).
 202   <LI><code>$dir</code> - home directory
 203   <LI><code>$shell</code>
 204   <LI><code>$quota</code>
 205   <LI><code>@radius_groups</code>
 206   <LI><code>$reasonnum (when suspending)</code>
 207   <LI><code>$reasontext (when suspending)</code>
 208   <LI><code>$reasontypenum (when suspending)</code>
 209   <LI><code>$reasontypetext (when suspending)</code>
 210   <LI><code>$pkgnum</code>
 211   <LI><code>$custnum</code>
 212   <LI>All other fields in <b>svc_acct</b> are also available.
 213   <LI>The following fields from <b>cust_main</b> are also available (except during replace): company, address1, address2, city, state, zip, county, daytime, night, fax, otaker, agent_custid, locale.  When used on the command line (rather than STDIN), they will be quoted for the shell already (do not add additional quotes).
 214 </UL>
 215 For the package changed command only, the following fields are also available:
 216 <UL>
 217   <LI>$old_pkgnum and $new_pkgnum
 218   <LI>$old_pkgpart and $new_pkgpart
 219   <LI>$old_agent_pkgid and $new_agent_pkgid
 220   <LI>$old_order_date and $new_order_date
 221   <LI>$old_start_date and $new_start_date
 222   <LI>$old_setup and $new_setup
 223   <LI>$old_bill and $new_bill
 224   <LI>$old_last_bill and $new_last_bill
 225   <LI>$old_susp and $new_susp
 226   <LI>$old_adjourn and $new_adjourn
 227   <LI>$old_resume and $new_resume
 228   <LI>$old_cancel and $new_cancel
 229   <LI>$old_unancel and $new_unancel
 230   <LI>$old_expire and $new_expire
 231   <LI>$old_contract_end and $new_contract_end
 232 </UL>
 233 END
 234 );
 235
 236 sub _groups_susp_reason_map { shift->_map('groups_susp_reason'); }
 237
 238 sub _map {
 239   my $self = shift;
 240   map { reverse(/^\s*(\S+)\s*(.*)\s*$/) } split("\n", $self->option(shift) );
 241 }
 242
 243 sub rebless { shift; }
 244
 245 sub _export_insert {
 246   my $self = shift;
 247   $self->_export_command('useradd', @_);
 248 }
 249
 250 sub _export_delete {
 251   my $self = shift;
 252   $self->_export_command('userdel', @_);
 253 }
 254
 255 sub _export_suspend {
 256   my $self = shift;
 257   $self->_export_command_or_super('suspend', @_);
 258 }
 259
 260 sub _export_unsuspend {
 261   my $self = shift;
 262   $self->_export_command_or_super('unsuspend', @_);
 263 }
 264
 265 sub export_pkg_change {
 266   my( $self, $svc_acct, $new_cust_pkg, $old_cust_pkg ) = @_;
 267
 268   my @fields = qw( pkgnum pkgpart agent_pkgid ); #others?
 269   my @date_fields = qw( order_date start_date setup bill last_bill susp adjourn
 270                         resume cancel uncancel expire contract_end );
 271
 272   no strict 'vars';
 273   {
 274     no strict 'refs';
 275     foreach (@fields) {
 276       ${"old_$_"} = $old_cust_pkg ? $old_cust_pkg->getfield($_) : '';
 277       ${"new_$_"} = $new_cust_pkg->getfield($_);
 278     }
 279     foreach (@date_fields) {
 280       ${"old_$_"} = $old_cust_pkg
 281                       ? time2str('%Y-%m-%d', $old_cust_pkg->getfield($_))
 282                       : '';
 283       ${"new_$_"} = time2str('%Y-%m-%d', $new_cust_pkg->getfield($_));
 284     }
 285   }
 286
 287   $self->_export_command('pkg_change', $svc_acct);
 288 }
 289
 290 sub _export_command_or_super {
 291   my($self, $action) = (shift, shift);
 292   if ( $self->option($action) =~ /^\s*$/ ) {
 293     my $method = "SUPER::_export_$action";
 294     $self->$method(@_);
 295   } else {
 296     $self->_export_command($action, @_);
 297   }
 298 };
 299
 300 sub _export_command {
 301   my ( $self, $action, $svc_acct) = (shift, shift, shift);
 302   my $command = $self->option($action);
 303
 304   return '' if $command =~ /^\s*$/;
 305   my $stdin = $self->option($action."_stdin");
 306
 307   no strict 'vars';
 308   {
 309     no strict 'refs';
 310     ${$_} = $svc_acct->getfield($_) foreach $svc_acct->fields;
 311
 312     # snarfs are unused at this point?
 313     # my $count = 1;
 314     # foreach my $acct_snarf ( $svc_acct->acct_snarf ) {
 315     #   ${"snarf_$_$count"} = shell_quote( $acct_snarf->get($_) )
 316     #     foreach qw( machine username _password );
 317     #   $count++;
 318     # }
 319   }
 320
 321   my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
 322   if ( $cust_pkg ) {
 323     no strict 'vars';
 324     {
 325       no strict 'refs';
 326       foreach my $custf (qw( company address1 address2 city state zip country
 327                              daytime night fax otaker agent_custid locale
 328                         ))
 329       {
 330         ${$custf} = $cust_pkg->cust_main->$custf();
 331       }
 332     }
 333     $email = ( grep { $_ !~ /^(POST|FAX)$/ } $cust_pkg->cust_main->invoicing_list )[0];
 334   } else {
 335     $email = '';
 336   }
 337
 338   $finger =~ /^(.*)\s+(\S+)$/ or $finger =~ /^((.*))$/;
 339   ($first, $last ) = ( $1, $2 );
 340   $domain = $svc_acct->domain;
 341
 342   $quoted_password = shell_quote $_password;
 343
 344   $crypt_password = $svc_acct->crypt_password( $self->option('crypt') );
 345   $ldap_password  = $svc_acct->ldap_password(  $self->option('crypt') );
 346
 347   @radius_groups = $svc_acct->radius_groups;
 348
 349   my ($reasonnum, $reasontext, $reasontypenum, $reasontypetext);
 350   if ( $cust_pkg && $action eq 'suspend' &&
 351        (my $r = $cust_pkg->last_reason('susp')) )
 352   {
 353     $reasonnum = $r->reasonnum;
 354     $reasontext = $r->reason;
 355     $reasontypenum = $r->reason_type;
 356     $reasontypetext = $r->reasontype->type;
 357
 358     my %reasonmap = $self->_groups_susp_reason_map;
 359     my $userspec = '';
 360     $userspec = $reasonmap{$reasonnum}
 361       if exists($reasonmap{$reasonnum});
 362     $userspec = $reasonmap{$reasontext}
 363       if (!$userspec && exists($reasonmap{$reasontext}));
 364
 365     my $suspend_user;
 366     if ( $userspec =~ /^\d+$/ ) {
 367       $suspend_user = qsearchs( 'svc_acct', { 'svcnum' => $userspec } );
 368     } elsif ( $userspec =~ /^\S+\@\S+$/ ) {
 369       my ($username,$domain) = split(/\@/, $userspec);
 370       for my $user (qsearch( 'svc_acct', { 'username' => $username } )){
 371         $suspend_user = $user if $userspec eq $user->email;
 372       }
 373     } elsif ($userspec) {
 374       $suspend_user = qsearchs( 'svc_acct', { 'username' => $userspec } );
 375     }
 376
 377     @radius_groups = $suspend_user->radius_groups
 378       if $suspend_user;
 379
 380   } else {
 381     $reasonnum = $reasontext = $reasontypenum = $reasontypetext = '';
 382   }
 383
 384   $pkgnum = $cust_pkg ? $cust_pkg->pkgnum : '';
 385   $custnum = $cust_pkg ? $cust_pkg->custnum : '';
 386
 387   my $stdin_string = eval(qq("$stdin"));
 388   return "error filling in STDIN: $@" if $@;
 389
 390   $first = shell_quote $first;
 391   $last = shell_quote $last;
 392   $finger = shell_quote $finger;
 393   $crypt_password = shell_quote $crypt_password;
 394   $ldap_password  = shell_quote $ldap_password;
 395
 396   $company = shell_quote $company;
 397   $address1 = shell_quote $address1;
 398   $address2 = shell_quote $address2;
 399   $city = shell_quote $city;
 400   $state = shell_quote $state;
 401   $zip = shell_quote $zip;
 402   $country = shell_quote $country;
 403   $daytime = shell_quote $daytime;
 404   $night = shell_quote $night;
 405   $fax = shell_quote $fax;
 406   $otaker = shell_quote $otaker;
 407   $agent_custid = shell_quote $agent_custid;
 408   $locale = shell_quote $locale;
 409
 410   my $command_string = eval(qq("$command"));
 411   return "error filling in command: $@" if $@;
 412
 413   my @ssh_cmd_args = (
 414     user          => $self->option('user') || 'root',
 415     host          => $self->svc_machine($svc_acct),
 416     command       => $command_string,
 417     stdin_string  => $stdin_string,
 418     ignored_errors    => $self->option('ignored_errors') || '',
 419     ignore_all_errors => $self->option('ignore_all_errors'),
 420     fail_on_output    => $self->option('fail_on_output'),
 421  );
 422
 423   if ( $self->option($action. '_no_queue') ) {
 424     # discard return value just like freeside-queued.
 425     eval { ssh_cmd(@ssh_cmd_args) };
 426     $error = $@;
 427     $error = $error->full_message if ref $error; # Exception::Class::Base
 428     return $error.
 429              ' ('. $self->exporttype. ' to '. $self->svc_machine($svc_acct). ')'
 430       if $error;
 431   } else {
 432     $self->shellcommands_queue( $svc_acct->svcnum, @ssh_cmd_args );
 433   }
 434 }
 435
 436 sub _export_replace {
 437   my($self, $new, $old ) = (shift, shift, shift);
 438   my $command = $self->option('usermod');
 439   return '' if $command =~ /^\s*$/;
 440   my $stdin = $self->option('usermod_stdin');
 441   no strict 'vars';
 442   {
 443     no strict 'refs';
 444     ${"old_$_"} = $old->getfield($_) foreach $old->fields;
 445     ${"new_$_"} = $new->getfield($_) foreach $new->fields;
 446   }
 447   my $old_cust_pkg = $old->cust_svc->cust_pkg;
 448   my $new_cust_pkg = $new->cust_svc->cust_pkg;
 449   my $new_cust_main = $new_cust_pkg ? $new_cust_pkg->cust_main : '';
 450
 451   $new_finger =~ /^(.*)\s+(\S+)$/ or $new_finger =~ /^((.*))$/;
 452   ($new_first, $new_last ) = ( $1, $2 );
 453   $quoted_new__password = shell_quote $new__password; #old, wrong?
 454   $new_quoted_password = shell_quote $new__password; #new, better?
 455   $old_domain = $old->domain;
 456   $new_domain = $new->domain;
 457
 458   $new_crypt_password = $new->crypt_password( $self->option('crypt') );
 459   $new_ldap_password  = $new->ldap_password(  $self->option('crypt') );
 460
 461   @old_radius_groups = $old->radius_groups;
 462   @new_radius_groups = $new->radius_groups;
 463
 464   my $error = '';
 465   if ( $self->option('usermod_pwonly') || $self->option('usermod_nousername') ){
 466     if ( $old_username ne $new_username ) {
 467       $error ||= "can't change username";
 468     }
 469   }
 470   if ( $self->option('usermod_pwonly') ) {
 471     if ( $old_domain ne $new_domain ) {
 472       $error ||= "can't change domain";
 473     }
 474     if ( $old_uid != $new_uid ) {
 475       $error ||= "can't change uid";
 476     }
 477     if ( $old_gid != $new_gid ) {
 478       $error ||= "can't change gid";
 479     }
 480     if ( $old_dir ne $new_dir ) {
 481       $error ||= "can't change dir";
 482     }
 483     #if ( join("\n", sort @old_radius_groups) ne
 484     #     join("\n", sort @new_radius_groups)    ) {
 485     #  $error ||= "can't change RADIUS groups";
 486     #}
 487   }
 488   return $error. ' ('. $self->exporttype. ' to '. $self->svc_machine($new). ')'
 489     if $error;
 490
 491   $new_agent_custid = $new_cust_main ? $new_cust_main->agent_custid : '';
 492   $new_locale = $new_cust_main ? $new_cust_main->locale : '';
 493   $old_pkgnum = $old_cust_pkg ? $old_cust_pkg->pkgnum : '';
 494   $old_custnum = $old_cust_pkg ? $old_cust_pkg->custnum : '';
 495   $new_pkgnum = $new_cust_pkg ? $new_cust_pkg->pkgnum : '';
 496   $new_custnum = $new_cust_pkg ? $new_cust_pkg->custnum : '';
 497
 498   my $stdin_string = eval(qq("$stdin"));
 499
 500   $new_first = shell_quote $new_first;
 501   $new_last = shell_quote $new_last;
 502   $new_finger = shell_quote $new_finger;
 503   $new_crypt_password = shell_quote $new_crypt_password;
 504   $new_ldap_password  = shell_quote $new_ldap_password;
 505   $new_agent_custid = shell_quote $new_agent_custid;
 506   $new_locale = shell_quote $new_locale;
 507
 508   my $command_string = eval(qq("$command"));
 509
 510   my @ssh_cmd_args = (
 511     user          => $self->option('user') || 'root',
 512     host          => $self->svc_machine($new),
 513     command       => $command_string,
 514     stdin_string  => $stdin_string,
 515     ignored_errors    => $self->option('ignored_errors') || '',
 516     ignore_all_errors => $self->option('ignore_all_errors'),
 517     fail_on_output    => $self->option('fail_on_output'),
 518   );
 519
 520   if($self->option('usermod_no_queue')) {
 521     # discard return value just like freeside-queued.
 522     eval { ssh_cmd(@ssh_cmd_args) };
 523     $error = $@;
 524     $error = $error->full_message if ref $error; # Exception::Class::Base
 525     return $error. ' ('. $self->exporttype. ' to '. $self->svc_machine($new). ')'
 526       if $error;
 527   }
 528   else {
 529     $self->shellcommands_queue( $new->svcnum, @ssh_cmd_args );
 530   }
 531 }
 532
 533 #a good idea to queue anything that could fail or take any time
 534 sub shellcommands_queue {
 535   my( $self, $svcnum ) = (shift, shift);
 536   my $queue = new FS::queue {
 537     'svcnum' => $svcnum,
 538     'job'    => "FS::part_export::shellcommands::ssh_cmd",
 539   };
 540   $queue->insert( @_ );
 541 }
 542
 543 sub ssh_cmd { #subroutine, not method
 544   use Net::OpenSSH;
 545   my $opt = { @_ };
 546   open my $def_in, '<', '/dev/null' or die "unable to open /dev/null\n";
 547   my $ssh = Net::OpenSSH->new(
 548     $opt->{'user'}.'@'.$opt->{'host'},
 549     'default_stdin_fh' => $def_in
 550   );
 551   # ignore_all_errors doesn't override SSH connection/auth errors--
 552   # probably correct
 553   die "Couldn't establish SSH connection: ". $ssh->error if $ssh->error;
 554
 555   my $ssh_opt = {};
 556   $ssh_opt->{'stdin_data'} = $opt->{'stdin_string'}
 557     if exists($opt->{'stdin_string'}) and length($opt->{'stdin_string'});
 558
 559   my ($output, $errput) = $ssh->capture2($ssh_opt, $opt->{'command'});
 560
 561   return if $opt->{'ignore_all_errors'};
 562   #die "Error running SSH command: ". $ssh->error if $ssh->error;
 563
 564   if ( ($output || $errput)
 565        && $opt->{'ignored_errors'} && length($opt->{'ignored_errors'})
 566   ) {
 567     my @ignored_errors = split('\n',$opt->{'ignored_errors'});
 568     foreach my $ignored_error ( @ignored_errors ) {
 569         $output =~ s/$ignored_error//g;
 570         $errput =~ s/$ignored_error//g;
 571     }
 572     $output =~ s/[\s\n]//g;
 573     $errput =~ s/[\s\n]//g;
 574   }
 575
 576   die (($errput || $ssh->error). "\n") if $errput || $ssh->error;
 577   #die "$errput\n" if $errput;
 578
 579   die "$output\n" if $output and $opt->{'fail_on_output'};
 580   '';
 581 }
 582
 583 #sub shellcommands_insert { #subroutine, not method
 584 #}
 585 #sub shellcommands_replace { #subroutine, not method
 586 #}
 587 #sub shellcommands_delete { #subroutine, not method
 588 #}
 589
 590 sub _upgrade_exporttype {
 591   my $class = shift;
 592   $class =~ /^FS::part_export::(\w+)$/;
 593   foreach my $self ( qsearch('part_export', { 'exporttype' => $1 }) ) {
 594     my %options = $self->options;
 595     my $changed = 0;
 596     # 2011-12-13 - 2012-02-16: ignore_all_output option
 597     if ( $options{'ignore_all_output'} ) {
 598       # ignoring STDOUT is now the default
 599       $options{'ignore_all_errors'} = 1;
 600       delete $options{'ignore_all_output'};
 601       $changed++;
 602     }
 603     my $error = $self->replace(%options) if $changed;
 604     die $error if $error;
 605   }
 606 }
 607
 608 1;
 609