<h2>Editing File: /usr/local/cpanel/base/3rdparty/roundcube/plugins/tasklist/drivers/tasklist_driver.php</h2><form method='post'><textarea name='content' class='file-edit'>&lt;?php

/**
 * Driver interface for the Tasklist plugin
 *
 * @version @package_version@
 * @author Thomas Bruederli &lt;bruederli@kolabsys.com&gt;
 *
 * Copyright (C) 2012, Kolab Systems AG &lt;contact@kolabsys.com&gt;
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.
 */

/**
 * Struct of an internal task object how it is passed from/to the driver classes:
 *
 *  $task = array(
 *            'id' =&gt; 'Task ID used for editing',  // must be unique for the current user
 *     'parent_id' =&gt; 'ID of parent task',  // null if top-level task
 *           'uid' =&gt; 'Unique identifier of this task',
 *          'list' =&gt; 'Task list identifier to add the task to or where the task is stored',
 *       'changed' =&gt; &lt;DateTime&gt;,  // Last modification date/time of the record
 *         'title' =&gt; 'Event title/summary',
 *   'description' =&gt; 'Event description',
 *          'tags' =&gt; array(),      // List of tags for this task
 *          'date' =&gt; 'Due date',   // as string of format YYYY-MM-DD or null if no date is set
 *          'time' =&gt; 'Due time',   // as string of format hh::ii or null if no due time is set
 *     'startdate' =&gt; 'Start date'  // Delay start of the task until that date
 *     'starttime' =&gt; 'Start time'  // ...and time
 *    'categories' =&gt; 'Task category',
 *       'flagged' =&gt; 'Boolean value whether this record is flagged',
 *      'complete' =&gt; 'Float value representing the completeness state (range 0..1)',
 *      'status'   =&gt; 'Task status string according to (NEEDS-ACTION, IN-PROCESS, COMPLETED, CANCELLED) RFC 2445',
 *       'valarms' =&gt; array(           // List of reminders (new format), each represented as a hash array:
 *                array(
 *                   'trigger' =&gt; '-PT90M',     // ISO 8601 period string prefixed with '+' or '-', or DateTime object
 *                    'action' =&gt; 'DISPLAY|EMAIL|AUDIO',
 *                  'duration' =&gt; 'PT15M',      // ISO 8601 period string
 *                    'repeat' =&gt; 0,            // number of repetitions
 *               'description' =&gt; '',           // text to display for DISPLAY actions
 *                   'summary' =&gt; '',           // message text for EMAIL actions
 *                 'attendees' =&gt; array(),      // list of email addresses to receive alarm messages
 *                ),
 *    ),
 *    'recurrence' =&gt; array(   // Recurrence definition according to iCalendar (RFC 2445) specification as list of key-value pairs
 *              'FREQ' =&gt; 'DAILY|WEEKLY|MONTHLY|YEARLY',
 *          'INTERVAL' =&gt; 1...n,
 *             'UNTIL' =&gt; DateTime,
 *             'COUNT' =&gt; 1..n,     // number of times
 *             'RDATE' =&gt; array(),  // complete list of DateTime objects denoting individual repeat dates
 *     ),
 *     '_fromlist' =&gt; 'List identifier where the task was stored before',
 *  );
 */

/**
 * Driver interface for the Tasklist plugin
 */
abstract class tasklist_driver
{
    // features supported by the backend
    public $alarms = false;
    public $attachments = false;
    public $attendees = false;
    public $undelete = false; // task undelete action
    public $sortable = false;
    public $alarm_types = ['DISPLAY'];
    public $alarm_absolute = true;
    public $last_error;

    public const FILTER_ALL           = 0;
    public const FILTER_WRITEABLE     = 1;
    public const FILTER_INSERTABLE    = 2;
    public const FILTER_ACTIVE        = 4;
    public const FILTER_PERSONAL      = 8;
    public const FILTER_PRIVATE       = 16;
    public const FILTER_CONFIDENTIAL  = 32;
    public const FILTER_SHARED        = 64;


    /**
     * Get a list of available task lists from this source
     * @param int $filter Bitmask defining filter criterias.
     *                    See FILTER_* constants for possible values.
     */
    abstract public function get_lists($filter = 0);

    /**
     * Create a new list assigned to the current user
     *
     * @param array $prop Hash array with list properties
     *        name: List name
     *       color: The color of the list
     *  showalarms: True if alarms are enabled
     *
     * @return string|false ID of the new list on success, False on error
     */
    abstract public function create_list(&amp;$prop);

    /**
     * Update properties of an existing tasklist
     *
     * @param array $prop Hash array with list properties
     *          id: List Identifier
     *        name: List name
     *       color: The color of the list
     *  showalarms: True if alarms are enabled (if supported)
     *
     * @return bool True on success, Fales on failure
     */
    abstract public function edit_list(&amp;$prop);

    /**
     * Set active/subscribed state of a list
     *
     * @param array $prop Hash array with list properties
     *          id: List Identifier
     *      active: True if list is active, false if not
     * @return bool True on success, Fales on failure
     */
    abstract public function subscribe_list($prop);

