FS/FS/part_export/shellcommands_withdomain.pm

   1 package FS::part_export::shellcommands_withdomain;
   2
   3 use vars qw(@ISA %info);
   4 use Tie::IxHash;
   5 use FS::part_export::shellcommands;
   6
   7 @ISA = qw(FS::part_export::shellcommands);
   8
   9 tie my %options, 'Tie::IxHash',
  10   'user' => { label=>'Remote username', default=>'root' },
  11   'useradd' => { label=>'Insert command',
  12                  #default=>''
  13                },
  14   'useradd_stdin' => { label=>'Insert command STDIN',
  15                        type =>'textarea',
  16                        #default=>"$_password\n$_password\n",
  17                      },
  18   'userdel' => { label=>'Delete command',
  19                  #default=>'',
  20                },
  21   'userdel_stdin' => { label=>'Delete command STDIN',
  22                        type =>'textarea',
  23                        #default=>'',
  24                      },
  25   'usermod' => { label=>'Modify command',
  26                  default=>'',
  27                },
  28   'usermod_stdin' => { label=>'Modify command STDIN',
  29                        type =>'textarea',
  30                        #default=>"$_password\n$_password\n",
  31                      },
  32   'usermod_pwonly' => { label=>'Disallow username changes',
  33                         type =>'checkbox',
  34                       },
  35   'suspend' => { label=>'Suspension command',
  36                  default=>'',
  37                },
  38   'suspend_stdin' => { label=>'Suspension command STDIN',
  39                        default=>'',
  40                      },
  41   'unsuspend' => { label=>'Unsuspension command',
  42                    default=>'',
  43                  },
  44   'unsuspend_stdin' => { label=>'Unsuspension command STDIN',
  45                          default=>'',
  46                        },
  47 ;
  48
  49 %info = (
  50   'svc'     => 'svc_acct',
  51   'desc'    => 'Real-time export via remote SSH (vpopmail, etc.)',
  52   'options' => \%options,
  53   'notes'   => <<'END'
  54 Run remote commands via SSH.  username@domain (rather than just usernames) are
  55 considered unique (also see shellcommands).  You probably want this if the
  56 commands you are running will accept a domain as a parameter, and will allow
  57 the same username with different domains.  You will need to
  58 <a href="../docs/ssh.html">setup SSH for unattended operation</a>.
  59
  60 <BR><BR>Use these buttons for some useful presets:
  61 <UL>
  62   <LI><INPUT TYPE="button" VALUE="vpopmail" onClick='
  63     this.form.useradd.value = "/home/vpopmail/bin/vadduser $username\\\@$domain $quoted_password";
  64     this.form.useradd_stdin.value = "";
  65     this.form.userdel.value = "/home/vpopmail/bin/vdeluser $username\\\@$domain"; this.form.userdel_stdin.value="";
  66     this.form.usermod.value = "/home/vpopmail/bin/vpasswd $new_username\\\@$new_domain $new_quoted_password";
  67     this.form.usermod_stdin.value = "";
  68     this.form.usermod_pwonly.checked = true;
  69   '>
  70 </UL>
  71
  72 The following variables are available for interpolation (prefixed with
  73 <code>new_</code> or <code>old_</code> for replace operations):
  74 <UL>
  75   <LI><code>$username</code>
  76   <LI><code>$domain</code>
  77   <LI><code>$_password</code>
  78   <LI><code>$quoted_password</code> - unencrypted password quoted for the shell
  79   <LI><code>$crypt_password</code> - encrypted password
  80   <LI><code>$uid</code>
  81   <LI><code>$gid</code>
  82   <LI><code>$finger</code> - GECOS, already quoted for the shell (do not add additional quotes)
  83   <LI><code>$dir</code> - home directory
  84   <LI><code>$shell</code>
  85   <LI><code>$quota</code>
  86   <LI>All other fields in <a href="../docs/schema.html#svc_acct">svc_acct</a> are also available.
  87 </UL>
  88 END
  89 );
  90
  91 1;
  92