states = [$this->getConf('sum approved'), $this->getConf('sum ready for approval'), $this->getConf('sum draft')]; } function getType() { return 'substition'; } function getSort() { return 20; } function PType() { return 'block'; } function connectTo($mode) { $this->Lexer->addSpecialPattern('----+ *approve table *-+\n.*?----+', $mode,'plugin_approve_table'); } function handle($match, $state, $pos, Doku_Handler $handler){ $lines = explode("\n", $match); array_shift($lines); array_pop($lines); $params = []; foreach ($lines as $line) { $pair = explode(':', $line, 2); if (count($pair) < 2) { continue; } $key = trim($pair[0]); $value = trim($pair[1]); if ($key == 'states') { $value = array_map('trim', explode(',', $value)); //normalize $value = array_map('strtolower', $value); $value = array_map('ucfirst', $value); foreach ($value as $state) { if (!in_array($state, $this->states)) { msg('approve plugin: unknown state "'.$state.'" should be: ' . implode(', ', $this->states), -1); return false; } } } elseif($key == 'filter' && preg_match($value, null) === false) { msg('approve plugin: invalid filter regex', -1); return false; } elseif ($key == 'summarize') { $value = $value == '0' ? false : true; } $params[$key] = $value; } return $params; } function render($mode, Doku_Renderer $renderer, $params) { global $conf; if ($mode != 'xhtml') return false; if ($params === false) return false; $defaults = [ 'namespace' => '', 'filter' => false, 'states' => $this->states, 'summarize' => true, ]; $params = array_replace($defaults, $params); $namespace = cleanID(getNS($params['namespace'] . ":*")); $pages = $this->_getPagesFromNamespace($namespace, $params['filter'], $params['states']); usort($pages, array($this,'_pagesorter')); // Output Table $renderer->doc .= ''; $renderer->doc .= ''; $renderer->doc .= ''; $renderer->doc .= ''; $renderer->doc .= ''; $all_approved = 0; $all_approved_ready = 0; $all = 0; $working_ns = null; foreach($pages as $page) { // $page: 0 -> pagename, 1 -> true -> approved else false, 2 -> last changed date $this_ns = getNS($page[0]); if($this_ns != $working_ns) { $name_ns = $this_ns; if($this_ns == '') { $name_ns = 'root'; } $renderer->doc .= ''; $working_ns = $this_ns; } $updated = '' . dformat($page[2]) . ''; $class = 'plugin__approve_red'; $state = $this->getLang('draft'); $all += 1; if ($page[1] === 'approved') { $class = 'plugin__approve_green'; $state = $this->getLang('approved'); $all_approved += 1; } elseif ($page[1] === 'ready for approval' && $this->getConf('ready_for_approval') === 1) { $class = 'plugin__approve_ready'; $state = $this->getLang('marked_approve_ready'); $all_approved_ready += 1; } $renderer->doc .= ''; $renderer->doc .= ''; } if ($params['summarize']) { if($this->getConf('ready_for_approval') === 1) { $renderer->doc .= ''; $renderer->doc .= ''; } $renderer->doc .= ''; $renderer->doc .= ''; } $renderer->doc .= '

' . $this->getLang('hdr_page') . '	' . $this->getLang('hdr_state') . '	' . $this->getLang('hdr_updated') . '
'; $renderer->doc .= $name_ns; $renderer->doc .= ' '; $renderer->doc .= '
'; if ($conf['useheading'] === '1') { $heading = p_get_first_heading($page[0]); if ($heading != '') { $renderer->doc .= $heading; } else { $renderer->doc .= $page[0]; } } else { $renderer->doc .= $page[0]; } $renderer->doc .= '	'; $renderer->doc .= ''.$state. ' '. $this->getLang('by'). ' ' . $page[4]; $renderer->doc .= '	'; $renderer->doc .= $updated; $renderer->doc .= '
'; $renderer->doc .= $this->getLang('all_approved_ready'); $renderer->doc .= '	'; $percent = 0; if($all > 0) { $percent = $all_approved_ready * 100 / $all; } $renderer->doc .= $all_approved_ready . ' / ' . $all . sprintf(" (%.0f%%)", $percent); $renderer->doc .= '
'; $renderer->doc .= $this->getLang('all_approved'); $renderer->doc .= '	'; $percent = 0; if($all > 0) { $percent = $all_approved * 100 / $all; } $renderer->doc .= $all_approved . ' / ' . $all . sprintf(" (%.0f%%)", $percent); $renderer->doc .= '

'; return true; } function _search_helper(&$data, $base, $file, $type, $lvl, $opts) { global $lang; $ns = $opts[0]; $invalid_ns = $opts[1]; $page_regex = $opts[2]; $states = $opts[3]; if ($type == 'd') { return true; } if (!preg_match('#\.txt$#', $file)) { return false; } $id = pathID($ns . $file); if (!empty($invalid_ns) && $this->hlp->in_namespace($invalid_ns, $id)) { return false; } //check page_regex if ($page_regex && !preg_match($page_regex, $id)) { return false; } //check states $meta = p_get_metadata($id); //check states $sum = $meta['last_change']['sum']; if ($sum == $this->getConf('sum approved') && !in_array($this->getConf('sum approved'), $states)) { return false; } if ($sum == $this->getConf('sum ready for approval') && !in_array($this->getConf('sum ready for approval'), $states)) { return false; } if ($sum != $this->getConf('sum approved') && $sum != $this->getConf('sum ready for approval') && !in_array($this->getConf('sum draft'), $states)) { return false; } $date = $meta['date']['modified']; if (isset($meta['last_change']) && $meta['last_change']['sum'] === $this->getConf('sum approved')) { $approved = 'approved'; } elseif (isset($meta['last_change']) && $meta['last_change']['sum'] === $this->getConf('sum ready for approval')) { $approved = 'ready for approval'; } else { $approved = 'not approved'; } if (isset($meta['last_change'])) { $user = $meta['last_change']['user']; if (isset($meta['contributor'][$user])) { $full_name = $meta['contributor'][$user]; } else { $full_name = $meta['creator']; } } else { $user = ''; $full_name = '('.$lang['external_edit'].')'; } $data[] = array($id, $approved, $date, $user, $full_name); return false; } function _getPagesFromNamespace($namespace, $page_regex=false, $states=[]) { global $conf; $dir = $conf['datadir'] . '/' . str_replace(':', '/', $namespace); $pages = array(); search($pages, $dir, array($this,'_search_helper'), array($namespace, $this->getConf('no_apr_namespaces'), $page_regex, $states)); return $pages; } /** * Custom sort callback */ function _pagesorter($a, $b){ $ac = explode(':',$a[0]); $bc = explode(':',$b[0]); $an = count($ac); $bn = count($bc); // Same number of elements, can just string sort if($an == $bn) { return strcmp($a[0], $b[0]); } // For each level: // If this is not the last element in either list: // same -> continue // otherwise strcmp // If this is the last element in either list, it wins $n = 0; while(true) { if($n + 1 == $an) { return -1; } if($n + 1 == $bn) { return 1; } $s = strcmp($ac[$n], $bc[$n]); if($s != 0) { return $s; } $n += 1; } } }