summaryrefslogtreecommitdiff
path: root/plugins/managesieve/lib
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/managesieve/lib')
-rw-r--r--plugins/managesieve/lib/Net/Sieve.php1212
-rw-r--r--plugins/managesieve/lib/rcube_sieve.php875
2 files changed, 0 insertions, 2087 deletions
diff --git a/plugins/managesieve/lib/Net/Sieve.php b/plugins/managesieve/lib/Net/Sieve.php
deleted file mode 100644
index b2549eed9..000000000
--- a/plugins/managesieve/lib/Net/Sieve.php
+++ /dev/null
@@ -1,1212 +0,0 @@
-<?php
-/**
- * This file contains the Net_Sieve class.
- *
- * PHP version 4
- *
- * +-----------------------------------------------------------------------+
- * | All rights reserved. |
- * | |
- * | Redistribution and use in source and binary forms, with or without |
- * | modification, are permitted provided that the following conditions |
- * | are met: |
- * | |
- * | o Redistributions of source code must retain the above copyright |
- * | notice, this list of conditions and the following disclaimer. |
- * | o Redistributions in binary form must reproduce the above copyright |
- * | notice, this list of conditions and the following disclaimer in the |
- * | documentation and/or other materials provided with the distribution.|
- * | |
- * | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
- * | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
- * | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
- * | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
- * | OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
- * | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
- * | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
- * | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
- * | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
- * | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
- * | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
- * +-----------------------------------------------------------------------+
- *
- * @category Networking
- * @package Net_Sieve
- * @author Richard Heyes <richard@phpguru.org>
- * @author Damian Fernandez Sosa <damlists@cnba.uba.ar>
- * @author Anish Mistry <amistry@am-productions.biz>
- * @author Jan Schneider <jan@horde.org>
- * @copyright 2002-2003 Richard Heyes
- * @copyright 2006-2008 Anish Mistry
- * @license http://www.opensource.org/licenses/bsd-license.php BSD
- * @version SVN: $Id: Sieve.php 289313 2009-10-07 22:26:33Z yunosh $
- * @link http://pear.php.net/package/Net_Sieve
- */
-
-require_once 'PEAR.php';
-require_once 'Net/Socket.php';
-
-/**
- * TODO
- *
- * o supportsAuthMech()
- */
-
-/**
- * Disconnected state
- * @const NET_SIEVE_STATE_DISCONNECTED
- */
-define('NET_SIEVE_STATE_DISCONNECTED', 1, true);
-
-/**
- * Authorisation state
- * @const NET_SIEVE_STATE_AUTHORISATION
- */
-define('NET_SIEVE_STATE_AUTHORISATION', 2, true);
-
-/**
- * Transaction state
- * @const NET_SIEVE_STATE_TRANSACTION
- */
-define('NET_SIEVE_STATE_TRANSACTION', 3, true);
-
-
-/**
- * A class for talking to the timsieved server which comes with Cyrus IMAP.
- *
- * @category Networking
- * @package Net_Sieve
- * @author Richard Heyes <richard@phpguru.org>
- * @author Damian Fernandez Sosa <damlists@cnba.uba.ar>
- * @author Anish Mistry <amistry@am-productions.biz>
- * @author Jan Schneider <jan@horde.org>
- * @copyright 2002-2003 Richard Heyes
- * @copyright 2006-2008 Anish Mistry
- * @license http://www.opensource.org/licenses/bsd-license.php BSD
- * @version Release: @package_version@
- * @link http://pear.php.net/package/Net_Sieve
- * @link http://www.ietf.org/rfc/rfc3028.txt RFC 3028 (Sieve: A Mail
- * Filtering Language)
- * @link http://tools.ietf.org/html/draft-ietf-sieve-managesieve A
- * Protocol for Remotely Managing Sieve Scripts
- */
-class Net_Sieve
-{
- /**
- * The authentication methods this class supports.
- *
- * Can be overwritten if having problems with certain methods.
- *
- * @var array
- */
- var $supportedAuthMethods = array('DIGEST-MD5', 'CRAM-MD5', 'EXTERNAL',
- 'PLAIN' , 'LOGIN');
-
- /**
- * SASL authentication methods that require Auth_SASL.
- *
- * @var array
- */
- var $_supportedSASLAuthMethods = array('DIGEST-MD5', 'CRAM-MD5');
-
- /**
- * The socket handle.
- *
- * @var resource
- */
- var $_sock;
-
- /**
- * Parameters and connection information.
- *
- * @var array
- */
- var $_data;
-
- /**
- * Current state of the connection.
- *
- * One of the NET_SIEVE_STATE_* constants.
- *
- * @var integer
- */
- var $_state;
-
- /**
- * Constructor error.
- *
- * @var PEAR_Error
- */
- var $_error;
-
- /**
- * Whether to enable debugging.
- *
- * @var boolean
- */
- var $_debug = false;
-
- /**
- * Debug output handler.
- *
- * This has to be a valid callback.
- *
- * @var string|array
- */
- var $_debug_handler = null;
-
- /**
- * Whether to pick up an already established connection.
- *
- * @var boolean
- */
- var $_bypassAuth = false;
-
- /**
- * Whether to use TLS if available.
- *
- * @var boolean
- */
- var $_useTLS = true;
-
- /**
- * Additional options for stream_context_create().
- *
- * @var array
- */
- var $_options = null;
-
- /**
- * Maximum number of referral loops
- *
- * @var array
- */
- var $_maxReferralCount = 15;
-
- /**
- * Constructor.
- *
- * Sets up the object, connects to the server and logs in. Stores any
- * generated error in $this->_error, which can be retrieved using the
- * getError() method.
- *
- * @param string $user Login username.
- * @param string $pass Login password.
- * @param string $host Hostname of server.
- * @param string $port Port of server.
- * @param string $logintype Type of login to perform (see
- * $supportedAuthMethods).
- * @param string $euser Effective user. If authenticating as an
- * administrator, login as this user.
- * @param boolean $debug Whether to enable debugging (@see setDebug()).
- * @param string $bypassAuth Skip the authentication phase. Useful if the
- * socket is already open.
- * @param boolean $useTLS Use TLS if available.
- * @param array $options Additional options for
- * stream_context_create().
- */
- function Net_Sieve($user = null, $pass = null, $host = 'localhost',
- $port = 2000, $logintype = '', $euser = '', $debug = false,
- $bypassAuth = false, $useTLS = true, $options = null
- ) {
- $this->_state = NET_SIEVE_STATE_DISCONNECTED;
- $this->_data['user'] = $user;
- $this->_data['pass'] = $pass;
- $this->_data['host'] = $host;
- $this->_data['port'] = $port;
- $this->_data['logintype'] = $logintype;
- $this->_data['euser'] = $euser;
- $this->_sock = new Net_Socket();
- $this->_debug = $debug;
- $this->_bypassAuth = $bypassAuth;
- $this->_useTLS = $useTLS;
- $this->_options = $options;
-
- /* Try to include the Auth_SASL package. If the package is not
- * available, we disable the authentication methods that depend upon
- * it. */
- if ((@include_once 'Auth/SASL.php') === false) {
- $this->_debug('Auth_SASL not present');
- foreach ($this->supportedSASLAuthMethods as $SASLMethod) {
- $pos = array_search($SASLMethod, $this->supportedAuthMethods);
- $this->_debug('Disabling method ' . $SASLMethod);
- unset($this->supportedAuthMethods[$pos]);
- }
- }
-
- if (strlen($user) && strlen($pass)) {
- $this->_error = $this->_handleConnectAndLogin();
- }
- }
-
- /**
- * Returns any error that may have been generated in the constructor.
- *
- * @return boolean|PEAR_Error False if no error, PEAR_Error otherwise.
- */
- function getError()
- {
- return PEAR::isError($this->_error) ? $this->_error : false;
- }
-
- /**
- * Sets the debug state and handler function.
- *
- * @param boolean $debug Whether to enable debugging.
- * @param string $handler A custom debug handler. Must be a valid callback.
- *
- * @return void
- */
- function setDebug($debug = true, $handler = null)
- {
- $this->_debug = $debug;
- $this->_debug_handler = $handler;
- }
-
- /**
- * Connects to the server and logs in.
- *
- * @return boolean True on success, PEAR_Error on failure.
- */
- function _handleConnectAndLogin()
- {
- if (PEAR::isError($res = $this->connect($this->_data['host'], $this->_data['port'], $this->_options, $this->_useTLS))) {
- return $res;
- }
- if ($this->_bypassAuth === false) {
- if (PEAR::isError($res = $this->login($this->_data['user'], $this->_data['pass'], $this->_data['logintype'], $this->_data['euser'], $this->_bypassAuth))) {
- return $res;
- }
- }
- return true;
- }
-
- /**
- * Handles connecting to the server and checks the response validity.
- *
- * @param string $host Hostname of server.
- * @param string $port Port of server.
- * @param array $options List of options to pass to
- * stream_context_create().
- * @param boolean $useTLS Use TLS if available.
- *
- * @return boolean True on success, PEAR_Error otherwise.
- */
- function connect($host, $port, $options = null, $useTLS = true)
- {
- if (NET_SIEVE_STATE_DISCONNECTED != $this->_state) {
- return PEAR::raiseError('Not currently in DISCONNECTED state', 1);
- }
-
- if (PEAR::isError($res = $this->_sock->connect($host, $port, false, 5, $options))) {
- return $res;
- }
-
- if ($this->_bypassAuth) {
- $this->_state = NET_SIEVE_STATE_TRANSACTION;
- } else {
- $this->_state = NET_SIEVE_STATE_AUTHORISATION;
- if (PEAR::isError($res = $this->_doCmd())) {
- return $res;
- }
- }
-
- // Explicitly ask for the capabilities in case the connection is
- // picked up from an existing connection.
- if (PEAR::isError($res = $this->_cmdCapability())) {
- return PEAR::raiseError(
- 'Failed to connect, server said: ' . $res->getMessage(), 2
- );
- }
-
- // Check if we can enable TLS via STARTTLS.
- if ($useTLS && !empty($this->_capability['starttls'])
- && function_exists('stream_socket_enable_crypto')
- ) {
- if (PEAR::isError($res = $this->_startTLS())) {
- return $res;
- }
- }
-
- return true;
- }
-
- /**
- * Disconnect from the Sieve server.
- *
- * @param boolean $sendLogoutCMD Whether to send LOGOUT command before
- * disconnecting.
- *
- * @return boolean True on success, PEAR_Error otherwise.
- */
- function disconnect($sendLogoutCMD = true)
- {
- return $this->_cmdLogout($sendLogoutCMD);
- }
-
- /**
- * Logs into server.
- *
- * @param string $user Login username.
- * @param string $pass Login password.
- * @param string $logintype Type of login method to use.
- * @param string $euser Effective UID (perform on behalf of $euser).
- * @param boolean $bypassAuth Do not perform authentication.
- *
- * @return boolean True on success, PEAR_Error otherwise.
- */
- function login($user, $pass, $logintype = null, $euser = '', $bypassAuth = false)
- {
- if (NET_SIEVE_STATE_AUTHORISATION != $this->_state) {
- return PEAR::raiseError('Not currently in AUTHORISATION state', 1);
- }
-
- if (!$bypassAuth ) {
- if (PEAR::isError($res = $this->_cmdAuthenticate($user, $pass, $logintype, $euser))) {
- return $res;
- }
- }
- $this->_state = NET_SIEVE_STATE_TRANSACTION;
-
- return true;
- }
-
- /**
- * Returns an indexed array of scripts currently on the server.
- *
- * @return array Indexed array of scriptnames.
- */
- function listScripts()
- {
- if (is_array($scripts = $this->_cmdListScripts())) {
- $this->_active = $scripts[1];
- return $scripts[0];
- } else {
- return $scripts;
- }
- }
-
- /**
- * Returns the active script.
- *
- * @return string The active scriptname.
- */
- function getActive()
- {
- if (!empty($this->_active)) {
- return $this->_active;
- }
- if (is_array($scripts = $this->_cmdListScripts())) {
- $this->_active = $scripts[1];
- return $scripts[1];
- }
- }
-
- /**
- * Sets the active script.
- *
- * @param string $scriptname The name of the script to be set as active.
- *
- * @return boolean True on success, PEAR_Error on failure.
- */
- function setActive($scriptname)
- {
- return $this->_cmdSetActive($scriptname);
- }
-
- /**
- * Retrieves a script.
- *
- * @param string $scriptname The name of the script to be retrieved.
- *
- * @return string The script on success, PEAR_Error on failure.
- */
- function getScript($scriptname)
- {
- return $this->_cmdGetScript($scriptname);
- }
-
- /**
- * Adds a script to the server.
- *
- * @param string $scriptname Name of the script.
- * @param string $script The script content.
- * @param boolean $makeactive Whether to make this the active script.
- *
- * @return boolean True on success, PEAR_Error on failure.
- */
- function installScript($scriptname, $script, $makeactive = false)
- {
- if (PEAR::isError($res = $this->_cmdPutScript($scriptname, $script))) {
- return $res;
- }
- if ($makeactive) {
- return $this->_cmdSetActive($scriptname);
- }
- return true;
- }
-
- /**
- * Removes a script from the server.
- *
- * @param string $scriptname Name of the script.
- *
- * @return boolean True on success, PEAR_Error on failure.
- */
- function removeScript($scriptname)
- {
- return $this->_cmdDeleteScript($scriptname);
- }
-
- /**
- * Checks if the server has space to store the script by the server.
- *
- * @param string $scriptname The name of the script to mark as active.
- * @param integer $size The size of the script.
- *
- * @return boolean|PEAR_Error True if there is space, PEAR_Error otherwise.
- *
- * @todo Rename to hasSpace()
- */
- function haveSpace($scriptname, $size)
- {
- if (NET_SIEVE_STATE_TRANSACTION != $this->_state) {
- return PEAR::raiseError('Not currently in TRANSACTION state', 1);
- }
- if (PEAR::isError($res = $this->_doCmd(sprintf('HAVESPACE "%s" %d', $scriptname, $size)))) {
- return $res;
- }
- return true;
- }
-
- /**
- * Returns the list of extensions the server supports.
- *
- * @return array List of extensions or PEAR_Error on failure.
- */
- function getExtensions()
- {
- if (NET_SIEVE_STATE_DISCONNECTED == $this->_state) {
- return PEAR::raiseError('Not currently connected', 7);
- }
- return $this->_capability['extensions'];
- }
-
- /**
- * Returns whether the server supports an extension.
- *
- * @param string $extension The extension to check.
- *
- * @return boolean Whether the extension is supported or PEAR_Error on
- * failure.
- */
- function hasExtension($extension)
- {
- if (NET_SIEVE_STATE_DISCONNECTED == $this->_state) {
- return PEAR::raiseError('Not currently connected', 7);
- }
-
- $extension = trim($this->_toUpper($extension));
- if (is_array($this->_capability['extensions'])) {
- foreach ($this->_capability['extensions'] as $ext) {
- if ($ext == $extension) {
- return true;
- }
- }
- }
-
- return false;
- }
-
- /**
- * Returns the list of authentication methods the server supports.
- *
- * @return array List of authentication methods or PEAR_Error on failure.
- */
- function getAuthMechs()
- {
- if (NET_SIEVE_STATE_DISCONNECTED == $this->_state) {
- return PEAR::raiseError('Not currently connected', 7);
- }
- return $this->_capability['sasl'];
- }
-
- /**
- * Returns whether the server supports an authentication method.
- *
- * @param string $method The method to check.
- *
- * @return boolean Whether the method is supported or PEAR_Error on
- * failure.
- */
- function hasAuthMech($method)
- {
- if (NET_SIEVE_STATE_DISCONNECTED == $this->_state) {
- return PEAR::raiseError('Not currently connected', 7);
- }
-
- $method = trim($this->_toUpper($method));
- if (is_array($this->_capability['sasl'])) {
- foreach ($this->_capability['sasl'] as $sasl) {
- if ($sasl == $method) {
- return true;
- }
- }
- }
-
- return false;
- }
-
- /**
- * Handles the authentication using any known method.
- *
- * @param string $uid The userid to authenticate as.
- * @param string $pwd The password to authenticate with.
- * @param string $userMethod The method to use. If empty, the class chooses
- * the best (strongest) available method.
- * @param string $euser The effective uid to authenticate as.
- *
- * @return void
- */
- function _cmdAuthenticate($uid, $pwd, $userMethod = null, $euser = '')
- {
- if (PEAR::isError($method = $this->_getBestAuthMethod($userMethod))) {
- return $method;
- }
- switch ($method) {
- case 'DIGEST-MD5':
- return $this->_authDigestMD5($uid, $pwd, $euser);
- case 'CRAM-MD5':
- $result = $this->_authCRAMMD5($uid, $pwd, $euser);
- break;
- case 'LOGIN':
- $result = $this->_authLOGIN($uid, $pwd, $euser);
- break;
- case 'PLAIN':
- $result = $this->_authPLAIN($uid, $pwd, $euser);
- break;
- case 'EXTERNAL':
- $result = $this->_authEXTERNAL($uid, $pwd, $euser);
- break;
- default :
- $result = PEAR::raiseError(
- $method . ' is not a supported authentication method'
- );
- break;
- }
-
- if (PEAR::isError($res = $this->_doCmd())) {
- return $res;
- }
-
- return $result;
- }
-
- /**
- * Authenticates the user using the PLAIN method.
- *
- * @param string $user The userid to authenticate as.
- * @param string $pass The password to authenticate with.
- * @param string $euser The effective uid to authenticate as.
- *
- * @return void
- */
- function _authPLAIN($user, $pass, $euser)
- {
- return $this->_sendCmd(
- sprintf(
- 'AUTHENTICATE "PLAIN" "%s"',
- base64_encode($euser . chr(0) . $user . chr(0) . $pass)
- )
- );
- }
-
- /**
- * Authenticates the user using the LOGIN method.
- *
- * @param string $user The userid to authenticate as.
- * @param string $pass The password to authenticate with.
- * @param string $euser The effective uid to authenticate as.
- *
- * @return void
- */
- function _authLOGIN($user, $pass, $euser)
- {
- if (PEAR::isError($result = $this->_sendCmd('AUTHENTICATE "LOGIN"'))) {
- return $result;
- }
- if (PEAR::isError($result = $this->_doCmd('"' . base64_encode($user) . '"'))) {
- return $result;
- }
- return $this->_doCmd('"' . base64_encode($pass) . '"');
- }
-
- /**
- * Authenticates the user using the CRAM-MD5 method.
- *
- * @param string $user The userid to authenticate as.
- * @param string $pass The password to authenticate with.
- * @param string $euser The effective uid to authenticate as.
- *
- * @return void
- */
- function _authCRAMMD5($user, $pass, $euser)
- {
- if (PEAR::isError($challenge = $this->_doCmd('AUTHENTICATE "CRAM-MD5"', true))) {
- return $challenge;
- }
-
- $challenge = base64_decode(trim($challenge));
- $cram = Auth_SASL::factory('crammd5');
- if (PEAR::isError($response = $cram->getResponse($user, $pass, $challenge))) {
- return $response;
- }
-
- return $this->_sendStringResponse(base64_encode($response));
- }
-
- /**
- * Authenticates the user using the DIGEST-MD5 method.
- *
- * @param string $user The userid to authenticate as.
- * @param string $pass The password to authenticate with.
- * @param string $euser The effective uid to authenticate as.
- *
- * @return void
- */
- function _authDigestMD5($user, $pass, $euser)
- {
- if (PEAR::isError($challenge = $this->_doCmd('AUTHENTICATE "DIGEST-MD5"', true))) {
- return $challenge;
- }
-
- $challenge = base64_decode(trim($challenge));
- $digest = Auth_SASL::factory('digestmd5');
- // @todo Really 'localhost'?
- if (PEAR::isError($response = $digest->getResponse($user, $pass, $challenge, 'localhost', 'sieve', $euser))) {
- return $response;
- }
-
- if (PEAR::isError($result = $this->_sendStringResponse(base64_encode($param)))) {
- return $result;
- }
- if (PEAR::isError($result = $this->_doCmd())) {
- return $result;
- }
- if ($this->_toUpper(substr($result, 0, 2)) == 'OK') {
- return;
- }
-
- /* We don't use the protocol's third step because SIEVE doesn't allow
- * subsequent authentication, so we just silently ignore it. */
- if (PEAR::isError($result = $this->_sendStringResponse(''))) {
- return $result;
- }
-
- return $this->_doCmd();
- }
-
- /**
- * Authenticates the user using the EXTERNAL method.
- *
- * @param string $user The userid to authenticate as.
- * @param string $pass The password to authenticate with.
- * @param string $euser The effective uid to authenticate as.
- *
- * @return void
- *
- * @since 1.1.7
- */
- function _authEXTERNAL($user, $pass, $euser)
- {
- $cmd = sprintf(
- 'AUTHENTICATE "EXTERNAL" "%s"',
- base64_encode(strlen($euser) ? $euser : $user)
- );
- return $this->_sendCmd($cmd);
- }
-
- /**
- * Removes a script from the server.
- *
- * @param string $scriptname Name of the script to delete.
- *
- * @return boolean True on success, PEAR_Error otherwise.
- */
- function _cmdDeleteScript($scriptname)
- {
- if (NET_SIEVE_STATE_TRANSACTION != $this->_state) {
- return PEAR::raiseError('Not currently in AUTHORISATION state', 1);
- }
- if (PEAR::isError($res = $this->_doCmd(sprintf('DELETESCRIPT "%s"', $scriptname)))) {
- return $res;
- }
- return true;
- }
-
- /**
- * Retrieves the contents of the named script.
- *
- * @param string $scriptname Name of the script to retrieve.
- *
- * @return string The script if successful, PEAR_Error otherwise.
- */
- function _cmdGetScript($scriptname)
- {
- if (NET_SIEVE_STATE_TRANSACTION != $this->_state) {
- return PEAR::raiseError('Not currently in AUTHORISATION state', 1);
- }
-
- if (PEAR::isError($res = $this->_doCmd(sprintf('GETSCRIPT "%s"', $scriptname)))) {
- return $res;
- }
-
- return preg_replace('/{[0-9]+}\r\n/', '', $res);
- }
-
- /**
- * Sets the active script, i.e. the one that gets run on new mail by the
- * server.
- *
- * @param string $scriptname The name of the script to mark as active.
- *
- * @return boolean True on success, PEAR_Error otherwise.
- */
- function _cmdSetActive($scriptname)
- {
- if (NET_SIEVE_STATE_TRANSACTION != $this->_state) {
- return PEAR::raiseError('Not currently in AUTHORISATION state', 1);
- }
- if (PEAR::isError($res = $this->_doCmd(sprintf('SETACTIVE "%s"', $scriptname)))) {
- return $res;
- }
- $this->_activeScript = $scriptname;
- return true;
- }
-
- /**
- * Returns the list of scripts on the server.
- *
- * @return array An array with the list of scripts in the first element
- * and the active script in the second element on success,
- * PEAR_Error otherwise.
- */
- function _cmdListScripts()
- {
- if (NET_SIEVE_STATE_TRANSACTION != $this->_state) {
- return PEAR::raiseError('Not currently in AUTHORISATION state', 1);
- }
-
- if (PEAR::isError($res = $this->_doCmd('LISTSCRIPTS'))) {
- return $res;
- }
-
- $scripts = array();
- $activescript = null;
- $res = explode("\r\n", $res);
- foreach ($res as $value) {
- if (preg_match('/^"(.*)"( ACTIVE)?$/i', $value, $matches)) {
- $scripts[] = $matches[1];
- if (!empty($matches[2])) {
- $activescript = $matches[1];
- }
- }
- }
-
- return array($scripts, $activescript);
- }
-
- /**
- * Adds a script to the server.
- *
- * @param string $scriptname Name of the new script.
- * @param string $scriptdata The new script.
- *
- * @return boolean True on success, PEAR_Error otherwise.
- */
- function _cmdPutScript($scriptname, $scriptdata)
- {
- if (NET_SIEVE_STATE_TRANSACTION != $this->_state) {
- return PEAR::raiseError('Not currently in AUTHORISATION state', 1);
- }
-
- $stringLength = $this->_getLineLength($scriptdata);
-
- if (PEAR::isError($res = $this->_doCmd(sprintf("PUTSCRIPT \"%s\" {%d+}\r\n%s", $scriptname, $stringLength, $scriptdata)))) {
- return $res;
- }
-
- return true;
- }
-
- /**
- * Logs out of the server and terminates the connection.
- *
- * @param boolean $sendLogoutCMD Whether to send LOGOUT command before
- * disconnecting.
- *
- * @return boolean True on success, PEAR_Error otherwise.
- */
- function _cmdLogout($sendLogoutCMD = true)
- {
- if (NET_SIEVE_STATE_DISCONNECTED == $this->_state) {
- return PEAR::raiseError('Not currently connected', 1);
- }
-
- if ($sendLogoutCMD) {
- if (PEAR::isError($res = $this->_doCmd('LOGOUT'))) {
- return $res;
- }
- }
-
- $this->_sock->disconnect();
- $this->_state = NET_SIEVE_STATE_DISCONNECTED;
-
- return true;
- }
-
- /**
- * Sends the CAPABILITY command
- *
- * @return boolean True on success, PEAR_Error otherwise.
- */
- function _cmdCapability()
- {
- if (NET_SIEVE_STATE_DISCONNECTED == $this->_state) {
- return PEAR::raiseError('Not currently connected', 1);
- }
- if (PEAR::isError($res = $this->_doCmd('CAPABILITY'))) {
- return $res;
- }
- $this->_parseCapability($res);
- return true;
- }
-
- /**
- * Parses the response from the CAPABILITY command and stores the result
- * in $_capability.
- *
- * @param string $data The response from the capability command.
- *
- * @return void
- */
- function _parseCapability($data)
- {
- // Clear the cached capabilities.
- $this->_capability = array('sasl' => array(),
- 'extensions' => array());
-
- $data = preg_split('/\r?\n/', $this->_toUpper($data), -1, PREG_SPLIT_NO_EMPTY);
-
- for ($i = 0; $i < count($data); $i++) {
- if (!preg_match('/^"([A-Z]+)"( "(.*)")?$/', $data[$i], $matches)) {
- continue;
- }
- switch ($matches[1]) {
- case 'IMPLEMENTATION':
- $this->_capability['implementation'] = $matches[3];
- break;
-
- case 'SASL':
- $this->_capability['sasl'] = preg_split('/\s+/', $matches[3]);
- break;
-
- case 'SIEVE':
- $this->_capability['extensions'] = preg_split('/\s+/', $matches[3]);
- break;
-
- case 'STARTTLS':
- $this->_capability['starttls'] = true;
- break;
- }
- }
- }
-
- /**
- * Sends a command to the server
- *
- * @param string $cmd The command to send.
- *
- * @return void
- */
- function _sendCmd($cmd)
- {
- $status = $this->_sock->getStatus();
- if (PEAR::isError($status) || $status['eof']) {
- return PEAR::raiseError('Failed to write to socket: connection lost');
- }
- if (PEAR::isError($error = $this->_sock->write($cmd . "\r\n"))) {
- return PEAR::raiseError(
- 'Failed to write to socket: ' . $error->getMessage()
- );
- }
- $this->_debug("C: $cmd");
- }
-
- /**
- * Sends a string response to the server.
- *
- * @param string $str The string to send.
- *
- * @return void
- */
- function _sendStringResponse($str)
- {
- return $this->_sendCmd('{' . $this->_getLineLength($str) . "+}\r\n" . $str);
- }
-
- /**
- * Receives a single line from the server.
- *
- * @return string The server response line.
- */
- function _recvLn()
- {
- if (PEAR::isError($lastline = $this->_sock->gets(8192))) {
- return PEAR::raiseError(
- 'Failed to read from socket: ' . $lastline->getMessage()
- );
- }
-
- $lastline = rtrim($lastline);
- $this->_debug("S: $lastline");
-
- if ($lastline === '') {
- return PEAR::raiseError('Failed to read from socket');
- }
-
- return $lastline;
- }
-
- /**
- * Send a command and retrieves a response from the server.
- *
- * @param string $cmd The command to send.
- * @param boolean $auth Whether this is an authentication command.
- *
- * @return string|PEAR_Error Reponse string if an OK response, PEAR_Error
- * if a NO response.
- */
- function _doCmd($cmd = '', $auth = false)
- {
- $referralCount = 0;
- while ($referralCount < $this->_maxReferralCount) {
- if (strlen($cmd)) {
- if (PEAR::isError($error = $this->_sendCmd($cmd))) {
- return $error;
- }
- }
-
- $response = '';
- while (true) {
- if (PEAR::isError($line = $this->_recvLn())) {
- return $line;
- }
- $uc_line = $this->_toUpper($line);
-
- if ('OK' == substr($uc_line, 0, 2)) {
- $response .= $line;
- return rtrim($response);
- }
-
- if ('NO' == substr($uc_line, 0, 2)) {
- // Check for string literal error message.
- if (preg_match('/^no {([0-9]+)\+?}/i', $line, $matches)) {
- $line .= str_replace(
- "\r\n", ' ', $this->_sock->read($matches[1] + 2)
- );
- $this->_debug("S: $line");
- }
- return PEAR::raiseError(trim($response . substr($line, 2)), 3);
- }
-
- if ('BYE' == substr($uc_line, 0, 3)) {
- if (PEAR::isError($error = $this->disconnect(false))) {
- return PEAR::raiseError(
- 'Cannot handle BYE, the error was: '
- . $error->getMessage(),
- 4
- );
- }
- // Check for referral, then follow it. Otherwise, carp an
- // error.
- if (preg_match('/^bye \(referral "(sieve:\/\/)?([^"]+)/i', $line, $matches)) {
- // Replace the old host with the referral host
- // preserving any protocol prefix.
- $this->_data['host'] = preg_replace(
- '/\w+(?!(\w|\:\/\/)).*/', $matches[2],
- $this->_data['host']
- );
- if (PEAR::isError($error = $this->_handleConnectAndLogin())) {
- return PEAR::raiseError(
- 'Cannot follow referral to '
- . $this->_data['host'] . ', the error was: '
- . $error->getMessage(),
- 5
- );
- }
- break;
- }
- return PEAR::raiseError(trim($response . $line), 6);
- }
-
- if (preg_match('/^{([0-9]+)\+?}/i', $line, $matches)) {
- // Matches String Responses.
- $str_size = $matches[1] + 2;
- $line = '';
- $line_length = 0;
- while ($line_length < $str_size) {
- $line .= $this->_sock->read($str_size - $line_length);
- $line_length = $this->_getLineLength($line);
- }
- $this->_debug("S: $line");
-
- if (!$auth) {
- // Receive the pending OK only if we aren't
- // authenticating since string responses during
- // authentication don't need an OK.
- $this->_recvLn();
- }
- return $line;
- }
-
- if ($auth) {
- // String responses during authentication don't need an
- // OK.
- $response .= $line;
- return rtrim($response);
- }
-
- $response .= $line . "\r\n";
- $referralCount++;
- }
- }
-
- return PEAR::raiseError('Max referral count (' . $referralCount . ') reached. Cyrus murder loop error?', 7);
- }
-
- /**
- * Returns the name of the best authentication method that the server
- * has advertised.
- *
- * @param string $userMethod Only consider this method as available.
- *
- * @return string The name of the best supported authentication method or
- * a PEAR_Error object on failure.
- */
- function _getBestAuthMethod($userMethod = null)
- {
- if (!isset($this->_capability['sasl'])) {
- return PEAR::raiseError('This server doesn\'t support any authentication methods. SASL problem?');
- }
-
- $serverMethods = $this->_capability['sasl'];
-
- if ($userMethod) {
- $methods = array($userMethod);
- } else {
- $methods = $this->supportedAuthMethods;
- }
-
- if (!$methods || !$serverMethods) {
- return PEAR::raiseError(
- 'This server doesn\'t support any authentication methods.'
- );
- }
-
- foreach ($methods as $method) {
- if (in_array($method, $serverMethods)) {
- return $method;
- }
- }
-
- return PEAR::raiseError(
- 'No supported authentication method found. The server supports these methods: '
- . implode(',', $serverMethods)
- . ', but we only support: '
- . implode(',', $this->supportedAuthMethods)
- );
- }
-
- /**
- * Starts a TLS connection.
- *
- * @return boolean True on success, PEAR_Error on failure.
- */
- function _startTLS()
- {
- if (PEAR::isError($res = $this->_doCmd('STARTTLS'))) {
- return $res;
- }
-
- if (!stream_socket_enable_crypto($this->_sock->fp, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
- return PEAR::raiseError('Failed to establish TLS connection', 2);
- }
-
- $this->_debug('STARTTLS negotiation successful');
-
- // The server should be sending a CAPABILITY response after
- // negotiating TLS. Read it, and ignore if it doesn't.
- $this->_doCmd();
-
- // RFC says we need to query the server capabilities again now that we
- // are under encryption.
- if (PEAR::isError($res = $this->_cmdCapability())) {
- return PEAR::raiseError(
- 'Failed to connect, server said: ' . $res->getMessage(), 2
- );
- }
-
- return true;
- }
-
- /**
- * Returns the length of a string.
- *
- * @param string $string A string.
- *
- * @return integer The length of the string.
- */
- function _getLineLength($string)
- {
- if (extension_loaded('mbstring')) {
- return mb_strlen($string, 'latin1');
- } else {
- return strlen($string);
- }
- }
-
- /**
- * Locale independant strtoupper() implementation.
- *
- * @param string $string The string to convert to lowercase.
- *
- * @return string The lowercased string, based on ASCII encoding.
- */
- function _toUpper($string)
- {
- $language = setlocale(LC_CTYPE, 0);
- setlocale(LC_CTYPE, 'C');
- $string = strtoupper($string);
- setlocale(LC_CTYPE, $language);
- return $string;
- }
-
- /**
- * Write debug text to the current debug output handler.
- *
- * @param string $message Debug message text.
- *
- * @return void
- */
- function _debug($message)
- {
- if ($this->_debug) {
- if ($this->_debug_handler) {
- call_user_func_array($this->_debug_handler, array(&$this, $message));
- } else {
- echo "$message\n";
- }
- }
- }
-}
diff --git a/plugins/managesieve/lib/rcube_sieve.php b/plugins/managesieve/lib/rcube_sieve.php
deleted file mode 100644
index 649967f57..000000000
--- a/plugins/managesieve/lib/rcube_sieve.php
+++ /dev/null
@@ -1,875 +0,0 @@
-<?php
-
-/*
- Classes for managesieve operations (using PEAR::Net_Sieve)
-
- Author: Aleksander Machniak <alec@alec.pl>
-
- $Id$
-
-*/
-
-// Sieve Language Basics: http://www.ietf.org/rfc/rfc5228.txt
-
-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_OTHER', 255); // other/unknown error
-
-
-class rcube_sieve
-{
- private $sieve; // Net_Sieve object
- private $error = false; // error flag
- private $list = array(); // scripts list
-
- public $script; // rcube_sieve_script object
- public $current; // name of currently loaded script
- private $disabled; // array of disabled extensions
-
- /**
- * Object constructor
- *
- * @param string Username (to managesieve login)
- * @param string Password (to managesieve login)
- * @param string Managesieve server hostname/address
- * @param string Managesieve server port number
- * @param string Enable/disable TLS use
- * @param array Disabled extensions
- */
- public function __construct($username, $password='', $host='localhost', $port=2000,
- $usetls=true, $disabled=array(), $debug=false)
- {
- $this->sieve = new Net_Sieve();
-
- if ($debug)
- $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->login($username, $password)))
- return $this->_set_error(SIEVE_ERROR_LOGIN);
-
- $this->disabled = $disabled;
- }
-
- public function __destruct() {
- $this->sieve->disconnect();
- }
-
- /**
- * Getter for error code
- */
- public function error()
- {
- return $this->error ? $this->error : false;
- }
-
- /**
- * Saves current script into server
- */
- public function save($name = null)
- {
- if (!$this->sieve)
- return $this->_set_error(SIEVE_ERROR_INTERNAL);
-
- if (!$this->script)
- return $this->_set_error(SIEVE_ERROR_INTERNAL);
-
- if (!$name)
- $name = $this->current;
-
- $script = $this->script->as_text();
-
- if (!$script)
- $script = '/* empty script */';
-
- if (PEAR::isError($this->sieve->installScript($name, $script)))
- return $this->_set_error(SIEVE_ERROR_INSTALL);
-
- return true;
- }
-
- /**
- * Saves text script into server
- */
- public function save_script($name, $content = null)
- {
- if (!$this->sieve)
- return $this->_set_error(SIEVE_ERROR_INTERNAL);
-
- if (!$content)
- $content = '/* empty script */';
-
- if (PEAR::isError($this->sieve->installScript($name, $content)))
- return $this->_set_error(SIEVE_ERROR_INSTALL);
-
- return true;
- }
-
- /**
- * Activates specified script
- */
- public function activate($name = null)
- {
- if (!$this->sieve)
- return $this->_set_error(SIEVE_ERROR_INTERNAL);
-
- if (!$name)
- $name = $this->current;
-
- if (PEAR::isError($this->sieve->setActive($name)))
- return $this->_set_error(SIEVE_ERROR_ACTIVATE);
-
- return true;
- }
-
- /**
- * Removes specified script
- */
- public function remove($name = null)
- {
- if (!$this->sieve)
- return $this->_set_error(SIEVE_ERROR_INTERNAL);
-
- if (!$name)
- $name = $this->current;
-
- // script must be deactivated first
- if ($name == $this->sieve->getActive())
- if (PEAR::isError($this->sieve->setActive('')))
- return $this->_set_error(SIEVE_ERROR_DELETE);
-
- if (PEAR::isError($this->sieve->removeScript($name)))
- return $this->_set_error(SIEVE_ERROR_DELETE);
-
- if ($name == $this->current)
- $this->current = null;
-
- return true;
- }
-
- /**
- * Gets list of supported by server Sieve extensions
- */
- public function get_extensions()
- {
- if (!$this->sieve)
- return $this->_set_error(SIEVE_ERROR_INTERNAL);
-
- $ext = $this->sieve->getExtensions();
- // we're working on lower-cased names
- $ext = array_map('strtolower', (array) $ext);
-
- if ($this->script) {
- $supported = $this->script->get_extensions();
- foreach ($ext as $idx => $ext_name)
- if (!in_array($ext_name, $supported))
- unset($ext[$idx]);
- }
-
- return array_values($ext);
- }
-
- /**
- * Gets list of scripts from server
- */
- public function get_scripts()
- {
- if (!$this->list) {
-
- if (!$this->sieve)
- return $this->_set_error(SIEVE_ERROR_INTERNAL);
-
- $this->list = $this->sieve->listScripts();
-
- if (PEAR::isError($this->list))
- return $this->_set_error(SIEVE_ERROR_OTHER);
- }
-
- return $this->list;
- }
-
- /**
- * Returns active script name
- */
- public function get_active()
- {
- if (!$this->sieve)
- return $this->_set_error(SIEVE_ERROR_INTERNAL);
-
- return $this->sieve->getActive();
- }
-
- /**
- * Loads script by name
- */
- public function load($name)
- {
- if (!$this->sieve)
- return $this->_set_error(SIEVE_ERROR_INTERNAL);
-
- if ($this->current == $name)
- return true;
-
- $script = $this->sieve->getScript($name);
-
- if (PEAR::isError($script))
- return $this->_set_error(SIEVE_ERROR_OTHER);
-
- // try to parse from Roundcube format
- $this->script = new rcube_sieve_script($script, $this->disabled);
-
- // ... else try to import from different formats
- if (empty($this->script->content)) {
- $script = $this->_import_rules($script);
- $this->script = new rcube_sieve_script($script, $this->disabled);
- }
-
- // replace all elsif with if+stop, we support only ifs
- foreach ($this->script->content as $idx => $rule) {
- if (!isset($this->script->content[$idx+1])
- || preg_match('/^else|elsif$/', $this->script->content[$idx+1]['type'])) {
- // 'stop' not found?
- if (!preg_match('/^(stop|vacation)$/', $rule['actions'][count($rule['actions'])-1]['type'])) {
- $this->script->content[$idx]['actions'][] = array(
- 'type' => 'stop'
- );
- }
- }
- }
-
- $this->current = $name;
-
- return true;
- }
-
- /**
- * Creates empty script or copy of other script
- */
- public function copy($name, $copy)
- {
- if (!$this->sieve)
- return $this->_set_error(SIEVE_ERROR_INTERNAL);
-
- if ($copy) {
- $content = $this->sieve->getScript($copy);
-
- if (PEAR::isError($content))
- return $this->_set_error(SIEVE_ERROR_OTHER);
- }
-
- return $this->save_script($name, $content);
- }
-
-
- private function _import_rules($script)
- {
- $i = 0;
- $name = array();
-
- // Squirrelmail (Avelsieve)
- if ($tokens = preg_split('/(#START_SIEVE_RULE.*END_SIEVE_RULE)\n/', $script, -1, PREG_SPLIT_DELIM_CAPTURE)) {
- foreach($tokens as $token) {
- if (preg_match('/^#START_SIEVE_RULE.*/', $token, $matches)) {
- $name[$i] = "unnamed rule ".($i+1);
- $content .= "# rule:[".$name[$i]."]\n";
- }
- elseif (isset($name[$i])) {
- $content .= "if $token\n";
- $i++;
- }
- }
- }
- // Horde (INGO)
- else if ($tokens = preg_split('/(# .+)\r?\n/i', $script, -1, PREG_SPLIT_DELIM_CAPTURE)) {
- foreach($tokens as $token) {
- if (preg_match('/^# (.+)/i', $token, $matches)) {
- $name[$i] = $matches[1];
- $content .= "# rule:[" . $name[$i] . "]\n";
- }
- elseif (isset($name[$i])) {
- $token = str_replace(":comparator \"i;ascii-casemap\" ", "", $token);
- $content .= $token . "\n";
- $i++;
- }
- }
- }
-
- return $content;
- }
-
- private function _set_error($error)
- {
- $this->error = $error;
- return false;
- }
-
- /**
- * This is our own debug handler for connection
- * @access public
- */
- public function debug_handler(&$sieve, $message)
- {
- write_log('sieve', preg_replace('/\r\n$/', '', $message));
- }
-}
-
-class rcube_sieve_script
-{
- public $content = array(); // script rules array
-
- private $supported = array( // extensions supported by class
- 'fileinto',
- 'reject',
- 'ereject',
- 'vacation', // RFC5230
- // TODO: (most wanted first) body, imapflags, notify, regex
- );
-
- /**
- * Object constructor
- *
- * @param string Script's text content
- * @param array Disabled extensions
- */
- public function __construct($script, $disabled=NULL)
- {
- if (!empty($disabled))
- foreach ($disabled as $ext)
- if (($idx = array_search($ext, $this->supported)) !== false)
- unset($this->supported[$idx]);
-
- $this->content = $this->_parse_text($script);
- }
-
- /**
- * Adds script contents as text to the script array (at the end)
- *
- * @param string Text script contents
- */
- public function add_text($script)
- {
- $content = $this->_parse_text($script);
- $result = false;
-
- // check existsing script rules names
- foreach ($this->content as $idx => $elem) {
- $names[$elem['name']] = $idx;
- }
-
- foreach ($content as $elem) {
- if (!isset($names[$elem['name']])) {
- array_push($this->content, $elem);
- $result = true;
- }
- }
-
- return $result;
- }
-
- /**
- * Adds rule to the script (at the end)
- *
- * @param string Rule name
- * @param array Rule content (as array)
- */
- public function add_rule($content)
- {
- // TODO: check this->supported
- array_push($this->content, $content);
- return sizeof($this->content)-1;
- }
-
- public function delete_rule($index)
- {
- if(isset($this->content[$index])) {
- unset($this->content[$index]);
- return true;
- }
- return false;
- }
-
- public function size()
- {
- return sizeof($this->content);
- }
-
- public function update_rule($index, $content)
- {
- // TODO: check this->supported
- if ($this->content[$index]) {
- $this->content[$index] = $content;
- return $index;
- }
- return false;
- }
-
- /**
- * Returns script as text
- */
- public function as_text()
- {
- $script = '';
- $exts = array();
- $idx = 0;
-
- // rules
- foreach ($this->content as $rule) {
- $extension = '';
- $tests = array();
- $i = 0;
-
- // header
- $script .= '# rule:[' . $rule['name'] . "]\n";
-
- // constraints expressions
- foreach ($rule['tests'] as $test) {
- $tests[$i] = '';
- switch ($test['test']) {
- case 'size':
- $tests[$i] .= ($test['not'] ? 'not ' : '');
- $tests[$i] .= 'size :' . ($test['type']=='under' ? 'under ' : 'over ') . $test['arg'];
- break;
- case 'true':
- $tests[$i] .= ($test['not'] ? 'not true' : 'true');
- break;
- case 'exists':
- $tests[$i] .= ($test['not'] ? 'not ' : '');
- if (is_array($test['arg']))
- $tests[$i] .= 'exists ["' . implode('", "', $this->_escape_string($test['arg'])) . '"]';
- else
- $tests[$i] .= 'exists "' . $this->_escape_string($test['arg']) . '"';
- break;
- case 'header':
- $tests[$i] .= ($test['not'] ? 'not ' : '');
- $tests[$i] .= 'header :' . $test['type'];
- if (is_array($test['arg1']))
- $tests[$i] .= ' ["' . implode('", "', $this->_escape_string($test['arg1'])) . '"]';
- else
- $tests[$i] .= ' "' . $this->_escape_string($test['arg1']) . '"';
- if (is_array($test['arg2']))
- $tests[$i] .= ' ["' . implode('", "', $this->_escape_string($test['arg2'])) . '"]';
- else
- $tests[$i] .= ' "' . $this->_escape_string($test['arg2']) . '"';
- break;
- }
- $i++;
- }
-
-// $script .= ($idx>0 ? 'els' : '').($rule['join'] ? 'if allof (' : 'if anyof (');
- // disabled rule: if false #....
- $script .= 'if' . ($rule['disabled'] ? ' false #' : '');
- $script .= $rule['join'] ? ' allof (' : ' anyof (';
- if (sizeof($tests) > 1)
- $script .= implode(",\n\t", $tests);
- else if (sizeof($tests))
- $script .= $tests[0];
- else
- $script .= 'true';
- $script .= ")\n{\n";
-
- // action(s)
- foreach ($rule['actions'] as $action) {
- switch ($action['type']) {
- case 'fileinto':
- $extension = 'fileinto';
- $script .= "\tfileinto \"" . $this->_escape_string($action['target']) . "\";\n";
- break;
- case 'redirect':
- $script .= "\tredirect \"" . $this->_escape_string($action['target']) . "\";\n";
- break;
- case 'reject':
- case 'ereject':
- $extension = $action['type'];
- if (strpos($action['target'], "\n")!==false)
- $script .= "\t".$action['type']." text:\n" . $action['target'] . "\n.\n;\n";
- else
- $script .= "\t".$action['type']." \"" . $this->_escape_string($action['target']) . "\";\n";
- break;
- case 'keep':
- case 'discard':
- case 'stop':
- $script .= "\t" . $action['type'] .";\n";
- break;
- case 'vacation':
- $extension = 'vacation';
- $script .= "\tvacation";
- if ($action['days'])
- $script .= " :days " . $action['days'];
- if ($action['addresses'])
- $script .= " :addresses " . $this->_print_list($action['addresses']);
- if ($action['subject'])
- $script .= " :subject \"" . $this->_escape_string($action['subject']) . "\"";
- if ($action['handle'])
- $script .= " :handle \"" . $this->_escape_string($action['handle']) . "\"";
- if ($action['from'])
- $script .= " :from \"" . $this->_escape_string($action['from']) . "\"";
- if ($action['mime'])
- $script .= " :mime";
- if (strpos($action['reason'], "\n")!==false)
- $script .= " text:\n" . $action['reason'] . "\n.\n;\n";
- else
- $script .= " \"" . $this->_escape_string($action['reason']) . "\";\n";
- break;
- }
-
- if ($extension && !isset($exts[$extension]))
- $exts[$extension] = $extension;
- }
-
- $script .= "}\n";
- $idx++;
- }
-
- // requires
- if (sizeof($exts))
- $script = 'require ["' . implode('","', $exts) . "\"];\n" . $script;
-
- return $script;
- }
-
- /**
- * Returns script object
- *
- */
- public function as_array()
- {
- return $this->content;
- }
-
- /**
- * Returns array of supported extensions
- *
- */
- public function get_extensions()
- {
- return array_values($this->supported);
- }
-
- /**
- * Converts text script to rules array
- *
- * @param string Text script
- */
- private function _parse_text($script)
- {
- $i = 0;
- $content = array();
-
- // remove C comments
- $script = preg_replace('|/\*.*?\*/|sm', '', $script);
-
- // tokenize rules
- if ($tokens = preg_split('/(# rule:\[.*\])\r?\n/', $script, -1, PREG_SPLIT_DELIM_CAPTURE)) {
- foreach($tokens as $token) {
- if (preg_match('/^# rule:\[(.*)\]/', $token, $matches)) {
- $content[$i]['name'] = $matches[1];
- }
- elseif (isset($content[$i]['name']) && sizeof($content[$i]) == 1) {
- if ($rule = $this->_tokenize_rule($token)) {
- $content[$i] = array_merge($content[$i], $rule);
- $i++;
- }
- else // unknown rule format
- unset($content[$i]);
- }
- }
- }
-
- return $content;
- }
-
- /**
- * Convert text script fragment to rule object
- *
- * @param string Text rule
- */
- private function _tokenize_rule($content)
- {
- $result = NULL;
-
- if (preg_match('/^(if|elsif|else)\s+((true|false|not\s+true|allof|anyof|exists|header|not|size)(.*))\s+\{(.*)\}$/sm',
- trim($content), $matches)) {
-
- $tests = trim($matches[2]);
-
- // disabled rule (false + comment): if false #.....
- if ($matches[3] == 'false') {
- $tests = preg_replace('/^false\s+#\s+/', '', $tests);
- $disabled = true;
- }
- else
- $disabled = false;
-
- list($tests, $join) = $this->_parse_tests($tests);
- $actions = $this->_parse_actions(trim($matches[5]));
-
- if ($tests && $actions)
- $result = array(
- 'type' => $matches[1],
- 'tests' => $tests,
- 'actions' => $actions,
- 'join' => $join,
- 'disabled' => $disabled,
- );
- }
-
- return $result;
- }
-
- /**
- * Parse body of actions section
- *
- * @param string Text body
- * @return array Array of parsed action type/target pairs
- */
- private function _parse_actions($content)
- {
- $result = NULL;
-
- // supported actions
- $patterns[] = '^\s*discard;';
- $patterns[] = '^\s*keep;';
- $patterns[] = '^\s*stop;';
- $patterns[] = '^\s*redirect\s+(.*?[^\\\]);';
- if (in_array('fileinto', $this->supported))
- $patterns[] = '^\s*fileinto\s+(.*?[^\\\]);';
- if (in_array('reject', $this->supported)) {
- $patterns[] = '^\s*reject\s+text:(.*)\n\.\n;';
- $patterns[] = '^\s*reject\s+(.*?[^\\\]);';
- $patterns[] = '^\s*ereject\s+text:(.*)\n\.\n;';
- $patterns[] = '^\s*ereject\s+(.*?[^\\\]);';
- }
- if (in_array('vacation', $this->supported))
- $patterns[] = '^\s*vacation\s+(.*?[^\\\]);';
-
- $pattern = '/(' . implode('$)|(', $patterns) . '$)/ms';
-
- // parse actions body
- if (preg_match_all($pattern, $content, $mm, PREG_SET_ORDER)) {
- foreach ($mm as $m) {
- $content = trim($m[0]);
-
- if(preg_match('/^(discard|keep|stop)/', $content, $matches)) {
- $result[] = array('type' => $matches[1]);
- }
- elseif(preg_match('/^fileinto/', $content)) {
- $result[] = array('type' => 'fileinto', 'target' => $this->_parse_string($m[sizeof($m)-1]));
- }
- elseif(preg_match('/^redirect/', $content)) {
- $result[] = array('type' => 'redirect', 'target' => $this->_parse_string($m[sizeof($m)-1]));
- }
- elseif(preg_match('/^(reject|ereject)\s+(.*);$/sm', $content, $matches)) {
- $result[] = array('type' => $matches[1], 'target' => $this->_parse_string($matches[2]));
- }
- elseif(preg_match('/^vacation\s+(.*);$/sm', $content, $matches)) {
- $vacation = array('type' => 'vacation');
-
- if (preg_match('/:(days)\s+([0-9]+)/', $content, $vm)) {
- $vacation['days'] = $vm[2];
- $content = preg_replace('/:(days)\s+([0-9]+)/', '', $content);
- }
- if (preg_match('/:(subject)\s+(".*?[^\\\]")/', $content, $vm)) {
- $vacation['subject'] = $vm[2];
- $content = preg_replace('/:(subject)\s+(".*?[^\\\]")/', '', $content);
- }
- if (preg_match('/:(addresses)\s+\[(.*?[^\\\])\]/', $content, $vm)) {
- $vacation['addresses'] = $this->_parse_list($vm[2]);
- $content = preg_replace('/:(addresses)\s+\[(.*?[^\\\])\]/', '', $content);
- }
- if (preg_match('/:(handle)\s+(".*?[^\\\]")/', $content, $vm)) {
- $vacation['handle'] = $vm[2];
- $content = preg_replace('/:(handle)\s+(".*?[^\\\]")/', '', $content);
- }
- if (preg_match('/:(from)\s+(".*?[^\\\]")/', $content, $vm)) {
- $vacation['from'] = $vm[2];
- $content = preg_replace('/:(from)\s+(".*?[^\\\]")/', '', $content);
- }
-
- $content = preg_replace('/^vacation/', '', $content);
- $content = preg_replace('/;$/', '', $content);
- $content = trim($content);
-
- if (preg_match('/^:(mime)/', $content, $vm)) {
- $vacation['mime'] = true;
- $content = preg_replace('/^:mime/', '', $content);
- }
-
- $vacation['reason'] = $this->_parse_string($content);
-
- $result[] = $vacation;
- }
- }
- }
-
- return $result;
- }
-
- /**
- * Parse test/conditions section
- *
- * @param string Text
- */
- private function _parse_tests($content)
- {
- $result = NULL;
-
- // lists
- if (preg_match('/^(allof|anyof)\s+\((.*)\)$/sm', $content, $matches)) {
- $content = $matches[2];
- $join = $matches[1]=='allof' ? true : false;
- }
- else
- $join = false;
-
- // supported tests regular expressions
- // TODO: comparators, envelope
- $patterns[] = '(not\s+)?(exists)\s+\[(.*?[^\\\])\]';
- $patterns[] = '(not\s+)?(exists)\s+(".*?[^\\\]")';
- $patterns[] = '(not\s+)?(true)';
- $patterns[] = '(not\s+)?(size)\s+:(under|over)\s+([0-9]+[KGM]{0,1})';
- $patterns[] = '(not\s+)?(header)\s+:(contains|is|matches)\s+\[(.*?[^\\\]")\]\s+\[(.*?[^\\\]")\]';
- $patterns[] = '(not\s+)?(header)\s+:(contains|is|matches)\s+(".*?[^\\\]")\s+(".*?[^\\\]")';
- $patterns[] = '(not\s+)?(header)\s+:(contains|is|matches)\s+\[(.*?[^\\\]")\]\s+(".*?[^\\\]")';
- $patterns[] = '(not\s+)?(header)\s+:(contains|is|matches)\s+(".*?[^\\\]")\s+\[(.*?[^\\\]")\]';
-
- // join patterns...
- $pattern = '/(' . implode(')|(', $patterns) . ')/';
-
- // ...and parse tests list
- if (preg_match_all($pattern, $content, $matches, PREG_SET_ORDER)) {
- foreach ($matches as $match) {
- $size = sizeof($match);
-
- if (preg_match('/^(not\s+)?size/', $match[0])) {
- $result[] = array(
- 'test' => 'size',
- 'not' => $match[$size-4] ? true : false,
- 'type' => $match[$size-2], // under/over
- 'arg' => $match[$size-1], // value
- );
- }
- elseif (preg_match('/^(not\s+)?header/', $match[0])) {
- $result[] = array(
- 'test' => 'header',
- 'not' => $match[$size-5] ? true : false,
- 'type' => $match[$size-3], // is/contains/matches
- 'arg1' => $this->_parse_list($match[$size-2]), // header(s)
- 'arg2' => $this->_parse_list($match[$size-1]), // string(s)
- );
- }
- elseif (preg_match('/^(not\s+)?exists/', $match[0])) {
- $result[] = array(
- 'test' => 'exists',
- 'not' => $match[$size-3] ? true : false,
- 'arg' => $this->_parse_list($match[$size-1]), // header(s)
- );
- }
- elseif (preg_match('/^(not\s+)?true/', $match[0])) {
- $result[] = array(
- 'test' => 'true',
- 'not' => $match[$size-2] ? true : false,
- );
- }
- }
- }
-
- return array($result, $join);
- }
-
- /**
- * Parse string value
- *
- * @param string Text
- */
- private function _parse_string($content)
- {
- $text = '';
- $content = trim($content);
-
- if (preg_match('/^text:(.*)\.$/sm', $content, $matches))
- $text = trim($matches[1]);
- elseif (preg_match('/^"(.*)"$/', $content, $matches))
- $text = str_replace('\"', '"', $matches[1]);
-
- return $text;
- }
-
- /**
- * Escape special chars in string value
- *
- * @param string Text
- */
- private function _escape_string($content)
- {
- $replace['/"/'] = '\\"';
-
- if (is_array($content)) {
- for ($x=0, $y=sizeof($content); $x<$y; $x++)
- $content[$x] = preg_replace(array_keys($replace), array_values($replace), $content[$x]);
-
- return $content;
- }
- else
- return preg_replace(array_keys($replace), array_values($replace), $content);
- }
-
- /**
- * Parse string or list of strings to string or array of strings
- *
- * @param string Text
- */
- private function _parse_list($content)
- {
- $result = array();
-
- for ($x=0, $len=strlen($content); $x<$len; $x++) {
- switch ($content[$x]) {
- case '\\':
- $str .= $content[++$x];
- break;
- case '"':
- if (isset($str)) {
- $result[] = $str;
- unset($str);
- }
- else
- $str = '';
- break;
- default:
- if(isset($str))
- $str .= $content[$x];
- break;
- }
- }
-
- if (sizeof($result)>1)
- return $result;
- elseif (sizeof($result) == 1)
- return $result[0];
- else
- return NULL;
- }
-
- /**
- * Convert array of elements to list of strings
- *
- * @param string Text
- */
- private function _print_list($list)
- {
- $list = (array) $list;
- foreach($list as $idx => $val)
- $list[$idx] = $this->_escape_string($val);
-
- return '["' . implode('","', $list) . '"]';
- }
-}
-
-?>