Added simple API to manage vacation rule

Aleksander Machniak

2014-08-26 613f96839cbf63d475a4f56cb1841647bb23ad0c

 plugins/managesieve/lib/Roundcube/rcube_sieve.php

@@ -6,32 +6,21 @@
 * Copyright (C) 2008-2011, The Roundcube Dev Team
 * Copyright (C) 2011, Kolab Systems AG
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation.
 * 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 3 of the License, 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 should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see http://www.gnu.org/licenses/.
 */

// Managesieve Protocol: RFC5804

define('SIEVE_ERROR_CONNECTION', 1);
define('SIEVE_ERROR_LOGIN', 2);
define('SIEVE_ERROR_NOT_EXISTS', 3);    // script not exists
define('SIEVE_ERROR_INSTALL', 4);       // script installation
define('SIEVE_ERROR_ACTIVATE', 5);      // script activation
define('SIEVE_ERROR_DELETE', 6);        // script deletion
define('SIEVE_ERROR_INTERNAL', 7);      // internal error
define('SIEVE_ERROR_DEACTIVATE', 8);    // script activation
define('SIEVE_ERROR_OTHER', 255);       // other/unknown error


class rcube_sieve
{
@@ -42,6 +31,16 @@
    public $script;                 // rcube_sieve_script object
    public $current;                // name of currently loaded script
    private $exts;                  // array of supported extensions

    const ERROR_CONNECTION = 1;
    const ERROR_LOGIN      = 2;
    const ERROR_NOT_EXISTS = 3;    // script not exists
    const ERROR_INSTALL    = 4;    // script installation
    const ERROR_ACTIVATE   = 5;    // script activation
    const ERROR_DELETE     = 6;    // script deletion
    const ERROR_INTERNAL   = 7;    // internal error
    const ERROR_DEACTIVATE = 8;    // script activation
    const ERROR_OTHER      = 255;  // other/unknown error


