From 0d4ccb8d8883769ccff175a52b15f9cb2fc442c5 Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Sun, 25 Nov 2012 16:25:17 +0100 Subject: Moved rcube_* classes to /lib/Roundcube for compat. with Roundcube Framework autoloader --- plugins/managesieve/Changelog | 1 + plugins/managesieve/lib/Roundcube/rcube_sieve.php | 384 +++++++ .../lib/Roundcube/rcube_sieve_script.php | 1154 ++++++++++++++++++++ plugins/managesieve/lib/rcube_sieve.php | 384 ------- plugins/managesieve/lib/rcube_sieve_script.php | 1154 -------------------- plugins/managesieve/tests/Parser.php | 2 +- plugins/managesieve/tests/Tokenizer.php | 2 +- 7 files changed, 1541 insertions(+), 1540 deletions(-) create mode 100644 plugins/managesieve/lib/Roundcube/rcube_sieve.php create mode 100644 plugins/managesieve/lib/Roundcube/rcube_sieve_script.php delete mode 100644 plugins/managesieve/lib/rcube_sieve.php delete mode 100644 plugins/managesieve/lib/rcube_sieve_script.php diff --git a/plugins/managesieve/Changelog b/plugins/managesieve/Changelog index dceac7602..4b839a8b2 100644 --- a/plugins/managesieve/Changelog +++ b/plugins/managesieve/Changelog @@ -1,4 +1,5 @@ - Fixed filter activation/deactivation confirmation message (#1488765) +- Moved rcube_* classes to /lib/Roundcube for compat. with Roundcube Framework autoloader * version 6.0 [2012-10-03] ----------------------------------------------------------- diff --git a/plugins/managesieve/lib/Roundcube/rcube_sieve.php b/plugins/managesieve/lib/Roundcube/rcube_sieve.php new file mode 100644 index 000000000..16c584b7d --- /dev/null +++ b/plugins/managesieve/lib/Roundcube/rcube_sieve.php @@ -0,0 +1,384 @@ +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 (!empty($auth_cid)) { + $authz = $username; + $username = $auth_cid; + $password = $auth_pw; + } + + if (PEAR::isError($this->sieve->login($username, $password, + $auth_type ? strtoupper($auth_type) : null, $authz)) + ) { + return $this->_set_error(SIEVE_ERROR_LOGIN); + } + + $this->exts = $this->get_extensions(); + + // disable features by config + if (!empty($disabled)) { + // we're working on lower-cased names + $disabled = array_map('strtolower', (array) $disabled); + foreach ($disabled as $ext) { + if (($idx = array_search($ext, $this->exts)) !== false) { + unset($this->exts[$idx]); + } + } + } + } + + 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; + } + + /** + * De-activates specified script + */ + public function deactivate() + { + if (!$this->sieve) + return $this->_set_error(SIEVE_ERROR_INTERNAL); + + if (PEAR::isError($this->sieve->setActive(''))) + return $this->_set_error(SIEVE_ERROR_DEACTIVATE); + + 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->exts) + return $this->exts; + + 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); + + $list = $this->sieve->listScripts(); + + if (PEAR::isError($list)) + return $this->_set_error(SIEVE_ERROR_OTHER); + + $this->list = $list; + } + + 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 = $this->_parse($script); + + $this->current = $name; + + return true; + } + + /** + * Loads script from text content + */ + public function load_script($script) + { + if (!$this->sieve) + return $this->_set_error(SIEVE_ERROR_INTERNAL); + + // try to parse from Roundcube format + $this->script = $this->_parse($script); + } + + /** + * Creates rcube_sieve_script object from text script + */ + private function _parse($txt) + { + // parse + $script = new rcube_sieve_script($txt, $this->exts); + + // fix/convert to Roundcube format + if (!empty($script->content)) { + // replace all elsif with if+stop, we support only ifs + foreach ($script->content as $idx => $rule) { + if (empty($rule['type']) || !preg_match('/^(if|elsif|else)$/', $rule['type'])) { + continue; + } + + $script->content[$idx]['type'] = 'if'; + + // 'stop' not found? + foreach ($rule['actions'] as $action) { + if (preg_match('/^(stop|vacation)$/', $action['type'])) { + continue 2; + } + } + if (empty($script->content[$idx+1]) || $script->content[$idx+1]['type'] != 'if') { + $script->content[$idx]['actions'][] = array('type' => 'stop'); + } + } + } + + return $script; + } + + /** + * Gets specified script as text + */ + public function get_script($name) + { + if (!$this->sieve) + return $this->_set_error(SIEVE_ERROR_INTERNAL); + + $content = $this->sieve->getScript($name); + + if (PEAR::isError($content)) + return $this->_set_error(SIEVE_ERROR_OTHER); + + return $content; + } + + /** + * 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 _set_error($error) + { + $this->error = $error; + return false; + } + + /** + * This is our own debug handler for connection + */ + public function debug_handler(&$sieve, $message) + { + write_log('sieve', preg_replace('/\r\n$/', '', $message)); + } +} diff --git a/plugins/managesieve/lib/Roundcube/rcube_sieve_script.php b/plugins/managesieve/lib/Roundcube/rcube_sieve_script.php new file mode 100644 index 000000000..36eb1bcf8 --- /dev/null +++ b/plugins/managesieve/lib/Roundcube/rcube_sieve_script.php @@ -0,0 +1,1154 @@ +supported as $idx => $ext) { + if (!in_array($ext, $capabilities)) { + unset($this->supported[$idx]); + } + } + } + + // Parse text content of the script + $this->_parse_text($script); + } + + /** + * Adds rule to the script (at the end) + * + * @param string Rule name + * @param array Rule content (as array) + * + * @return int The index of the new rule + */ + 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; + } + + /** + * Sets "global" variable + * + * @param string $name Variable name + * @param string $value Variable value + * @param array $mods Variable modifiers + */ + public function set_var($name, $value, $mods = array()) + { + // Check if variable exists + for ($i=0, $len=count($this->vars); $i<$len; $i++) { + if ($this->vars[$i]['name'] == $name) { + break; + } + } + + $var = array_merge($mods, array('name' => $name, 'value' => $value)); + $this->vars[$i] = $var; + } + + /** + * Unsets "global" variable + * + * @param string $name Variable name + */ + public function unset_var($name) + { + // Check if variable exists + foreach ($this->vars as $idx => $var) { + if ($var['name'] == $name) { + unset($this->vars[$idx]); + break; + } + } + } + + /** + * Gets the value of "global" variable + * + * @param string $name Variable name + * + * @return string Variable value + */ + public function get_var($name) + { + // Check if variable exists + for ($i=0, $len=count($this->vars); $i<$len; $i++) { + if ($this->vars[$i]['name'] == $name) { + return $this->vars[$i]['name']; + } + } + } + + /** + * Sets script header content + * + * @param string $text Header content + */ + public function set_prefix($text) + { + $this->prefix = $text; + } + + /** + * Returns script as text + */ + public function as_text() + { + $output = ''; + $exts = array(); + $idx = 0; + + if (!empty($this->vars)) { + if (in_array('variables', (array)$this->supported)) { + $has_vars = true; + array_push($exts, 'variables'); + } + foreach ($this->vars as $var) { + if (empty($has_vars)) { + // 'variables' extension not supported, put vars in comments + $output .= sprintf("# %s %s\n", $var['name'], $var['value']); + } + else { + $output .= 'set '; + foreach (array_diff(array_keys($var), array('name', 'value')) as $opt) { + $output .= ":$opt "; + } + $output .= self::escape_string($var['name']) . ' ' . self::escape_string($var['value']) . ";\n"; + } + } + } + + $imapflags = in_array('imap4flags', $this->supported) ? 'imap4flags' : 'imapflags'; + $notify = in_array('enotify', $this->supported) ? 'enotify' : 'notify'; + + // rules + foreach ($this->content as $rule) { + $extension = ''; + $script = ''; + $tests = array(); + $i = 0; + + // header + if (!empty($rule['name']) && strlen($rule['name'])) { + $script .= '# rule:[' . $rule['name'] . "]\n"; + } + + // constraints expressions + if (!empty($rule['tests'])) { + 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'] ? 'false' : 'true'); + break; + + case 'exists': + $tests[$i] .= ($test['not'] ? 'not ' : ''); + $tests[$i] .= 'exists ' . self::escape_string($test['arg']); + break; + + case 'header': + $tests[$i] .= ($test['not'] ? 'not ' : ''); + $tests[$i] .= 'header'; + + if (!empty($test['type'])) { + // relational operator + comparator + if (preg_match('/^(value|count)-([gteqnl]{2})/', $test['type'], $m)) { + array_push($exts, 'relational'); + array_push($exts, 'comparator-i;ascii-numeric'); + + $tests[$i] .= ' :' . $m[1] . ' "' . $m[2] . '" :comparator "i;ascii-numeric"'; + } + else { + $this->add_comparator($test, $tests[$i], $exts); + + if ($test['type'] == 'regex') { + array_push($exts, 'regex'); + } + + $tests[$i] .= ' :' . $test['type']; + } + } + + $tests[$i] .= ' ' . self::escape_string($test['arg1']); + $tests[$i] .= ' ' . self::escape_string($test['arg2']); + break; + + case 'address': + case 'envelope': + if ($test['test'] == 'envelope') { + array_push($exts, 'envelope'); + } + + $tests[$i] .= ($test['not'] ? 'not ' : ''); + $tests[$i] .= $test['test']; + + if (!empty($test['part'])) { + $tests[$i] .= ' :' . $test['part']; + if ($test['part'] == 'user' || $test['part'] == 'detail') { + array_push($exts, 'subaddress'); + } + } + + $this->add_comparator($test, $tests[$i], $exts); + + if (!empty($test['type'])) { + if ($test['type'] == 'regex') { + array_push($exts, 'regex'); + } + $tests[$i] .= ' :' . $test['type']; + } + + $tests[$i] .= ' ' . self::escape_string($test['arg1']); + $tests[$i] .= ' ' . self::escape_string($test['arg2']); + break; + + case 'body': + array_push($exts, 'body'); + + $tests[$i] .= ($test['not'] ? 'not ' : '') . 'body'; + + $this->add_comparator($test, $tests[$i], $exts); + + if (!empty($test['part'])) { + $tests[$i] .= ' :' . $test['part']; + + if (!empty($test['content']) && $test['part'] == 'content') { + $tests[$i] .= ' ' . self::escape_string($test['content']); + } + } + + if (!empty($test['type'])) { + if ($test['type'] == 'regex') { + array_push($exts, 'regex'); + } + $tests[$i] .= ' :' . $test['type']; + } + + $tests[$i] .= ' ' . self::escape_string($test['arg']); + break; + } + $i++; + } + } + + // disabled rule: if false #.... + if (!empty($tests)) { + $script .= 'if ' . ($rule['disabled'] ? 'false # ' : ''); + + if (count($tests) > 1) { + $tests_str = implode(', ', $tests); + } + else { + $tests_str = $tests[0]; + } + + if ($rule['join'] || count($tests) > 1) { + $script .= sprintf('%s (%s)', $rule['join'] ? 'allof' : 'anyof', $tests_str); + } + else { + $script .= $tests_str; + } + $script .= "\n{\n"; + } + + // action(s) + if (!empty($rule['actions'])) { + foreach ($rule['actions'] as $action) { + $action_script = ''; + + switch ($action['type']) { + + case 'fileinto': + array_push($exts, 'fileinto'); + $action_script .= 'fileinto '; + if ($action['copy']) { + $action_script .= ':copy '; + array_push($exts, 'copy'); + } + $action_script .= self::escape_string($action['target']); + break; + + case 'redirect': + $action_script .= 'redirect '; + if ($action['copy']) { + $action_script .= ':copy '; + array_push($exts, 'copy'); + } + $action_script .= self::escape_string($action['target']); + break; + + case 'reject': + case 'ereject': + array_push($exts, $action['type']); + $action_script .= $action['type'].' ' + . self::escape_string($action['target']); + break; + + case 'addflag': + case 'setflag': + case 'removeflag': + array_push($exts, $imapflags); + $action_script .= $action['type'].' ' + . self::escape_string($action['target']); + break; + + case 'keep': + case 'discard': + case 'stop': + $action_script .= $action['type']; + break; + + case 'include': + array_push($exts, 'include'); + $action_script .= 'include '; + foreach (array_diff(array_keys($action), array('target', 'type')) as $opt) { + $action_script .= ":$opt "; + } + $action_script .= self::escape_string($action['target']); + break; + + case 'set': + array_push($exts, 'variables'); + $action_script .= 'set '; + foreach (array_diff(array_keys($action), array('name', 'value', 'type')) as $opt) { + $action_script .= ":$opt "; + } + $action_script .= self::escape_string($action['name']) . ' ' . self::escape_string($action['value']); + break; + + case 'notify': + array_push($exts, $notify); + $action_script .= 'notify'; + + // Here we support only 00 version of notify draft, there + // were a couple regressions in 00 to 04 changelog, we use + // the version used by Cyrus + if ($notify == 'notify') { + switch ($action['importance']) { + case 1: $action_script .= " :high"; break; + case 2: $action_script .= " :normal"; break; + case 3: $action_script .= " :low"; break; + + } + unset($action['importance']); + } + + foreach (array('from', 'importance', 'options', 'message') as $n_tag) { + if (!empty($action[$n_tag])) { + $action_script .= " :$n_tag " . self::escape_string($action[$n_tag]); + } + } + + if (!empty($action['address'])) { + $method = 'mailto:' . $action['address']; + if (!empty($action['body'])) { + $method .= '?body=' . rawurlencode($action['body']); + } + } + else { + $method = $action['method']; + } + + // method is optional in notify extension + if (!empty($method)) { + $action_script .= ($notify == 'notify' ? " :method " : " ") . self::escape_string($method); + } + + break; + + case 'vacation': + array_push($exts, 'vacation'); + $action_script .= 'vacation'; + if (!empty($action['days'])) + $action_script .= " :days " . $action['days']; + if (!empty($action['addresses'])) + $action_script .= " :addresses " . self::escape_string($action['addresses']); + if (!empty($action['subject'])) + $action_script .= " :subject " . self::escape_string($action['subject']); + if (!empty($action['handle'])) + $action_script .= " :handle " . self::escape_string($action['handle']); + if (!empty($action['from'])) + $action_script .= " :from " . self::escape_string($action['from']); + if (!empty($action['mime'])) + $action_script .= " :mime"; + $action_script .= " " . self::escape_string($action['reason']); + break; + } + + if ($action_script) { + $script .= !empty($tests) ? "\t" : ''; + $script .= $action_script . ";\n"; + } + } + } + + if ($script) { + $output .= $script . (!empty($tests) ? "}\n" : ''); + $idx++; + } + } + + // requires + if (!empty($exts)) + $output = 'require ["' . implode('","', array_unique($exts)) . "\"];\n" . $output; + + if (!empty($this->prefix)) { + $output = $this->prefix . "\n\n" . $output; + } + + return $output; + } + + /** + * 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) + { + $prefix = ''; + $options = array(); + + while ($script) { + $script = trim($script); + $rule = array(); + + // Comments + while (!empty($script) && $script[0] == '#') { + $endl = strpos($script, "\n"); + $line = $endl ? substr($script, 0, $endl) : $script; + + // Roundcube format + if (preg_match('/^# rule:\[(.*)\]/', $line, $matches)) { + $rulename = $matches[1]; + } + // KEP:14 variables + else if (preg_match('/^# (EDITOR|EDITOR_VERSION) (.+)$/', $line, $matches)) { + $this->set_var($matches[1], $matches[2]); + } + // Horde-Ingo format + else if (!empty($options['format']) && $options['format'] == 'INGO' + && preg_match('/^# (.*)/', $line, $matches) + ) { + $rulename = $matches[1]; + } + else if (empty($options['prefix'])) { + $prefix .= $line . "\n"; + } + + $script = ltrim(substr($script, strlen($line) + 1)); + } + + // handle script header + if (empty($options['prefix'])) { + $options['prefix'] = true; + if ($prefix && strpos($prefix, 'horde.org/ingo')) { + $options['format'] = 'INGO'; + } + } + + // Control structures/blocks + if (preg_match('/^(if|else|elsif)/i', $script)) { + $rule = $this->_tokenize_rule($script); + if (strlen($rulename) && !empty($rule)) { + $rule['name'] = $rulename; + } + } + // Simple commands + else { + $rule = $this->_parse_actions($script, ';'); + if (!empty($rule[0]) && is_array($rule)) { + // set "global" variables + if ($rule[0]['type'] == 'set') { + unset($rule[0]['type']); + $this->vars[] = $rule[0]; + } + else { + $rule = array('actions' => $rule); + } + } + } + + $rulename = ''; + + if (!empty($rule)) { + $this->content[] = $rule; + } + } + + if (!empty($prefix)) { + $this->prefix = trim($prefix); + } + } + + /** + * Convert text script fragment to rule object + * + * @param string Text rule + * + * @return array Rule data + */ + private function _tokenize_rule(&$content) + { + $cond = strtolower(self::tokenize($content, 1)); + + if ($cond != 'if' && $cond != 'elsif' && $cond != 'else') { + return null; + } + + $disabled = false; + $join = false; + + // disabled rule (false + comment): if false # ..... + if (preg_match('/^\s*false\s+#/i', $content)) { + $content = preg_replace('/^\s*false\s+#\s*/i', '', $content); + $disabled = true; + } + + while (strlen($content)) { + $tokens = self::tokenize($content, true); + $separator = array_pop($tokens); + + if (!empty($tokens)) { + $token = array_shift($tokens); + } + else { + $token = $separator; + } + + $token = strtolower($token); + + if ($token == 'not') { + $not = true; + $token = strtolower(array_shift($tokens)); + } + else { + $not = false; + } + + switch ($token) { + case 'allof': + $join = true; + break; + case 'anyof': + break; + + case 'size': + $size = array('test' => 'size', 'not' => $not); + for ($i=0, $len=count($tokens); $i<$len; $i++) { + if (!is_array($tokens[$i]) + && preg_match('/^:(under|over)$/i', $tokens[$i]) + ) { + $size['type'] = strtolower(substr($tokens[$i], 1)); + } + else { + $size['arg'] = $tokens[$i]; + } + } + + $tests[] = $size; + break; + + case 'header': + $header = array('test' => 'header', 'not' => $not, 'arg1' => '', 'arg2' => ''); + for ($i=0, $len=count($tokens); $i<$len; $i++) { + if (!is_array($tokens[$i]) && preg_match('/^:comparator$/i', $tokens[$i])) { + $header['comparator'] = $tokens[++$i]; + } + else if (!is_array($tokens[$i]) && preg_match('/^:(count|value)$/i', $tokens[$i])) { + $header['type'] = strtolower(substr($tokens[$i], 1)) . '-' . $tokens[++$i]; + } + else if (!is_array($tokens[$i]) && preg_match('/^:(is|contains|matches|regex)$/i', $tokens[$i])) { + $header['type'] = strtolower(substr($tokens[$i], 1)); + } + else { + $header['arg1'] = $header['arg2']; + $header['arg2'] = $tokens[$i]; + } + } + + $tests[] = $header; + break; + + case 'address': + case 'envelope': + $header = array('test' => $token, 'not' => $not, 'arg1' => '', 'arg2' => ''); + for ($i=0, $len=count($tokens); $i<$len; $i++) { + if (!is_array($tokens[$i]) && preg_match('/^:comparator$/i', $tokens[$i])) { + $header['comparator'] = $tokens[++$i]; + } + else if (!is_array($tokens[$i]) && preg_match('/^:(is|contains|matches|regex)$/i', $tokens[$i])) { + $header['type'] = strtolower(substr($tokens[$i], 1)); + } + else if (!is_array($tokens[$i]) && preg_match('/^:(localpart|domain|all|user|detail)$/i', $tokens[$i])) { + $header['part'] = strtolower(substr($tokens[$i], 1)); + } + else { + $header['arg1'] = $header['arg2']; + $header['arg2'] = $tokens[$i]; + } + } + + $tests[] = $header; + break; + + case 'body': + $header = array('test' => 'body', 'not' => $not, 'arg' => ''); + for ($i=0, $len=count($tokens); $i<$len; $i++) { + if (!is_array($tokens[$i]) && preg_match('/^:comparator$/i', $tokens[$i])) { + $header['comparator'] = $tokens[++$i]; + } + else if (!is_array($tokens[$i]) && preg_match('/^:(is|contains|matches|regex)$/i', $tokens[$i])) { + $header['type'] = strtolower(substr($tokens[$i], 1)); + } + else if (!is_array($tokens[$i]) && preg_match('/^:(raw|content|text)$/i', $tokens[$i])) { + $header['part'] = strtolower(substr($tokens[$i], 1)); + + if ($header['part'] == 'content') { + $header['content'] = $tokens[++$i]; + } + } + else { + $header['arg'] = $tokens[$i]; + } + } + + $tests[] = $header; + break; + + case 'exists': + $tests[] = array('test' => 'exists', 'not' => $not, + 'arg' => array_pop($tokens)); + break; + + case 'true': + $tests[] = array('test' => 'true', 'not' => $not); + break; + + case 'false': + $tests[] = array('test' => 'true', 'not' => !$not); + break; + } + + // goto actions... + if ($separator == '{') { + break; + } + } + + // ...and actions block + $actions = $this->_parse_actions($content); + + if ($tests && $actions) { + $result = array( + 'type' => $cond, + 'tests' => $tests, + 'actions' => $actions, + 'join' => $join, + 'disabled' => $disabled, + ); + } + + return $result; + } + + /** + * Parse body of actions section + * + * @param string $content Text body + * @param string $end End of text separator + * + * @return array Array of parsed action type/target pairs + */ + private function _parse_actions(&$content, $end = '}') + { + $result = null; + + while (strlen($content)) { + $tokens = self::tokenize($content, true); + $separator = array_pop($tokens); + + if (!empty($tokens)) { + $token = array_shift($tokens); + } + else { + $token = $separator; + } + + switch ($token) { + case 'discard': + case 'keep': + case 'stop': + $result[] = array('type' => $token); + break; + + case 'fileinto': + case 'redirect': + $copy = false; + $target = ''; + + for ($i=0, $len=count($tokens); $i<$len; $i++) { + if (strtolower($tokens[$i]) == ':copy') { + $copy = true; + } + else { + $target = $tokens[$i]; + } + } + + $result[] = array('type' => $token, 'copy' => $copy, + 'target' => $target); + break; + + case 'reject': + case 'ereject': + $result[] = array('type' => $token, 'target' => array_pop($tokens)); + break; + + case 'vacation': + $vacation = array('type' => 'vacation', 'reason' => array_pop($tokens)); + + for ($i=0, $len=count($tokens); $i<$len; $i++) { + $tok = strtolower($tokens[$i]); + if ($tok == ':days') { + $vacation['days'] = $tokens[++$i]; + } + else if ($tok == ':subject') { + $vacation['subject'] = $tokens[++$i]; + } + else if ($tok == ':addresses') { + $vacation['addresses'] = $tokens[++$i]; + } + else if ($tok == ':handle') { + $vacation['handle'] = $tokens[++$i]; + } + else if ($tok == ':from') { + $vacation['from'] = $tokens[++$i]; + } + else if ($tok == ':mime') { + $vacation['mime'] = true; + } + } + + $result[] = $vacation; + break; + + case 'setflag': + case 'addflag': + case 'removeflag': + $result[] = array('type' => $token, + // Flags list: last token (skip optional variable) + 'target' => $tokens[count($tokens)-1] + ); + break; + + case 'include': + $include = array('type' => 'include', 'target' => array_pop($tokens)); + + // Parameters: :once, :optional, :global, :personal + for ($i=0, $len=count($tokens); $i<$len; $i++) { + $tok = strtolower($tokens[$i]); + if ($tok[0] == ':') { + $include[substr($tok, 1)] = true; + } + } + + $result[] = $include; + break; + + case 'set': + $set = array('type' => 'set', 'value' => array_pop($tokens), 'name' => array_pop($tokens)); + + // Parameters: :lower :upper :lowerfirst :upperfirst :quotewildcard :length + for ($i=0, $len=count($tokens); $i<$len; $i++) { + $tok = strtolower($tokens[$i]); + if ($tok[0] == ':') { + $set[substr($tok, 1)] = true; + } + } + + $result[] = $set; + break; + + case 'require': + // skip, will be build according to used commands + // $result[] = array('type' => 'require', 'target' => $tokens); + break; + + case 'notify': + $notify = array('type' => 'notify'); + $priorities = array(':high' => 1, ':normal' => 2, ':low' => 3); + + // Parameters: :from, :importance, :options, :message + // additional (optional) :method parameter for notify extension + for ($i=0, $len=count($tokens); $i<$len; $i++) { + $tok = strtolower($tokens[$i]); + if ($tok[0] == ':') { + // Here we support only 00 version of notify draft, there + // were a couple regressions in 00 to 04 changelog, we use + // the version used by Cyrus + if (isset($priorities[$tok])) { + $notify['importance'] = $priorities[$tok]; + } + else { + $notify[substr($tok, 1)] = $tokens[++$i]; + } + } + else { + // unnamed parameter is a :method in enotify extension + $notify['method'] = $tokens[$i]; + } + } + + $method_components = parse_url($notify['method']); + if ($method_components['scheme'] == 'mailto') { + $notify['address'] = $method_components['path']; + $method_params = array(); + if (array_key_exists('query', $method_components)) { + parse_str($method_components['query'], $method_params); + } + $method_params = array_change_key_case($method_params, CASE_LOWER); + // magic_quotes_gpc and magic_quotes_sybase affect the output of parse_str + if (ini_get('magic_quotes_gpc') || ini_get('magic_quotes_sybase')) { + array_map('stripslashes', $method_params); + } + $notify['body'] = (array_key_exists('body', $method_params)) ? $method_params['body'] : ''; + } + + $result[] = $notify; + break; + + } + + if ($separator == $end) + break; + } + + return $result; + } + + /** + * + */ + private function add_comparator($test, &$out, &$exts) + { + if (empty($test['comparator'])) { + return; + } + + if ($test['comparator'] == 'i;ascii-numeric') { + array_push($exts, 'relational'); + array_push($exts, 'comparator-i;ascii-numeric'); + } + else if (!in_array($test['comparator'], array('i;octet', 'i;ascii-casemap'))) { + array_push($exts, 'comparator-' . $test['comparator']); + } + + // skip default comparator + if ($test['comparator'] != 'i;ascii-casemap') { + $out .= ' :comparator ' . self::escape_string($test['comparator']); + } + } + + /** + * Escape special chars into quoted string value or multi-line string + * or list of strings + * + * @param string $str Text or array (list) of strings + * + * @return string Result text + */ + static function escape_string($str) + { + if (is_array($str) && count($str) > 1) { + foreach($str as $idx => $val) + $str[$idx] = self::escape_string($val); + + return '[' . implode(',', $str) . ']'; + } + else if (is_array($str)) { + $str = array_pop($str); + } + + // multi-line string + if (preg_match('/[\r\n\0]/', $str) || strlen($str) > 1024) { + return sprintf("text:\n%s\n.\n", self::escape_multiline_string($str)); + } + // quoted-string + else { + return '"' . addcslashes($str, '\\"') . '"'; + } + } + + /** + * Escape special chars in multi-line string value + * + * @param string $str Text + * + * @return string Text + */ + static function escape_multiline_string($str) + { + $str = preg_split('/(\r?\n)/', $str, -1, PREG_SPLIT_DELIM_CAPTURE); + + foreach ($str as $idx => $line) { + // dot-stuffing + if (isset($line[0]) && $line[0] == '.') { + $str[$idx] = '.' . $line; + } + } + + return implode($str); + } + + /** + * Splits script into string tokens + * + * @param string &$str The script + * @param mixed $num Number of tokens to return, 0 for all + * or True for all tokens until separator is found. + * Separator will be returned as last token. + * @param int $in_list Enable to call recursively inside a list + * + * @return mixed Tokens array or string if $num=1 + */ + static function tokenize(&$str, $num=0, $in_list=false) + { + $result = array(); + + // remove spaces from the beginning of the string + while (($str = ltrim($str)) !== '' + && (!$num || $num === true || count($result) < $num) + ) { + switch ($str[0]) { + + // Quoted string + case '"': + $len = strlen($str); + + for ($pos=1; $pos<$len; $pos++) { + if ($str[$pos] == '"') { + break; + } + if ($str[$pos] == "\\") { + if ($str[$pos + 1] == '"' || $str[$pos + 1] == "\\") { + $pos++; + } + } + } + if ($str[$pos] != '"') { + // error + } + // we need to strip slashes for a quoted string + $result[] = stripslashes(substr($str, 1, $pos - 1)); + $str = substr($str, $pos + 1); + break; + + // Parenthesized list + case '[': + $str = substr($str, 1); + $result[] = self::tokenize($str, 0, true); + break; + case ']': + $str = substr($str, 1); + return $result; + break; + + // list/test separator + case ',': + // command separator + case ';': + // block/tests-list + case '(': + case ')': + case '{': + case '}': + $sep = $str[0]; + $str = substr($str, 1); + if ($num === true) { + $result[] = $sep; + break 2; + } + break; + + // bracket-comment + case '/': + if ($str[1] == '*') { + if ($end_pos = strpos($str, '*/')) { + $str = substr($str, $end_pos + 2); + } + else { + // error + $str = ''; + } + } + break; + + // hash-comment + case '#': + if ($lf_pos = strpos($str, "\n")) { + $str = substr($str, $lf_pos); + break; + } + else { + $str = ''; + } + + // String atom + default: + // empty or one character + if ($str === '' || $str === null) { + break 2; + } + if (strlen($str) < 2) { + $result[] = $str; + $str = ''; + break; + } + + // tag/identifier/number + if (preg_match('/^([a-z0-9:_]+)/i', $str, $m)) { + $str = substr($str, strlen($m[1])); + + if ($m[1] != 'text:') { + $result[] = $m[1]; + } + // multiline string + else { + // possible hash-comment after "text:" + if (preg_match('/^( |\t)*(#[^\n]+)?\n/', $str, $m)) { + $str = substr($str, strlen($m[0])); + } + // get text until alone dot in a line + if (preg_match('/^(.*)\r?\n\.\r?\n/sU', $str, $m)) { + $text = $m[1]; + // remove dot-stuffing + $text = str_replace("\n..", "\n.", $text); + $str = substr($str, strlen($m[0])); + } + else { + $text = ''; + } + + $result[] = $text; + } + } + // fallback, skip one character as infinite loop prevention + else { + $str = substr($str, 1); + } + + break; + } + } + + return $num === 1 ? (isset($result[0]) ? $result[0] : null) : $result; + } + +} diff --git a/plugins/managesieve/lib/rcube_sieve.php b/plugins/managesieve/lib/rcube_sieve.php deleted file mode 100644 index 16c584b7d..000000000 --- a/plugins/managesieve/lib/rcube_sieve.php +++ /dev/null @@ -1,384 +0,0 @@ -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 (!empty($auth_cid)) { - $authz = $username; - $username = $auth_cid; - $password = $auth_pw; - } - - if (PEAR::isError($this->sieve->login($username, $password, - $auth_type ? strtoupper($auth_type) : null, $authz)) - ) { - return $this->_set_error(SIEVE_ERROR_LOGIN); - } - - $this->exts = $this->get_extensions(); - - // disable features by config - if (!empty($disabled)) { - // we're working on lower-cased names - $disabled = array_map('strtolower', (array) $disabled); - foreach ($disabled as $ext) { - if (($idx = array_search($ext, $this->exts)) !== false) { - unset($this->exts[$idx]); - } - } - } - } - - 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; - } - - /** - * De-activates specified script - */ - public function deactivate() - { - if (!$this->sieve) - return $this->_set_error(SIEVE_ERROR_INTERNAL); - - if (PEAR::isError($this->sieve->setActive(''))) - return $this->_set_error(SIEVE_ERROR_DEACTIVATE); - - 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->exts) - return $this->exts; - - 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); - - $list = $this->sieve->listScripts(); - - if (PEAR::isError($list)) - return $this->_set_error(SIEVE_ERROR_OTHER); - - $this->list = $list; - } - - 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 = $this->_parse($script); - - $this->current = $name; - - return true; - } - - /** - * Loads script from text content - */ - public function load_script($script) - { - if (!$this->sieve) - return $this->_set_error(SIEVE_ERROR_INTERNAL); - - // try to parse from Roundcube format - $this->script = $this->_parse($script); - } - - /** - * Creates rcube_sieve_script object from text script - */ - private function _parse($txt) - { - // parse - $script = new rcube_sieve_script($txt, $this->exts); - - // fix/convert to Roundcube format - if (!empty($script->content)) { - // replace all elsif with if+stop, we support only ifs - foreach ($script->content as $idx => $rule) { - if (empty($rule['type']) || !preg_match('/^(if|elsif|else)$/', $rule['type'])) { - continue; - } - - $script->content[$idx]['type'] = 'if'; - - // 'stop' not found? - foreach ($rule['actions'] as $action) { - if (preg_match('/^(stop|vacation)$/', $action['type'])) { - continue 2; - } - } - if (empty($script->content[$idx+1]) || $script->content[$idx+1]['type'] != 'if') { - $script->content[$idx]['actions'][] = array('type' => 'stop'); - } - } - } - - return $script; - } - - /** - * Gets specified script as text - */ - public function get_script($name) - { - if (!$this->sieve) - return $this->_set_error(SIEVE_ERROR_INTERNAL); - - $content = $this->sieve->getScript($name); - - if (PEAR::isError($content)) - return $this->_set_error(SIEVE_ERROR_OTHER); - - return $content; - } - - /** - * 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 _set_error($error) - { - $this->error = $error; - return false; - } - - /** - * This is our own debug handler for connection - */ - public function debug_handler(&$sieve, $message) - { - write_log('sieve', preg_replace('/\r\n$/', '', $message)); - } -} diff --git a/plugins/managesieve/lib/rcube_sieve_script.php b/plugins/managesieve/lib/rcube_sieve_script.php deleted file mode 100644 index 36eb1bcf8..000000000 --- a/plugins/managesieve/lib/rcube_sieve_script.php +++ /dev/null @@ -1,1154 +0,0 @@ -supported as $idx => $ext) { - if (!in_array($ext, $capabilities)) { - unset($this->supported[$idx]); - } - } - } - - // Parse text content of the script - $this->_parse_text($script); - } - - /** - * Adds rule to the script (at the end) - * - * @param string Rule name - * @param array Rule content (as array) - * - * @return int The index of the new rule - */ - 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; - } - - /** - * Sets "global" variable - * - * @param string $name Variable name - * @param string $value Variable value - * @param array $mods Variable modifiers - */ - public function set_var($name, $value, $mods = array()) - { - // Check if variable exists - for ($i=0, $len=count($this->vars); $i<$len; $i++) { - if ($this->vars[$i]['name'] == $name) { - break; - } - } - - $var = array_merge($mods, array('name' => $name, 'value' => $value)); - $this->vars[$i] = $var; - } - - /** - * Unsets "global" variable - * - * @param string $name Variable name - */ - public function unset_var($name) - { - // Check if variable exists - foreach ($this->vars as $idx => $var) { - if ($var['name'] == $name) { - unset($this->vars[$idx]); - break; - } - } - } - - /** - * Gets the value of "global" variable - * - * @param string $name Variable name - * - * @return string Variable value - */ - public function get_var($name) - { - // Check if variable exists - for ($i=0, $len=count($this->vars); $i<$len; $i++) { - if ($this->vars[$i]['name'] == $name) { - return $this->vars[$i]['name']; - } - } - } - - /** - * Sets script header content - * - * @param string $text Header content - */ - public function set_prefix($text) - { - $this->prefix = $text; - } - - /** - * Returns script as text - */ - public function as_text() - { - $output = ''; - $exts = array(); - $idx = 0; - - if (!empty($this->vars)) { - if (in_array('variables', (array)$this->supported)) { - $has_vars = true; - array_push($exts, 'variables'); - } - foreach ($this->vars as $var) { - if (empty($has_vars)) { - // 'variables' extension not supported, put vars in comments - $output .= sprintf("# %s %s\n", $var['name'], $var['value']); - } - else { - $output .= 'set '; - foreach (array_diff(array_keys($var), array('name', 'value')) as $opt) { - $output .= ":$opt "; - } - $output .= self::escape_string($var['name']) . ' ' . self::escape_string($var['value']) . ";\n"; - } - } - } - - $imapflags = in_array('imap4flags', $this->supported) ? 'imap4flags' : 'imapflags'; - $notify = in_array('enotify', $this->supported) ? 'enotify' : 'notify'; - - // rules - foreach ($this->content as $rule) { - $extension = ''; - $script = ''; - $tests = array(); - $i = 0; - - // header - if (!empty($rule['name']) && strlen($rule['name'])) { - $script .= '# rule:[' . $rule['name'] . "]\n"; - } - - // constraints expressions - if (!empty($rule['tests'])) { - 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'] ? 'false' : 'true'); - break; - - case 'exists': - $tests[$i] .= ($test['not'] ? 'not ' : ''); - $tests[$i] .= 'exists ' . self::escape_string($test['arg']); - break; - - case 'header': - $tests[$i] .= ($test['not'] ? 'not ' : ''); - $tests[$i] .= 'header'; - - if (!empty($test['type'])) { - // relational operator + comparator - if (preg_match('/^(value|count)-([gteqnl]{2})/', $test['type'], $m)) { - array_push($exts, 'relational'); - array_push($exts, 'comparator-i;ascii-numeric'); - - $tests[$i] .= ' :' . $m[1] . ' "' . $m[2] . '" :comparator "i;ascii-numeric"'; - } - else { - $this->add_comparator($test, $tests[$i], $exts); - - if ($test['type'] == 'regex') { - array_push($exts, 'regex'); - } - - $tests[$i] .= ' :' . $test['type']; - } - } - - $tests[$i] .= ' ' . self::escape_string($test['arg1']); - $tests[$i] .= ' ' . self::escape_string($test['arg2']); - break; - - case 'address': - case 'envelope': - if ($test['test'] == 'envelope') { - array_push($exts, 'envelope'); - } - - $tests[$i] .= ($test['not'] ? 'not ' : ''); - $tests[$i] .= $test['test']; - - if (!empty($test['part'])) { - $tests[$i] .= ' :' . $test['part']; - if ($test['part'] == 'user' || $test['part'] == 'detail') { - array_push($exts, 'subaddress'); - } - } - - $this->add_comparator($test, $tests[$i], $exts); - - if (!empty($test['type'])) { - if ($test['type'] == 'regex') { - array_push($exts, 'regex'); - } - $tests[$i] .= ' :' . $test['type']; - } - - $tests[$i] .= ' ' . self::escape_string($test['arg1']); - $tests[$i] .= ' ' . self::escape_string($test['arg2']); - break; - - case 'body': - array_push($exts, 'body'); - - $tests[$i] .= ($test['not'] ? 'not ' : '') . 'body'; - - $this->add_comparator($test, $tests[$i], $exts); - - if (!empty($test['part'])) { - $tests[$i] .= ' :' . $test['part']; - - if (!empty($test['content']) && $test['part'] == 'content') { - $tests[$i] .= ' ' . self::escape_string($test['content']); - } - } - - if (!empty($test['type'])) { - if ($test['type'] == 'regex') { - array_push($exts, 'regex'); - } - $tests[$i] .= ' :' . $test['type']; - } - - $tests[$i] .= ' ' . self::escape_string($test['arg']); - break; - } - $i++; - } - } - - // disabled rule: if false #.... - if (!empty($tests)) { - $script .= 'if ' . ($rule['disabled'] ? 'false # ' : ''); - - if (count($tests) > 1) { - $tests_str = implode(', ', $tests); - } - else { - $tests_str = $tests[0]; - } - - if ($rule['join'] || count($tests) > 1) { - $script .= sprintf('%s (%s)', $rule['join'] ? 'allof' : 'anyof', $tests_str); - } - else { - $script .= $tests_str; - } - $script .= "\n{\n"; - } - - // action(s) - if (!empty($rule['actions'])) { - foreach ($rule['actions'] as $action) { - $action_script = ''; - - switch ($action['type']) { - - case 'fileinto': - array_push($exts, 'fileinto'); - $action_script .= 'fileinto '; - if ($action['copy']) { - $action_script .= ':copy '; - array_push($exts, 'copy'); - } - $action_script .= self::escape_string($action['target']); - break; - - case 'redirect': - $action_script .= 'redirect '; - if ($action['copy']) { - $action_script .= ':copy '; - array_push($exts, 'copy'); - } - $action_script .= self::escape_string($action['target']); - break; - - case 'reject': - case 'ereject': - array_push($exts, $action['type']); - $action_script .= $action['type'].' ' - . self::escape_string($action['target']); - break; - - case 'addflag': - case 'setflag': - case 'removeflag': - array_push($exts, $imapflags); - $action_script .= $action['type'].' ' - . self::escape_string($action['target']); - break; - - case 'keep': - case 'discard': - case 'stop': - $action_script .= $action['type']; - break; - - case 'include': - array_push($exts, 'include'); - $action_script .= 'include '; - foreach (array_diff(array_keys($action), array('target', 'type')) as $opt) { - $action_script .= ":$opt "; - } - $action_script .= self::escape_string($action['target']); - break; - - case 'set': - array_push($exts, 'variables'); - $action_script .= 'set '; - foreach (array_diff(array_keys($action), array('name', 'value', 'type')) as $opt) { - $action_script .= ":$opt "; - } - $action_script .= self::escape_string($action['name']) . ' ' . self::escape_string($action['value']); - break; - - case 'notify': - array_push($exts, $notify); - $action_script .= 'notify'; - - // Here we support only 00 version of notify draft, there - // were a couple regressions in 00 to 04 changelog, we use - // the version used by Cyrus - if ($notify == 'notify') { - switch ($action['importance']) { - case 1: $action_script .= " :high"; break; - case 2: $action_script .= " :normal"; break; - case 3: $action_script .= " :low"; break; - - } - unset($action['importance']); - } - - foreach (array('from', 'importance', 'options', 'message') as $n_tag) { - if (!empty($action[$n_tag])) { - $action_script .= " :$n_tag " . self::escape_string($action[$n_tag]); - } - } - - if (!empty($action['address'])) { - $method = 'mailto:' . $action['address']; - if (!empty($action['body'])) { - $method .= '?body=' . rawurlencode($action['body']); - } - } - else { - $method = $action['method']; - } - - // method is optional in notify extension - if (!empty($method)) { - $action_script .= ($notify == 'notify' ? " :method " : " ") . self::escape_string($method); - } - - break; - - case 'vacation': - array_push($exts, 'vacation'); - $action_script .= 'vacation'; - if (!empty($action['days'])) - $action_script .= " :days " . $action['days']; - if (!empty($action['addresses'])) - $action_script .= " :addresses " . self::escape_string($action['addresses']); - if (!empty($action['subject'])) - $action_script .= " :subject " . self::escape_string($action['subject']); - if (!empty($action['handle'])) - $action_script .= " :handle " . self::escape_string($action['handle']); - if (!empty($action['from'])) - $action_script .= " :from " . self::escape_string($action['from']); - if (!empty($action['mime'])) - $action_script .= " :mime"; - $action_script .= " " . self::escape_string($action['reason']); - break; - } - - if ($action_script) { - $script .= !empty($tests) ? "\t" : ''; - $script .= $action_script . ";\n"; - } - } - } - - if ($script) { - $output .= $script . (!empty($tests) ? "}\n" : ''); - $idx++; - } - } - - // requires - if (!empty($exts)) - $output = 'require ["' . implode('","', array_unique($exts)) . "\"];\n" . $output; - - if (!empty($this->prefix)) { - $output = $this->prefix . "\n\n" . $output; - } - - return $output; - } - - /** - * 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) - { - $prefix = ''; - $options = array(); - - while ($script) { - $script = trim($script); - $rule = array(); - - // Comments - while (!empty($script) && $script[0] == '#') { - $endl = strpos($script, "\n"); - $line = $endl ? substr($script, 0, $endl) : $script; - - // Roundcube format - if (preg_match('/^# rule:\[(.*)\]/', $line, $matches)) { - $rulename = $matches[1]; - } - // KEP:14 variables - else if (preg_match('/^# (EDITOR|EDITOR_VERSION) (.+)$/', $line, $matches)) { - $this->set_var($matches[1], $matches[2]); - } - // Horde-Ingo format - else if (!empty($options['format']) && $options['format'] == 'INGO' - && preg_match('/^# (.*)/', $line, $matches) - ) { - $rulename = $matches[1]; - } - else if (empty($options['prefix'])) { - $prefix .= $line . "\n"; - } - - $script = ltrim(substr($script, strlen($line) + 1)); - } - - // handle script header - if (empty($options['prefix'])) { - $options['prefix'] = true; - if ($prefix && strpos($prefix, 'horde.org/ingo')) { - $options['format'] = 'INGO'; - } - } - - // Control structures/blocks - if (preg_match('/^(if|else|elsif)/i', $script)) { - $rule = $this->_tokenize_rule($script); - if (strlen($rulename) && !empty($rule)) { - $rule['name'] = $rulename; - } - } - // Simple commands - else { - $rule = $this->_parse_actions($script, ';'); - if (!empty($rule[0]) && is_array($rule)) { - // set "global" variables - if ($rule[0]['type'] == 'set') { - unset($rule[0]['type']); - $this->vars[] = $rule[0]; - } - else { - $rule = array('actions' => $rule); - } - } - } - - $rulename = ''; - - if (!empty($rule)) { - $this->content[] = $rule; - } - } - - if (!empty($prefix)) { - $this->prefix = trim($prefix); - } - } - - /** - * Convert text script fragment to rule object - * - * @param string Text rule - * - * @return array Rule data - */ - private function _tokenize_rule(&$content) - { - $cond = strtolower(self::tokenize($content, 1)); - - if ($cond != 'if' && $cond != 'elsif' && $cond != 'else') { - return null; - } - - $disabled = false; - $join = false; - - // disabled rule (false + comment): if false # ..... - if (preg_match('/^\s*false\s+#/i', $content)) { - $content = preg_replace('/^\s*false\s+#\s*/i', '', $content); - $disabled = true; - } - - while (strlen($content)) { - $tokens = self::tokenize($content, true); - $separator = array_pop($tokens); - - if (!empty($tokens)) { - $token = array_shift($tokens); - } - else { - $token = $separator; - } - - $token = strtolower($token); - - if ($token == 'not') { - $not = true; - $token = strtolower(array_shift($tokens)); - } - else { - $not = false; - } - - switch ($token) { - case 'allof': - $join = true; - break; - case 'anyof': - break; - - case 'size': - $size = array('test' => 'size', 'not' => $not); - for ($i=0, $len=count($tokens); $i<$len; $i++) { - if (!is_array($tokens[$i]) - && preg_match('/^:(under|over)$/i', $tokens[$i]) - ) { - $size['type'] = strtolower(substr($tokens[$i], 1)); - } - else { - $size['arg'] = $tokens[$i]; - } - } - - $tests[] = $size; - break; - - case 'header': - $header = array('test' => 'header', 'not' => $not, 'arg1' => '', 'arg2' => ''); - for ($i=0, $len=count($tokens); $i<$len; $i++) { - if (!is_array($tokens[$i]) && preg_match('/^:comparator$/i', $tokens[$i])) { - $header['comparator'] = $tokens[++$i]; - } - else if (!is_array($tokens[$i]) && preg_match('/^:(count|value)$/i', $tokens[$i])) { - $header['type'] = strtolower(substr($tokens[$i], 1)) . '-' . $tokens[++$i]; - } - else if (!is_array($tokens[$i]) && preg_match('/^:(is|contains|matches|regex)$/i', $tokens[$i])) { - $header['type'] = strtolower(substr($tokens[$i], 1)); - } - else { - $header['arg1'] = $header['arg2']; - $header['arg2'] = $tokens[$i]; - } - } - - $tests[] = $header; - break; - - case 'address': - case 'envelope': - $header = array('test' => $token, 'not' => $not, 'arg1' => '', 'arg2' => ''); - for ($i=0, $len=count($tokens); $i<$len; $i++) { - if (!is_array($tokens[$i]) && preg_match('/^:comparator$/i', $tokens[$i])) { - $header['comparator'] = $tokens[++$i]; - } - else if (!is_array($tokens[$i]) && preg_match('/^:(is|contains|matches|regex)$/i', $tokens[$i])) { - $header['type'] = strtolower(substr($tokens[$i], 1)); - } - else if (!is_array($tokens[$i]) && preg_match('/^:(localpart|domain|all|user|detail)$/i', $tokens[$i])) { - $header['part'] = strtolower(substr($tokens[$i], 1)); - } - else { - $header['arg1'] = $header['arg2']; - $header['arg2'] = $tokens[$i]; - } - } - - $tests[] = $header; - break; - - case 'body': - $header = array('test' => 'body', 'not' => $not, 'arg' => ''); - for ($i=0, $len=count($tokens); $i<$len; $i++) { - if (!is_array($tokens[$i]) && preg_match('/^:comparator$/i', $tokens[$i])) { - $header['comparator'] = $tokens[++$i]; - } - else if (!is_array($tokens[$i]) && preg_match('/^:(is|contains|matches|regex)$/i', $tokens[$i])) { - $header['type'] = strtolower(substr($tokens[$i], 1)); - } - else if (!is_array($tokens[$i]) && preg_match('/^:(raw|content|text)$/i', $tokens[$i])) { - $header['part'] = strtolower(substr($tokens[$i], 1)); - - if ($header['part'] == 'content') { - $header['content'] = $tokens[++$i]; - } - } - else { - $header['arg'] = $tokens[$i]; - } - } - - $tests[] = $header; - break; - - case 'exists': - $tests[] = array('test' => 'exists', 'not' => $not, - 'arg' => array_pop($tokens)); - break; - - case 'true': - $tests[] = array('test' => 'true', 'not' => $not); - break; - - case 'false': - $tests[] = array('test' => 'true', 'not' => !$not); - break; - } - - // goto actions... - if ($separator == '{') { - break; - } - } - - // ...and actions block - $actions = $this->_parse_actions($content); - - if ($tests && $actions) { - $result = array( - 'type' => $cond, - 'tests' => $tests, - 'actions' => $actions, - 'join' => $join, - 'disabled' => $disabled, - ); - } - - return $result; - } - - /** - * Parse body of actions section - * - * @param string $content Text body - * @param string $end End of text separator - * - * @return array Array of parsed action type/target pairs - */ - private function _parse_actions(&$content, $end = '}') - { - $result = null; - - while (strlen($content)) { - $tokens = self::tokenize($content, true); - $separator = array_pop($tokens); - - if (!empty($tokens)) { - $token = array_shift($tokens); - } - else { - $token = $separator; - } - - switch ($token) { - case 'discard': - case 'keep': - case 'stop': - $result[] = array('type' => $token); - break; - - case 'fileinto': - case 'redirect': - $copy = false; - $target = ''; - - for ($i=0, $len=count($tokens); $i<$len; $i++) { - if (strtolower($tokens[$i]) == ':copy') { - $copy = true; - } - else { - $target = $tokens[$i]; - } - } - - $result[] = array('type' => $token, 'copy' => $copy, - 'target' => $target); - break; - - case 'reject': - case 'ereject': - $result[] = array('type' => $token, 'target' => array_pop($tokens)); - break; - - case 'vacation': - $vacation = array('type' => 'vacation', 'reason' => array_pop($tokens)); - - for ($i=0, $len=count($tokens); $i<$len; $i++) { - $tok = strtolower($tokens[$i]); - if ($tok == ':days') { - $vacation['days'] = $tokens[++$i]; - } - else if ($tok == ':subject') { - $vacation['subject'] = $tokens[++$i]; - } - else if ($tok == ':addresses') { - $vacation['addresses'] = $tokens[++$i]; - } - else if ($tok == ':handle') { - $vacation['handle'] = $tokens[++$i]; - } - else if ($tok == ':from') { - $vacation['from'] = $tokens[++$i]; - } - else if ($tok == ':mime') { - $vacation['mime'] = true; - } - } - - $result[] = $vacation; - break; - - case 'setflag': - case 'addflag': - case 'removeflag': - $result[] = array('type' => $token, - // Flags list: last token (skip optional variable) - 'target' => $tokens[count($tokens)-1] - ); - break; - - case 'include': - $include = array('type' => 'include', 'target' => array_pop($tokens)); - - // Parameters: :once, :optional, :global, :personal - for ($i=0, $len=count($tokens); $i<$len; $i++) { - $tok = strtolower($tokens[$i]); - if ($tok[0] == ':') { - $include[substr($tok, 1)] = true; - } - } - - $result[] = $include; - break; - - case 'set': - $set = array('type' => 'set', 'value' => array_pop($tokens), 'name' => array_pop($tokens)); - - // Parameters: :lower :upper :lowerfirst :upperfirst :quotewildcard :length - for ($i=0, $len=count($tokens); $i<$len; $i++) { - $tok = strtolower($tokens[$i]); - if ($tok[0] == ':') { - $set[substr($tok, 1)] = true; - } - } - - $result[] = $set; - break; - - case 'require': - // skip, will be build according to used commands - // $result[] = array('type' => 'require', 'target' => $tokens); - break; - - case 'notify': - $notify = array('type' => 'notify'); - $priorities = array(':high' => 1, ':normal' => 2, ':low' => 3); - - // Parameters: :from, :importance, :options, :message - // additional (optional) :method parameter for notify extension - for ($i=0, $len=count($tokens); $i<$len; $i++) { - $tok = strtolower($tokens[$i]); - if ($tok[0] == ':') { - // Here we support only 00 version of notify draft, there - // were a couple regressions in 00 to 04 changelog, we use - // the version used by Cyrus - if (isset($priorities[$tok])) { - $notify['importance'] = $priorities[$tok]; - } - else { - $notify[substr($tok, 1)] = $tokens[++$i]; - } - } - else { - // unnamed parameter is a :method in enotify extension - $notify['method'] = $tokens[$i]; - } - } - - $method_components = parse_url($notify['method']); - if ($method_components['scheme'] == 'mailto') { - $notify['address'] = $method_components['path']; - $method_params = array(); - if (array_key_exists('query', $method_components)) { - parse_str($method_components['query'], $method_params); - } - $method_params = array_change_key_case($method_params, CASE_LOWER); - // magic_quotes_gpc and magic_quotes_sybase affect the output of parse_str - if (ini_get('magic_quotes_gpc') || ini_get('magic_quotes_sybase')) { - array_map('stripslashes', $method_params); - } - $notify['body'] = (array_key_exists('body', $method_params)) ? $method_params['body'] : ''; - } - - $result[] = $notify; - break; - - } - - if ($separator == $end) - break; - } - - return $result; - } - - /** - * - */ - private function add_comparator($test, &$out, &$exts) - { - if (empty($test['comparator'])) { - return; - } - - if ($test['comparator'] == 'i;ascii-numeric') { - array_push($exts, 'relational'); - array_push($exts, 'comparator-i;ascii-numeric'); - } - else if (!in_array($test['comparator'], array('i;octet', 'i;ascii-casemap'))) { - array_push($exts, 'comparator-' . $test['comparator']); - } - - // skip default comparator - if ($test['comparator'] != 'i;ascii-casemap') { - $out .= ' :comparator ' . self::escape_string($test['comparator']); - } - } - - /** - * Escape special chars into quoted string value or multi-line string - * or list of strings - * - * @param string $str Text or array (list) of strings - * - * @return string Result text - */ - static function escape_string($str) - { - if (is_array($str) && count($str) > 1) { - foreach($str as $idx => $val) - $str[$idx] = self::escape_string($val); - - return '[' . implode(',', $str) . ']'; - } - else if (is_array($str)) { - $str = array_pop($str); - } - - // multi-line string - if (preg_match('/[\r\n\0]/', $str) || strlen($str) > 1024) { - return sprintf("text:\n%s\n.\n", self::escape_multiline_string($str)); - } - // quoted-string - else { - return '"' . addcslashes($str, '\\"') . '"'; - } - } - - /** - * Escape special chars in multi-line string value - * - * @param string $str Text - * - * @return string Text - */ - static function escape_multiline_string($str) - { - $str = preg_split('/(\r?\n)/', $str, -1, PREG_SPLIT_DELIM_CAPTURE); - - foreach ($str as $idx => $line) { - // dot-stuffing - if (isset($line[0]) && $line[0] == '.') { - $str[$idx] = '.' . $line; - } - } - - return implode($str); - } - - /** - * Splits script into string tokens - * - * @param string &$str The script - * @param mixed $num Number of tokens to return, 0 for all - * or True for all tokens until separator is found. - * Separator will be returned as last token. - * @param int $in_list Enable to call recursively inside a list - * - * @return mixed Tokens array or string if $num=1 - */ - static function tokenize(&$str, $num=0, $in_list=false) - { - $result = array(); - - // remove spaces from the beginning of the string - while (($str = ltrim($str)) !== '' - && (!$num || $num === true || count($result) < $num) - ) { - switch ($str[0]) { - - // Quoted string - case '"': - $len = strlen($str); - - for ($pos=1; $pos<$len; $pos++) { - if ($str[$pos] == '"') { - break; - } - if ($str[$pos] == "\\") { - if ($str[$pos + 1] == '"' || $str[$pos + 1] == "\\") { - $pos++; - } - } - } - if ($str[$pos] != '"') { - // error - } - // we need to strip slashes for a quoted string - $result[] = stripslashes(substr($str, 1, $pos - 1)); - $str = substr($str, $pos + 1); - break; - - // Parenthesized list - case '[': - $str = substr($str, 1); - $result[] = self::tokenize($str, 0, true); - break; - case ']': - $str = substr($str, 1); - return $result; - break; - - // list/test separator - case ',': - // command separator - case ';': - // block/tests-list - case '(': - case ')': - case '{': - case '}': - $sep = $str[0]; - $str = substr($str, 1); - if ($num === true) { - $result[] = $sep; - break 2; - } - break; - - // bracket-comment - case '/': - if ($str[1] == '*') { - if ($end_pos = strpos($str, '*/')) { - $str = substr($str, $end_pos + 2); - } - else { - // error - $str = ''; - } - } - break; - - // hash-comment - case '#': - if ($lf_pos = strpos($str, "\n")) { - $str = substr($str, $lf_pos); - break; - } - else { - $str = ''; - } - - // String atom - default: - // empty or one character - if ($str === '' || $str === null) { - break 2; - } - if (strlen($str) < 2) { - $result[] = $str; - $str = ''; - break; - } - - // tag/identifier/number - if (preg_match('/^([a-z0-9:_]+)/i', $str, $m)) { - $str = substr($str, strlen($m[1])); - - if ($m[1] != 'text:') { - $result[] = $m[1]; - } - // multiline string - else { - // possible hash-comment after "text:" - if (preg_match('/^( |\t)*(#[^\n]+)?\n/', $str, $m)) { - $str = substr($str, strlen($m[0])); - } - // get text until alone dot in a line - if (preg_match('/^(.*)\r?\n\.\r?\n/sU', $str, $m)) { - $text = $m[1]; - // remove dot-stuffing - $text = str_replace("\n..", "\n.", $text); - $str = substr($str, strlen($m[0])); - } - else { - $text = ''; - } - - $result[] = $text; - } - } - // fallback, skip one character as infinite loop prevention - else { - $str = substr($str, 1); - } - - break; - } - } - - return $num === 1 ? (isset($result[0]) ? $result[0] : null) : $result; - } - -} diff --git a/plugins/managesieve/tests/Parser.php b/plugins/managesieve/tests/Parser.php index 2f24870e2..9050f09c6 100644 --- a/plugins/managesieve/tests/Parser.php +++ b/plugins/managesieve/tests/Parser.php @@ -5,7 +5,7 @@ class Parser extends PHPUnit_Framework_TestCase function setUp() { - include_once dirname(__FILE__) . '/../lib/rcube_sieve_script.php'; + include_once dirname(__FILE__) . '/../lib/Roundcube/rcube_sieve_script.php'; } /** diff --git a/plugins/managesieve/tests/Tokenizer.php b/plugins/managesieve/tests/Tokenizer.php index 8c0bced23..e71bae015 100644 --- a/plugins/managesieve/tests/Tokenizer.php +++ b/plugins/managesieve/tests/Tokenizer.php @@ -5,7 +5,7 @@ class Tokenizer extends PHPUnit_Framework_TestCase function setUp() { - include_once dirname(__FILE__) . '/../lib/rcube_sieve_script.php'; + include_once dirname(__FILE__) . '/../lib/Roundcube/rcube_sieve_script.php'; } function data_tokenizer() -- cgit v1.2.3