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\SearchConfig; 13use plugin\struct\meta\StructException; 14 15if (!defined('DOKU_INC')) die(); 16 17class syntax_plugin_struct_table extends DokuWiki_Syntax_Plugin { 18 /** 19 * @return string Syntax mode type 20 */ 21 public function getType() { 22 return 'substition'; 23 } 24 /** 25 * @return string Paragraph type 26 */ 27 public function getPType() { 28 return 'block'; 29 } 30 /** 31 * @return int Sort order - Low numbers go before high numbers 32 */ 33 public function getSort() { 34 return 155; 35 } 36 37 /** 38 * Connect lookup pattern to lexer. 39 * 40 * @param string $mode Parser mode 41 */ 42 public function connectTo($mode) { 43 $this->Lexer->addSpecialPattern('----+ *struct table *-+\n.*?\n----+', $mode, 'plugin_struct_table'); 44 } 45 46 47 /** 48 * Handle matches of the struct syntax 49 * 50 * @param string $match The match of the syntax 51 * @param int $state The state of the handler 52 * @param int $pos The position in the document 53 * @param Doku_Handler $handler The handler 54 * @return array Data for the renderer 55 */ 56 public function handle($match, $state, $pos, Doku_Handler $handler){ 57 58 $lines = explode("\n", $match); 59 array_shift($lines); 60 array_pop($lines); 61 62 try { 63 $parser = new ConfigParser($lines); 64 return $parser->getConfig(); 65 } catch (StructException $e) { 66 msg($e->getMessage(), -1, $e->getLine(), $e->getFile()); 67 return null; 68 } 69 } 70 71 protected $sums = array(); 72 73 /** 74 * Render xhtml output or metadata 75 * 76 * @param string $mode Renderer mode (supported modes: xhtml) 77 * @param Doku_Renderer $renderer The renderer 78 * @param array $data The data from the handler() function 79 * @return bool If rendering was successful. 80 */ 81 public function render($mode, Doku_Renderer $renderer, $data) { 82 if($mode != 'xhtml') return false; 83 if(!$data) return false; 84 85 //reset counters 86 $this->sums = array(); 87 88 try { 89 $search = new SearchConfig($data); 90 $data = $search->getConf(); 91 $rows = $search->execute(); 92 $cnt = $search->getCount(); 93 $cols = $search->getColumns(); 94 95 if ($cnt === 0) { 96 $this->nullList($data, $mode, $renderer, $cols); 97 return true; 98 } 99 100 $this->renderPreTable($mode, $renderer, $data, $cols); 101 $this->renderRows($mode, $renderer, $data, $rows); 102 $this->renderPostTable($mode, $renderer, $data, $cnt); 103 } catch (StructException $e) { 104 msg($e->getMessage(), -1, $e->getLine(), $e->getFile()); 105 } 106 107 return true; 108 } 109 110 /** 111 * create the pretext to the actual table rows 112 * 113 * @param string $mode 114 * @param Doku_Renderer $renderer 115 * @param array $data the configuration data 116 * @param Column[] $cols 117 */ 118 protected function renderPreTable($mode, Doku_Renderer $renderer, $data, $cols) { 119 $this->startScope($mode, $renderer, md5(serialize($data))); 120 $this->showActiveFilters($mode, $renderer); 121 $this->startTable($mode, $renderer); 122 $renderer->tablethead_open(); 123 $this->buildColumnHeaders($mode, $renderer, $data, $cols); 124 $this->addDynamicFilters($mode, $renderer, $data); 125 $renderer->tablethead_close(); 126 } 127 128 /** 129 * @param string $mode current render mode 130 * @param Doku_Renderer $renderer 131 * @param array $data 132 * @param int $rowcnt 133 * @return string 134 */ 135 private function renderPostTable($mode, Doku_Renderer $renderer, $data, $rowcnt) { 136 $this->summarize($mode, $renderer, $data, $this->sums); 137 $this->addLimitControls($mode, $renderer, $data, $rowcnt); 138 $this->finishTableAndScope($mode, $renderer); 139 } 140 141 /** 142 * if limit was set, add control 143 * 144 * @param string $mode the mode of the renderer 145 * @param Doku_Renderer $renderer the renderer 146 * @param array $data the configuration of the table/search 147 * @param $rowcnt 148 */ 149 protected function addLimitControls($mode, Doku_Renderer $renderer, $data, $rowcnt) { 150 global $ID; 151 152 if($data['limit']) { 153 $renderer->tablerow_open(); 154 $renderer->tableheader_open((count($data['cols']) + ($data['rownumbers'] ? 1 : 0))); 155 $offset = (int) $_REQUEST['dataofs']; 156 157 // keep url params 158 $params = array(); 159 if (!empty($data['current_params']['dataflt'])) {$params['dataflt'] = $data['current_params']['dataflt'];} 160 if (!empty($data['current_params']['datasrt'])) {$params['datasrt'] = $data['current_params']['datasrt'];} 161 162 if($offset) { 163 $prev = $offset - $data['limit']; 164 if($prev < 0) { 165 $prev = 0; 166 } 167 $params['dataofs'] = $prev; 168 $renderer->internallink($ID . '?' . http_build_query($params), $this->getLang('prev')); 169 } 170 171 if($rowcnt > $offset + $data['limit']) { 172 $next = $offset + $data['limit']; 173 $params['dataofs'] = $next; 174 $renderer->internallink($ID . '?' . http_build_query($params), $this->getLang('next')); 175 } 176 $renderer->tableheader_close(); 177 $renderer->tablerow_close(); 178 } 179 } 180 181 /** 182 * @param string $mode the mode of the renderer 183 * @param Doku_Renderer $renderer the renderer 184 */ 185 protected function showActiveFilters($mode, Doku_Renderer $renderer) { 186 global $ID; 187 188 if($mode == 'xhtml' && !empty($data['current_params']['dataflt'])) { 189 $filters = $data['current_params']['dataflt']; 190 /** @var helper_plugin_struct_config $confHelper */ 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 if(isset($cols[$num]) && is_a($cols[$num], 'plugin\struct\meta\Column')) { 297 $head = $cols[$num]->getTranslatedLabel(); 298 } else { 299 $head = 'column '.$num; // this should never happen 300 } 301 } 302 303 $width = ''; 304 if(isset($data['widths'][$num]) AND $data['widths'][$num] != '-') { 305 $width = ' style="width: ' . $data['widths'][$num] . ';"'; 306 } 307 if ($mode == 'xhmtl') { 308 $renderer->doc .= '<th' . $width . '>'; 309 } else { 310 $renderer->tableheader_open(); 311 } 312 313 // add sort arrow 314 if ($mode == 'xhtml') { 315 if(isset($data['sort']) && $ckey == $data['sort'][0]) { 316 if($data['sort'][1] == 'ASC') { 317 $renderer->doc .= '<span>↓</span> '; 318 $ckey = '^' . $ckey; 319 } else { 320 $renderer->doc .= '<span>↑</span> '; 321 } 322 } 323 } 324 $renderer->internallink($ID . "?" . http_build_query(array('datasrt' => $ckey,) + $data['current_params']), hsc($head)); 325 $renderer->tableheader_close(); 326 } 327 $renderer->tablerow_close(); 328 } 329 330 /** 331 * @param string $mode the mode of the renderer 332 * @param Doku_Renderer $renderer the renderer 333 * @param string $hash hash to identify the table and group images in gallery 334 */ 335 protected function startScope($mode, \Doku_Renderer $renderer, $hash) { 336 if ($mode == 'xhtml') { 337 $renderer->doc .= "<div class=\"table structaggregation\">"; 338 $renderer->info['struct_table_hash'] = $hash; 339 } 340 } 341 342 /** 343 * if summarize was set, add sums 344 * 345 * @param string $mode the mode of the renderer 346 * @param Doku_Renderer $renderer the renderer 347 * @param array $data the configuration of the table/search 348 * @param array $sums the summarized output of the numerical fields 349 */ 350 private function summarize($mode, \Doku_Renderer $renderer, $data, $sums) { 351 if($data['summarize']) { 352 $renderer->tablerow_open(); 353 $len = count($data['cols']); 354 355 if($data['rownumbers']) { 356 $renderer->tablecell_open(); 357 $renderer->tablecell_close(); 358 } 359 360 for($i = 0; $i < $len; $i++) { 361 $renderer->tablecell_open(1, $data['align'][$i]); 362 if(!empty($sums[$i])) { 363 $renderer->cdata('∑ ' . $sums[$i]); 364 } else { 365 if ($mode == 'xhtml') { 366 $renderer->doc .= ' '; 367 } 368 } 369 $renderer->tablecell_close(); 370 } 371 $renderer->tablerow_close(); 372 } 373 } 374 375 /** 376 * @param string $mode the mode of the renderer 377 * @param Doku_Renderer $renderer the renderer 378 * 379 */ 380 private function finishTableAndScope($mode, Doku_Renderer $renderer) { 381 $renderer->table_close(); 382 if ($mode == 'xhtml') { 383 $renderer->doc .= '</div>'; 384 if(isset($renderer->info['struct_table_hash'])) { 385 unset($renderer->info['struct_table_hash']); 386 } 387 } 388 } 389 390 /** 391 * @param string $mode the mode of the renderer 392 * @param Doku_Renderer $renderer the renderer 393 * @param array $data the configuration of the table/search 394 * @param $rows 395 * 396 */ 397 private function renderRows($mode, Doku_Renderer $renderer, $data, $rows) { 398 $renderer->tabletbody_open(); 399 foreach($rows as $rownum => $row) { 400 $renderer->tablerow_open(); 401 402 if($data['rownumbers']) { 403 $renderer->tablecell_open(); 404 $renderer->doc .= $rownum + 1; 405 $renderer->tablecell_close(); 406 } 407 408 /** @var plugin\struct\meta\Value $value */ 409 foreach($row as $colnum => $value) { 410 $renderer->tablecell_open(); 411 $value->render($renderer, $mode); 412 $renderer->tablecell_close(); 413 414 // summarize 415 if($data['summarize'] && is_numeric($value->getValue())) { 416 if(!isset($this->sums[$colnum])) { 417 $this->sums[$colnum] = 0; 418 } 419 $this->sums[$colnum] += $value->getValue(); 420 } 421 } 422 $renderer->tablerow_close(); 423 } 424 $renderer->tabletbody_close(); 425 } 426 427 /** 428 * @param array $data the configuration of the table/search 429 * @param string $mode the mode of the renderer 430 * @param Doku_Renderer $renderer the renderer 431 * @param Column[] $cols 432 */ 433 private function nullList($data, $mode, Doku_Renderer $renderer, $cols) { 434 $this->renderPreTable($mode, $renderer, $data, $cols); 435 $renderer->tablerow_open(); 436 $renderer->tablecell_open(count($data['cols']) + $data['rownumbers'], 'center'); 437 $renderer->cdata($this->getLang('none')); 438 $renderer->tablecell_close(); 439 $renderer->tablerow_close(); 440 $renderer->table_close(); 441 } 442} 443 444// vim:ts=4:sw=4:et: 445