Provide new API calls to set quota, find a mailbox, etc.

2 files changed, 228 insertions, 27 deletions

diff --git a/lib/Kolab.pm b/lib/Kolab.pm
index f33ba28..91ae68c 100644
--- a/lib/Kolab.pm
+++ b/lib/Kolab.pm
@@ -331,7 +331,6 @@ This function reloads the configuration for the Kolab perl library.
 
     if (!($tempval = URI->new($config{'user_ldap_uri'}))) {
         &log('C', "Unable to parse user_ldap_uri `" . $config{'user_ldap_uri'} . "'", KOLAB_ERROR);
-#        exit(1);
         $error = 1;
     } else {
         $config{'user_ldap_ip'} = $tempval->host;
@@ -464,6 +463,7 @@ sub log
     } else {
         $text = $prefix . ': ' . $text;
     }
+
     syslog('info', "$text") if $config{'log_level'} >= $priority;
     print STDERR "$text\n" if $config{'debug'};
 }
@@ -510,12 +510,12 @@ Example usage:
 
 =cut
 
-    my $location = '';
-
     my $mailboxName = shift;
     my $mailHost = shift || 0;
     my $mailboxType = shift || 'user';
 
+    my $folder = '';
+
     my $connectAddress = (
             $mailHost ? $mailHost :
             ( $Kolab::config{'connect_addr'} ?
@@ -529,39 +529,150 @@ Example usage:
     # folder a boolean.
     my $sharedFolder = ( $mailboxType eq 'user' ? 0 : 1 );
 
-    Kolab::Cyrus::createMailbox( $cyrus, $mailboxName, $sharedFolder);
+    my $rc = Kolab::Cyrus::createMailbox( $cyrus, $mailboxName, $sharedFolder);
+
+    if (!$rc) {
+        Kolab::log("Could not create mailbox", KOLAB_ERROR);
+        exit $rc;
+    }
 
     my $mailboxPath = Kolab::Cyrus::createUid($mailboxName, $sharedFolder);
 
-    use Mail::IMAPClient;
+    my $location = Kolab::cyrusMurderFindMailbox( $cyrus, $mailboxPath);
 
-    my $imap = Mail::IMAPClient->new(
-            Server => $connectAddress,
-            User => $Kolab::config{'cyrus_admin'},
-            Password => $Kolab::config{'cyrus_admin_pw'},
-        );
+    my @mbox = split(/@/, $mailboxPath);
+
+    my $mailbox = $mbox[0];
+    my $domain = $mbox[1];
 
-    if (! $imap) {
-        die("Cannot connect to mail server '$connectAddress' to locate mailbox - $!");
+    $folder = $mailbox . '/Calendar@' . $domain;
+
+    $cyrus->createmailbox($folder);
+    $cyrus->mboxconfig($folder, '/vendor/kolab/folder-test', 'true') or
+        die("Could not set annotations");
+    $cyrus->mboxconfig($folder, '/vendor/kolab/folder-type', 'event.default') or
+        die("Could not set annotations");
+
+    $folder = $mailbox . '/Contacts@' . $domain;
+
+    $cyrus->createmailbox($folder);
+    $cyrus->mboxconfig($folder, '/vendor/kolab/folder-test', 'true') or
+        die("Could not set annotations");
+    $cyrus->mboxconfig($folder, '/vendor/kolab/folder-type', 'contact.default') or
+        die("Could not set annotations");
+
+    $folder = $mailbox . '/_Restore@' . $domain;
+    $cyrus->createmailbox($folder);
+    $cyrus->deleteacl($folder, $mailboxName);
+
+    $folder = $mailbox . '/_Archive@' . $domain;
+    $cyrus->createmailbox($folder);
+    $cyrus->deleteacl($folder, $mailboxName);
+
+    if ( !exists $config{'default_quota'} ) {
+        Kolab::cyrusMurderSetQuota($mailboxName, 0);
+    } else {
+        Kolab::cyrusMurderSetQuota($mailboxName, $config{'default_quota'});
     }
 
-    my @results = $imap->tag_and_run(qq/GETANNOTATION $mailboxPath "*" "value.shared"/);
+    return $location;
+}
 
-    $imap->logout;
+sub cyrusMurderSetQuota {
+    my $mailbox = shift;
+    my $quota = shift || 0;
+    my $mailboxType = shift || 'user';
 
-    foreach my $r (@results) {
-        $r =~ s/\r//g;
-        $r =~ s/\n//g;
-        if ($r =~ /\/vendor\/cmu\/cyrus-imapd\/server" \("value.shared" "(.*)"\)$/) {
-            $location = $1;
-        }
+    my $connectAddress = (
+            $Kolab::config{'connect_addr'} ?
+                $Kolab::config{'connect_addr'} : 'localhost'
+        );
+
+    my $cyrus = Kolab::Cyrus::create($connectAddress);
+
+    # Make whether the mailbox we're about to create is a shared or a user
+    # folder a boolean.
+    my $sharedFolder = ( $mailboxType eq 'user' ? 0 : 1 );
+
+    my $mailboxPath = Kolab::Cyrus::createUid($mailbox, $sharedFolder);
+
+    my $location = Kolab::cyrusMurderFindMailbox( $cyrus, $mailboxPath);
+
+    my $cyrus2 = Kolab::Cyrus::create($location);
+
+    if (!$cyrus2) {
+        die("Cannot connect to Cyrus at `$location'");
     }
 
-    if ($location eq '') {
-        die("Cannot locate mailbox '$mailboxPath'.\n");
+    $cyrus2->setquota($mailboxPath, ('STORAGE' => $quota) );
+
+    return 0;
+}
+
+sub cyrusMurderFindMailbox {
+    my ($cyrus, $mailbox) = @_;
+
+    my %info = $cyrus->info($mailbox, ('/vendor/cmu/cyrus-imapd/server'));
+
+    my $key = '/mailbox/{' . $mailbox . '}/vendor/cmu/cyrus-imapd/server';
+
+    if (exists($info{$key})) {
+        return $info{$key};
     }
 
-    return $location;
+    return 0;
+}
+
+################################################################################
+sub cyrusMurderDeleteMailbox {
+################################################################################
+=pod
+
+=head3 Delete a Mailbox in a Cyrus Murder
+
+=head4 cyrusMurderDeleteMailbox
+
+This function deletes a mailbox in a Cyrus IMAP Murder. It expects to be passed
+a mailbox name, such as 'jdoe', 'jdoe@example.org' or 'info@company.com', and
+a type ('user' or 'shared').
+
+The function connects to the configured 'connect_addr', which should be set to
+a (functional) Cyrus IMAP frontend server using /etc/kolab/kolab.conf.
+
+It creates the administrative connection using the 'cyrus_admin' and
+'cyrus_admin_pw' settings from /etc/kolab/kolab.conf, and issues the delete
+command.
+
+Example usage:
+
+  Kolab::cyrusMurderDeleteMailbox('jdoe@example.org')
+
+  Kolab::cyrusMurderDeleteMailbox('info@example.org', 'shared')
+
+=cut
+
+    my $location = '';
+
+    my $mailboxName = shift;
+    my $mailboxType = shift || 'user';
+
+    my $connectAddress = ( $Kolab::config{'connect_addr'} ?
+            $Kolab::config{'connect_addr'} : 'localhost'
+        );
+
+    my $cyrus = Kolab::Cyrus::create($connectAddress);
+
+    # Make whether the mailbox we're about to create is a shared or a user
+    # folder a boolean.
+    my $sharedFolder = ( $mailboxType eq 'user' ? 0 : 1 );
+
+    my $rc = Kolab::Cyrus::deleteMailbox(
+            $cyrus,
+            $mailboxName,
+            $sharedFolder
+        );
+
+    return $rc;
 }
 
 ################################################################################
@@ -624,6 +735,68 @@ Example usage:
         );
 }
 
+################################################################################
+sub cyrusMurderTransferMailbox {
+################################################################################
+=pod
+
+=head3 Transfer a Mailbox in a Cyrus Murder
+
+=head4 cyrusMurderTrasnferMailbox
+
+This function transfers a mailbox in a Cyrus IMAP Murder. It expects to be
+passed a mailbox name, such as 'jdoe', 'jdoe@example.org' or 'info@company.com',
+and a target server fully qualified domain name, such as 'mail01.example.org'.
+
+A third argument may be specified to indicate the folder type, 'user' or
+'shared'. If the folder type is not specified, 'user' is used.
+
+Example usage:
+
+  Kolab::cyrusMurderTransferMailbox('jdoe@example.org', 'cyrus01.example.org')
+
+  Kolab::cyrusMurderTransferMailbox('info@example.org', 'cyrus04.example.org',
+        'shared'
+    )
+
+=cut
+
+    my $mailboxName = shift;
+    my $mailHost = shift || 0;
+    my $mailboxType = shift || 'user';
+
+    my $connectAddress = (
+            $Kolab::config{'connect_addr'} ?
+                    $Kolab::config{'connect_addr'} : 'localhost'
+        );
+
+    my $cyrus = Kolab::Cyrus::create($connectAddress);
+
+    # Make whether the mailbox we're about to create is a shared or a user
+    # folder a boolean.
+    my $sharedFolder = ( $mailboxType eq 'user' ? 0 : 1 );
+
+    my $mailboxPath = Kolab::Cyrus::createUid($mailboxName, $sharedFolder);
+
+    print $mailboxPath . "\n";
+
+    my $location = Kolab::cyrusMurderFindMailbox($cyrus, $mailboxPath);
+
+    if ($location eq '') {
+        die("Cannot locate mailbox '$mailboxPath'.\n");
+    }
+
+    my $cyrus2 = Kolab::Cyrus::create($location);
+
+    if (!$cyrus2) {
+        die("Cannot connect to Cyrus at `$location'");
+    }
+
+    my $rc = Kolab::Cyrus::transferMailbox($cyrus2, $mailboxPath, $mailHost);
+
+    return $rc;
+}
+
 1;
 __END__
 =head1 NAME
diff --git a/lib/Kolab/Cyrus.pm b/lib/Kolab/Cyrus.pm
index 17b1adf..1cabab1 100644
--- a/lib/Kolab/Cyrus.pm
+++ b/lib/Kolab/Cyrus.pm
@@ -42,6 +42,7 @@ our %EXPORT_TAGS = (
         &createMailbox
         &createCalendar
         &deleteMailbox
+        &transferMailbox
         &renameMailbox
         &setQuota
         &setACL
@@ -106,14 +107,25 @@ sub createMailbox
     my $cyruid = &createUid($uid, $sf);
     my $mailbox = ($cyrus->list($cyruid))[0];
 
-    if ($uid && ($uid ne $Kolab::config{'cyrus_admin'}) && ($uid ne "freebusy") && ($uid ne "nobody") && !defined($mailbox)) {
-        Kolab::log('Y', "Creating mailbox `$cyruid' on ".($partition?"partition `$partition'":"default partition"));
-        if (!$cyrus->create($cyruid, $partition)) {
-            Kolab::log('Y', "Unable to create mailbox `$cyruid', Error = `" . $cyrus->error . "'", KOLAB_WARN);
+    if ($uid && ($uid ne $Kolab::config{'cyrus_admin'}) && ($uid ne "freebusy") && ($uid ne "nobody")) {
+        if ( !defined($mailbox) ) {
+            Kolab::log('Y', "Creating mailbox `$cyruid' on ".($partition?"partition `$partition'":"default partition"));
+            if (!$cyrus->create($cyruid, $partition)) {
+                Kolab::log('Y', "Unable to create mailbox `$cyruid', Error = `" . $cyrus->error . "'", KOLAB_WARN);
+                return 0;
+            } else {
+                return 1;
+            }
+        } else {
+            Kolab::log('Y', "Unable to create mailbox `$cyruid', mailbox already exists", KOLAB_WARN);
+            return 10036;
         }
     } else {
         Kolab::log('Y', "Skipping mailbox creation for $uid (cyruid='$cyruid', mailbox='".join(',',@{$mailbox})."'", KOLAB_DEBUG);
+        return 0;
     }
+
+    return 1;
 }
 
 sub createCalendar
@@ -210,6 +222,22 @@ sub renameMailbox
     }
 }
 
+sub transferMailbox
+{
+    my $cyrus = shift;
+    my $mailboxPath = shift;
+    my $mailHost = shift;
+
+    Kolab::log('Y', "Transferring mailbox `$mailboxPath' to `$mailHost`");
+
+    if (!$cyrus->xfermailbox($mailboxPath, $mailHost)) {
+        Kolab::log('Y', "Unable to transfer mailbox `$mailboxPath' to `$mailHost', Error = `" . $cyrus->error . "'", KOLAB_WARN);
+        return 0;
+    }
+
+    return 1;
+}
+
 sub setACL
 {
     my $cyrus = shift;