xref: /plugin/addnewpage/syntax.php (revision fec857f50bb91e0f90aca33e06d86afc7702a60d) 
1<?php
2
3// must be run within Dokuwiki
4if(!defined('DOKU_INC')) die();
5
6/**
7 * Add-New-Page Plugin: a simple form for adding new pages.
8 *
9 * @license  GPL 2 (http://www.gnu.org/licenses/gpl.html)
10 * @author   iDO <ido@idotech.info>
11 * @author   Sam Wilson <sam@samwilson.id.au>
12 */
13class syntax_plugin_addnewpage extends DokuWiki_Syntax_Plugin {
14
15    /**
16     * Syntax Type
17     */
18    public function getType() {
19        return 'substition';
20    }
21
22    /**
23     * Paragraph Type
24     */
25    public function getPType() {
26        return 'block';
27    }
28
29    /**
30     * @return int
31     */
32    public function getSort() {
33        return 199;
34    }
35
36    /**
37     * @param string $mode
38     */
39    public function connectTo($mode) {
40        $this->Lexer->addSpecialPattern('\{\{NEWPAGE[^\}]*\}\}', $mode, 'plugin_addnewpage');
41    }
42
43    /**
44     * Handler to prepare matched data for the rendering process
45     *
46     * Handled syntax options:
47     *   {{NEWPAGE}}
48     *   {{NEWPAGE>your:namespace}}
49     *   {{NEWPAGE#newtpl1,newtpl2}}
50     *   {{NEWPAGE#newtpl1|Title1,newtpl2|Title1}}
51     *   {{NEWPAGE>your:namespace#newtpl1|Title1,newtpl2|Title1}}
52     *
53     * @param   string       $match   The text matched by the patterns
54     * @param   int          $state   The lexer state for the match
55     * @param   int          $pos     The character position of the matched text
56     * @param   Doku_Handler $handler The Doku_Handler object
57     * @return  array Return an array with all data you want to use in render
58     * @codingStandardsIgnoreStart
59     */
60    public function handle($match, $state, $pos, Doku_Handler $handler) {
61        /* @codingStandardsIgnoreEnd */
62        $options = substr($match, 9, -2); // strip markup
63        $options = explode('#', $options, 2);
64
65        $namespace = trim(ltrim($options[0], '>'));
66        $templates = explode(',', $options[1]);
67        $templates = array_map('trim', $templates);
68        return array(
69            'namespace' => $namespace,
70            'newpagetemplates' => $templates
71        );
72    }
73
74    /**
75     * Create the new-page form.
76     *
77     * @param   $mode     string        output format being rendered
78     * @param   $renderer Doku_Renderer the current renderer object
79     * @param   $data     array         data created by handler()
80     * @return  boolean                 rendered correctly?
81     */
82    public function render($mode, Doku_Renderer $renderer, $data) {
83        global $lang;
84
85        if($mode == 'xhtml') {
86            $disablecache = null;
87            $namespaceinput = $this->_htmlNamespaceInput($data['namespace'], $disablecache);
88            if($namespaceinput === false) {
89                if($this->getConf('addpage_hideACL')) {
90                    $renderer->doc .= '';
91                } else {
92                    $renderer->doc .= $this->getLang('nooption');
93                }
94                return true;
95            }
96            if($disablecache) $renderer->info['cache'] = false;
97
98            $newpagetemplateinput = $this->_htmlTemplateInput($data['newpagetemplates']);
99
100            $form = '<div class="addnewpage">' . DOKU_LF
101                . DOKU_TAB . '<form name="addnewpage" method="get" action="' . DOKU_BASE . DOKU_SCRIPT . '" accept-charset="' . $lang['encoding'] . '">' . DOKU_LF
102                . DOKU_TAB . DOKU_TAB . $namespaceinput . DOKU_LF
103                . DOKU_TAB . DOKU_TAB . '<input class="edit" type="text" name="title" size="20" maxlength="255" tabindex="2" />' . DOKU_LF
104                . $newpagetemplateinput
105                . DOKU_TAB . DOKU_TAB . '<input type="hidden" name="do" value="edit" />' . DOKU_LF
106                . DOKU_TAB . DOKU_TAB . '<input type="hidden" name="id" />' . DOKU_LF
107                . DOKU_TAB . DOKU_TAB . '<input class="button" type="submit" value="' . $this->getLang('okbutton') . '" tabindex="4" />' . DOKU_LF
108                . DOKU_TAB . '</form>' . DOKU_LF
109                . '</div>';
110            $renderer->doc .= $form;
111
112            return true;
113        }
114        return false;
115    }
116
117    /**
118     * Parse namespace request
119     *
120     * @author Samuele Tognini <samuele@cli.di.unipi.it>
121     * @author Michael Braun <michael-dev@fami-braun.de>
122     */
123    protected function _parseNS($ns) {
124        global $INFO;
125        $id = $INFO['id'];
126        if(strpos($ns, '@PAGE@') !== false) {
127            return cleanID(str_replace('@PAGE@', $id, $ns));
128        }
129        if($ns == "@NS@") return getNS($id);
130        $ns = preg_replace("/^\.(:|$)/", dirname(str_replace(':', '/', $id)) . "$1", $ns);
131        $ns = str_replace("/", ":", $ns);
132        $ns = cleanID($ns);
133        return $ns;
134    }
135
136    /**
137     * Create the HTML Select element for namespace selection.
138     *
139     * @param string|false $dest_ns The destination namespace, or false if none provided.
140     * @param bool $disablecache reference indicates if caching need to be disabled
141     * @global string $ID The page ID
142     * @return string Select element with appropriate NS selected.
143     */
144    protected function _htmlNamespaceInput($dest_ns, &$disablecache) {
145        global $ID;
146        $disablecache = false;
147
148        // If a NS has been provided:
149        // Whether to hide the NS selection (otherwise, show only subnamespaces).
150        $hide = $this->getConf('addpage_hide');
151
152        $parsed_dest_ns = $this->_parseNS($dest_ns);
153        // Whether the user can create pages in the provided NS (or root, if no
154        // destination NS has been set.
155        $can_create = (auth_quickaclcheck($parsed_dest_ns . ":") >= AUTH_CREATE);
156
157        //namespace given, but hidden
158        if($hide && !empty($dest_ns)) {
159            if($can_create) {
160                return '<input type="hidden" name="np_cat" id="np_cat" value="' . $parsed_dest_ns . '"/>';
161            } else {
162                return false;
163            }
164        }
165
166        //show select of given namespace
167        $currentns = getNS($ID);
168
169        $ret = '<select class="edit" id="np_cat" name="np_cat" tabindex="1">';
170
171        // Whether the NS select element has any options
172        $someopt = false;
173
174        // Show root namespace if requested and allowed
175        if($this->getConf('addpage_showroot') && $can_create) {
176            if(empty($dest_ns)) {
177                // If no namespace has been provided, add an option for the root NS.
178                $ret .= '<option ' . (($currentns == '') ? 'selected ' : '') . 'value="">' . $this->getLang('namespaceRoot') . '</option>';
179                $someopt = true;
180            } else {
181                // If a namespace has been provided, add an option for it.
182                $ret .= '<option ' . (($currentns == $dest_ns) ? 'selected ' : '') . 'value="' . formText($dest_ns) . '">' . formText($dest_ns) . '</option>';
183                $someopt = true;
184            }
185        }
186
187        $subnamespaces = $this->_getNamespaceList($dest_ns);
188
189        // The top of this stack will always be the last printed ancestor namespace
190        $ancestor_stack = array();
191        if (!empty($dest_ns)) {
192            array_push($ancestor_stack, $dest_ns);
193        }
194
195        foreach($subnamespaces as $ns) {
196
197            if(auth_quickaclcheck($ns . ":") < AUTH_CREATE) continue;
198
199            // Pop any elements off the stack that are not ancestors of the current namespace
200            while(!empty($ancestor_stack) && strpos($ns, $ancestor_stack[count($ancestor_stack) - 1] . ':') !== 0) {
201                array_pop($ancestor_stack);
202            }
203
204            $nsparts = explode(':', $ns);
205            $first_unprinted_depth = empty($ancestor_stack)? 1 : (2 + substr_count($ancestor_stack[count($ancestor_stack) - 1], ':'));
206            for ($i = $first_unprinted_depth, $end = count($nsparts); $i <= $end; $i++) {
207                $namespace = implode(':', array_slice($nsparts, 0, $i));
208                array_push($ancestor_stack, $namespace);
209                $selectOptionText = str_repeat('&nbsp;&nbsp;', substr_count($namespace, ':')) . $nsparts[$i - 1];
210                $ret .= '<option ' .
211                    (($currentns == $namespace) ? 'selected ' : '') .
212                    ($i == $end? ('value="' . $namespace . '">') : 'disabled>') .
213                    $selectOptionText .
214                    '</option>';
215            }
216            $someopt = true;
217            $disablecache = true;
218        }
219
220        $ret .= '</select>';
221
222        if($someopt) {
223            return $ret;
224        } else {
225            return false;
226        }
227    }
228
229    /**
230     * Get a list of namespaces below the given namespace.
231     * Recursively fetches subnamespaces.
232     *
233     * @param string $topns The top namespace
234     * @return array Multi-dimensional array of all namespaces below $tns
235     */
236    protected function _getNamespaceList($topns = '') {
237        global $conf;
238
239        $topns = utf8_encodeFN(str_replace(':', '/', $topns));
240
241        $excludes = $this->getConf('addpage_exclude');
242        if($excludes == "") {
243            $excludes = array();
244        } else {
245            $excludes = @explode(';', strtolower($excludes));
246        }
247        $searchdata = array();
248        search($searchdata, $conf['datadir'], 'search_namespaces', array(), $topns);
249
250        $namespaces = array();
251        foreach($searchdata as $ns) {
252            foreach($excludes as $exclude) {
253                if( ! empty($exclude) && strpos($ns['id'], $exclude) === 0) {
254                    continue 2;
255                }
256            }
257            $namespaces[] = $ns['id'];
258        }
259
260        return $namespaces;
261    }
262
263    /**
264     * Create html for selection of namespace templates
265     *
266     * @param array $newpagetemplates array of namespace templates
267     * @return string html of select or hidden input
268     */
269    public function _htmlTemplateInput($newpagetemplates) {
270        $cnt = count($newpagetemplates);
271        if($cnt < 1 || $cnt == 1 && $newpagetemplates[0] == '') {
272            $input = '';
273
274        } else {
275            if($cnt == 1) {
276                list($template, ) = $this->_parseNSTemplatePage($newpagetemplates[0]);
277                $input = '<input type="hidden" name="newpagetemplate" value="' . formText($template) . '" />';
278            } else {
279                $first = true;
280                $input = '<select name="newpagetemplate" tabindex="3">';
281                foreach($newpagetemplates as $template) {
282                    $p = ($first ? ' selected="selected"' : '');
283                    $first = false;
284
285                    list($template, $name) = $this->_parseNSTemplatePage($template);
286                    $p .= ' value="'.formText($template).'"';
287                    $input .= "<option $p>".formText($name)."</option>";
288                }
289                $input .= '</select>';
290            }
291            $input = DOKU_TAB . DOKU_TAB . $input . DOKU_LF;
292        }
293        return $input;
294    }
295
296    /**
297     * Parses and resolves the namespace template page
298     *
299     * @param $nstemplate
300     * @return array
301     */
302    protected function _parseNSTemplatePage($nstemplate) {
303        global $ID;
304
305        @list($template, $name) = explode('|', $nstemplate, 2);
306
307        $exist = null;
308        resolve_pageid(getNS($ID), $template, $exist); //get absolute id
309
310        if (is_null($name)) $name = $template;
311
312        return array($template, $name);
313    }
314
315}
316