xref: /plugin/siteexport/preload.php (revision 36db4d823bd7bbb9c641d7236b90861b0afbb6b5)
17d101cc1SGerry Weißbach<?php
27d101cc1SGerry Weißbachif(!defined('DOKU_INC')) define('DOKU_INC',fullpath(dirname(__FILE__).'/../../../').'/');
37d101cc1SGerry Weißbach
47d101cc1SGerry Weißbach@include_once(DOKU_INC . 'inc/plugincontroller.class.php');
57d101cc1SGerry Weißbach
67d101cc1SGerry Weißbachclass preload_plugin_siteexport {
77d101cc1SGerry Weißbach
87d101cc1SGerry Weißbach	function __register_template() {
97d101cc1SGerry Weißbach
1016c5261cSGerry Weißbach		global $conf;
1116c5261cSGerry Weißbach
127d101cc1SGerry Weißbach		if ( !empty($_REQUEST['q']) ) {
137d101cc1SGerry Weißbach
147d101cc1SGerry Weißbach			require_once( DOKU_INC . 'inc/JSON.php');
157d101cc1SGerry Weißbach			$json = new JSON();
167d101cc1SGerry Weißbach			$tempREQUEST = (array)$json->dec(stripslashes($_REQUEST['q']));
177d101cc1SGerry Weißbach
187d101cc1SGerry Weißbach		} else if ( !empty( $_REQUEST['template'] ) ) {
197d101cc1SGerry Weißbach			$tempREQUEST = $_REQUEST;
2016c5261cSGerry Weißbach		} else if ( preg_match("/(js|css)\.php$/", $_SERVER['SCRIPT_NAME']) && isset($_SERVER['HTTP_REFERER']) ) {
2116c5261cSGerry Weißbach			// this is a css or script, nothing before matched and we have a referrer.
2216c5261cSGerry Weißbach			// lets asume we came from the dokuwiki page.
2316c5261cSGerry Weißbach
2416c5261cSGerry Weißbach			// Parse the Referrer URL
2516c5261cSGerry Weißbach			$url = parse_url($_SERVER['HTTP_REFERER']);
26641ccffdSGerry Weißbach			if ( isset($url['query']) ) {
2716c5261cSGerry Weißbach				parse_str($url['query'], $tempREQUEST);
28641ccffdSGerry Weißbach			}
297d101cc1SGerry Weißbach		} else {
307d101cc1SGerry Weißbach			return;
317d101cc1SGerry Weißbach		}
327d101cc1SGerry Weißbach
337d101cc1SGerry Weißbach		// define Template baseURL
34*36db4d82SGerry Weißbach		$newTemplate = $tempREQUEST['template'];
35*36db4d82SGerry Weißbach		// Make sure, that the template is set and the basename is equal to the template, alas there are no path definitions. see #48
36*36db4d82SGerry Weißbach		if ( empty($newTemplate) || basename($newTemplate) != $newTemplate ) { return; }
37*36db4d82SGerry Weißbach		$tplDir = DOKU_INC.'lib/tpl/'.$newTemplate;
38*36db4d82SGerry Weißbach		// check if the directory is valid, has no more "../" in it and is equal to what we expect. DOKU_INC itself is absolute. see #48
39*36db4d82SGerry Weißbach		if ( $tplDir != realpath($tplDir) ) { return; }
407d101cc1SGerry Weißbach
41*36db4d82SGerry Weißbach		// Use fileexists, because realpath is not always right.
427d101cc1SGerry Weißbach		if ( !file_exists($tplDir) ) { return; }
437d101cc1SGerry Weißbach
4406337b60SGerry Weißbach		// Set hint for Dokuwiki_Started event
457d101cc1SGerry Weißbach		if (!defined('SITEEXPORT_TPL'))		define('SITEEXPORT_TPL', $tempREQUEST['template']);
4606337b60SGerry Weißbach
4706337b60SGerry Weißbach		// define baseURL
4806337b60SGerry Weißbach		// This should be DEPRECATED - as it is in init.php which suggest tpl_basedir and tpl_incdir
4906337b60SGerry Weißbach		/* **************************************************************************************** */
5006337b60SGerry Weißbach		if(!defined('DOKU_REL')) define('DOKU_REL',getBaseURL(false));
5106337b60SGerry Weißbach		if(!defined('DOKU_URL')) define('DOKU_URL',getBaseURL(true));
5206337b60SGerry Weißbach		if(!defined('DOKU_BASE')){
539210c477SGerry Weißbach			if( isset($conf['canonical']) ){
5406337b60SGerry Weißbach				define('DOKU_BASE',DOKU_URL);
5506337b60SGerry Weißbach			}else{
5606337b60SGerry Weißbach				define('DOKU_BASE',DOKU_REL);
5706337b60SGerry Weißbach			}
5806337b60SGerry Weißbach		}
5906337b60SGerry Weißbach
6006337b60SGerry Weißbach		// This should be DEPRECATED - as it is in init.php which suggest tpl_basedir and tpl_incdir
6106337b60SGerry Weißbach		if (!defined('DOKU_TPL'))			define('DOKU_TPL', (empty($tempREQUEST['base']) ? DOKU_BASE : $tempREQUEST['base']) . 'lib/tpl/'.$tempREQUEST['template'].'/');
627d101cc1SGerry Weißbach		if (!defined('DOKU_TPLINC'))		define('DOKU_TPLINC', $tplDir);
6306337b60SGerry Weißbach		/* **************************************************************************************** */
647d101cc1SGerry Weißbach	}
657d101cc1SGerry Weißbach
667d101cc1SGerry Weißbach	function __temporary_disable_plugins() {
677d101cc1SGerry Weißbach
687d101cc1SGerry Weißbach		// Check for siteexport - otherwise this does not matter.
697d101cc1SGerry Weißbach		if ( empty($_REQUEST['do']) || $_REQUEST['do'] != 'siteexport' ) {
707d101cc1SGerry Weißbach			return;
717d101cc1SGerry Weißbach		}
727d101cc1SGerry Weißbach
7365e0d1bfSGerry Weißbach		// check for css and js  ... only disable in that case.
747d101cc1SGerry Weißbach		if ( !preg_match("/(js|css)\.php$/", $_SERVER['SCRIPT_NAME']) ) {
757d101cc1SGerry Weißbach			return;
767d101cc1SGerry Weißbach		}
777d101cc1SGerry Weißbach
787d101cc1SGerry Weißbach		//		print "removing plugins ";
797d101cc1SGerry Weißbach		$_GET['purge'] = 'purge'; //activate purging
807d101cc1SGerry Weißbach		$_POST['purge'] = 'purge'; //activate purging
817d101cc1SGerry Weißbach		$_REQUEST['purge'] = 'purge'; //activate purging
827d101cc1SGerry Weißbach
837d101cc1SGerry Weißbach		$_SERVER['HTTP_HOST'] = 'siteexport.js'; // fake everything in here
847d101cc1SGerry Weißbach
85641ccffdSGerry Weißbach		// require_once(DOKU_INC.'inc/plugincontroller.class.php'); // Have to get the pluginutils already
86641ccffdSGerry Weißbach		// require_once(DOKU_INC.'inc/pluginutils.php'); // Have to get the pluginutils already
877d101cc1SGerry Weißbach		$this->__disablePlugins();
887d101cc1SGerry Weißbach	}
897d101cc1SGerry Weißbach
907d101cc1SGerry Weißbach	function __disablePlugins() {
91641ccffdSGerry Weißbach		global $plugin_controller_class;
927d101cc1SGerry Weißbach		$plugin_controller_class = 'preload_plugin_siteexport_controller';
937d101cc1SGerry Weißbach	}
947d101cc1SGerry Weißbach
957d101cc1SGerry Weißbach	function __create_preload_function() {
967d101cc1SGerry Weißbach
977d101cc1SGerry Weißbach		$PRELOADFILE = DOKU_INC.'inc/preload.php';
987d101cc1SGerry Weißbach		$CURRENTFILE = 'DOKU_INC' . " . 'lib/plugins/siteexport/preload.php'";
997d101cc1SGerry Weißbach		$CONTENT = <<<OUTPUT
1007d101cc1SGerry Weißbach/* SITE EXPORT *********************************************************** */
1017d101cc1SGerry Weißbach	if ( file_exists($CURRENTFILE) ) {
1027d101cc1SGerry Weißbach		include_once($CURRENTFILE);
1037d101cc1SGerry Weißbach		\$siteexport_preload = new preload_plugin_siteexport();
1047d101cc1SGerry Weißbach		\$siteexport_preload->__register_template();
1057d101cc1SGerry Weißbach		\$siteexport_preload->__temporary_disable_plugins();
1067d101cc1SGerry Weißbach		unset(\$siteexport_preload);
1077d101cc1SGerry Weißbach	}
1087d101cc1SGerry Weißbach/* SITE EXPORT END *********************************************************** */
1097d101cc1SGerry Weißbach
1107d101cc1SGerry WeißbachOUTPUT;
1117d101cc1SGerry Weißbach
1127d101cc1SGerry Weißbach		if ( file_exists($PRELOADFILE) ) {
1137d101cc1SGerry Weißbach
1147d101cc1SGerry Weißbach			if ( ! is_readable($PRELOADFILE) ) {
1157d101cc1SGerry Weißbach				msg("Preload File locked. It exists, but it can't be read.", -1);
1167d101cc1SGerry Weißbach				return false;
1177d101cc1SGerry Weißbach			}
1187d101cc1SGerry Weißbach
1197d101cc1SGerry Weißbach			if ( !is_writeable($PRELOADFILE) ) {
1207d101cc1SGerry Weißbach				msg("Preload File locked. It exists and is readable, but it can't be written.", -1);
1217d101cc1SGerry Weißbach				return false;
1227d101cc1SGerry Weißbach			}
1237d101cc1SGerry Weißbach
1247d101cc1SGerry Weißbach			$fileContent = file($PRELOADFILE);
1257d101cc1SGerry Weißbach			if ( !strstr(implode("", $fileContent), $CONTENT) ) {
1267d101cc1SGerry Weißbach
1277d101cc1SGerry Weißbach				$fp = fopen($PRELOADFILE, "a");
1287d101cc1SGerry Weißbach				fputs($fp, "\n".$CONTENT);
1297d101cc1SGerry Weißbach				fclose($fp);
1307d101cc1SGerry Weißbach			}
1317d101cc1SGerry Weißbach
1327d101cc1SGerry Weißbach			return true;
1337d101cc1SGerry Weißbach
1347d101cc1SGerry Weißbach		} else if ( is_writeable(DOKU_INC . 'inc/') ) {
1357d101cc1SGerry Weißbach
1367d101cc1SGerry Weißbach			$fp = fopen($PRELOADFILE,"w");
1377d101cc1SGerry Weißbach			fputs($fp, "<?php\n/*\n * Dokuwiki Preload File\n * Auto-generated by Site Export plugin \n * Date: ".date('Y-m-d H:s:i')."\n */\n");
1387d101cc1SGerry Weißbach			fputs($fp, $CONTENT);
1397d101cc1SGerry Weißbach			fputs($fp, "// end auto-generated content\n\n");
1407d101cc1SGerry Weißbach			fclose($fp);
1417d101cc1SGerry Weißbach
1427d101cc1SGerry Weißbach			return true;
1437d101cc1SGerry Weißbach		}
1447d101cc1SGerry Weißbach
1457d101cc1SGerry Weißbach		msg("Could not create/modify preload.php. Please check the write permissions for your DokuWiki/inc directory.", -1);
1467d101cc1SGerry Weißbach		return false;
1477d101cc1SGerry Weißbach	}
1487d101cc1SGerry Weißbach
1497d101cc1SGerry Weißbach}
1507d101cc1SGerry Weißbach
1517d101cc1SGerry Weißbach// return a custom plugin list
1527d101cc1SGerry Weißbachclass preload_plugin_siteexport_controller extends Doku_Plugin_Controller {
1537d101cc1SGerry Weißbach
15465e0d1bfSGerry Weißbach	/**
15565e0d1bfSGerry Weißbach	 * Setup disabling
15665e0d1bfSGerry Weißbach	 */
15765e0d1bfSGerry Weißbach	public function __construct() {
15865e0d1bfSGerry Weißbach		parent::__construct();
1597d101cc1SGerry Weißbach
1602e56ccbaSGerry Weißbach		$disabledPlugins = array();
1612e56ccbaSGerry Weißbach
1622e56ccbaSGerry Weißbach		// support of old syntax
1632e56ccbaSGerry Weißbach		if ( is_array($_REQUEST['diPlu']) ) {
1642e56ccbaSGerry Weißbach			$disabledPlugins = $_REQUEST['diPlu'];
1652e56ccbaSGerry Weißbach		}
1662e56ccbaSGerry Weißbach
167641ccffdSGerry Weißbach		if ( !empty($_REQUEST['diInv']) )
168641ccffdSGerry Weißbach		{
169641ccffdSGerry Weißbach		    $allPlugins = array();
170641ccffdSGerry Weißbach		    foreach($this->tmp_plugins as $plugin => $enabled) { // All plugins
171641ccffdSGerry Weißbach		    	// check for CSS or JS
172641ccffdSGerry Weißbach		    	if ( $enabled == 1 && !file_exists(DOKU_PLUGIN."$plugin/script.js") && !file_exists(DOKU_PLUGIN."$plugin/style.css") && !file_exists(DOKU_PLUGIN."$plugin/print.css") ) { continue; }
173641ccffdSGerry Weißbach		    	$allPlugins[] = $plugin;
174641ccffdSGerry Weißbach		    }
175641ccffdSGerry Weißbach			$disabledPlugins = empty($_REQUEST['diPlu']) ? $allPlugins : array_diff($allPlugins, $_REQUEST['diPlu']);
1762e56ccbaSGerry Weißbach		}
1772e56ccbaSGerry Weißbach
1782e56ccbaSGerry Weißbach		// if this is defined, it overrides the settings made above. obviously.
1792e56ccbaSGerry Weißbach		$disabledPlugins = empty($_REQUEST['disableplugin']) ? $disabledPlugins : $_REQUEST['disableplugin'];
1802e56ccbaSGerry Weißbach
18165e0d1bfSGerry Weißbach		foreach( $disabledPlugins as $plugin ) {
18265e0d1bfSGerry Weißbach			$this->disable($plugin);
1837d101cc1SGerry Weißbach		}
184c7c6980aSGerry Weißbach
185c7c6980aSGerry Weißbach        // always enabled - JS and CSS will be cut out later.
186c7c6980aSGerry Weißbach        $this->enable('siteexport');
1877d101cc1SGerry Weißbach	}
1887d101cc1SGerry Weißbach
18965e0d1bfSGerry Weißbach   /**
19065e0d1bfSGerry Weißbach    * Disable the plugin
19165e0d1bfSGerry Weißbach    *
19265e0d1bfSGerry Weißbach    * @param string $plugin name of plugin
19365e0d1bfSGerry Weißbach    * @return bool; true allways.
19465e0d1bfSGerry Weißbach    */
19565e0d1bfSGerry Weißbach   public function disable($plugin) {
19665e0d1bfSGerry Weißbach	   $this->tmp_plugins[$plugin] = 0;
19765e0d1bfSGerry Weißbach	   return true;
1987d101cc1SGerry Weißbach   }
199c7c6980aSGerry Weißbach
20068901b7bSGerry Weißbach   /**
20168901b7bSGerry Weißbach    * Enable the plugin
20268901b7bSGerry Weißbach    *
20368901b7bSGerry Weißbach    * @param string $plugin name of plugin
20468901b7bSGerry Weißbach    * @return bool; true allways.
20568901b7bSGerry Weißbach    */
20668901b7bSGerry Weißbach   public function enable($plugin) {
20768901b7bSGerry Weißbach	   $this->tmp_plugins[$plugin] = 1;
20868901b7bSGerry Weißbach	   return true;
20968901b7bSGerry Weißbach   }
210c7c6980aSGerry Weißbach
211c7c6980aSGerry Weißbach   public function hasSiteexportHeaders() {
212c7c6980aSGerry Weißbach       $headers = function_exists('getallheaders') ? getallheaders() : null;
213c7c6980aSGerry Weißbach       return is_array($headers) && array_key_exists('X-Site-Exporter', $headers) && $headers['X-Site-Exporter'] = getSecurityToken();
214c7c6980aSGerry Weißbach   }
215c7c6980aSGerry Weißbach
216c7c6980aSGerry Weißbach   /**
2177fa31378SGerry Weißbach    * Filter the List of Plugins for the siteexport plugin
2187fa31378SGerry Weißbach    */
2197fa31378SGerry Weißbach   private function isSiteexportPlugin ($item) {
2207fa31378SGerry Weißbach        return $item != 'siteexport';
2217fa31378SGerry Weißbach   }
2227fa31378SGerry Weißbach
2237fa31378SGerry Weißbach    /**
224c7c6980aSGerry Weißbach     * Get the list of plugins, bute remove Siteexport from Style and
225c7c6980aSGerry Weißbach     * JS if in export Mode
226c7c6980aSGerry Weißbach     */
227c7c6980aSGerry Weißbach   public function getList($type='',$all=false) {
228c7c6980aSGerry Weißbach       $plugins = parent::getList($type, $all);
229c7c6980aSGerry Weißbach
230c7c6980aSGerry Weißbach       list(,, $caller) = debug_backtrace(false);
231c7c6980aSGerry Weißbach       if ( $this->hasSiteexportHeaders() && $caller != null && preg_match("/^(js|css)_/", $caller['function']) && preg_match("/(js|css)\.php$/", $caller['file']) ) {
2327fa31378SGerry Weißbach           $plugins = array_filter($plugins, array($this, 'isSiteexportPlugin'));
233c7c6980aSGerry Weißbach       }
234c7c6980aSGerry Weißbach
235c7c6980aSGerry Weißbach       return $plugins;
236c7c6980aSGerry Weißbach   }
2377d101cc1SGerry Weißbach}
2387d101cc1SGerry Weißbach
2397d101cc1SGerry Weißbach
2407d101cc1SGerry Weißbach?>
241