FS/FS/part_export/vpopmail.pm

   1 package FS::part_export::vpopmail;
   2
   3 use vars qw(@ISA %info @saltset $exportdir);
   4 use Fcntl qw(:flock);
   5 use Tie::IxHash;
   6 use File::Path;
   7 use FS::UID qw( datasrc );
   8 use FS::part_export;
   9
  10 @ISA = qw(FS::part_export);
  11
  12 tie my %options, 'Tie::IxHash',
  13   #'machine' => { label=>'vpopmail machine', },
  14   'dir'     => { label=>'directory', }, # ?more info? default?
  15   'uid'     => { label=>'vpopmail uid' },
  16   'gid'     => { label=>'vpopmail gid' },
  17   'restart' => { label=> 'vpopmail restart command',
  18                  default=> 'cd /home/vpopmail/domains; for domain in *; do /home/vpopmail/bin/vmkpasswd $domain; done; /var/qmail/bin/qmail-newu; killall -HUP qmail-send',
  19                },
  20 ;
  21
  22 %info = (
  23   'svc'     => 'svc_acct',
  24   'desc'    => 'Real-time export to vpopmail text files',
  25   'options' => \%options,
  26   'notes'   => <<'END'
  27 This export is currently unmaintained.  See shellcommands_withdomain for an
  28 export that uses vpopmail CLI commands instead.<BR>
  29 <BR>
  30 Real time export to <a href="http://inter7.com/vpopmail/">vpopmail</a> text
  31 files.  <a href="http://search.cpan.org/dist/File-Rsync">File::Rsync</a>
  32 must be installed, and you will need to
  33 <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.9:Documentation:Administration:SSH_Keys">setup SSH for unattended operation</a>
  34 to <b>vpopmail</b>@<i>export.host</i>.
  35 END
  36 );
  37
  38 @saltset = ( 'a'..'z' , 'A'..'Z' , '0'..'9' , '.' , '/' );
  39
  40 sub rebless { shift; }
  41
  42 sub _export_insert {
  43   my($self, $svc_acct) = (shift, shift);
  44   $self->vpopmail_queue( $svc_acct->svcnum, 'insert',
  45     $svc_acct->username,
  46     crypt($svc_acct->_password,$saltset[int(rand(64))].$saltset[int(rand(64))]),
  47     $svc_acct->domain,
  48     $svc_acct->quota,
  49     $svc_acct->finger,
  50   );
  51 }
  52
  53 sub _export_replace {
  54   my( $self, $new, $old ) = (shift, shift, shift);
  55
  56   my $cpassword = crypt(
  57     $new->_password, $saltset[int(rand(64))].$saltset[int(rand(64))]
  58   );
  59
  60   return "can't change username with vpopmail"
  61     if $old->username ne $new->username;
  62
  63   #no.... if mail can't be preserved, better to disallow username changes
  64   #if ($old->username ne $new->username || $old->domain ne $new->domain ) {
  65   #  vpopmail_queue( $svc_acct->svcnum, 'delete',
  66   #    $old->username, $old->domain
  67   #  );
  68   #  vpopmail_queue( $svc_acct->svcnum, 'insert',
  69   #    $new->username,
  70   #    $cpassword,
  71   #    $new->domain,
  72   #  );
  73
  74   return '' unless $old->_password ne $new->_password;
  75
  76   $self->vpopmail_queue( $new->svcnum, 'replace',
  77     $new->username, $cpassword, $new->domain, $new->quota, $new->finger );
  78 }
  79
  80 sub _export_delete {
  81   my( $self, $svc_acct ) = (shift, shift);
  82   $self->vpopmail_queue( $svc_acct->svcnum, 'delete',
  83     $svc_acct->username, $svc_acct->domain );
  84 }
  85
  86 #a good idea to queue anything that could fail or take any time
  87 sub vpopmail_queue {
  88   my( $self, $svcnum, $method ) = (shift, shift, shift);
  89
  90   my $exportdir = "%%%FREESIDE_EXPORT%%%/export." . datasrc;
  91   mkdir $exportdir, 0700 or die $! unless -d $exportdir;
  92   $exportdir .= "/vpopmail";
  93   mkdir $exportdir, 0700 or die $! unless -d $exportdir;
  94   $exportdir .= '/'. $self->machine;
  95   mkdir $exportdir, 0700 or die $! unless -d $exportdir;
  96   mkdir "$exportdir/domains", 0700 or die $! unless -d "$exportdir/domains";
  97
  98   my $queue = new FS::queue {
  99     'svcnum' => $svcnum,
 100     'job'    => "FS::part_export::vpopmail::vpopmail_$method",
 101   };
 102   $queue->insert(
 103     $exportdir,
 104     $self->machine,
 105     $self->option('dir'),
 106     $self->option('uid'),
 107     $self->option('gid'),
 108     $self->option('restart'),
 109     @_
 110   );
 111 }
 112
 113 sub vpopmail_insert { #subroutine, not method
 114   my( $exportdir, $machine, $dir, $uid, $gid, $restart ) = splice @_,0,6;
 115   my( $username, $password, $domain, $quota, $finger ) = @_;
 116
 117   mkdir "$exportdir/domains/$domain", 0700 or die $!
 118     unless -d "$exportdir/domains/$domain";
 119
 120   (open(VPASSWD, ">>$exportdir/domains/$domain/vpasswd")
 121     and flock(VPASSWD,LOCK_EX)
 122   ) or die "can't open vpasswd file for $username\@$domain: ".
 123            "$exportdir/domains/$domain/vpasswd: $!";
 124   print VPASSWD join(":",
 125     $username,
 126     $password,
 127     '1',
 128     '0',
 129     $finger,
 130     "$dir/domains/$domain/$username",
 131     $quota ? $quota.'S' : 'NOQUOTA',
 132   ), "\n";
 133
 134   flock(VPASSWD,LOCK_UN);
 135   close(VPASSWD);
 136
 137   for my $mkdir (
 138     grep { ! -d $_ } map { "$exportdir/domains/$domain/$username$_" }
 139         ( '', qw( /Maildir /Maildir/cur /Maildir/new /Maildir/tmp ) )
 140   ) {
 141     mkdir $mkdir, 0700 or die "can't mkdir $mkdir: $!";
 142   }
 143
 144   vpopmail_sync( $exportdir, $machine, $dir, $uid, $gid, $restart );
 145
 146 }
 147
 148 sub vpopmail_replace { #subroutine, not method
 149   my( $exportdir, $machine, $dir, $uid, $gid, $restart ) = splice @_,0,6;
 150   my( $username, $password, $domain, $quota, $finger ) = @_;
 151
 152   (open(VPASSWD, "$exportdir/domains/$domain/vpasswd")
 153     and flock(VPASSWD,LOCK_EX)
 154   ) or die "can't open $exportdir/domains/$domain/vpasswd: $!";
 155
 156   open(VPASSWDTMP, ">$exportdir/domains/$domain/vpasswd.tmp")
 157     or die "Can't open $exportdir/domains/$domain/vpasswd.tmp: $!";
 158
 159   while (<VPASSWD>) {
 160     my ($mailbox, $pw, $vuid, $vgid, $vfinger, $vdir, $vquota, @rest) =
 161       split(':', $_);
 162     if ( $username ne $mailbox ) {
 163       print VPASSWDTMP $_;
 164       next
 165     }
 166     print VPASSWDTMP join (':',
 167       $mailbox,
 168       $password,
 169       '1',
 170       '0',
 171       $finger,
 172       "$dir/domains/$domain/$username", #$vdir
 173       $quota ? $quota.'S' : 'NOQUOTA',
 174     ), "\n";
 175   }
 176
 177   close(VPASSWDTMP);
 178
 179   rename "$exportdir/domains/$domain/vpasswd.tmp", "$exportdir/domains/$domain/vpasswd"
 180     or die "Can't rename $exportdir/domains/$domain/vpasswd.tmp: $!";
 181
 182   flock(VPASSWD,LOCK_UN);
 183   close(VPASSWD);
 184
 185   vpopmail_sync( $exportdir, $machine, $dir, $uid, $gid, $restart );
 186
 187 }
 188
 189 sub vpopmail_delete { #subroutine, not method
 190   my( $exportdir, $machine, $dir, $uid, $gid, $restart ) = splice @_,0,6;
 191   my( $username, $domain ) = @_;
 192
 193   (open(VPASSWD, "$exportdir/domains/$domain/vpasswd")
 194     and flock(VPASSWD,LOCK_EX)
 195   ) or die "can't open $exportdir/domains/$domain/vpasswd: $!";
 196
 197   open(VPASSWDTMP, ">$exportdir/domains/$domain/vpasswd.tmp")
 198     or die "Can't open $exportdir/domains/$domain/vpasswd.tmp: $!";
 199
 200   while (<VPASSWD>) {
 201     my ($mailbox, $rest) = split(':', $_);
 202     print VPASSWDTMP $_ unless $username eq $mailbox;
 203   }
 204
 205   close(VPASSWDTMP);
 206
 207   rename "$exportdir/domains/$domain/vpasswd.tmp",
 208          "$exportdir/domains/$domain/vpasswd"
 209     or die "Can't rename $exportdir/domains/$domain/vpasswd.tmp: $!";
 210
 211   flock(VPASSWD,LOCK_UN);
 212   close(VPASSWD);
 213
 214   rmtree "$exportdir/domains/$domain/$username"
 215     or die "can't rmtree $exportdir/domains/$domain/$username: $!";
 216
 217   vpopmail_sync( $exportdir, $machine, $dir, $uid, $gid, $restart );
 218 }
 219
 220 sub vpopmail_sync {
 221   my( $exportdir, $machine, $dir, $uid, $gid, $restart ) = splice @_,0,6;
 222
 223   chdir $exportdir;
 224 #  my @args = ( $rsync, "-rlpt", "-e", $ssh, "domains/",
 225 #               "vpopmail\@$machine:$dir/domains/"  );
 226 #  system {$args[0]} @args;
 227
 228   eval "use File::Rsync;";
 229   die $@ if $@;
 230
 231   my $rsync = File::Rsync->new({ rsh => 'ssh' });
 232
 233   $rsync->exec( {
 234     recursive => 1,
 235     perms     => 1,
 236     times     => 1,
 237     src       => "$exportdir/domains/",
 238     dest      => "vpopmail\@$machine:$dir/domains/",
 239   } ); # true/false return value from exec is not working, alas
 240   if ( $rsync->err ) {
 241     die "error uploading to vpopmail\@$machine:$dir/domains/ : ".
 242         'exit status: '. $rsync->status. ', '.
 243         'STDERR: '. join(" / ", $rsync->err). ', '.
 244         'STDOUT: '. join(" / ", $rsync->out);
 245   }
 246
 247   eval "use Net::SSH qw(ssh);";
 248   die $@ if $@;
 249
 250   ssh("vpopmail\@$machine", $restart) if $restart;
 251 }
 252
 253 1;
 254