xref: /plugin/struct/meta/SearchConfig.php (revision bf4e3880a98336c9f3d6e62ad6bdc3ad402ac771) 
1<?php
2
3namespace dokuwiki\plugin\struct\meta;
4
5/**
6 * Class SearchConfig
7 *
8 * The same as @see Search but can be initialized by a configuration array
9 *
10 * @package dokuwiki\plugin\struct\meta
11 */
12class SearchConfig extends Search {
13
14    /** @var int default aggregation caching (depends on last struct save) */
15    static public $CACHE_DEFAULT = 1;
16    /** @var int caching depends on current user */
17    static public $CACHE_USER = 2;
18    /** @var int caching depends on current date */
19    static public $CACHE_DATE = 4;
20
21    /**
22     * @var array hold the configuration as parsed and extended by dynamic params
23     */
24    protected $config;
25
26    /**
27     * @var SearchConfigParameters manages dynamic parameters
28     */
29    protected $dynamicParameters;
30
31    /**
32     * @var int the cache flag to use (binary flags)
33     */
34    protected $cacheFlag;
35
36    /**
37     * SearchConfig constructor.
38     * @param array $config The parsed configuration for this search
39     */
40    public function __construct($config) {
41        parent::__construct();
42
43        // setup schemas and columns
44        if(!empty($config['schemas'])) foreach($config['schemas'] as $schema) {
45            $this->addSchema($schema[0], $schema[1]);
46        }
47        if(!empty($config['cols'])) foreach($config['cols'] as $col) {
48            $this->addColumn($col);
49        }
50
51        // cache flag setting
52        $this->cacheFlag = self::$CACHE_DEFAULT;
53        if(!empty($config['filters'])) $this->cacheFlag = $this->determineCacheFlag($config['filters']);
54
55        // apply dynamic paramters
56        $this->dynamicParameters = new SearchConfigParameters($this);
57        $config = $this->dynamicParameters->updateConfig($config);
58
59        // configure search from configuration
60        if(!empty($config['filter'])) foreach($config['filter'] as $filter) {
61            $this->addFilter($filter[0], $this->applyFilterVars($filter[2]), $filter[1], $filter[3]);
62        }
63
64        if(!empty($config['sort'])) foreach($config['sort'] as $sort) {
65            $this->addSort($sort[0], $sort[1]);
66        }
67
68        if(!empty($config['limit'])) {
69            $this->setLimit($config['limit']);
70        }
71
72        if(!empty($config['offset'])) {
73            $this->setLimit($config['offset']);
74        }
75
76        $this->config = $config;
77    }
78
79    /**
80     * Set the cache flag accordingly to the set filter placeholders
81     *
82     * @param array $filters
83     * @return int
84     */
85    protected function determineCacheFlag($filters) {
86        $flags = self::$CACHE_DEFAULT;
87
88        foreach($filters as $filter) {
89            if(is_array($filter)) $filter = $filter[2]; // this is the format we get fro the config parser
90
91            if(strpos($filter, '$USER$') !== false) {
92                $flags |= self::$CACHE_USER;
93            } else if(strpos($filter, '$TODAY$') !== false) {
94                $flags |= self::$CACHE_DATE;
95            }
96        }
97
98        return $flags;
99    }
100
101    /**
102     * Replaces placeholders in the given filter value by the proper value
103     *
104     * @param string $filter
105     * @return string
106     */
107    protected function applyFilterVars($filter) {
108        global $ID;
109
110        // apply inexpensive filters first
111        $filter = str_replace(
112            array(
113                '$ID$',
114                '$NS$',
115                '$PAGE$',
116                '$TITLE$',
117                '$USER$',
118                '$TODAY$'
119            ),
120            array(
121                $ID,
122                getNS($ID),
123                noNS($ID),
124                p_get_first_heading($ID) ? p_get_first_heading($ID) : $ID,
125                isset($_SERVER['REMOTE_USER']) ? $_SERVER['REMOTE_USER'] : '',
126                date('Y-m-d')
127            ),
128            $filter
129        );
130
131        // apply struct filter
132        while(preg_match('/\$STRUCT\.(.*?)\$/', $filter, $match)) {
133            $key = $match[1];
134            $column = $this->findColumn($key);
135
136            if($column) {
137                $label = $column->getLabel();
138                $table = $column->getTable();
139                $schemaData = new SchemaData($table, $ID, 0);
140                $schemaData->optionRawValue(true);
141                $data = $schemaData->getDataArray();
142                $value = $data[$label];
143                if(is_array($value)) $value = array_shift($value);
144            } else {
145                $value = '';
146            }
147
148            $key = preg_quote_cb($key);
149            $filter = preg_replace('/\$STRUCT\.' . $key . '\$/', $value, $filter, 1);
150
151        }
152
153        return $filter;
154    }
155
156    /**
157     * @return int cacheflag for this search
158     */
159    public function getCacheFlag() {
160        return $this->cacheFlag;
161    }
162
163    /**
164     * Access the dynamic paramters of this search
165     *
166     * Note: This call returns a clone of the parameters as they were initialized
167     *
168     * @return SearchConfigParameters
169     */
170    public function getDynamicParameters() {
171        return clone $this->dynamicParameters;
172    }
173
174    /**
175     * @return array the current config
176     */
177    public function getConf() {
178        return $this->config;
179    }
180
181}
182