xref: /plugin/include/action.php (revision 54d466b6ba2d7164a6c3fc8bd46d98723c1c1bdd) 
1<?php
2/**
3 * Include Plugin:  Display a wiki page within another wiki page
4 *
5 * Action plugin component, for cache validity determination
6 *
7 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
8 * @author     Christopher Smith <chris@jalakai.co.uk>
9 * @author     Michael Klier <chi@chimeric.de>
10 */
11if(!defined('DOKU_INC')) die();  // no Dokuwiki, no go
12
13if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
14require_once(DOKU_PLUGIN.'action.php');
15
16/**
17 * All DokuWiki plugins to extend the parser/rendering mechanism
18 * need to inherit from this class
19 */
20class action_plugin_include extends DokuWiki_Action_Plugin {
21
22    var $supportedModes = array('xhtml', 'i');
23    var $helper = null;
24
25    function action_plugin_include() {
26        $this->helper = plugin_load('helper', 'include');
27    }
28
29    /**
30     * return some info
31     */
32    function getInfo() {
33      return array(
34        'author' => 'Gina Häußge, Michael Klier, Christopher Smith',
35        'email'  => 'dokuwiki@chimeric.de',
36        'date'   => @file_get_contents(DOKU_PLUGIN . 'blog/VERSION'),
37        'name'   => 'Include Plugin',
38        'desc'   => 'Improved cache handling for included pages and redirect-handling',
39        'url'    => 'http://dokuwiki.org/plugin:include',
40      );
41    }
42
43    /**
44     * plugin should use this method to register its handlers with the dokuwiki's event controller
45     */
46    function register(&$controller) {
47      $controller->register_hook('PARSER_CACHE_USE','BEFORE', $this, '_cache_prepare');
48//      $controller->register_hook('PARSER_CACHE_USE','AFTER', $this, '_cache_result');    // debugging only
49      $controller->register_hook('HTML_EDITFORM_OUTPUT', 'BEFORE', $this, 'handle_form');
50      $controller->register_hook('HTML_CONFLICTFORM_OUTPUT', 'BEFORE', $this, 'handle_form');
51      $controller->register_hook('HTML_DRAFTFORM_OUTPUT', 'BEFORE', $this, 'handle_form');
52      $controller->register_hook('ACTION_SHOW_REDIRECT', 'BEFORE', $this, 'handle_redirect');
53      $controller->register_hook('PARSER_HANDLER_DONE', 'BEFORE', $this, 'handle_parser');
54    }
55
56    /**
57     * Supplies the current section level to the include syntax plugin
58     *
59     * @author Michael Klier <chi@chimeric.de>
60     */
61    function handle_parser(&$event, $param) {
62        global $ID;
63
64        // check for stored toplevel ID in helper plugin
65        // if it's missing lets see if we have to do anything at all
66        if(!isset($this->helper->toplevel_id)) {
67            $ins =& $event->data->calls;
68            $num = count($ins);
69            for($i=0; $i<$num; $i++) {
70                if(($ins[$i][0] == 'plugin') && ($ins[$i][1][0] == 'include_include')) {
71                    if(!isset($this->helper->toplevel_id)) $this->helper->toplevel_id = $ID;
72                    $this->helper->parse_instructions($ID, $ins);
73                }
74            }
75        }
76    }
77
78    /**
79     * Add a hidden input to the form to preserve the redirect_id
80     */
81    function handle_form(&$event, $param) {
82      if (array_key_exists('redirect_id', $_REQUEST)) {
83        $event->data->addHidden('redirect_id', cleanID($_REQUEST['redirect_id']));
84      }
85    }
86
87    /**
88     * Modify the data for the redirect when there is a redirect_id set
89     */
90    function handle_redirect(&$event, $param) {
91      if (array_key_exists('redirect_id', $_REQUEST)) {
92        $event->data['id'] = cleanID($_REQUEST['redirect_id']);
93        $event->data['title'] = '';
94      }
95    }
96
97    /**
98     * prepare the cache object for default _useCache action
99     */
100    function _cache_prepare(&$event, $param) {
101        global $ID;
102        global $conf;
103
104        $cache =& $event->data;
105
106        // we're only interested in instructions of the current page
107        // without the ID check we'd get the cache objects for included pages as well
108        if(!isset($cache->page) && ($cache->page != $ID)) return;
109        if(!isset($cache->mode) || !in_array($cache->mode, $this->supportedModes)) return;
110
111        // get additional depends
112        $depends = p_get_metadata($ID, 'relation haspart');
113        if(empty($depends)) return;
114
115        $key = '';
116        foreach(array_keys($depends) as $page) {
117            $page = $this->helper->_apply_macro($page);
118            if(strpos($page,'/') || cleanID($page) != $page) {
119                continue;
120            } else {
121                $file = wikiFN($page);
122                if(!in_array($cache->depends['files'], array($file)) && @file_exists($file)) {
123                    $cache->depends['files'][] = $file;
124                    $key .= '#' . $page . '|ACL' . auth_quickaclcheck($page);
125                }
126            }
127        }
128
129        // empty $key implies no includes, so nothing to do
130        if(empty($key)) return;
131
132        // mark the cache as being modified by the include plugin
133        $cache->include = true;
134
135        // set new cache key & cache name
136        // now also dependent on included page ids and their ACL_READ status
137        $cache->key .= $key;
138        $cache->cache = getCacheName($cache->key, $cache->ext);
139    }
140
141    function _cache_result(&$event, $param) {
142        $cache =& $event->data;
143        if (empty($cache->include)) return;
144        //global $debug;
145        //$debug['cache_result'][] = $event->result ? 'true' : 'false';
146    }
147}
148//vim:ts=4:sw=4:et:enc=utf-8:
149