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://wiki.splitbrain.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 $controller->register_hook('TPL_TOC_RENDER', 'BEFORE', $this, 'handle_toc'); 55 } 56 57 function handle_toc(&$event, $param) { 58 //dbglog($event->data); 59 } 60 61 /** 62 * Supplies the current section level to the include syntax plugin 63 * 64 * @author Michael Klier <chi@chimeric.de> 65 */ 66 function handle_parser(&$event, $param) { 67 global $ID; 68 69 // check for stored toplevel ID in helper plugin 70 // if it's missing lets see if we have to do anything at all 71 if(!isset($this->helper->toplevel_id)) { 72 $ins =& $event->data->calls; 73 $num = count($ins); 74 for($i=0; $i<$num; $i++) { 75 if(($ins[$i][0] == 'plugin') && ($ins[$i][1][0] == 'include_include')) { 76 $this->helper->toplevel_id = $ID; 77 $this->helper->parse_instructions($ID, $ins); 78 } 79 } 80 } 81 } 82 83 /** 84 * Add a hidden input to the form to preserve the redirect_id 85 */ 86 function handle_form(&$event, $param) { 87 if (array_key_exists('redirect_id', $_REQUEST)) { 88 $event->data->addHidden('redirect_id', cleanID($_REQUEST['redirect_id'])); 89 } 90 } 91 92 /** 93 * Modify the data for the redirect when there is a redirect_id set 94 */ 95 function handle_redirect(&$event, $param) { 96 if (array_key_exists('redirect_id', $_REQUEST)) { 97 $event->data['id'] = cleanID($_REQUEST['redirect_id']); 98 $event->data['title'] = ''; 99 } 100 } 101 102 /** 103 * prepare the cache object for default _useCache action 104 */ 105 function _cache_prepare(&$event, $param) { 106 global $ID; 107 global $conf; 108 109 $cache =& $event->data; 110 111 // we're only interested in instructions of the current page 112 // without the ID check we'd get the cache objects for included pages as well 113 if(!isset($cache->page) && ($cache->page != $ID)) return; 114 if(!isset($cache->mode) || !in_array($cache->mode, $this->supportedModes)) return; 115 116 // get additional depends 117 $depends = p_get_metadata($ID, 'relation haspart'); 118 if(empty($depends)) return; 119 120 $key = ''; 121 foreach(array_keys($depends) as $page) { 122 if(strpos($page,'/') || cleanID($page) != $page) { 123 continue; 124 } else { 125 $file = wikiFN($page); 126 if(!in_array($cache->depends['files'], array($file)) && @file_exists($file)) { 127 $cache->depends['files'][] = $file; 128 $acl = (AUTH_READ <= auth_quickaclcheck($id)) ? 'READ' : 'NONE'; 129 $key .= '#' . $page . '|' . $acl; 130 } 131 } 132 } 133 134 // empty $key implies no includes, so nothing to do 135 if(empty($key)) return; 136 137 // mark the cache as being modified by the include plugin 138 $cache->include = true; 139 140 // set new cache key & cache name 141 // now also dependent on included page ids and their ACL_READ status 142 $cache->key .= $key; 143 $cache->cache = getCacheName($cache->key, $cache->ext); 144 } 145 146 function _cache_result(&$event, $param) { 147 $cache =& $event->data; 148 if (empty($cache->include)) return; 149 //global $debug; 150 //$debug['cache_result'][] = $event->result ? 'true' : 'false'; 151 } 152} 153//vim:ts=4:sw=4:et:enc=utf-8: 154