communigate (phase 2): Account Preferences (& Domain::Account Defaults:Preferences...
[freeside.git] / FS / FS / part_export / communigate_pro.pm
index 2084f15..07281f1 100644 (file)
@@ -33,11 +33,11 @@ tie %options, 'Tie::IxHash',
 ;
 
 %info = (
-  'svc'     => [qw( svc_acct svc_domain svc_forward )],
-  'desc'    => 'Real-time export of accounts and domains to a CommuniGate Pro mail server',
+  'svc'     => [qw( svc_acct svc_domain svc_forward svc_mailinglist )],
+  'desc'    => 'Real-time export of accounts, domains, mail forwards and mailing lists to a CommuniGate Pro mail server',
   'options' => \%options,
   'notes'   => <<'END'
-Real time export of accounts and domains to a
+Real time export of accounts, domains, mail forwards and mailing lists to a
 <a href="http://www.stalker.com/CommuniGatePro/">CommuniGate Pro</a>
 mail server.  The
 <a href="http://www.stalker.com/CGPerl/">CommuniGate Pro Perl Interface</a>
@@ -77,12 +77,18 @@ sub _export_insert_svc_acct {
                         ],
     'RealName'       => $svc_acct->finger,
     'Password'       => $svc_acct->_password,
+
+    'PasswordRecovery' => ($svc_acct->password_recover ? 'YES':'NO'),
+
+    'RulesAllowed'     => $svc_acct->cgp_rulesallowed,
+    'RPOPAllowed'      =>($svc_acct->cgp_rpopallowed    ?'YES':'NO'),
+    'MailToAll'        =>($svc_acct->cgp_mailtoall      ?'YES':'NO'),
+    'AddMailTrailer'   =>($svc_acct->cgp_addmailtrailer ?'YES':'NO'),
+
     map { $quotas{$_} => $svc_acct->$_() }
         grep $svc_acct->$_(), keys %quotas
   );
-  #phase 2: pwdallowed, passwordrecovery, allowed mail rules,
-  # RPOP modifications, accepts mail to all, add trailer to sent mail
-  #phase 3: archive messages, mailing lists
+  #XXX phase 3: archive messages, mailing lists
 
   my @options = ( 'CreateAccount',
     'accountName'    => $self->export_username($svc_acct),
@@ -103,7 +109,11 @@ sub _export_insert_svc_acct {
   my %prefs = ();
   $prefs{'DeleteMode'} = $svc_acct->cgp_deletemode if $svc_acct->cgp_deletemode;
   $prefs{'EmptyTrash'} = $svc_acct->cgp_emptytrash if $svc_acct->cgp_emptytrash;
-  #phase 2: language, time zone, layout, pronto style, send read receipts
+  $prefs{'Language'} = $svc_acct->cgp_language if $svc_acct->cgp_language;
+  $prefs{'TimeZone'} = $svc_acct->cgp_timezone if $svc_acct->cgp_timezone;
+  $prefs{'SkinName'} = $svc_acct->cgp_skinname if $svc_acct->cgp_skinname;
+  $prefs{'ProntoSkinName'} = $svc_acct->cgp_prontoskinname if $svc_acct->cgp_prontoskinname;
+  $prefs{'SendMDNMode'} = $svc_acct->cgp_sendmdnmode if $svc_acct->cgp_sendmdnmode;
   if ( keys %prefs ) {
     my $pref_err = $self->communigate_pro_queue( $svc_acct->svcnum,
       'UpdateAccountPrefs',
@@ -141,6 +151,8 @@ sub _export_insert_svc_domain {
     if $svc_domain->max_accounts;
   $settings{'AdminDomainName'} = $svc_domain->parent_svc_x->domain
     if $svc_domain->parent_svcnum;
+  $settings{'TrailerText'} = $svc_domain->trailer
+    if $svc_domain->trailer;
 
   my @options = ( $create, $svc_domain->domain, \%settings );
 
@@ -169,6 +181,10 @@ sub _export_insert_svc_domain {
     'MaxWebSize'       => $svc_domain->acct_def_file_quota,
     'MaxWebFile'       => $svc_domain->acct_def_file_maxnum,
     'MaxFileSize'      => $svc_domain->acct_def_file_maxsize,
+    'RulesAllowed'     => $svc_domain->acct_def_cgp_rulesallowed,
+    'RPOPAllowed'      =>($svc_domain->acct_def_cgp_rpopallowed    ?'YES':'NO'),
+    'MailToAll'        =>($svc_domain->acct_def_cgp_mailtoall      ?'YES':'NO'),
+    'AddMailTrailer'   =>($svc_domain->acct_def_cgp_addmailtrailer ?'YES':'NO'),
   );
   warn "WARNING: error queueing SetAccountDefaults job: $def_err"
     if $def_err;
@@ -177,8 +193,13 @@ sub _export_insert_svc_domain {
   my $pref_err = $self->communigate_pro_queue( $svc_domain->svcnum,
     'SetAccountDefaultPrefs',
     $svc_domain->domain,
-    'DeleteMode' => $svc_domain->acct_def_cgp_deletemode,
-    'EmptyTrash' => $svc_domain->acct_def_cgp_emptytrash,
+    'DeleteMode'     => $svc_domain->acct_def_cgp_deletemode,
+    'EmptyTrash'     => $svc_domain->acct_def_cgp_emptytrash,
+    'Language'       => $svc_domain->acct_def_cgp_language,
+    'TimeZone'       => $svc_domain->acct_def_cgp_timezone,
+    'SkinName'       => $svc_domain->acct_def_cgp_skinname,
+    'ProntoSkinName' => $svc_domain->acct_def_cgp_prontoskinname,
+    'SendMDNMode'    => $svc_domain->acct_def_cgp_sendmdnmode,
   );
   warn "WARNING: error queueing SetAccountDefaultPrefs job: $pref_err"
     if $pref_err;
@@ -200,6 +221,31 @@ sub _export_insert_svc_forward {
   '';
 }
 
+sub _export_insert_svc_mailinglist {
+  my( $self, $svc_mlist ) = (shift, shift);
+
+  my @members = map $_->email_address,
+                    $svc_mlist->mailinglist->mailinglistmember;
+
+  #real-time here, presuming CGP does some dup detection
+  eval { $self->communigate_pro_runcommand(
+           'CreateGroup',
+           $svc_mlist->username.'@'.$svc_mlist->domain,
+           { 'RealName'      => $svc_mlist->listname,
+             'SetReplyTo'    => ( $svc_mlist->reply_to         ? 'YES' : 'NO' ),
+             'RemoveAuthor'  => ( $svc_mlist->remove_from      ? 'YES' : 'NO' ),
+             'RejectAuto'    => ( $svc_mlist->reject_auto      ? 'YES' : 'NO' ),
+             'RemoveToAndCc' => ( $svc_mlist->remove_to_and_cc ? 'YES' : 'NO' ),
+             'Members'       => \@members,
+           }
+         );
+       };
+  return $@ if $@;
+
+  '';
+
+}
+
 sub _export_replace {
   my( $self, $new, $old ) = (shift, shift, shift);
 
@@ -243,9 +289,19 @@ sub _export_replace_svc_acct {
     if $old->cgp_accessmodes ne $new->cgp_accessmodes
     || $old->cgp_type ne $new->cgp_type;
 
-  #phase 2: pwdallowed, passwordrecovery, allowed mail rules,
-  # RPOP modifications, accepts mail to all, add trailer to sent mail
-  #phase 3: archive messages, mailing lists
+  $settings{'PasswordRecovery'} = ( $new->password_recover ? 'YES':'NO' )
+    if $old->password_recover ne $new->password_recover;
+
+  $settings{'RulesAllowed'} = $new->cgp_rulesallowed
+    if $old->cgp_rulesallowed ne $new->cgp_rulesallowed;
+  $settings{'RPOPAllowed'} = ( $new->cgp_rpopallowed ? 'YES':'NO' )
+    if $old->cgp_rpopallowed ne $new->cgp_rpopallowed;
+  $settings{'MailToAll'} = ( $new->cgp_mailtoall ? 'YES':'NO' )
+    if $old->cgp_mailtoall ne $new->cgp_mailtoall;
+  $settings{'AddMailTrailer'} = ( $new->cgp_addmailtrailer ? 'YES':'NO' )
+    if $old->cgp_addmailtrailer ne $new->cgp_addmailtrailer;
+
+  #XXX phase 3: archive messages, mailing lists
 
   if ( keys %settings ) {
     my $error = $self->communigate_pro_queue(
@@ -263,7 +319,16 @@ sub _export_replace_svc_acct {
     if $old->cgp_deletemode ne $new->cgp_deletemode;
   $prefs{'EmptyTrash'} = $new->cgp_emptytrash
     if $old->cgp_emptytrash ne $new->cgp_emptytrash;
-  #phase 2: language, time zone, layout, pronto style, send read receipts
+  $prefs{'Language'} = $new->cgp_language
+    if $old->cgp_language ne $new->cgp_language;
+  $prefs{'TimeZone'} = $new->cgp_timezone
+    if $old->cgp_timezone ne $new->cgp_timezone;
+  $prefs{'SkinName'} = $new->cgp_skinname
+    if $old->cgp_skinname ne $new->cgp_skinname;
+  $prefs{'ProntoSkinName'} = $new->cgp_prontoskinname
+    if $old->cgp_prontoskinname ne $new->cgp_prontoskinname;
+  $prefs{'SendMDNMode'} = $new->cgp_sendmdnmode
+    if $old->cgp_sendmdnmode ne $new->cgp_sendmdnmode;
   if ( keys %prefs ) {
     my $pref_err = $self->communigate_pro_queue( $new->svcnum,
       'UpdateAccountPrefs',
@@ -300,6 +365,8 @@ sub _export_replace_svc_domain {
   my %settings = ();
   $settings{'AccountsLimit'} = $new->max_accounts
     if $old->max_accounts ne $new->max_accounts;
+  $settings{'TrailerText'} = $new->trailer
+    if $old->trailer ne $new->trailer;
   $settings{'DomainAccessModes'} = $new->cgp_accessmodes
     if $old->cgp_accessmodes ne $new->cgp_accessmodes;
   $settings{'AdminDomainName'} =
@@ -339,6 +406,10 @@ sub _export_replace_svc_domain {
     'MaxWebSize'       => $new->acct_def_file_quota,
     'MaxWebFile'       => $new->acct_def_file_maxnum,
     'MaxFileSize'      => $new->acct_def_file_maxsize,
+    'RulesAllowed'     => $new->acct_def_cgp_rulesallowed,
+    'RPOPAllowed'      => ( $new->acct_def_cgp_rpopallowed    ? 'YES' : 'NO' ),
+    'MailToAll'        => ( $new->acct_def_cgp_mailtoall      ? 'YES' : 'NO' ),
+    'AddMailTrailer'   => ( $new->acct_def_cgp_addmailtrailer ? 'YES' : 'NO' ),
   );
   warn "WARNING: error queueing SetAccountDefaults job: $def_err"
     if $def_err;
@@ -347,8 +418,13 @@ sub _export_replace_svc_domain {
   my $pref_err = $self->communigate_pro_queue( $new->svcnum,
     'SetAccountDefaultPrefs',
     $new->domain,
-    'DeleteMode' => $new->acct_def_cgp_deletemode,
-    'EmptyTrash' => $new->acct_def_cgp_emptytrash,
+    'DeleteMode'     => $new->acct_def_cgp_deletemode,
+    'EmptyTrash'     => $new->acct_def_cgp_emptytrash,
+    'Language'       => $new->acct_def_cgp_language,
+    'TimeZone'       => $new->acct_def_cgp_timezone,
+    'SkinName'       => $new->acct_def_cgp_skinname,
+    'ProntoSkinName' => $new->acct_def_cgp_prontoskinname,
+    'SendMDNMode'    => $new->acct_def_cgp_sendmdnmode,
   );
   warn "WARNING: error queueing SetAccountDefaultPrefs job: $pref_err"
     if $pref_err;
@@ -385,6 +461,39 @@ sub _export_replace_svc_forward {
   '';
 }
 
+sub _export_replace_svc_mailinglist {
+  my( $self, $new, $old ) = (shift, shift, shift);
+
+  my $oldGroupName = $old->username.'@'.$old->domain;
+  my $newGroupName = $new->username.'@'.$new->domain;
+
+  if ( $oldGroupName ne $newGroupName ) {
+    eval { $self->communigate_pro_runcommand(
+             'RenameGroup', $oldGroupName, $newGroupName ); };
+    return $@ if $@;
+  }
+
+  my @members = map $_->email_address,
+                $new->mailinglist->mailinglistmember;
+
+  #real-time here, presuming CGP does some dup detection
+  eval { $self->communigate_pro_runcommand(
+           'SetGroup', $newGroupName,
+           { 'RealName'      => $new->listname,
+             'SetReplyTo'    => ( $new->reply_to         ? 'YES' : 'NO' ),
+             'RemoveAuthor'  => ( $new->remove_from      ? 'YES' : 'NO' ),
+             'RejectAuto'    => ( $new->reject_auto      ? 'YES' : 'NO' ),
+             'RemoveToAndCc' => ( $new->remove_to_and_cc ? 'YES' : 'NO' ),
+             'Members'       => \@members,
+           }
+         );
+       };
+  return $@ if $@;
+
+  '';
+
+}
+
 sub _export_delete {
   my( $self, $svc_x ) = (shift, shift);
 
@@ -418,6 +527,21 @@ sub _export_delete_svc_forward {
   );
 }
 
+sub _export_delete_svc_mailinglist {
+  my( $self, $svc_mailinglist ) = (shift, shift);
+
+  #real-time here, presuming CGP does some dup detection
+  eval { $self->communigate_pro_runcommand(
+           'DeleteGroup',
+           $svc_mailinglist->username.'@'.$svc_mailinglist->domain,
+         );
+       };
+  return $@ if $@;
+
+  '';
+
+}
+
 sub _export_suspend {
   my( $self, $svc_x ) = (shift, shift);
 
@@ -479,6 +603,20 @@ sub _export_unsuspend_svc_domain {
 
 }
 
+sub export_mailinglistmember_insert {
+  my( $self, $svc_mailinglist, $mailinglistmember ) = (shift, shift, shift);
+  $svc_mailinglist->replace();
+}
+
+sub export_mailinglistmember_replace {
+  my( $self, $svc_mailinglist, $new, $old ) = (shift, shift, shift, shift);
+  die "no way to do this from the UI right now";
+}
+
+sub export_mailinglistmember_delete {
+  my( $self, $svc_mailinglist, $mailinglistmember ) = (shift, shift, shift);
+  $svc_mailinglist->replace();
+}
 
 sub export_getsettings {
   my($self, $svc_x) = (shift, shift);
@@ -647,6 +785,22 @@ sub export_getsettings_svc_acct {
 
 }
 
+sub export_getsettings_svc_mailinglist {
+  my($self, $svc_mailinglist, $settingsref, $defaultref ) = @_;
+
+  my $settings = eval { $self->communigate_pro_runcommand(
+    'GetGroup',
+    $svc_mailinglist->username.'@'.$svc_mailinglist->domain,
+  ) };
+  return $@ if $@;
+
+  $settings->{'Members'} = join(', ', @{ $settings->{'Members'} } );
+
+  %{$settingsref} = %$settings;
+
+  '';
+}
+
 sub communigate_pro_queue {
   my( $self, $svcnum, $method ) = (shift, shift, shift);
   my $jobnum = ''; #don't actually care
@@ -762,6 +916,7 @@ sub communigate_pro_command { #subroutine, not method
   my( $machine, $port, $login, $password, $method, @args ) = @_;
 
   eval "use CGP::CLI";
+  die $@ if $@;
 
   my $cli = new CGP::CLI( {
     'PeerAddr' => $machine,