egroupware_official/emailadmin/inc/class.emailadmin_imap_cyrus.inc.php
2014-07-09 17:51:10 +00:00

191 lines
4.7 KiB
PHP

<?php
/**
* EGroupware EMailAdmin: Support for Cyrus IMAP
*
* @link http://www.stylite.de
* @package emailadmin
* @author Ralf Becker <rb@stylite.de>
* @author Klaus Leithoff <kl@stylite.de>
* @author Lars Kneschke
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @version $Id$
*/
/**
* Manages connection to Cyrus IMAP server
*/
class emailadmin_imap_cyrus extends emailadmin_imap
{
/**
* Label shown in EMailAdmin
*/
const DESCRIPTION = 'Cyrus';
/**
* Capabilities of this class (pipe-separated): default, sieve, admin, logintypeemail
*/
const CAPABILITIES = 'default|sieve|timedsieve|admin|logintypeemail';
/**
* prefix for groupnames, when using groups in ACL Management
*/
const ACL_GROUP_PREFIX = 'group:';
// mailbox delimiter
var $mailboxDelimiter = '.';
// mailbox prefix
var $mailboxPrefix = '';
/**
* Updates an account
*
* @param array $_hookValues only value for key 'account_lid' and 'new_passwd' is used
*/
function addAccount($_hookValues)
{
return $this->updateAccount($_hookValues);
}
/**
* Delete an account
*
* @param array $_hookValues only value for key 'account_lid' is used
*/
function deleteAccount($_hookValues)
{
// some precausion to really delete just _one_ account
if (strpos($_hookValues['account_lid'],'%') !== false ||
strpos($_hookValues['account_lid'],'*') !== false)
{
return false;
}
return !!$this->deleteUsers($_hookValues['account_lid']);
}
/**
* Delete multiple (user-)mailboxes via a wildcard, eg. '%' for whole domain
*
* Domain is the configured domain and it uses the Cyrus admin user
*
* @return string $username='%' username containing wildcards, default '%' for all users of a domain
* @return int|boolean number of deleted mailboxes on success or false on error
*/
function deleteUsers($username='%')
{
if(!$this->acc_imap_administration || empty($username))
{
return false;
}
// we need a admin connection
$this->adminConnection();
$mailboxName = $this->getUserMailboxString($username);
list($reference,$restriction) = explode($username,$mailboxName,2);
try {
$mboxes = $this->getMailboxes($reference,$username.$restriction);
//error_log(__METHOD__."('$username') getMailboxes('$reference','$username$restriction') = ".array2string($mboxes));
foreach($mboxes as $mbox)
{
// give the admin account the rights to delete this mailbox
$this->setACL($mbox, $this->adminUsername, 'lrswipcda');
$this->deleteMailbox($mbox);
}
}
catch(Horde_Imap_Client_Exception $e) {
_egw_log_exception($e);
$this->disconnect();
return false;
}
$this->disconnect();
return count($mboxes);
}
/**
* returns information about a user
* currently only supported information is the current quota
*
* @param string $_username
* @return array userdata
*/
function getUserData($_username)
{
$this->adminConnection();
$userData = array();
if(($quota = $this->getQuotaByUser($_username,'ALL')))
{
$userData['quotaLimit'] = (int)($quota['limit'] / 1024);
$userData['quotaUsed'] = (int)($quota['usage'] / 1024);
}
//error_log(__LINE__.': '.__METHOD__."('$_username') quota=".array2string($quota).' returning '.array2string($userData));
$this->disconnect();
return $userData;
}
/**
* Set information about a user
* currently only supported information is the current quota
*
* @param string $_username
* @param int $_quota
*/
function setUserData($_username, $_quota)
{
if(!$this->acc_imap_administration)
{
return false;
}
// create a admin connection
$this->adminConnection();
$mailboxName = $this->getUserMailboxString($_username);
$this->setQuota($mailboxName, array('STORAGE' => (int)$_quota > 0 ? (int)$_quota*1024 : -1));
$this->disconnect();
return true;
}
/**
* Updates an account
*
* @param array $_hookValues only value for key 'account_lid' and 'new_passwd' is used
*/
function updateAccount($_hookValues)
{
if(!$this->acc_imap_administration)
{
return false;
}
// we need a admin connection
$this->adminConnection();
// create the mailbox, with the account_lid, as it is passed from the hook values (gets transformed there if needed)
$mailboxName = $this->getUserMailboxString($_hookValues['account_lid'], $mailboxName);
// make sure we use the correct username here.
$username = $this->getMailBoxUserName($_hookValues['account_lid']);
$folderInfo = $this->getMailboxes('', $mailboxName, true);
if(empty($folderInfo))
{
try {
$this->createMailbox($mailboxName);
$this->setACL($mailboxName, $username, "lrswipcda");
}
catch(Horde_Imap_Client_Exception $e) {
_egw_log_exception($e);
}
}
$this->disconnect();
}
}