xref: /plugin/addnewpage/syntax.php (revision fead6b5e11f1849c6819f05563b65f40f5f9da33) 
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 $ID;
125        if($ns == "@PAGE@") return $ID;
126        if($ns == "@NS@") return getNS($ID);
127        $ns = preg_replace("/^\.(:|$)/", dirname(str_replace(':', '/', $ID)) . "$1", $ns);
128        $ns = str_replace("/", ":", $ns);
129        $ns = cleanID($ns);
130        return $ns;
131    }
132
133    /**
134     * Create the HTML Select element for namespace selection.
135     *
136     * @param string|false $dest_ns The destination namespace, or false if none provided.
137     * @param bool $disablecache reference indicates if caching need to be disabled
138     * @global string $ID The page ID
139     * @return string Select element with appropriate NS selected.
140     */
141    protected function _htmlNamespaceInput($dest_ns, &$disablecache) {
142        global $ID;
143        $disablecache = false;
144
145        // If a NS has been provided:
146        // Whether to hide the NS selection (otherwise, show only subnamespaces).
147        $hide = $this->getConf('addpage_hide');
148
149        // Whether the user can create pages in the provided NS (or root, if no
150        // destination NS has been set.
151        $can_create = (auth_quickaclcheck($dest_ns . ":") >= AUTH_CREATE);
152
153        //namespace given, but hidden
154        if($hide && !empty($dest_ns)) {
155            if($can_create) {
156                return '<input type="hidden" name="np_cat" id="np_cat" value="' . $this->_parseNS($dest_ns) . '"/>';
157            } else {
158                return false;
159            }
160        }
161
162        //show select of given namespace
163        $currentns = getNS($ID);
164
165        $ret = '<select class="edit" id="np_cat" name="np_cat" tabindex="1">';
166
167        // Whether the NS select element has any options
168        $someopt = false;
169
170        // Show root namespace if requested and allowed
171        if($this->getConf('addpage_showroot') && $can_create) {
172            if(empty($dest_ns)) {
173                // If no namespace has been provided, add an option for the root NS.
174                $ret .= '<option ' . (($currentns == '') ? 'selected ' : '') . 'value="">' . $this->getLang('namespaceRoot') . '</option>';
175                $someopt = true;
176            } else {
177                // If a namespace has been provided, add an option for it.
178                $ret .= '<option ' . (($currentns == $dest_ns) ? 'selected ' : '') . 'value="' . formText($dest_ns) . '">' . formText($dest_ns) . '</option>';
179                $someopt = true;
180            }
181        }
182
183        $subnamespaces = $this->_getNamespaceList($dest_ns);
184
185        // The top of this stack will always be the last printed ancestor namespace
186        $ancestor_stack = array();
187        if (!empty($dest_ns)) {
188            array_push($ancestor_stack, $dest_ns);
189        }
190
191        foreach($subnamespaces as $ns) {
192
193            if(auth_quickaclcheck($ns . ":") < AUTH_CREATE) continue;
194
195            // Pop any elements off the stack that are not ancestors of the current namespace
196            while(!empty($ancestor_stack) && strpos($ns, $ancestor_stack[count($ancestor_stack) - 1] . ':') !== 0) {
197                array_pop($ancestor_stack);
198            }
199
200            $nsparts = explode(':', $ns);
201            $first_unprinted_depth = empty($ancestor_stack)? 1 : (2 + substr_count($ancestor_stack[count($ancestor_stack) - 1], ':'));
202            for ($i = $first_unprinted_depth, $end = count($nsparts); $i <= $end; $i++) {
203                $namespace = implode(':', array_slice($nsparts, 0, $i));
204                array_push($ancestor_stack, $namespace);
205                $selectOptionText = str_repeat('&nbsp;&nbsp;', substr_count($namespace, ':')) . $nsparts[$i - 1];
206                $ret .= '<option ' .
207                    (($currentns == $namespace) ? 'selected ' : '') .
208                    ($i == $end? ('value="' . $namespace . '">') : 'disabled>') .
209                    $selectOptionText .
210                    '</option>';
211            }
212            $someopt = true;
213            $disablecache = true;
214        }
215
216        $ret .= '</select>';
217
218        if($someopt) {
219            return $ret;
220        } else {
221            return false;
222        }
223    }
224
225    /**
226     * Get a list of namespaces below the given namespace.
227     * Recursively fetches subnamespaces.
228     *
229     * @param string $topns The top namespace
230     * @return array Multi-dimensional array of all namespaces below $tns
231     */
232    protected function _getNamespaceList($topns = '') {
233        global $conf;
234
235        $topns = utf8_encodeFN(str_replace(':', '/', $topns));
236
237        $excludes = $this->getConf('addpage_exclude');
238        if($excludes == "") {
239            $excludes = array();
240        } else {
241            $excludes = @explode(';', strtolower($excludes));
242        }
243        $searchdata = array();
244        search($searchdata, $conf['datadir'], 'search_namespaces', array(), $topns);
245
246        $namespaces = array();
247        foreach($searchdata as $ns) {
248            foreach($excludes as $exclude) {
249                if(strpos($ns['id'], $exclude) === 0) {
250                    continue 2;
251                }
252            }
253            $namespaces[] = $ns['id'];
254        }
255
256        return $namespaces;
257    }
258
259    /**
260     * Create html for selection of namespace templates
261     *
262     * @param array $newpagetemplates array of namespace templates
263     * @return string html of select or hidden input
264     */
265    public function _htmlTemplateInput($newpagetemplates) {
266        $cnt = count($newpagetemplates);
267        if($cnt < 1 || $cnt == 1 && $newpagetemplates[0] == '') {
268            $input = '';
269
270        } else {
271            if($cnt == 1) {
272                list($template, ) = $this->_parseNSTemplatePage($newpagetemplates[0]);
273                $input = '<input type="hidden" name="newpagetemplate" value="' . formText($template) . '" />';
274            } else {
275                $first = true;
276                $input = '<select name="newpagetemplate" tabindex="3">';
277                foreach($newpagetemplates as $template) {
278                    $p = ($first ? ' selected="selected"' : '');
279                    $first = false;
280
281                    list($template, $name) = $this->_parseNSTemplatePage($template);
282                    $p .= ' value="'.formText($template).'"';
283                    $input .= "<option $p>".formText($name)."</option>";
284                }
285                $input .= '</select>';
286            }
287            $input = DOKU_TAB . DOKU_TAB . $input . DOKU_LF;
288        }
289        return $input;
290    }
291
292    /**
293     * Parses and resolves the namespace template page
294     *
295     * @param $nstemplate
296     * @return array
297     */
298    protected function _parseNSTemplatePage($nstemplate) {
299        global $ID;
300
301        @list($template, $name) = explode('|', $nstemplate, 2);
302
303        $exist = null;
304        resolve_pageid(getNS($ID), $template, $exist); //get absolute id
305
306        if (is_null($name)) $name = $template;
307
308        return array($template, $name);
309    }
310
311}
312