xref: /plugin/backlinks/syntax.php (revision 63597158507e50eadc6e08f621c0e1c41760b4cb) 
1<?php
2/**
3 * DokuWiki Syntax Plugin Backlinks.
4 *
5 * Shows a list of pages that link back to a given page.
6 *
7 * Syntax:  {{backlinks>[pagename][#filterNS|!#filterNS]}}
8 *
9 *   [pagename] - a valid wiki pagename or a . for the current page
10 *   [filterNS] - a valid,absolute namespace name, optionally prepended with ! to exclude
11 *
12 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
13 * @author  Michael Klier <chi@chimeric.de>
14 * @author  Mark C. Prins <mprins@users.sf.net>
15 */
16if (!defined('DOKU_INC')) {
17    die();
18}
19
20if (!defined('DOKU_PLUGIN')) {
21    define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/');
22}
23if (!defined('DW_LF')) {
24    define('DW_LF', "\n");
25}
26
27require_once(DOKU_PLUGIN.'syntax.php');
28require_once(DOKU_INC.'inc/parserutils.php');
29
30/**
31 * All DokuWiki plugins to extend the parser/rendering mechanism
32 * need to inherit from this class
33 */
34class syntax_plugin_backlinks extends DokuWiki_Syntax_Plugin {
35    /**
36     * Syntax Type.
37     *
38     * Needs to return one of the mode types defined in $PARSER_MODES in parser.php
39     * @see DokuWiki_Syntax_Plugin::getType()
40     */
41    function getType() { return 'substition'; }
42
43    /**
44     * @see DokuWiki_Syntax_Plugin::getPType()
45     */
46    function getPType() { return 'block'; }
47
48    /**
49     * @see Doku_Parser_Mode::getSort()
50     */
51    function getSort() { return 304; }
52
53    /**
54     * Connect pattern to lexer.
55     * @see Doku_Parser_Mode::connectTo()
56     */
57    function connectTo($mode) {
58        $this->Lexer->addSpecialPattern('\{\{backlinks>.+?\}\}', $mode, 'plugin_backlinks');
59    }
60
61    /**
62     * Handler to prepare matched data for the rendering process.
63     * @see DokuWiki_Syntax_Plugin::handle()
64     */
65    function handle($match, $state, $pos, Doku_Handler $handler) {
66
67        // Take the id of the source
68        // It can be a rendering of a sidebar
69        global $INFO;
70        global $ID;
71        $id = $ID;
72        // If it's a sidebar, get the original id.
73        if ($INFO != null) {
74            $id = $INFO['id'];
75        }
76
77        // strip {{backlinks> from start and }} from end
78        $match = substr($match, 12, -2);
79
80        if (strstr($match, "#")) {
81            $includeNS = substr(strstr($match, "#", FALSE), 1);
82            $match = strstr($match, "#", TRUE);
83        }
84
85        $match = ($match == '.') ? $id : $match;
86
87        if (strstr($match, ".:")) {
88            resolve_pageid(getNS($id), $match, $exists);
89        }
90
91        return (array($match, $includeNS));
92    }
93
94    /**
95     * Handles the actual output creation.
96     * @see DokuWiki_Syntax_Plugin::render()
97     */
98    function render($mode, Doku_Renderer $renderer, $data) {
99        global $lang;
100
101        if ($mode == 'xhtml') {
102            $renderer->info['cache'] = false;
103
104            @require_once(DOKU_INC.'inc/fulltext.php');
105            $backlinks = ft_backlinks($data[0]);
106
107            dbglog($backlinks, "backlinks: all backlinks to: $data[0]");
108
109            $renderer->doc .= '<div id="plugin__backlinks">'.DW_LF;
110
111            $filterNS = $data[1];
112            if (!empty($backlinks) && !empty($filterNS)) {
113                if (stripos($filterNS, "!", 0) === 0) {
114                    $filterNS = substr($filterNS, 1);
115                    dbglog($filterNS, "backlinks: exluding all of namespace: $filterNS");
116                    $backlinks = array_filter($backlinks, function($ns) use($filterNS) {
117                        return stripos($ns, $filterNS, 0) !== 0;
118                    });
119                } else {
120                    dbglog($filterNS, "backlinks: including namespace: $filterNS only");
121                    $backlinks = array_filter($backlinks, function($ns) use($filterNS) {
122                        return stripos($ns, $filterNS, 0) === 0;
123                    });
124                }
125            }
126
127            dbglog($backlinks, "backlinks: all backlinks to be rendered");
128
129            if (!empty($backlinks)) {
130
131                $renderer->doc .= '<ul class="idx">';
132
133                foreach ($backlinks as $backlink) {
134                    $name = p_get_metadata($backlink, 'title');
135                    if (empty($name)) $name = $backlink;
136                    $renderer->doc .= '<li><div class="li">';
137                    $renderer->doc .= html_wikilink(':'.$backlink, $name);
138                    $renderer->doc .= '</div></li>'.DW_LF;
139                }
140
141                $renderer->doc .= '</ul>'.DW_LF;
142            } else {
143                $renderer->doc .= "<strong>Plugin Backlinks: ".$lang['nothingfound']."</strong>".DW_LF;
144            }
145
146            $renderer->doc .= '</div>'.DW_LF;
147
148            return true;
149        }
150        return false;
151    }
152}
153