xref: /plugin/struct/syntax/table.php (revision fd81b928afb513ef792d1537a28003c99cab3622) 
1<?php
2/**
3 * DokuWiki Plugin struct (Syntax Component)
4 *
5 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
6 * @author  Andreas Gohr, Michael Große <dokuwiki@cosmocode.de>
7 */
8
9// must be run within Dokuwiki
10use plugin\struct\meta\Column;
11use plugin\struct\meta\ConfigParser;
12use plugin\struct\meta\Search;
13use plugin\struct\meta\SearchConfig;
14use plugin\struct\meta\SearchException;
15use plugin\struct\meta\StructException;
16
17if (!defined('DOKU_INC')) die();
18
19class syntax_plugin_struct_table extends DokuWiki_Syntax_Plugin {
20    /**
21     * @return string Syntax mode type
22     */
23    public function getType() {
24        return 'substition';
25    }
26    /**
27     * @return string Paragraph type
28     */
29    public function getPType() {
30        return 'block';
31    }
32    /**
33     * @return int Sort order - Low numbers go before high numbers
34     */
35    public function getSort() {
36        return 155;
37    }
38
39    /**
40     * Connect lookup pattern to lexer.
41     *
42     * @param string $mode Parser mode
43     */
44    public function connectTo($mode) {
45        $this->Lexer->addSpecialPattern('----+ *struct table *-+\n.*?\n----+', $mode, 'plugin_struct_table');
46    }
47
48
49    /**
50     * Handle matches of the struct syntax
51     *
52     * @param string $match The match of the syntax
53     * @param int    $state The state of the handler
54     * @param int    $pos The position in the document
55     * @param Doku_Handler    $handler The handler
56     * @return array Data for the renderer
57     */
58    public function handle($match, $state, $pos, Doku_Handler $handler){
59
60        $lines = explode("\n", $match);
61        array_shift($lines);
62        array_pop($lines);
63
64        try {
65            $parser = new ConfigParser($lines);
66            return  $parser->getConfig();
67        } catch (StructException $e) {
68            msg($e->getMessage(), -1, $e->getLine(), $e->getFile());
69            return null;
70        }
71    }
72
73    protected $sums = array();
74
75    /**
76     * Render xhtml output or metadata
77     *
78     * @param string         $mode      Renderer mode (supported modes: xhtml)
79     * @param Doku_Renderer  $renderer  The renderer
80     * @param array          $data      The data from the handler() function
81     * @return bool If rendering was successful.
82     */
83    public function render($mode, Doku_Renderer $renderer, $data) {
84        if($mode != 'xhtml') return false;
85        if(!$data) return false;
86
87        //reset counters
88        $this->sums = array();
89
90        try {
91            $search = new SearchConfig($data);
92            $data = $search->getConf();
93            $rows = $search->execute();
94            $cnt = $search->getCount();
95            $cols = $search->getColumns();
96
97            if ($cnt === 0) {
98                $this->nullList($data, $mode, $renderer);
99                return true;
100            }
101
102            $this->renderPreTable($mode, $renderer, $data, $cols);
103            $this->renderRows($mode, $renderer, $data, $rows);
104            $this->renderPostTable($mode, $renderer, $data, $cnt);
105        } catch (StructException $e) {
106            msg($e->getMessage(), -1, $e->getLine(), $e->getFile());
107        }
108
109        return true;
110    }
111
112    /**
113     * create the pretext to the actual table rows
114     *
115     * @param string $mode
116     * @param Doku_Renderer $renderer
117     * @param array $data the configuration data
118     * @param Column[] $cols
119     */
120    protected function renderPreTable($mode, Doku_Renderer $renderer, $data, $cols) {
121        $this->startScope($mode, $renderer, md5(serialize($data)));
122        $this->showActiveFilters($mode, $renderer);
123        $this->startTable($mode, $renderer);
124        $renderer->tablethead_open();
125        $this->buildColumnHeaders($mode, $renderer, $data, $cols);
126        $this->addDynamicFilters($mode, $renderer, $data);
127        $renderer->tablethead_close();
128    }
129
130    /**
131     * @param array $data
132     * @param int $rowcnt
133     *
134     * @return string
135     */
136    private function renderPostTable($mode, Doku_Renderer $renderer, $data, $rowcnt) {
137        $this->summarize($mode, $renderer, $data, $this->sums);
138        $this->addLimitControls($mode, $renderer, $data, $rowcnt);
139        $this->finishTableAndScope($mode, $renderer);
140    }
141
142    /**
143     * if limit was set, add control
144     *
145     * @param string        $mode     the mode of the renderer
146     * @param Doku_Renderer $renderer the renderer
147     * @param array         $data     the configuration of the table/search
148     * @param               $rowcnt
149     */
150    protected function addLimitControls($mode, Doku_Renderer $renderer, $data, $rowcnt) {
151        global $ID;
152
153        if($data['limit']) {
154            $renderer->tablerow_open();
155            $renderer->tableheader_open((count($data['cols']) + ($data['rownumbers'] ? 1 : 0)));
156            $offset = (int) $_REQUEST['dataofs'];
157
158            // keep url params
159            $params = array();
160            if (!empty($data['current_params']['dataflt'])) {$params['dataflt'] = $data['current_params']['dataflt'];}
161            if (!empty($data['current_params']['datasrt'])) {$params['datasrt'] = $data['current_params']['datasrt'];}
162
163            if($offset) {
164                $prev = $offset - $data['limit'];
165                if($prev < 0) {
166                    $prev = 0;
167                }
168                $params['dataofs'] = $prev;
169                $renderer->internallink($ID . '?' . http_build_query($params), $this->getLang('prev'));
170            }
171
172            if($rowcnt > $offset + $data['limit']) {
173                $next = $offset + $data['limit'];
174                $params['dataofs'] = $next;
175                $renderer->internallink($ID . '?' . http_build_query($params), $this->getLang('next'));
176            }
177            $renderer->tableheader_close();
178            $renderer->tablerow_close();
179        }
180    }
181
182    /**
183     * @param string        $mode     the mode of the renderer
184     * @param Doku_Renderer $renderer the renderer
185     */
186    protected function showActiveFilters($mode, Doku_Renderer $renderer) {
187        global $ID;
188
189        if($mode == 'xhtml' && !empty($data['current_params']['dataflt'])) {
190            $filters = $data['current_params']['dataflt'];
191            $confHelper = $this->loadHelper('struct_config');
192            $fltrs = array();
193            foreach($filters as $colcomp => $filter) {
194                $filter = $confHelper->parseFilterLine('', $colcomp.$filter);
195                if(strpos($filter[1], '~') !== false) {
196                    if(strpos($filter[1], '!~') !== false) {
197                        $comparator_value = '!~' . str_replace('%', '*', $filter[2]);
198                    } else {
199                        $comparator_value = '~' . str_replace('%', '', $filter[2]);
200                    }
201                    $fltrs[] = $filter[0] . $comparator_value;
202                } else {
203                    $fltrs[] = $filter[0] . $filter[1] . $filter[2];
204                }
205            }
206
207            $renderer->doc .= '<div class="filter">';
208            $renderer->doc .= '<h4>' . sprintf($this->getLang('tablefilteredby'), hsc(implode(' & ', $fltrs))) . '</h4>';
209            $renderer->doc .= '<div class="resetfilter">';
210            $renderer->internallink($ID, $this->getLang('tableresetfilter'));
211            $renderer->doc .=  '</div>';
212            $renderer->doc .= '</div>';
213        }
214    }
215
216    /**
217     * @param string        $mode     the mode of the renderer
218     * @param Doku_Renderer $renderer the renderer
219     * @param array         $data     the configuration of the table/search
220     */
221    protected function addDynamicFilters($mode, Doku_Renderer $renderer, $data) {
222        if ($mode != 'xhtml') return;
223
224        global $conf, $ID;
225
226        $cur_params = $data['current_params'];
227        $html = '';
228        if($data['dynfilters']) {
229            $html .= '<tr class="dataflt">';
230
231            if($data['rownumbers']) {
232                $html .= '<th></th>';
233            }
234
235            foreach($data['headers'] as $num => $head) {
236                $html .= '<th>';
237                $form = new Doku_Form(array('method' => 'GET',));
238                $form->_hidden = array();
239                if(!$conf['userewrite']) {
240                    $form->addHidden('id', $ID);
241                }
242
243                $key = $data['cols'][$num] . '*~';
244                $val = isset($cur_params['dataflt'][$key]) ? $cur_params['dataflt'][$key] : '';
245
246                // Add current request params
247                if (!empty($cur_params['datasrt'])) {
248                    $form->addHidden('datasrt', $cur_params['datasrt']);
249                }
250                if (!empty($cur_params['dataofs'])) {
251                    $form->addHidden('dataofs', $cur_params['dataofs']);
252                }
253                foreach($cur_params['dataflt'] as $c_key => $c_val) {
254                    if($c_val !== '' && $c_key !== $key) {
255                        $form->addHidden('dataflt[' . $c_key . ']', $c_val);
256                    }
257                }
258
259                $form->addElement(form_makeField('text', 'dataflt[' . $key . ']', $val, ''));
260                $html .= $form->getForm();
261                $html .= '</th>';
262            }
263            $html .= '</tr>';
264            $renderer->doc .= $html;
265        }
266    }
267
268    /**
269     * @param string        $mode     the mode of the renderer
270     * @param Doku_Renderer $renderer the renderer
271     */
272    private function startTable($mode, Doku_Renderer $renderer) {
273        $renderer->table_open();
274    }
275
276    /**
277     * @param string $mode the mode of the renderer
278     * @param Doku_Renderer $renderer the renderer
279     * @param array $data the configuration of the table/search
280     * @param Column[] $cols
281     */
282    protected function buildColumnHeaders($mode, Doku_Renderer $renderer, $data, $cols) {
283        global $ID;
284
285        $renderer->tablerow_open();
286
287        if($data['rownumbers']) {
288            $renderer->tableheader_open();
289            $renderer->cdata('#');
290            $renderer->tableheader_close();
291        }
292
293        foreach($data['headers'] as $num => $head) {
294            $ckey = $data['cols'][$num];
295            if(blank($head)) {
296                $head = $cols[$num]->getTranslatedLabel();
297            }
298
299            $width = '';
300            if(isset($data['widths'][$num]) AND $data['widths'][$num] != '-') {
301                $width = ' style="width: ' . $data['widths'][$num] . ';"';
302            }
303            if ($mode == 'xhmtl') {
304                $renderer->doc .= '<th' . $width . '>';
305            } else {
306                $renderer->tableheader_open();
307            }
308
309            // add sort arrow
310            if ($mode == 'xhtml') {
311                if(isset($data['sort']) && $ckey == $data['sort'][0]) {
312                    if($data['sort'][1] == 'ASC') {
313                        $renderer->doc .= '<span>&darr;</span> ';
314                        $ckey = '^' . $ckey;
315                    } else {
316                        $renderer->doc .= '<span>&uarr;</span> ';
317                    }
318                }
319            }
320            $renderer->internallink($ID . "?" . http_build_query(array('datasrt' => $ckey,) + $data['current_params']), hsc($head));
321            $renderer->tableheader_close();
322        }
323        $renderer->tablerow_close();
324    }
325
326    /**
327     * @param string        $mode     the mode of the renderer
328     * @param Doku_Renderer $renderer the renderer
329     * @param string        $hash     hash to identify the table and group images in gallery
330     */
331    protected function startScope($mode, \Doku_Renderer $renderer, $hash) {
332        if ($mode == 'xhtml') {
333            $renderer->doc .= "<div class=\"table structaggregation\">";
334            $renderer->info['struct_table_hash'] = $hash;
335        }
336    }
337
338    /**
339     * if summarize was set, add sums
340     *
341     * @param string        $mode     the mode of the renderer
342     * @param Doku_Renderer $renderer the renderer
343     * @param array         $data     the configuration of the table/search
344     * @param array         $sums     the summarized output of the numerical fields
345     */
346    private function summarize($mode, \Doku_Renderer $renderer, $data, $sums) {
347        if($data['summarize']) {
348            $renderer->tablerow_open();
349            $len = count($data['cols']);
350
351            if($data['rownumbers']) {
352                $renderer->tablecell_open();
353                $renderer->tablecell_close();
354            }
355
356            for($i = 0; $i < $len; $i++) {
357                $renderer->tablecell_open(1, $data['align'][$i]);
358                if(!empty($sums[$i])) {
359                    $renderer->cdata('∑ ' . $sums[$i]);
360                } else {
361                    if ($mode == 'xhtml') {
362                        $renderer->doc .= '&nbsp;';
363                    }
364                }
365                $renderer->tablecell_close();
366            }
367            $renderer->tablerow_close();
368        }
369    }
370
371    /**
372     * @param string        $mode     the mode of the renderer
373     * @param Doku_Renderer $renderer the renderer
374     *
375     */
376    private function finishTableAndScope($mode, Doku_Renderer $renderer) {
377        $renderer->table_close();
378        if ($mode == 'xhtml') {
379            $renderer->doc .= '</div>';
380            if(isset($renderer->info['struct_table_hash'])) {
381                unset($renderer->info['struct_table_hash']);
382            }
383        }
384    }
385
386    /**
387     * @param string        $mode     the mode of the renderer
388     * @param Doku_Renderer $renderer the renderer
389     * @param array         $data     the configuration of the table/search
390     * @param               $rows
391     *
392     */
393    private function renderRows($mode, Doku_Renderer $renderer, $data, $rows) {
394        $renderer->tabletbody_open();
395        foreach($rows as $rownum => $row) {
396            $renderer->tablerow_open();
397
398            if($data['rownumbers']) {
399                $renderer->tablecell_open();
400                $renderer->doc .= $rownum + 1;
401                $renderer->tablecell_close();
402            }
403
404            /** @var plugin\struct\meta\Value $value */
405            foreach($row as $colnum => $value) {
406                $renderer->tablecell_open();
407                $value->render($renderer, $mode);
408                $renderer->tablecell_close();
409
410                // summarize
411                if($data['summarize'] && is_numeric($value->getValue())) {
412                    if(!isset($this->sums[$colnum])) {
413                        $this->sums[$colnum] = 0;
414                    }
415                    $this->sums[$colnum] += $value->getValue();
416                }
417            }
418            $renderer->tablerow_close();
419        }
420        $renderer->tabletbody_close();
421    }
422
423    /**
424     * @param array         $data     the configuration of the table/search
425     * @param string        $mode     the mode of the renderer
426     * @param Doku_Renderer $renderer the renderer
427     */
428    private function nullList($data, $mode, Doku_Renderer $renderer) {
429        $this->renderPreTable($mode, $renderer, $data);
430        $renderer->tablerow_open();
431        $renderer->tablecell_open(count($data['cols']) + $data['rownumbers'], 'center');
432        $renderer->cdata($this->getLang('none'));
433        $renderer->tablecell_close();
434        $renderer->tablerow_close();
435        $renderer->table_close();
436    }
437}
438
439// vim:ts=4:sw=4:et:
440