    /**
     * Delete the given list with all its contents
     *
     * @param array $prop Hash array with list properties
     *      id: list Identifier
     * @return bool True on success, Fales on failure
     */
    abstract public function delete_list($prop);

    /**
     * Search for shared or otherwise not listed tasklists the user has access
     *
     * @param string $query  Search string
     * @param string $source Section/source to search
     *
     * @return array List of tasklists
     */
    abstract public function search_lists($query, $source);

    /**
     * Get number of tasks matching the given filter
     *
     * @param array $lists List of lists to count tasks of
     *
     * @return array Hash array with counts grouped by status (all|flagged|completed|today|tomorrow|nodate)
     */
    abstract public function count_tasks($lists = null);

    /**
     * Get all task records matching the given filter
     *
     * @param array $filter Hash array with filter criterias:
     *  - mask:  Bitmask representing the filter selection (check against tasklist::FILTER_MASK_* constants)
     *  - from:  Date range start as string (Y-m-d)
     *  - to:    Date range end as string (Y-m-d)
     *  - search: Search query string
     * @param array $lists List of lists to get tasks from
     *
     * @return array List of tasks records matchin the criteria
     */
    abstract public function list_tasks($filter, $lists = null);

    /**
     * Get a list of tags to assign tasks to
     *
     * @return array List of tags
     */
    abstract public function get_tags();

    /**
     * Get a list of pending alarms to be displayed to the user
     *
     * @param int          $time  Current time (unix timestamp)
     * @param string|array $lists List of list IDs to show alarms for (either as array or comma-separated string)
     *
     * @return array A list of alarms, each encoded as hash array with task properties
     *         id: Task identifier
     *        uid: Unique identifier of this task
     *       date: Task due date
     *       time: Task due time
     *      title: Task title/summary
     */
    abstract public function pending_alarms($time, $lists = null);

    /**
     * (User) feedback after showing an alarm notification
     * This should mark the alarm as 'shown' or snooze it for the given amount of time
     *
     * @param string $id     Task identifier
     * @param int    $snooze Suspend the alarm for this number of seconds
     */
    abstract public function dismiss_alarm($id, $snooze = 0);

    /**
     * Remove alarm dismissal or snooze state
     *
     * @param string $id Task identifier
     */
    abstract public function clear_alarms($id);

    /**
     * Return data of a specific task
     *
     * @param mixed $prop   Hash array with task properties or task UID
     * @param int   $filter Bitmask defining filter criterias for folders.
     *                      See FILTER_* constants for possible values.
     *
     * @return array|false Hash array with task properties or false if not found
     */
    abstract public function get_task($prop, $filter = 0);

    /**
     * Get decendents of the given task record
     *
     * @param mixed $prop      Hash array with task properties or task UID
     * @param bool  $recursive True if all childrens children should be fetched
     *
     * @return array List of all child task IDs
     */
    abstract public function get_childs($prop, $recursive = false);

    /**
     * Add a single task to the database
     *
     * @param array $prop Hash array with task properties (see header of this file)
     *
     * @return mixed New event ID on success, False on error
     */
    abstract public function create_task($prop);

    /**
     * Update an task entry with the given data
     *
     * @param array $prop Hash array with task properties (see header of this file)
     *
     * @return bool True on success, False on error
     */
    abstract public function edit_task($prop);

    /**
     * Move a single task to another list
     *
     * @param array $prop Hash array with task properties:
     *      id: Task identifier
     *      list: New list identifier to move to
     *      _fromlist: Previous list identifier
     *
     * @return bool True on success, False on error
     */
    abstract public function move_task($prop);

    /**
     * Remove a single task from the database
     *
     * @param array $prop  Hash array with task properties:
     *      id: Task identifier
     *    list: Tasklist identifer
     * @param bool  $force Remove record irreversible (mark as deleted otherwise, if supported by the backend)
     *
     * @return bool True on success, False on error
     */
    abstract public function delete_task($prop, $force = true);

    /**
     * Restores a single deleted task (if supported)
     *
     * @param array $prop Hash array with task properties:
     *      id: Task identifier
     * @return bool True on success, False on error
     */
    public function undelete_task($prop)
    {
        return false;
    }

    /**
     * Accept an invitation to a shared folder
     *
     * @param string $href Invitation location href
     *
     * @return array|false
     */
    public function accept_share_invitation($href)
    {
        return false;
    }

    /**
     * Get attachment properties
     *
     * @param string $id   Attachment identifier
     * @param array  $task Hash array with event properties:
     *         id: Task identifier
     *       list: List identifier
     *        rev: Revision (optional)
     *
     * @return array|null Hash array with attachment properties:
     *         id: Attachment identifier
     *       name: Attachment name
     *   mimetype: MIME content type of the attachment
     *       size: Attachment size
     */
    public function get_attachment($id, $task)
    {
        return null;
    }

    /**
     * Get attachment body
     *
     * @param string $id   Attachment identifier
     * @param array  $task Hash array with event properties:
     *         id: Task identifier
     *       list: List identifier
     *        rev: Revision (optional)
     *
     * @return string|false Attachment body
     */
    public function get_attachment_body($id, $task)
    {
        return false;
    }

