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
|
<?php
require_once('Net/Sieve.php');
/**
* Ingo_Driver_timsieved:: Implements the Sieve_Driver api to allow scripts to
* be installed and set active via a Cyrus timsieved server.
*
* $Horde: ingo/lib/Driver/timsieved.php,v 1.15.10.13 2009/12/21 18:29:09 jan Exp $
*
* Copyright 2003-2009 The Horde Project (http://www.horde.org/)
*
* See the enclosed file LICENSE for license information (ASL). If you
* did not receive this file, see http://www.horde.org/licenses/asl.php.
*
* @author Mike Cochrane <mike@graftonhall.co.nz>
* @author Jan Schneider <jan@horde.org>
* @package Ingo
*/
class Ingo_Driver_timsieved extends Ingo_Driver {
/**
* Whether this driver allows managing other users' rules.
*
* @var boolean
*/
var $_support_shares = true;
/**
* The Net_Sieve object.
*
* @var Net_Sieve
*/
var $_sieve;
/**
* Constructor.
*/
function Ingo_Driver_timsieved($params = array())
{
$default_params = array(
'hostspec' => 'localhost',
'logintype' => 'PLAIN',
'port' => 2000,
'scriptname' => 'ingo',
'admin' => '',
'usetls' => true
);
$this->_params = array_merge($this->_params, $default_params, $params);
}
/**
* Connects to the sieve server.
*/
function _connect()
{
if (!empty($this->_sieve)) {
return;
}
if (empty($this->_params['admin'])) {
$auth = $this->_params['username'];
} else {
$auth = $this->_params['admin'];
}
$this->_sieve = &new Net_Sieve($auth,
$this->_params['password'],
$this->_params['hostspec'],
$this->_params['port'],
$this->_params['logintype'],
Ingo::getUser(false),
false,
false,
$this->_params['usetls']);
$res = $this->_sieve->getError();
if (is_a($res, 'PEAR_Error')) {
unset($this->_sieve);
return $res;
}
if (!empty($this->_params['debug'])) {
$this->_sieve->setDebug(true, array($this, '_debug'));
}
}
/**
* Routes the Sieve protocol log to the Horde log.
*
* @param Net_Sieve $sieve A Net_Sieve object.
* @param string $message The tracked Sieve communication.
*/
function _debug($sieve, $message)
{
Horde::logMessage($message, __FILE__, __LINE__, PEAR_LOG_DEBUG);
}
/**
* Sets a script running on the backend.
*
* @param string $script The sieve script.
*
* @return mixed True on success, PEAR_Error on error.
*/
function setScriptActive($script)
{
$res = $this->_connect();
if (is_a($res, 'PEAR_Error')) {
return $res;
}
if (!strlen($script)) {
return $this->_sieve->setActive('');
}
$res = $this->_sieve->haveSpace($this->_params['scriptname'],
strlen($script));
if (is_a($res, 'PEAR_ERROR')) {
return $res;
}
return $this->_sieve->installScript($this->_params['scriptname'],
$script, true);
}
/**
* Returns the content of the currently active script.
*
* @return string The complete ruleset of the specified user.
*/
function getScript()
{
$res = $this->_connect();
if (is_a($res, 'PEAR_Error')) {
return $res;
}
$active = $this->_sieve->getActive();
if (empty($active)) {
return '';
}
return $this->_sieve->getScript($active);
}
}
|