summaryrefslogtreecommitdiff
path: root/FS/FS/part_export/domain_shellcommands.pm
blob: 994c113bf95d33792a024a126d17e9bd6885a0d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
package FS::part_export::domain_shellcommands;

use strict;
use vars qw(@ISA %info);
use Tie::IxHash;
use FS::part_export;

@ISA = qw(FS::part_export);

tie my %options, 'Tie::IxHash',
  'user' => { label=>'Remote username', default=>'root' },
  'useradd' => { label=>'Insert command',
                 default=>'',
               },
  'userdel'  => { label=>'Delete command',
                  default=>'',
                },
  'usermod'  => { label=>'Modify command',
                  default=>'',
                },
;

%info = (
  'svc'     => 'svc_domain',
  'desc'    => 'Run remote commands via SSH, for domains (qmail, ISPMan).',
  'options' => \%options,
  'notes'   => <<'END'
Run remote commands via SSH, for domains.  You will need to
<a href="../docs/ssh.html">setup SSH for unattended operation</a>.
<BR><BR>Use these buttons for some useful presets:
<UL>
  <LI>
    <INPUT TYPE="button" VALUE="qmail catchall .qmail-domain-default maintenance" onClick='
      this.form.useradd.value = "[ \"$uid\" -a \"$gid\" -a \"$dir\" -a \"$qdomain\" ] && [ -e $dir/.qmail-$qdomain-default ] || { touch $dir/.qmail-$qdomain-default; chown $uid:$gid $dir/.qmail-$qdomain-default; }";
      this.form.userdel.value = "";
      this.form.usermod.value = "";
    '>
  <LI>
    <INPUT TYPE="button" VALUE="ISPMan CLI" onClick='
      this.form.useradd.value = "/usr/local/ispman/bin/ispman.addDomain -d $domain changeme";
      this.form.userdel.value = "/usr/local/ispman/bin/ispman.deleteDomain -d $domain";
      this.form.usermod.value = "";
    '>
</UL>
The following variables are available for interpolation (prefixed with <code>new_</code> or <code>old_</code> for replace operations):
<UL>
  <LI><code>$domain</code>
  <LI><code>$qdomain</code> - domain with periods replaced by colons
  <LI><code>$uid</code> - of catchall account
  <LI><code>$gid</code> - of catchall account
  <LI><code>$dir</code> - home directory of catchall account
  <LI>All other fields in
    <a href="../docs/schema.html#svc_domain">svc_domain</a> are also available.
</UL>
END
);

sub rebless { shift; }

sub _export_insert {
  my($self) = shift;
  $self->_export_command('useradd', @_);
}

sub _export_delete {
  my($self) = shift;
  $self->_export_command('userdel', @_);
}

sub _export_command {
  my ( $self, $action, $svc_domain) = (shift, shift, shift);
  my $command = $self->option($action);
  return '' if $command =~ /^\s*$/;

  #set variable for the command
  no strict 'vars';
  {
    no strict 'refs';
    ${$_} = $svc_domain->getfield($_) foreach $svc_domain->fields;
  }
  ( $qdomain = $domain ) =~ s/\./:/g; #see dot-qmail(5): EXTENSION ADDRESSES

  if ( $svc_domain->catchall ) {
    no strict 'refs';
    my $svc_acct = $svc_domain->catchall_svc_acct;
    ${$_} = $svc_acct->getfield($_) foreach qw(uid gid dir);
  } else {
    no strict 'refs';
    ${$_} = '' foreach qw(uid gid dir);
  }

  #done setting variables for the command

  $self->shellcommands_queue( $svc_domain->svcnum,
    user         => $self->option('user')||'root',
    host         => $self->machine,
    command      => eval(qq("$command")),
  );
}

sub _export_replace {
  my($self, $new, $old ) = (shift, shift, shift);
  my $command = $self->option('usermod');
  
  #set variable for the command
  no strict 'vars';
  {
    no strict 'refs';
    ${"old_$_"} = $old->getfield($_) foreach $old->fields;
    ${"new_$_"} = $new->getfield($_) foreach $new->fields;
  }
  ( $old_qdomain = $old_domain ) =~ s/\./:/g; #see dot-qmail(5): EXTENSION ADDRESSES
  ( $new_qdomain = $new_domain ) =~ s/\./:/g; #see dot-qmail(5): EXTENSION ADDRESSES

  { 
    no strict 'refs';

    if ( $old->catchall ) {
      my $svc_acct = $old->catchall_svc_acct;
      ${"old_$_"} = $svc_acct->getfield($_) foreach qw(uid gid dir);
    } else {
      ${"old_$_"} = '' foreach qw(uid gid dir);
    }
    if ( $new->catchall ) {
      my $svc_acct = $new->catchall_svc_acct;
      ${"new_$_"} = $svc_acct->getfield($_) foreach qw(uid gid dir);
    } else {
      ${"new_$_"} = '' foreach qw(uid gid dir);
    }

  }

  #done setting variables for the command

  $self->shellcommands_queue( $new->svcnum,
    user         => $self->option('user')||'root',
    host         => $self->machine,
    command      => eval(qq("$command")),
  );
}

#a good idea to queue anything that could fail or take any time
sub shellcommands_queue {
  my( $self, $svcnum ) = (shift, shift);
  my $queue = new FS::queue {
    'svcnum' => $svcnum,
    'job'    => "FS::part_export::domain_shellcommands::ssh_cmd",
  };
  $queue->insert( @_ );
}

sub ssh_cmd { #subroutine, not method
  use Net::SSH '0.08';
  &Net::SSH::ssh_cmd( { @_ } );
}

#sub shellcommands_insert { #subroutine, not method
#}
#sub shellcommands_replace { #subroutine, not method
#}
#sub shellcommands_delete { #subroutine, not method
#}

1;