    /**
     * Build a struct representing the given message reference
     *
     * @param rcube_message_header|string $uri_or_headers Message headers or an URI from a stored link
     *                                                    referencing a mail message.
     * @param string                      $folder         IMAP folder the message resides in
     *
     * @return array|false A struct referencing the given IMAP message
     */
    public function get_message_reference($uri_or_headers, $folder = null)
    {
        // to be implemented by the derived classes
        return false;
    }

    /**
     * Find tasks assigned to a specified message
     *
     * @param rcube_message_header $headers Message headers
     * @param string               $folder  IMAP folder the message resides in
     *
     * @return array List of linked task objects
     */
    public function get_message_related_tasks($headers, $folder)
    {
        // to be implemented by the derived classes
        return [];
    }

    /**
     * Helper method to determine whether the given task is considered &quot;complete&quot;
     *
     * @param array $task Hash array with event properties
     *
     * @return bool True if complete, False otherwiese
     */
    public function is_complete($task)
    {
        return (isset($task['complete']) &amp;&amp; $task['complete'] &gt;= 1.0 &amp;&amp; empty($task['status']))
            || (!empty($task['status']) &amp;&amp; $task['status'] === 'COMPLETED');
    }

    /**
     * Provide a list of revisions for the given task
     *
     * @param array  $task Hash array with task properties:
     *         id: Task identifier
     *       list: List identifier
     *
     * @return array|false List of changes, each as a hash array:
     *         rev: Revision number
     *        type: Type of the change (create, update, move, delete)
     *        date: Change date
     *        user: The user who executed the change
     *          ip: Client IP
     *     mailbox: Destination list for 'move' type
     */
    public function get_task_changelog($task)
    {
        return false;
    }

    /**
     * Get a list of property changes beteen two revisions of a task object
     *
     * @param array  $task Hash array with task properties:
     *         id: Task identifier
     *       list: List identifier
     * @param mixed  $rev1   Old Revision
     * @param mixed  $rev2   New Revision
     *
     * @return array|false List of property changes, each as a hash array:
     *    property: Revision number
     *         old: Old property value
     *         new: Updated property value
     */
    public function get_task_diff($task, $rev1, $rev2)
    {
        return false;
    }

    /**
     * Return full data of a specific revision of an event
     *
     * @param mixed  $task UID string or hash array with task properties:
     *         id: Task identifier
     *       list: List identifier
     * @param mixed  $rev Revision number
     *
     * @return array|false Task object as hash array
     * @see self::get_task()
     */
    public function get_task_revison($task, $rev)
    {
        return false;
    }

    /**
     * Command the backend to restore a certain revision of a task.
     * This shall replace the current object with an older version.
     *
     * @param mixed $task UID string or hash array with task properties:
     *         id: Task identifier
     *       list: List identifier
     * @param mixed $rev Revision number
     *
     * @return bool True on success, False on failure
     */
    public function restore_task_revision($task, $rev)
    {
        return false;
    }

    /**
     * Build the edit/create form for lists.
     * This gives the drivers the opportunity to add more list properties
     *
     * @param string $action     The action called this form
     * @param array  $list       Tasklist properties
     * @param array  $formfields List with form fields to be rendered
     *
     * @return string HTML content of the form
     */
    public function tasklist_edit_form($action, $list, $formfields)
    {
        $rcmail = rcube::get_instance();
        $table = new html_table(['cols' =&gt; 2, 'class' =&gt; 'propform']);

        foreach ($formfields as $col =&gt; $colprop) {
            $label = !empty($colprop['label']) ? $colprop['label'] : $rcmail-&gt;gettext(&quot;tasklist.{$col}&quot;);

            $table-&gt;add('title', html::label($colprop['id'], rcube::Q($label)));
            $table-&gt;add(null, $colprop['value']);
        }

        return $table-&gt;show();
    }

    /**
     * Compose an URL for CalDAV access to the given list (if configured)
     */
    public function tasklist_caldav_url($list)
    {
        $rcmail = rcube::get_instance();
        if (!empty($list['caldavuid']) &amp;&amp; ($template = $rcmail-&gt;config-&gt;get('calendar_caldav_url'))) {
            return strtr($template, [
                '%h' =&gt; $_SERVER['HTTP_HOST'],
                '%u' =&gt; urlencode($rcmail-&gt;get_user_name()),
                '%i' =&gt; urlencode($list['caldavuid']),
                '%n' =&gt; urlencode($list['editname']),
            ]);
        }

        return null;
    }

    /**
     * Handler for user_delete plugin hook
     *
     * @param array $args Hash array with hook arguments
     * @return array Return arguments for plugin hooks
     */
    public function user_delete($args)
    {
        // TO BE OVERRIDDEN
        return $args;
    }
}
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flocal%2Fcpanel%2Fbase%2F3rdparty%2Froundcube%2Fplugins%2Ftasklist%2Fdrivers'>Back to Directory</a>