Proyectos de Subversion Moodle

<?php

/**

 +-----------------------------------------------------------------------+

 | This file is part of the Roundcube Webmail client                     |

 |                                                                       |

 | Copyright (C) The Roundcube Dev Team                                  |

 | Copyright (C) Kolab Systems AG                                        |

 |                                                                       |

 | Licensed under the GNU General Public License version 3 or            |

 | any later version with exceptions for skins & plugins.                |

 | See the README file for a full license statement.                     |

 |                                                                       |

 | PURPOSE:                                                              |

 |   SORT/SEARCH/ESEARCH response handler                                |

 +-----------------------------------------------------------------------+

 | Author: Thomas Bruederli <roundcube@gmail.com>                        |

 | Author: Aleksander Machniak <alec@alec.pl>                            |

 +-----------------------------------------------------------------------+

*/

/**

 * Class for accessing IMAP's SORT/SEARCH/ESEARCH result

 *

 * @package    Framework

 * @subpackage Storage

 */

class rcube_result_index

{

    public $incomplete = false;

    protected $raw_data;

    protected $mailbox;

    protected $meta   = [];

    protected $params = [];

    protected $order  = 'ASC';

    const SEPARATOR_ELEMENT = ' ';

    /**

     * Object constructor.

     */

    public function __construct($mailbox = null, $data = null, $order = null)

    {

        $this->mailbox = $mailbox;

        $this->order   = $order == 'DESC' ? 'DESC' : 'ASC';

        $this->init($data);

    }

    /**

     * Initializes object with SORT command response

     *

     * @param string $data IMAP response string

     */

    public function init($data = null)

    {

        $this->meta = [];

        $data = explode('*', (string)$data);

        // ...skip unilateral untagged server responses

        for ($i=0, $len=count($data); $i<$len; $i++) {

            $data_item = &$data[$i];

            if (preg_match('/^ SORT/i', $data_item)) {

                // valid response, initialize raw_data for is_error()

                $this->raw_data = '';

                $data_item = substr($data_item, 5);

                break;

            }

            else if (preg_match('/^ (E?SEARCH)/i', $data_item, $m)) {

                // valid response, initialize raw_data for is_error()

                $this->raw_data = '';

                $data_item = substr($data_item, strlen($m[0]));

                if (strtoupper($m[1]) == 'ESEARCH') {

                    $data_item = trim($data_item);

                    // remove MODSEQ response

                    if (preg_match('/\(MODSEQ ([0-9]+)\)$/i', $data_item, $m)) {

                        $data_item = substr($data_item, 0, -strlen($m[0]));

                        $this->params['MODSEQ'] = $m[1];

                    }

                    // remove TAG response part

                    if (preg_match('/^\(TAG ["a-z0-9]+\)\s*/i', $data_item, $m)) {

                        $data_item = substr($data_item, strlen($m[0]));

                    }

                    // remove UID

                    $data_item = preg_replace('/^UID\s*/i', '', $data_item);

                    // ESEARCH parameters

                    while (preg_match('/^([a-z]+) ([0-9:,]+)\s*/i', $data_item, $m)) {

                        $param = strtoupper($m[1]);

                        $value = $m[2];

                        $this->params[$param] = $value;

                        $data_item = substr($data_item, strlen($m[0]));

                        if (in_array($param, ['COUNT', 'MIN', 'MAX'])) {

                            $this->meta[strtolower($param)] = (int) $value;

                        }

                    }

// @TODO: Implement compression using compressMessageSet() in __sleep() and __wakeup() ?

// @TODO: work with compressed result?!

                    if (isset($this->params['ALL'])) {

                        $data_item = implode(self::SEPARATOR_ELEMENT,

                            rcube_imap_generic::uncompressMessageSet($this->params['ALL']));

                    }

                }

                break;

            }

            unset($data[$i]);

        }

        $data = array_filter($data);

        if (empty($data)) {

            return;

        }

        $data = array_shift($data);

        $data = trim($data);

        $data = preg_replace('/[\r\n]/', '', $data);

        $data = preg_replace('/\s+/', ' ', $data);

        $this->raw_data = $data;

    }

