Skip to content
Snippets Groups Projects
class.queue.php 81.3 KiB
Newer Older
  • Learn to ignore specific revisions
  •             if ($include_queue && ($q = $this->getQueue())
                    && ($q_conds = $q->getConditions())
                ) {
                    $this->_conditions = array_merge($this->_conditions, $q_conds);
                }
    
            return $this->_conditions;
        }
    
    
        static function __create($vars) {
    
            $c = new static($vars);
    
            $c->save();
            return $c;
        }
    
    
        static function placeholder($vars) {
            return static::__hydrate($vars);
        }
    
    
        function update($vars, $root='Ticket') {
    
            $form = $this->getDataConfigForm($vars);
            foreach ($form->getClean() as $k=>$v)
                $this->set($k, $v);
    
            // Do the annotations
            $this->_annotations = $annotations = array();
            if (isset($vars['annotations'])) {
                foreach (@$vars['annotations'] as $i=>$class) {
                    if ($vars['deco_column'][$i] != $this->id)
                        continue;
                    if (!class_exists($class) || !is_subclass_of($class, 'QueueColumnAnnotation'))
                        continue;
                    $json = array('c' => $class, 'p' => $vars['deco_pos'][$i]);
                    $annotations[] = $json;
                    $this->_annotations[] = QueueColumnAnnotation::fromJson($json);
                }
    
    
            // Do the conditions
    
            $this->_conditions = $conditions = array();
            if (isset($vars['conditions'])) {
    
                list($this->_conditions, $conditions)
                    = self::getConditionsFromPost($vars, $this->id, $root);
    
            // Store as JSON array
    
            $this->annotations = JsonDataEncoder::encode($annotations);
            $this->conditions = JsonDataEncoder::encode($conditions);
        }
    
    
        static function getConditionsFromPost(array $vars, $myid, $root='Ticket') {
            $condition_objects = $conditions = array();
    
            if (!isset($vars['conditions']))
                return array($condition_objects, $conditions);
    
            foreach (@$vars['conditions'] as $i=>$id) {
                if ($vars['condition_column'][$i] != $myid)
                    // Not a condition for this column
                    continue;
                // Determine the criteria
                $name = $vars['condition_field'][$i];
                $fields = CustomQueue::getSearchableFields($root);
                if (!isset($fields[$name]))
                    // No such field exists for this queue root type
                    continue;
                $parts = CustomQueue::getSearchField($fields[$name], $name);
                $search_form = new SimpleForm($parts, $vars, array('id' => $id));
                $search_form->getField("{$name}+search")->value = true;
                $crit = $search_form->getClean();
                // Check the box to enable searching on the field
                $crit["{$name}+search"] = true;
    
                // Isolate only the critical parts of the criteria
                $crit = QueueColumnCondition::isolateCriteria($crit);
    
                // Determine the properties
                $props = array();
                foreach ($vars['properties'] as $i=>$cid) {
                    if ($cid != $id)
                        // Not a property for this condition
                        continue;
    
                    // Determine the property configuration
                    $prop = $vars['property_name'][$i];
                    if (!($F = QueueColumnConditionProperty::getField($prop))) {
                        // Not a valid property
                        continue;
                    }
                    $prop_form = new SimpleForm(array($F), $vars, array('id' => $cid));
                    $props[$prop] = $prop_form->getField($prop)->getClean();
                }
                $json = array('crit' => $crit, 'prop' => $props);
                $condition_objects[] = QueueColumnCondition::fromJson($json);
                $conditions[] = $json;
            }
            return array($condition_objects, $conditions);
        }
    
    Peter Rotich's avatar
    Peter Rotich committed
    class QueueExport
    extends VerySimpleModel {
        static $meta = array(
            'table' => QUEUE_EXPORT_TABLE,
            'pk' => array('id'),
            'joins' => array(
                'queue' => array(
                    'constraint' => array('queue_id' => 'CustomQueue.id'),
                ),
            ),
            'select_related' => array('queue'),
            'ordering' => array('sort'),
        );
    
    
        function getPath() {
            return $this->path;
        }
    
        function getField() {
            return $this->getPath();
        }
    
        function getHeading() {
            return $this->heading;
        }
    
        static function create($vars=false) {
            $inst = new static($vars);
            return $inst;
        }
    }
    
    
    class QueueColumnGlue
    extends VerySimpleModel {
        static $meta = array(
            'table' => QUEUE_COLUMN_TABLE,
            'pk' => array('queue_id', 'column_id'),
            'joins' => array(
                'column' => array(
                    'constraint' => array('column_id' => 'QueueColumn.id'),
                ),
                'queue' => array(
                    'constraint' => array('queue_id' => 'CustomQueue.id'),
                ),
            ),
            'select_related' => array('column', 'queue'),
            'ordering' => array('sort'),
        );
    }
    
    
    class QueueColumnGlueMIM
    extends ModelInstanceManager {
    
        function getOrBuild($modelClass, $fields, $cache=true) {
            $m = parent::getOrBuild($modelClass, $fields, $cache);
            if ($m && $modelClass === 'QueueColumnGlue') {
                // Instead, yield the QueueColumn instance with the local fields
    
                // in the association table as annotations
    
                $m = AnnotatedModel::wrap($m->column, $m, 'QueueColumn');
            }
            return $m;
        }
    
    }
    
    class QueueColumnListBroker
    extends InstrumentedList {
        function __construct($fkey, $queryset=false) {
            parent::__construct($fkey, $queryset, 'QueueColumnGlueMIM');
            $this->queryset->select_related('column');
        }
    
        function add($column, $glue=null, $php7_is_annoying=true) {
    
            $glue = $glue ?: new QueueColumnGlue();
    
            $glue->column = $column;
    
            $anno = AnnotatedModel::wrap($column, $glue);
    
            parent::add($anno, false);
    
    class QueueSort
    extends VerySimpleModel {
        static $meta = array(
            'table' => QUEUE_SORT_TABLE,
            'pk' => array('id'),
            'ordering' => array('name'),
            'joins' => array(
                'queue' => array(
                    'constraint' => array('queue_id' => 'CustomQueue.id'),
                ),
            ),
        );
    
        var $_columns;
    
        function getRoot($hint=false) {
            switch ($hint ?: $this->root) {
            case 'T':
            default:
                return 'Ticket';
            }
        }
    
        function getName() {
            return $this->name;
        }
    
        function getId() {
            return $this->id;
        }
    
        function applySort(QuerySet $query, $reverse=false, $root=false) {
            $fields = CustomQueue::getSearchableFields($this->getRoot($root));
            foreach ($this->getColumnPaths() as $path=>$descending) {
                $descending = $reverse ? !$descending : $descending;
                if (isset($fields[$path])) {
                    list(,$field) = $fields[$path];
                    $query = $field->applyOrderBy($query, $descending,
                        CustomQueue::getOrmPath($path, $query));
                }
            }
            return $query;
        }
    
        function getColumnPaths() {
            if (!isset($this->_columns)) {
                $columns = array();
                foreach (JsonDataParser::decode($this->columns) as $path) {
                    if ($descending = $path[0] == '-')
                        $path = substr($path, 1);
                    $columns[$path] = $descending;
                }
                $this->_columns = $columns;
            }
            return $this->_columns;
        }
    
        function getColumns() {
            $columns = array();
            $paths = $this->getColumnPaths();
            $everything = CustomQueue::getSearchableFields($this->getRoot());
            foreach ($paths as $p=>$descending) {
                if (isset($everything[$p])) {
                    $columns[$p] = array($everything[$p], $descending);
                }
            }
            return $columns;
        }
    
        function getDataConfigForm($source=false) {
            return new QueueSortDataConfigForm($source ?: $this->getDbFields(),
                array('id' => $this->id));
        }
    
        static function forQueue(CustomQueue $queue) {
            return static::objects()->filter([
    
                'root' => $queue->root ?: 'T',
    
            ]);
        }
    
        function save($refetch=false) {
            if ($this->dirty)
                $this->updated = SqlFunction::NOW();
            return parent::save($refetch || $this->dirty);
        }
    
        function update($vars, &$errors=array()) {
            if (!isset($vars['name']))
                $errors['name'] = __('A title is required');
    
            $this->name = $vars['name'];
            if (isset($vars['root']))
                $this->root = $vars['root'];
            elseif (!isset($this->root))
                $this->root = 'T';
    
            $fields = CustomQueue::getSearchableFields($this->getRoot($vars['root']));
            $columns = array();
            if (@is_array($vars['columns'])) {
                foreach ($vars['columns']as $path=>$info) {
                    $descending = (int) @$info['descending'];
                    // TODO: Check if column is valid, stash in $columns
                    if (!isset($fields[$path]))
                        continue;
                    $columns[] = ($descending ? '-' : '') . $path;
                }
                $this->columns = JsonDataEncoder::encode($columns);
            }
    
            if (count($errors))
                return false;
    
            return $this->save();
        }
    
        static function __create($vars) {
            $c = new static($vars);
            $c->save();
            return $c;
        }
    }
    
    class QueueSortGlue
    extends VerySimpleModel {
        static $meta = array(
            'table' => QUEUE_SORTING_TABLE,
            'pk' => array('sort_id', 'queue_id'),
            'joins' => array(
                'ordering' => array(
                    'constraint' => array('sort_id' => 'QueueSort.id'),
                ),
                'queue' => array(
                    'constraint' => array('queue_id' => 'CustomQueue.id'),
                ),
            ),
            'select_related' => array('ordering', 'queue'),
            'ordering' => array('sort'),
        );
    }
    
    class QueueSortGlueMIM
    extends ModelInstanceManager {
        function getOrBuild($modelClass, $fields, $cache=true) {
            $m = parent::getOrBuild($modelClass, $fields, $cache);
            if ($m && $modelClass === 'QueueSortGlue') {
                // Instead, yield the QueueColumn instance with the local fields
                // in the association table as annotations
                $m = AnnotatedModel::wrap($m->ordering, $m, 'QueueSort');
            }
            return $m;
        }
    }
    
    class QueueSortListBroker
    extends InstrumentedList {
        function __construct($fkey, $queryset=false) {
            parent::__construct($fkey, $queryset, 'QueueSortGlueMIM');
            $this->queryset->select_related('ordering');
        }
    
        function add($ordering, $glue=null, $php7_is_annoying=true) {
            $glue = $glue ?: new QueueSortGlue();
            $glue->ordering = $ordering;
            $anno = AnnotatedModel::wrap($ordering, $glue);
            parent::add($anno, false);
            return $anno;
        }
    }
    
    
    abstract class QueueColumnFilter {
        static $registry;
    
        static $id = null;
        static $desc = null;
    
    
        static function register($filter, $group) {
    
            if (!isset($filter::$id))
                throw new Exception('QueueColumnFilter must define $id');
            if (isset(static::$registry[$filter::$id]))
                throw new Exception($filter::$id
                    . ': QueueColumnFilter already registered under that id');
            if (!is_subclass_of($filter, get_called_class()))
                throw new Exception('Filter must extend QueueColumnFilter');
    
    
            static::$registry[$filter::$id] = array($group, $filter);
    
        }
    
        static function getFilters() {
    
            $list = static::$registry;
            $base = array();
            foreach ($list as $id=>$stuff) {
                list($group, $class) = $stuff;
                $base[$group][$id] = __($class::$desc);
    
            }
            return $base;
        }
    
        static function getInstance($id) {
    
            if (isset(static::$registry[$id])) {
    
                list(, $class) = @static::$registry[$id];
                if ($class && class_exists($class))
                    return new $class();
    
        }
    
        function mangleQuery($query, $column) { return $query; }
    
        abstract function filter($value, $row);
    }
    
    class TicketLinkFilter
    extends QueueColumnFilter {
        static $id = 'link:ticket';
        static $desc = /* @trans */ "Ticket Link";
    
        function filter($text, $row) {
    
            if ($link = $this->getLink($row))
    
                return sprintf('<a style="display:inline" href="%s">%s</a>', $link, $text);
    
        }
    
        function mangleQuery($query, $column) {
            static $fields = array(
                'link:ticket'   => 'ticket_id',
                'link:ticketP'  => 'ticket_id',
                'link:user'     => 'user_id',
                'link:org'      => 'user__org_id',
            );
    
            if (isset($fields[static::$id])) {
                $query = $query->values($fields[static::$id]);
            }
            return $query;
        }
    
        function getLink($row) {
            return Ticket::getLink($row['ticket_id']);
        }
    }
    
    class UserLinkFilter
    extends TicketLinkFilter {
        static $id = 'link:user';
        static $desc = /* @trans */ "User Link";
    
        function getLink($row) {
            return User::getLink($row['user_id']);
        }
    }
    
    class OrgLinkFilter
    extends TicketLinkFilter {
        static $id = 'link:org';
        static $desc = /* @trans */ "Organization Link";
    
        function getLink($row) {
    
            return Organization::getLink($row['user__org_id']);
    
    QueueColumnFilter::register('TicketLinkFilter', __('Link'));
    QueueColumnFilter::register('UserLinkFilter', __('Link'));
    QueueColumnFilter::register('OrgLinkFilter', __('Link'));
    
    
    class TicketLinkWithPreviewFilter
    extends TicketLinkFilter {
        static $id = 'link:ticketP';
        static $desc = /* @trans */ "Ticket Link with Preview";
    
        function filter($text, $row) {
            $link = $this->getLink($row);
    
            return sprintf('<a style="display: inline" class="preview" data-preview="#tickets/%d/preview" href="%s">%s</a>',
    
                $row['ticket_id'], $link, $text);
        }
    }
    
    QueueColumnFilter::register('TicketLinkWithPreviewFilter', __('Link'));
    
    class DateTimeFilter
    extends QueueColumnFilter {
        static $id = 'date:full';
        static $desc = /* @trans */ "Date and Time";
    
        function filter($text, $row) {
            return $text->changeTo(Format::datetime($text->value));
        }
    }
    
    class HumanizedDateFilter
    extends QueueColumnFilter {
        static $id = 'date:human';
        static $desc = /* @trans */ "Relative Date and Time";
    
        function filter($text, $row) {
            return sprintf(
                '<time class="relative" datetime="%s" title="%s">%s</time>',
                date(DateTime::W3C, Misc::db2gmtime($text->value)),
                Format::daydatetime($text->value),
                Format::relativeTime(Misc::db2gmtime($text->value))
            );
        }
    }
    QueueColumnFilter::register('DateTimeFilter', __('Date Format'));
    QueueColumnFilter::register('HumanizedDateFilter', __('Date Format'));
    
    class QueueColDataConfigForm
    extends AbstractForm {
    
        function buildFields() {
            return array(
                'primary' => new DataSourceField(array(
                    'label' => __('Primary Data Source'),
    
                    'required' => true,
    
                    'configuration' => array(
                        'root' => 'Ticket',
                    ),
                    'layout' => new GridFluidCell(6),
                )),
                'secondary' => new DataSourceField(array(
                    'label' => __('Secondary Data Source'),
                    'configuration' => array(
                        'root' => 'Ticket',
                    ),
                    'layout' => new GridFluidCell(6),
                )),
                'name' => new TextboxField(array(
                    'label' => __('Name'),
                    'required' => true,
                    'layout' => new GridFluidCell(4),
    
                'filter' => new ChoiceField(array(
                    'label' => __('Filter'),
    
                    'required' => false,
    
                    'choices' => QueueColumnFilter::getFilters(),
    
                    'layout' => new GridFluidCell(4),
    
                )),
                'truncate' => new ChoiceField(array(
                    'label' => __('Text Overflow'),
                    'choices' => array(
                        'wrap' => __("Wrap Lines"),
                        'ellipsis' => __("Add Ellipsis"),
                        'clip' => __("Clip Text"),
    
                        'lclip' => __("Clip Beginning Text"),
    
                    ),
                    'default' => 'wrap',
    
                    'layout' => new GridFluidCell(4),
    
    
    class QueueSortDataConfigForm
    extends AbstractForm {
        function getInstructions() {
    
            return __('Add, and remove the fields in this list using the options below. Sorting can be performed on any field, whether displayed in the queue or not.');
    
        }
    
        function buildFields() {
            return array(
                'name' => new TextboxField(array(
                    'required' => true,
                    'layout' => new GridFluidCell(12),
                    'translatable' => isset($this->options['id'])
                        ? _H('queuesort.name.'.$this->options['id']) : false,
                    'configuration' => array(
                        'placeholder' => __('Sort Criteria Title'),
                    ),
                )),
            );
        }
    }