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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
|
package Kolab::Cyrus;
## COPYRIGHT
## ---------
##
## See AUTHORS file
##
##
## LICENSE
## -------
##
## This program is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License as
## published by the Free Software Foundation; either version 2, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You can view the GNU General Public License, online, at the GNU
## Project's homepage; see <http://www.gnu.org/licenses/gpl.html>.
##
## $Revision: 1.6.2.1 $
use 5.008;
use strict;
use warnings;
use Cyrus::IMAP::Admin;
use Kolab::Util;
use Kolab;
require Exporter;
our @ISA = qw(Exporter);
our %EXPORT_TAGS = (
'all' => [ qw(
&create
&createUid
&createMailbox
&createCalendar
&deleteMailbox
&setQuota
&setACL
) ]
);
our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
our @EXPORT = qw(
);
our $VERSION = '0.9';
sub create
{
Kolab::log('Y', 'Connecting to local Cyrus admin interface');
my $cyrus = Cyrus::IMAP::Admin->new($Kolab::config{'connect_addr'});
if (!$cyrus) {
Kolab::log('Y', 'Unable to connect to local Cyrus admin interface', KOLAB_ERROR);
return 0;
}
if (!$cyrus->authenticate(
'User' => $Kolab::config{'cyrus_admin'},
'Password' => $Kolab::config{'cyrus_admin_pw'},
'Mechanism' => 'LOGIN',
)) {
Kolab::log('Y', "Unable to authenticate with Cyrus admin interface, Error = `" . $cyrus->error . "'", KOLAB_ERROR);
return 0;
}
return $cyrus;
}
sub createUid
{
my $user = shift;
my $sf = shift || 0;
my $seperator = '/';
my $uidprefix = 'user';
if ($sf) {
$seperator = '.';
$uidprefix = 'shared';
}
return $uidprefix . $seperator . $user;
# return 'user' . ($sf ? '.' : '/') . $user;
}
sub createMailbox
{
my $cyrus = shift;
my $uid = shift;
my $sf = shift || 0;
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'");
if (!$cyrus->create($cyruid)) {
Kolab::log('Y', "Unable to create mailbox `$cyruid', Error = `" . $cyrus->error . "'", KOLAB_WARN);
}
} else {
Kolab::log('Y', "Skipping mailbox creation for $uid (curuid='$cyruid', mailbox='".join(',',@{$mailbox})."'", KOLAB_DEBUG);
}
}
sub createCalendar
{
my $cyrus = shift;
my $user = shift;
my $domain = shift;
my $folder = shift;
my $acl = shift;
my $calendar = 0;
my @mailboxes = $cyrus->list("user/$user/*\@$domain");
my %info;
foreach my $mailbox (@mailboxes) {
my $u = @{$mailbox}[0];
%info = $cyrus->info($u, ('/vendor/kolab/folder-type'));
my $key = '/mailbox/{' . $u . '}/vendor/kolab/folder-type';
if (exists($info{$key}) && $info{$key} eq 'event.default') {
$calendar = $u;
}
}
if ($calendar) {
Kolab::log('Y', "Skipping calendar creation for $user\@$domain as $calendar is a default calendar.", KOLAB_DEBUG);
} else {
Kolab::log('Y', "Creating default calendar for $user\@$domain.", KOLAB_DEBUG);
createMailbox($cyrus, $folder, 0);
setFolderType($cyrus, $folder, 0, 'event.default');
setACL($cyrus, $folder, 0, $acl);
Kolab::log('Y', "Successfully created default calendar for $user\@$domain.", KOLAB_DEBUG);
}
}
sub setQuota
{
my $cyrus = shift;
my $uid = shift;
my $quota = shift || 0;
my $sf = shift || 0;
my $cyruid = &createUid($uid, $sf);
if( $quota < 0 ) {
return;
}
(my $root, my %quota) = $cyrus->quotaroot($cyruid);
my $setquota = $quota{'STORAGE'}[1];
if (!defined($setquota) || ($setquota != $quota)) {
if( $quota == 0 ) {
Kolab::log('Y', "Removing quota from mailbox `$cyruid'");
if (!$cyrus->setquota($cyruid)) {
Kolab::log('Y', "Unable to remove quota for mailbox `$cyruid', Error = `" . $cyrus->error . "'", KOLAB_WARN);
}
} else {
Kolab::log('Y', "Setting quota of mailbox `$cyruid' to $quota");
if (!$cyrus->setquota($cyruid, 'STORAGE', $quota)) {
Kolab::log('Y', "Unable to set quota for mailbox `$cyruid', Error = `" . $cyrus->error . "'", KOLAB_WARN);
}
}
}
}
sub deleteMailbox
{
my $cyrus = shift;
my $uid = shift;
my $sf = shift || 0;
my $cyruid = &createUid($uid, $sf);
Kolab::log('Y', "Removing mailbox `$cyruid'");
if (!$cyrus->setacl($cyruid, $Kolab::config{'cyrus_admin'}, 'c')) {
Kolab::log('Y', "Unable to reset ACL of mailbox `$cyruid', Error = `" . $cyrus->error . "'", KOLAB_WARN);
}
if (!$cyrus->delete($cyruid)) {
Kolab::log('Y', "Unable to remove mailbox `$cyruid', Error = `" . $cyrus->error . "'", KOLAB_WARN);
}
}
sub setACL
{
my $cyrus = shift;
my $uid = shift;
my $sf = shift || 0;
my $cyruid = &createUid($uid, $sf);
Kolab::log('Y', "Setting up ACL of mailbox `$cyruid'");
my %acls = $cyrus->listacl( $cyruid );
my ($user, $entry, $acl);
Kolab::log('Y', "Removing users from ACL of $cyruid (users are \"".join(', ', keys %acls)."\")", KOLAB_DEBUG);
foreach $user ( keys %acls) {
Kolab::log('Y', "Removing `$user' from the ACL of mailbox `$cyruid'");
if (!$cyrus->deleteacl($cyruid, $user)) {
Kolab::log('Y', "Unable to remove `$user' from the ACL of mailbox `$cyruid', Error = `" . $cyrus->error . "'", KOLAB_WARN);
}
}
Kolab::log('Y', "Add users from ACL of $cyruid", KOLAB_DEBUG);
my $newacl = shift;
foreach $entry (@$newacl) {
Kolab::log('Y', "Setting up ACL `$entry'", KOLAB_DEBUG);
($user, $acl) = split(/ /, $entry , 2);
Kolab::log('Y', "Split `$user' and `$acl'", KOLAB_DEBUG);
$user = trim($user);
$acl = trim($acl);
Kolab::log('Y', "Setting the ACL of user `$user' in mailbox `$cyruid' to $acl");
if (!$cyrus->setacl($cyruid, $user, $acl)) {
Kolab::log('Y', "Unable to set the ACL of user `$user' in mailbox `$cyruid' to $acl, Error = `" . $cyrus->error . "'", KOLAB_WARN);
}
}
Kolab::log('Y', "Finished modifying ACL of $cyruid", KOLAB_DEBUG);
}
sub setFolderType {
my $cyrus = shift;
my $uid = shift;
my $sf = shift || 0;
my $foldertype = shift || 'mail';
my $cyruid = &createUid($uid, $sf);
if (!$cyrus->mboxconfig($cyruid, '/vendor/kolab/folder-type', $foldertype)) {
Kolab::log('Y', "Unable to set the folder type for mailbox `$cyruid' to `$foldertype', Error = `" . $cyrus->error . "'", KOLAB_WARN);
}
}
1;
__END__
# Below is stub documentation for your module. You'd better edit it!
=head1 NAME
Kolab::Cyrus - Perl extension for interfacing with the Kolab Cyrus
admin module.
=head1 ABSTRACT
Kolab::Cyrus contains cyrus-related functions, such as
adding/deleting mailboxes, etc.
=head1 COPYRIGHT AND AUTHORS
Stuart Bing and others (see AUTHORS file)
=head1 LICENSE
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You can view the GNU General Public License, online, at the GNU
Project's homepage; see <http://www.gnu.org/licenses/gpl.html>.
=cut
|