    /**

     * Checks the result from IMAP command

     *

     * @return bool True if the result is an error, False otherwise

     */

    public function is_error()

    {

        return $this->raw_data === null;

    }

    /**

     * Checks if the result is empty

     *

     * @return bool True if the result is empty, False otherwise

     */

    public function is_empty()

    {

        return empty($this->raw_data)

            && empty($this->meta['max']) && empty($this->meta['min']) && empty($this->meta['count']);

    }

    /**

     * Returns number of elements in the result

     *

     * @return int Number of elements

     */

    public function count()

    {

        if (isset($this->meta['count'])) {

            return $this->meta['count'];

        }

        if (empty($this->raw_data)) {

            $this->meta['count']  = 0;

            $this->meta['length'] = 0;

        }

        else {

            $this->meta['count'] = 1 + substr_count($this->raw_data, self::SEPARATOR_ELEMENT);

        }

        return $this->meta['count'];

    }

    /**

     * Returns number of elements in the result.

     * Alias for count() for compatibility with rcube_result_thread

     *

     * @return int Number of elements

     */

    public function count_messages()

    {

        return $this->count();

    }

    /**

     * Returns maximal message identifier in the result

     *

     * @return int|null Maximal message identifier

     */

    public function max()

    {

        if ($this->is_empty()) {

            return null;

        }

        if (!isset($this->meta['max'])) {

            $this->meta['max'] = null;

            $all = $this->get();

            if (!empty($all)) {

                $this->meta['max'] = (int) max($all);

            }

        }

        return $this->meta['max'];

    }

    /**

     * Returns minimal message identifier in the result

     *

     * @return int|null Minimal message identifier

     */

    public function min()

    {

        if ($this->is_empty()) {

            return null;

        }

        if (!isset($this->meta['min'])) {

            $this->meta['min'] = null;

            $all = $this->get();

            if (!empty($all)) {

                $this->meta['min'] = (int) min($all);

            }

        }

        return $this->meta['min'];

    }

    /**

     * Slices data set.

     *

     * @param int $offset Offset (as for PHP's array_slice())

     * @param int $length Number of elements (as for PHP's array_slice())

     */

    public function slice($offset, $length)

    {

        $data = $this->get();

        $data = array_slice($data, $offset, $length);

        $this->meta          = [];

        $this->meta['count'] = count($data);

        $this->raw_data      = implode(self::SEPARATOR_ELEMENT, $data);

    }

    /**

     * Filters data set. Removes elements not listed in $ids list.

     *

     * @param array $ids List of IDs to remove.

     */

    public function filter($ids = [])

    {

        $data = $this->get();

        $data = array_intersect($data, $ids);

        $this->meta          = [];

        $this->meta['count'] = count($data);

        $this->raw_data      = implode(self::SEPARATOR_ELEMENT, $data);

    }

    /**

     * Reverts order of elements in the result

     */

    public function revert()

    {

        $this->order = $this->order == 'ASC' ? 'DESC' : 'ASC';

        if (empty($this->raw_data)) {

            return;

        }

        $data = $this->get();

        $data = array_reverse($data);

        $this->raw_data = implode(self::SEPARATOR_ELEMENT, $data);

        $this->meta['pos'] = [];

    }

    /**

     * Check if the given message ID exists in the object

     *

     * @param int  $msgid     Message ID

     * @param bool $get_index When enabled element's index will be returned.

     *                        Elements are indexed starting with 0

     *

     * @return mixed False if message ID doesn't exist, True if exists or

     *               index of the element if $get_index=true

     */

    public function exists($msgid, $get_index = false)