    /**
@@ -57,10 +56,11 @@
     * @param boolean Enable/disable debugging
     * @param string  Proxy authentication identifier
     * @param string  Proxy authentication password
     * @param array   List of options to pass to stream_context_create().
     */
    public function __construct($username, $password='', $host='localhost', $port=2000,
        $auth_type=null, $usetls=true, $disabled=array(), $debug=false,
        $auth_cid=null, $auth_pw=null)
        $auth_cid=null, $auth_pw=null, $options=array())
    {
        $this->sieve = new Net_Sieve();

@@ -68,8 +68,8 @@
            $this->sieve->setDebug(true, array($this, 'debug_handler'));
        }

        if (PEAR::isError($this->sieve->connect($host, $port, null, $usetls))) {
            return $this->_set_error(SIEVE_ERROR_CONNECTION);
        if (PEAR::isError($this->sieve->connect($host, $port, $options, $usetls))) {
            return $this->_set_error(self::ERROR_CONNECTION);
        }

        if (!empty($auth_cid)) {
@@ -81,10 +81,10 @@
        if (PEAR::isError($this->sieve->login($username, $password,
            $auth_type ? strtoupper($auth_type) : null, $authz))
        ) {
            return $this->_set_error(SIEVE_ERROR_LOGIN);
            return $this->_set_error(self::ERROR_LOGIN);
        }

        $this->exts     = $this->get_extensions();
        $this->exts = $this->get_extensions();

        // disable features by config
        if (!empty($disabled)) {
@@ -116,10 +116,10 @@
    public function save($name = null)
    {
        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        if (!$this->script)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        if (!$name)
            $name = $this->current;
@@ -130,7 +130,7 @@
            $script = '/* empty script */';

        if (PEAR::isError($this->sieve->installScript($name, $script)))
            return $this->_set_error(SIEVE_ERROR_INSTALL);
            return $this->_set_error(self::ERROR_INSTALL);

        return true;
    }
@@ -141,13 +141,13 @@
    public function save_script($name, $content = null)
    {
        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        if (!$content)
            $content = '/* empty script */';

        if (PEAR::isError($this->sieve->installScript($name, $content)))
            return $this->_set_error(SIEVE_ERROR_INSTALL);
            return $this->_set_error(self::ERROR_INSTALL);

        return true;
    }
@@ -158,13 +158,13 @@
    public function activate($name = null)
    {
        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        if (!$name)
            $name = $this->current;

        if (PEAR::isError($this->sieve->setActive($name)))
            return $this->_set_error(SIEVE_ERROR_ACTIVATE);
            return $this->_set_error(self::ERROR_ACTIVATE);

        return true;
    }
@@ -175,10 +175,10 @@
    public function deactivate()
    {
        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        if (PEAR::isError($this->sieve->setActive('')))
            return $this->_set_error(SIEVE_ERROR_DEACTIVATE);
            return $this->_set_error(self::ERROR_DEACTIVATE);

        return true;
    }
@@ -189,7 +189,7 @@
    public function remove($name = null)
    {
        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        if (!$name)
            $name = $this->current;
@@ -197,10 +197,10 @@
        // script must be deactivated first
        if ($name == $this->sieve->getActive())
            if (PEAR::isError($this->sieve->setActive('')))
                return $this->_set_error(SIEVE_ERROR_DELETE);
                return $this->_set_error(self::ERROR_DELETE);

        if (PEAR::isError($this->sieve->removeScript($name)))
            return $this->_set_error(SIEVE_ERROR_DELETE);
            return $this->_set_error(self::ERROR_DELETE);

        if ($name == $this->current)
            $this->current = null;
@@ -217,9 +217,14 @@
            return $this->exts;

        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        $ext = $this->sieve->getExtensions();

        if (PEAR::isError($ext)) {
            return array();
        }

        // we're working on lower-cased names
        $ext = array_map('strtolower', (array) $ext);

@@ -241,12 +246,12 @@
        if (!$this->list) {

            if (!$this->sieve)
                return $this->_set_error(SIEVE_ERROR_INTERNAL);
                return $this->_set_error(self::ERROR_INTERNAL);

            $list = $this->sieve->listScripts();

            if (PEAR::isError($list))
                return $this->_set_error(SIEVE_ERROR_OTHER);
                return $this->_set_error(self::ERROR_OTHER);

            $this->list = $list;
        }
@@ -260,7 +265,7 @@
    public function get_active()
    {
        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        return $this->sieve->getActive();
    }
@@ -271,7 +276,7 @@
    public function load($name)
    {
        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        if ($this->current == $name)
            return true;
@@ -279,7 +284,7 @@
        $script = $this->sieve->getScript($name);

        if (PEAR::isError($script))
            return $this->_set_error(SIEVE_ERROR_OTHER);
            return $this->_set_error(self::ERROR_OTHER);

        // try to parse from Roundcube format
        $this->script = $this->_parse($script);
@@ -295,7 +300,7 @@
    public function load_script($script)
    {
        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        // try to parse from Roundcube format
        $this->script = $this->_parse($script);
@@ -340,12 +345,12 @@
    public function get_script($name)
    {
        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        $content = $this->sieve->getScript($name);

        if (PEAR::isError($content))
            return $this->_set_error(SIEVE_ERROR_OTHER);
            return $this->_set_error(self::ERROR_OTHER);

        return $content;
    }
@@ -356,13 +361,13 @@
    public function copy($name, $copy)
    {
        if (!$this->sieve)
            return $this->_set_error(SIEVE_ERROR_INTERNAL);
            return $this->_set_error(self::ERROR_INTERNAL);

        if ($copy) {
            $content = $this->sieve->getScript($copy);

            if (PEAR::isError($content))
                return $this->_set_error(SIEVE_ERROR_OTHER);
                return $this->_set_error(self::ERROR_OTHER);
        }

        return $this->save_script($name, $content);
@@ -379,6 +384,6 @@
     */
    public function debug_handler(&$sieve, $message)
    {
        write_log('sieve', preg_replace('/\r\n$/', '', $message));
        rcube::write_log('sieve', preg_replace('/\r\n$/', '', $message));
    }
}