File Manager

Editing File: /usr/local/cpanel/base/3rdparty/roundcube/plugins/managesieve/lib/Roundcube/rcube_sieve_script.php

<?php

/**
 * Class for operations on Sieve scripts
 *
 * Copyright (C) The Roundcube Dev Team
 * Copyright (C) Kolab Systems AG
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see https://www.gnu.org/licenses/.
 */

class rcube_sieve_script
{
    public $content = [];      // script rules array

private $vars      = [];   // "global" variables
    private $prefix    = '';   // script header (comments)
    private $supported = [     // supported Sieve extensions:
        'body',                     // RFC5173
        'copy',                     // RFC3894
        'date',                     // RFC5260
        'duplicate',                // RFC7352
        'editheader',               // RFC5293
        'enotify',                  // RFC5435
        'envelope',                 // RFC5228
        'ereject',                  // RFC5429
        'fileinto',                 // RFC5228
        'imapflags',                // draft-melnikov-sieve-imapflags-06
        'imap4flags',               // RFC5232
        'include',                  // RFC6609
        'index',                    // RFC5260
        'mime',                     // RFC5703 (except: foreverypart/break, enclose, extracttext)
        'notify',                   // RFC5435
        'regex',                    // draft-ietf-sieve-regex-01
        'reject',                   // RFC5429
        'relational',               // RFC3431
        'subaddress',               // RFC5233
        'vacation',                 // RFC5230
        'vacation-seconds',         // RFC6131
        'variables',                // RFC5229
        'spamtest',                 // RFC3685 (not RFC5235 with :percent argument)
        // @TODO: virustest, mailbox
    ];

/**
     * Object constructor
     *
     * @param string $script       Script's text content
     * @param array  $capabilities List of capabilities supported by server
     */
    public function __construct($script, $capabilities = [])
    {
        $capabilities = array_map('strtolower', (array) $capabilities);

// disable features by server capabilities
        if (!empty($capabilities)) {
            foreach ($this->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 array $content 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 count($this->content) - 1;
    }

/**
     * Removes a rule from the script.
     *
     * @param int $index Rule index
     *
     * @return bool True on success, False otherwise
     */
    public function delete_rule($index)
    {
        if (isset($this->content[$index])) {
            unset($this->content[$index]);
            return true;
        }

return false;
    }

/**
     * Get the script size - count of rules.
     *
     * @return int Count of rules
     */
    public function size()
    {
        return count($this->content);
    }

/**
     * Updates (replaces) a rule at specified index.
     *
     * @param int   $index   Rule index
     * @param array $content Rule content (as array)
     *
     * @return bool True on success, False otherwise
     */
    public function update_rule($index, $content)
    {
        // TODO: check this->supported
        if (isset($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 = [])
    {
        // 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, ['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   = [];
        $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\r\n", $var['name'], $var['value']);
                }
                else {
                    $output .= 'set ';
                    foreach (array_diff(array_keys($var), ['name', 'value']) as $opt) {
                        $output .= ":$opt ";
                    }
                    $output .= self::escape_string($var['name']) . ' ' . self::escape_string($var['value']) . ";\r\n";
                }
            }
        }

$imapflags = in_array('imap4flags', $this->supported) ? 'imap4flags' : 'imapflags';
        $notify    = in_array('enotify', $this->supported) ? 'enotify' : 'notify';

// rules
        foreach ($this->content as $rule) {
            $script    = '';
            $tests     = [];
            $i         = 0;

// header
            if (!empty($rule['name']) && strlen($rule['name'])) {
                $script .= '# rule:[' . $rule['name'] . "]\r\n";
            }

// constraints expressions
            if (!empty($rule['tests'])) {
                foreach ($rule['tests'] as $test) {
                    $tests[$i] = '';
                    switch ($test['test']) {
                    case 'size':
                        $tests[$i] .= (!empty($test['not']) ? 'not ' : '');
                        $tests[$i] .= 'size :' . ($test['type'] == 'under' ? 'under ' : 'over ') . $test['arg'];
                        break;

case 'spamtest':
                        array_push($exts, 'spamtest');
                        $tests[$i] .= (!empty($test['not']) ? 'not ' : '');
                        $tests[$i] .= $test['test'];

$this->add_operator($test, $tests[$i], $exts);

$tests[$i] .= ' ' . self::escape_string($test['arg']);
                        break;

case 'true':
                        $tests[$i] .= !empty($test['not']) ? 'false' : 'true';
                        break;

case 'exists':
                        $tests[$i] .= (!empty($test['not']) ? 'not ' : '') . 'exists';

$this->add_mime($test, $tests[$i], $exts);

$tests[$i] .= ' ' . self::escape_string($test['arg']);
                        break;

case 'header':
                    case 'string':
                        if ($test['test'] == 'string') {
                            array_push($exts, 'variables');
                        }

$tests[$i] .= (!empty($test['not']) ? 'not ' : '');
                        $tests[$i] .= $test['test'];

if ($test['test'] == 'header') {
                            $this->add_mime($test, $tests[$i], $exts);
                        }

$this->add_index($test, $tests[$i], $exts);
                        $this->add_operator($test, $tests[$i], $exts);

$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] .= (!empty($test['not']) ? 'not ' : '');
                        $tests[$i] .= $test['test'];

if ($test['test'] == 'address') {
                            $this->add_mime($test, $tests[$i], $exts);
                            $this->add_index($test, $tests[$i], $exts);
                        }

// :all address-part is optional, skip it
                        if (!empty($test['part']) && $test['part'] != 'all') {
                            $tests[$i] .= ' :' . $test['part'];
                            if ($test['part'] == 'user' || $test['part'] == 'detail') {
                                array_push($exts, 'subaddress');
                            }
                        }

$this->add_operator($test, $tests[$i], $exts);

$tests[$i] .= ' ' . self::escape_string($test['arg1']);
                        $tests[$i] .= ' ' . self::escape_string($test['arg2']);
                        break;

case 'body':
                        array_push($exts, 'body');

$tests[$i] .= (!empty($test['not']) ? 'not ' : '') . 'body';

if (!empty($test['part'])) {
                            $tests[$i] .= ' :' . $test['part'];

if (!empty($test['content']) && $test['part'] == 'content') {
                                $tests[$i] .= ' ' . self::escape_string($test['content']);
                            }
                        }

$this->add_operator($test, $tests[$i], $exts);

$tests[$i] .= ' ' . self::escape_string($test['arg']);
                        break;

case 'date':
                    case 'currentdate':
                        array_push($exts, 'date');

$tests[$i] .= (!empty($test['not']) ? 'not ' : '') . $test['test'];

$this->add_index($test, $tests[$i], $exts);

if (!empty($test['originalzone']) && $test['test'] == 'date') {
                            $tests[$i] .= ' :originalzone';
                        }
                        else if (!empty($test['zone'])) {
                            $tests[$i] .= ' :zone ' . self::escape_string($test['zone']);
                        }

$this->add_operator($test, $tests[$i], $exts);

if ($test['test'] == 'date') {
                            $tests[$i] .= ' ' . self::escape_string($test['header']);
                        }

$tests[$i] .= ' ' . self::escape_string($test['part']);
                        $tests[$i] .= ' ' . self::escape_string($test['arg']);

break;

case 'duplicate':
                        array_push($exts, 'duplicate');

$tests[$i] .= (!empty($test['not']) ? 'not ' : '') . $test['test'];

$tokens = ['handle', 'uniqueid', 'header'];
                        foreach ($tokens as $token)
                            if (isset($test[$token]) && $test[$token] !== '') {
                                $tests[$i] .= " :$token " . self::escape_string($test[$token]);
                            }

if (!empty($test['seconds'])) {
                            $tests[$i] .= ' :seconds ' . intval($test['seconds']);
                        }

if (!empty($test['last'])) {
                            $tests[$i] .= ' :last';
                        }

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 .= "\r\n{\r\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 (!empty($action['copy'])) {
                            $action_script .= ':copy ';
                            array_push($exts, 'copy');
                        }
                        $action_script .= self::escape_string($action['target']);
                        break;

case 'redirect':
                        $action_script .= 'redirect ';
                        if (!empty($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 'addheader':
                    case 'deleteheader':
                        array_push($exts, 'editheader');
                        $action_script .= $action['type'];
                        if (!empty($action['index'])) {
                            $action_script .= " :index " . intval($action['index']);
                        }
                        if (!empty($action['last']) && (!empty($action['index']) || $action['type'] == 'addheader')) {
                            $action_script .= " :last";
                        }
                        if ($action['type'] == 'deleteheader') {
                            $action['type'] = $action['match-type'] ?? null;
                            $this->add_operator($action, $action_script, $exts);
                        }
                        $action_script .= " " . self::escape_string($action['name']);
                        if ((is_string($action['value']) && strlen($action['value']) > 0) || (is_array($action['value']) && !empty($action['value']))) {
                            $action_script .= " " . self::escape_string($action['value']);
                        }
                        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), ['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), ['name', 'value', 'type']) as $opt) {
                            $action_script .= ":$opt ";
                        }
                        $action_script .= self::escape_string($action['name']) . ' ' . self::escape_string($action['value']);
                        break;

case 'replace':
                        array_push($exts, 'mime');
                        $action_script .= 'replace';
                        if (!empty($action['mime'])) {
                            $action_script .= " :mime";
                        }
                        if (!empty($action['subject'])) {
                            $action_script .= " :subject " . self::escape_string($action['subject']);
                        }
                        if (!empty($action['from'])) {
                            $action_script .= " :from " . self::escape_string($action['from']);
                        }
                        $action_script .= ' ' . self::escape_string($action['replace']);
                        break;

case 'notify':
                        array_push($exts, $notify);
                        $action_script .= 'notify';

$method = $action['method'];
                        unset($action['method']);
                        $action['options'] = (array) $action['options'];

// Here we support draft-martin-sieve-notify-01 used by Cyrus
                        if ($notify == 'notify') {
                            if (!empty($action['importance'])) {
                                switch ($action['importance']) {
                                    case 1: $action_script .= " :high"; break;
                                    //case 2: $action_script .= " :normal"; break;
                                    case 3: $action_script .= " :low"; break;
                                }
                            }

// Old-draft way: :method "mailto" :options "email@address"
                            if (!empty($method)) {
                                $parts = explode(':', $method, 2);
                                $action['method'] = $parts[0];
                                array_unshift($action['options'], $parts[1]);
                            }

unset($action['importance']);
                            unset($action['from']);
                            unset($method);
                        }

foreach (['id', 'importance', 'method', 'options', 'from', 'message'] as $n_tag) {
                            if (!empty($action[$n_tag])) {
                                $action_script .= " :$n_tag " . self::escape_string($action[$n_tag]);
                            }
                        }

if (!empty($method)) {
                            $action_script .= ' ' . self::escape_string($method);
                        }

break;

case 'vacation':
                        array_push($exts, 'vacation');
                        $action_script .= 'vacation';
                        if (isset($action['seconds'])) {
                            array_push($exts, 'vacation-seconds');
                            $action_script .= " :seconds " . intval($action['seconds']);
                        }
                        else if (!empty($action['days'])) {
                            $action_script .= " :days " . intval($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 . ";\r\n";
                    }
                }
            }

if ($script) {
                $output .= $script . (!empty($tests) ? "}\r\n" : '');
                $idx++;
            }
        }

// requires
        if (!empty($exts)) {
            $exts = array_unique($exts);

if (in_array('vacation-seconds', $exts) && ($key = array_search('vacation', $exts)) !== false) {
                unset($exts[$key]);
            }

sort($exts); // for convenience use always the same order

$output = 'require ["' . implode('","', $exts) . "\"];\r\n" . $output;
        }

if (!empty($this->prefix)) {
            $output = $this->prefix . "\r\n\r\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 $script Text script
     */
    private function _parse_text($script)
    {
        $prefix   = '';
        $options  = [];
        $position = 0;
        $length   = strlen($script);

while ($position < $length) {
            // skip whitespace chars
            $position = self::ltrim_position($script, $position);
            $rulename = '';

// Comments
            while (isset($script[$position]) && $script[$position] === '#') {
                $endl = strpos($script, "\n", $position);
                if ($endl === false) {
                    $endl = $length;
                } elseif ($script[$endl - 1] === "\r") {
                    --$endl;
                }
                $line = substr($script, $position, $endl - $position);

// 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";
                }

// skip empty lines after the comment (#5657)
                $position = self::ltrim_position($script, $endl + 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', substr($script, $position, 5))) {
                $rule = $this->_tokenize_rule($script, $position);
                if (strlen($rulename) && !empty($rule)) {
                    $rule['name'] = $rulename;
                }
            }
            // Simple commands
            else {
                $rule = $this->_parse_actions($script, $position, ';');
                if (is_array($rule) && !empty($rule[0])) {
                    // set "global" variables
                    if ($rule[0]['type'] == 'set') {
                        unset($rule[0]['type']);
                        $this->vars[] = $rule[0];
                        unset($rule);
                    }
                    else {
                        $rule = ['actions' => $rule];
                    }
                }
            }

if (!empty($rule)) {
                $this->content[] = $rule;
            }
        }

if (!empty($prefix)) {
            $this->prefix = trim(preg_replace('/\r?\n/', "\r\n", $prefix));
        }
    }

/**
     * Convert text script fragment to rule object
     *
     * @param string $content   The whole script content
     * @param int    &$position Start position in the script
     *
     * @return array Rule data
     */
    private function _tokenize_rule($content, &$position)
    {
        $cond = strtolower(self::tokenize($content, 1, $position));
        if ($cond != 'if' && $cond != 'elsif' && $cond != 'else') {
            return null;
        }

$disabled = false;
        $join     = false;
        $join_not = false;
        $length   = strlen($content);

// disabled rule (false + comment): if false # .....
        if (preg_match('/^\s*false\s+#\s*/i', substr($content, $position, 20), $m)) {
            $position += strlen($m[0]);
            $disabled = true;
        }

while ($position < $length) {
            $tokens    = self::tokenize($content, true, $position);
            $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;
            }

// we support "not allof" as a negation of allof sub-tests
            if ($join_not) {
                $not = !$not;
            }

switch ($token) {
            case 'allof':
                $join     = true;
                $join_not = $not;
                break;

case 'anyof':
                break;

case 'size':
                $test = ['test' => 'size', 'not' => $not];

$test['arg'] = array_pop($tokens);

for ($i=0, $len=count($tokens); $i<$len; $i++) {
                    if (!is_array($tokens[$i])
                        && preg_match('/^:(under|over)$/i', $tokens[$i])
                    ) {
                        $test['type'] = strtolower(substr($tokens[$i], 1));
                    }
                }