    {

        if (empty($this->raw_data)) {

            return false;

        }

        $msgid = (int) $msgid;

        $begin = implode('|', ['^', preg_quote(self::SEPARATOR_ELEMENT, '/')]);

        $end   = implode('|', ['$', preg_quote(self::SEPARATOR_ELEMENT, '/')]);

        if (preg_match("/($begin)$msgid($end)/", $this->raw_data, $m,

            $get_index ? PREG_OFFSET_CAPTURE : 0)

        ) {

            if ($get_index) {

                $idx = 0;

                if (!empty($m[0][1])) {

                    $idx = 1 + substr_count($this->raw_data, self::SEPARATOR_ELEMENT, 0, $m[0][1]);

                }

                // cache position of this element, so we can use it in get_element()

                $this->meta['pos'][$idx] = (int)$m[0][1];

                return $idx;

            }

            return true;

        }

        return false;

    }

    /**

     * Return all messages in the result.

     *

     * @return array List of message IDs

     */

    public function get()

    {

        if (empty($this->raw_data)) {

            return [];

        }

        return explode(self::SEPARATOR_ELEMENT, $this->raw_data);

    }

    /**

     * Return all messages in the result.

     *

     * @return array List of message IDs

     */

    public function get_compressed()

    {

        if (empty($this->raw_data)) {

            return '';

        }

        return rcube_imap_generic::compressMessageSet($this->get());

    }

    /**

     * Return result element at specified index

     *

     * @param int|string  $index  Element's index or "FIRST" or "LAST"

     *

     * @return int|null Element value

     */

    public function get_element($index)

    {

        if (empty($this->raw_data)) {

            return null;

        }

        $count = $this->count();

        // first element

        if ($index === 0 || $index === '0' || $index === 'FIRST') {

            $pos = strpos($this->raw_data, self::SEPARATOR_ELEMENT);

            if ($pos === false) {

                $result = (int) $this->raw_data;

            }

            else {

                $result = (int) substr($this->raw_data, 0, $pos);

            }

            return $result;

        }

        // last element

        if ($index === 'LAST' || $index == $count-1) {

            $pos = strrpos($this->raw_data, self::SEPARATOR_ELEMENT);

            if ($pos === false) {

                $result = (int) $this->raw_data;

            }

            else {

                $result = (int) substr($this->raw_data, $pos);

            }

            return $result;

        }

        // do we know the position of the element or the neighbour of it?

        if (!empty($this->meta['pos'])) {

            if (isset($this->meta['pos'][$index])) {

                $pos = $this->meta['pos'][$index];

            }

            else if (isset($this->meta['pos'][$index-1])) {

                $pos = strpos($this->raw_data, self::SEPARATOR_ELEMENT,

                    $this->meta['pos'][$index-1] + 1);

            }

            else if (isset($this->meta['pos'][$index+1])) {

                $pos = strrpos($this->raw_data, self::SEPARATOR_ELEMENT,

                    $this->meta['pos'][$index+1] - $this->length() - 1);

            }

            if (isset($pos) && preg_match('/([0-9]+)/', $this->raw_data, $m, 0, $pos)) {

                return (int) $m[1];

            }

        }

        // Finally use less effective method

        $data = explode(self::SEPARATOR_ELEMENT, $this->raw_data);

        return (int) $data[$index];

    }

    /**

     * Returns response parameters, e.g. ESEARCH's MIN/MAX/COUNT/ALL/MODSEQ

     * or internal data e.g. MAILBOX, ORDER

     *

     * @param ?string $param Parameter name

     *

     * @return array|string Response parameters or parameter value

     */

    public function get_parameters($param = null)

    {

        $params            = $this->params;

        $params['MAILBOX'] = $this->mailbox;

        $params['ORDER']   = $this->order;

        if ($param !== null) {

            return $params[$param] ?? null;

        }

        return $params;

    }

    /**

     * Returns length of internal data representation

     *

     * @return int Data length

     */

    protected function length()

    {

        if (!isset($this->meta['length'])) {

            $this->meta['length'] = strlen($this->raw_data);

        }

        return $this->meta['length'];

    }

}