xref: /plugin/siteexport/preload.php (revision 1d35ab9ddae1063a1d6b576c599794bf4bbbcad1)
17d101cc1SGerry Weißbach<?php
2996c253aSGerry Weißbachif(!defined('DOKU_INC')) define('DOKU_INC',realpath(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
8*1d35ab9dSGerry Weißbach    var $error;
9*1d35ab9dSGerry Weißbach
107d101cc1SGerry Weißbach	function __register_template() {
117d101cc1SGerry Weißbach
1216c5261cSGerry Weißbach		global $conf;
1316c5261cSGerry Weißbach
147d101cc1SGerry Weißbach		if ( !empty($_REQUEST['q']) ) {
157d101cc1SGerry Weißbach
167d101cc1SGerry Weißbach			require_once( DOKU_INC . 'inc/JSON.php');
177d101cc1SGerry Weißbach			$json = new JSON();
187d101cc1SGerry Weißbach			$tempREQUEST = (array)$json->dec(stripslashes($_REQUEST['q']));
197d101cc1SGerry Weißbach
207d101cc1SGerry Weißbach		} else if ( !empty( $_REQUEST['template'] ) ) {
217d101cc1SGerry Weißbach			$tempREQUEST = $_REQUEST;
2216c5261cSGerry Weißbach		} else if ( preg_match("/(js|css)\.php$/", $_SERVER['SCRIPT_NAME']) && isset($_SERVER['HTTP_REFERER']) ) {
2316c5261cSGerry Weißbach			// this is a css or script, nothing before matched and we have a referrer.
2416c5261cSGerry Weißbach			// lets asume we came from the dokuwiki page.
2516c5261cSGerry Weißbach
2616c5261cSGerry Weißbach			// Parse the Referrer URL
2716c5261cSGerry Weißbach			$url = parse_url($_SERVER['HTTP_REFERER']);
28641ccffdSGerry Weißbach			if ( isset($url['query']) ) {
2916c5261cSGerry Weißbach				parse_str($url['query'], $tempREQUEST);
30641ccffdSGerry Weißbach			}
317d101cc1SGerry Weißbach		} else {
327d101cc1SGerry Weißbach			return;
337d101cc1SGerry Weißbach		}
347d101cc1SGerry Weißbach
357d101cc1SGerry Weißbach		// define Template baseURL
3636db4d82SGerry Weißbach		$newTemplate = $tempREQUEST['template'];
3736db4d82SGerry 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
3836db4d82SGerry Weißbach		if ( empty($newTemplate) || basename($newTemplate) != $newTemplate ) { return; }
3936db4d82SGerry Weißbach		$tplDir = DOKU_INC.'lib/tpl/'.$newTemplate;
4036db4d82SGerry 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
4136db4d82SGerry Weißbach		if ( $tplDir != realpath($tplDir) ) { return; }
427d101cc1SGerry Weißbach
4336db4d82SGerry Weißbach		// Use fileexists, because realpath is not always right.
447d101cc1SGerry Weißbach		if ( !file_exists($tplDir) ) { return; }
457d101cc1SGerry Weißbach
4606337b60SGerry Weißbach		// Set hint for Dokuwiki_Started event
477d101cc1SGerry Weißbach		if (!defined('SITEEXPORT_TPL'))		define('SITEEXPORT_TPL', $tempREQUEST['template']);
4806337b60SGerry Weißbach
4906337b60SGerry Weißbach		// define baseURL
5006337b60SGerry Weißbach		// This should be DEPRECATED - as it is in init.php which suggest tpl_basedir and tpl_incdir
5106337b60SGerry Weißbach		/* **************************************************************************************** */
5206337b60SGerry Weißbach		if(!defined('DOKU_REL')) define('DOKU_REL',getBaseURL(false));
5306337b60SGerry Weißbach		if(!defined('DOKU_URL')) define('DOKU_URL',getBaseURL(true));
5406337b60SGerry Weißbach		if(!defined('DOKU_BASE')){
559210c477SGerry Weißbach			if( isset($conf['canonical']) ){
5606337b60SGerry Weißbach				define('DOKU_BASE',DOKU_URL);
5706337b60SGerry Weißbach			}else{
5806337b60SGerry Weißbach				define('DOKU_BASE',DOKU_REL);
5906337b60SGerry Weißbach			}
6006337b60SGerry Weißbach		}
6106337b60SGerry Weißbach
6206337b60SGerry Weißbach		// This should be DEPRECATED - as it is in init.php which suggest tpl_basedir and tpl_incdir
6306337b60SGerry Weißbach		if (!defined('DOKU_TPL'))			define('DOKU_TPL', (empty($tempREQUEST['base']) ? DOKU_BASE : $tempREQUEST['base']) . 'lib/tpl/'.$tempREQUEST['template'].'/');
647d101cc1SGerry Weißbach		if (!defined('DOKU_TPLINC'))		define('DOKU_TPLINC', $tplDir);
6506337b60SGerry Weißbach		/* **************************************************************************************** */
667d101cc1SGerry Weißbach	}
677d101cc1SGerry Weißbach
687d101cc1SGerry Weißbach	function __temporary_disable_plugins() {
697d101cc1SGerry Weißbach
707d101cc1SGerry Weißbach		// Check for siteexport - otherwise this does not matter.
717d101cc1SGerry Weißbach		if ( empty($_REQUEST['do']) || $_REQUEST['do'] != 'siteexport' ) {
727d101cc1SGerry Weißbach			return;
737d101cc1SGerry Weißbach		}
747d101cc1SGerry Weißbach
7565e0d1bfSGerry Weißbach		// check for css and js  ... only disable in that case.
767d101cc1SGerry Weißbach		if ( !preg_match("/(js|css)\.php$/", $_SERVER['SCRIPT_NAME']) ) {
777d101cc1SGerry Weißbach			return;
787d101cc1SGerry Weißbach		}
797d101cc1SGerry Weißbach
807d101cc1SGerry Weißbach		//		print "removing plugins ";
817d101cc1SGerry Weißbach		$_GET['purge'] = 'purge'; //activate purging
827d101cc1SGerry Weißbach		$_POST['purge'] = 'purge'; //activate purging
837d101cc1SGerry Weißbach		$_REQUEST['purge'] = 'purge'; //activate purging
847d101cc1SGerry Weißbach
857d101cc1SGerry Weißbach		$_SERVER['HTTP_HOST'] = 'siteexport.js'; // fake everything in here
867d101cc1SGerry Weißbach
87641ccffdSGerry Weißbach		// require_once(DOKU_INC.'inc/plugincontroller.class.php'); // Have to get the pluginutils already
88641ccffdSGerry Weißbach		// require_once(DOKU_INC.'inc/pluginutils.php'); // Have to get the pluginutils already
897d101cc1SGerry Weißbach		$this->__disablePlugins();
907d101cc1SGerry Weißbach	}
917d101cc1SGerry Weißbach
927d101cc1SGerry Weißbach	function __disablePlugins() {
93641ccffdSGerry Weißbach		global $plugin_controller_class;
947d101cc1SGerry Weißbach		$plugin_controller_class = 'preload_plugin_siteexport_controller';
957d101cc1SGerry Weißbach	}
967d101cc1SGerry Weißbach
977d101cc1SGerry Weißbach	function __create_preload_function() {
987d101cc1SGerry Weißbach
997d101cc1SGerry Weißbach		$PRELOADFILE = DOKU_INC.'inc/preload.php';
1007d101cc1SGerry Weißbach		$CURRENTFILE = 'DOKU_INC' . " . 'lib/plugins/siteexport/preload.php'";
1017d101cc1SGerry Weißbach		$CONTENT = <<<OUTPUT
1027d101cc1SGerry Weißbach/* SITE EXPORT *********************************************************** */
1037d101cc1SGerry Weißbach	if ( file_exists($CURRENTFILE) ) {
1047d101cc1SGerry Weißbach		include_once($CURRENTFILE);
1057d101cc1SGerry Weißbach		\$siteexport_preload = new preload_plugin_siteexport();
1067d101cc1SGerry Weißbach		\$siteexport_preload->__register_template();
1077d101cc1SGerry Weißbach		\$siteexport_preload->__temporary_disable_plugins();
1087d101cc1SGerry Weißbach		unset(\$siteexport_preload);
1097d101cc1SGerry Weißbach	}
1107d101cc1SGerry Weißbach/* SITE EXPORT END *********************************************************** */
1117d101cc1SGerry Weißbach
1127d101cc1SGerry WeißbachOUTPUT;
1137d101cc1SGerry Weißbach
1147d101cc1SGerry Weißbach		if ( file_exists($PRELOADFILE) ) {
1157d101cc1SGerry Weißbach
1167d101cc1SGerry Weißbach			if ( ! is_readable($PRELOADFILE) ) {
117996c253aSGerry Weißbach    			$this->error = "Preload File locked. It exists, but it can't be read.";
118996c253aSGerry Weißbach				msg($this->error, -1);
1197d101cc1SGerry Weißbach				return false;
1207d101cc1SGerry Weißbach			}
1217d101cc1SGerry Weißbach
1227d101cc1SGerry Weißbach			if ( !is_writeable($PRELOADFILE) ) {
123996c253aSGerry Weißbach    			$this->error = "Preload File locked. It exists and is readable, but it can't be written.";
124996c253aSGerry Weißbach				msg($this->error, -1);
1257d101cc1SGerry Weißbach				return false;
1267d101cc1SGerry Weißbach			}
1277d101cc1SGerry Weißbach
1287d101cc1SGerry Weißbach			$fileContent = file($PRELOADFILE);
1297d101cc1SGerry Weißbach			if ( !strstr(implode("", $fileContent), $CONTENT) ) {
1307d101cc1SGerry Weißbach
1317d101cc1SGerry Weißbach				$fp = fopen($PRELOADFILE, "a");
132996c253aSGerry Weißbach				if ( !strstr(implode("", $fileContent), "<?" )) {
133996c253aSGerry Weißbach    				fputs($fp, "<?php\n");
134996c253aSGerry Weißbach				}
1357d101cc1SGerry Weißbach				fputs($fp, "\n".$CONTENT);
1367d101cc1SGerry Weißbach				fclose($fp);
1377d101cc1SGerry Weißbach			}
1387d101cc1SGerry Weißbach
1397d101cc1SGerry Weißbach			return true;
1407d101cc1SGerry Weißbach
1417d101cc1SGerry Weißbach		} else if ( is_writeable(DOKU_INC . 'inc/') ) {
1427d101cc1SGerry Weißbach
1437d101cc1SGerry Weißbach			$fp = fopen($PRELOADFILE,"w");
1447d101cc1SGerry 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");
1457d101cc1SGerry Weißbach			fputs($fp, $CONTENT);
1467d101cc1SGerry Weißbach			fputs($fp, "// end auto-generated content\n\n");
1477d101cc1SGerry Weißbach			fclose($fp);
1487d101cc1SGerry Weißbach
1497d101cc1SGerry Weißbach			return true;
1507d101cc1SGerry Weißbach		}
1517d101cc1SGerry Weißbach
152996c253aSGerry Weißbach		$this->error = "Could not create/modify preload.php. Please check the write permissions for your DokuWiki/inc directory.";
153996c253aSGerry Weißbach		msg($this->error, -1);
1547d101cc1SGerry Weißbach		return false;
1557d101cc1SGerry Weißbach	}
1567d101cc1SGerry Weißbach
1577d101cc1SGerry Weißbach}
1587d101cc1SGerry Weißbach
1597d101cc1SGerry Weißbach// return a custom plugin list
1607d101cc1SGerry Weißbachclass preload_plugin_siteexport_controller extends Doku_Plugin_Controller {
1617d101cc1SGerry Weißbach
16265e0d1bfSGerry Weißbach	/**
16365e0d1bfSGerry Weißbach	 * Setup disabling
16465e0d1bfSGerry Weißbach	 */
16565e0d1bfSGerry Weißbach	public function __construct() {
16665e0d1bfSGerry Weißbach		parent::__construct();
1677d101cc1SGerry Weißbach
1682e56ccbaSGerry Weißbach		$disabledPlugins = array();
1692e56ccbaSGerry Weißbach
1702e56ccbaSGerry Weißbach		// support of old syntax
1712e56ccbaSGerry Weißbach		if ( is_array($_REQUEST['diPlu']) ) {
1722e56ccbaSGerry Weißbach			$disabledPlugins = $_REQUEST['diPlu'];
1732e56ccbaSGerry Weißbach		}
1742e56ccbaSGerry Weißbach
175641ccffdSGerry Weißbach		if ( !empty($_REQUEST['diInv']) )
176641ccffdSGerry Weißbach		{
177641ccffdSGerry Weißbach		    $allPlugins = array();
178641ccffdSGerry Weißbach		    foreach($this->tmp_plugins as $plugin => $enabled) { // All plugins
179641ccffdSGerry Weißbach		    	// check for CSS or JS
180641ccffdSGerry 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; }
181641ccffdSGerry Weißbach		    	$allPlugins[] = $plugin;
182641ccffdSGerry Weißbach		    }
183641ccffdSGerry Weißbach			$disabledPlugins = empty($_REQUEST['diPlu']) ? $allPlugins : array_diff($allPlugins, $_REQUEST['diPlu']);
1842e56ccbaSGerry Weißbach		}
1852e56ccbaSGerry Weißbach
1862e56ccbaSGerry Weißbach		// if this is defined, it overrides the settings made above. obviously.
1872e56ccbaSGerry Weißbach		$disabledPlugins = empty($_REQUEST['disableplugin']) ? $disabledPlugins : $_REQUEST['disableplugin'];
1882e56ccbaSGerry Weißbach
18965e0d1bfSGerry Weißbach		foreach( $disabledPlugins as $plugin ) {
19065e0d1bfSGerry Weißbach			$this->disable($plugin);
1917d101cc1SGerry Weißbach		}
192c7c6980aSGerry Weißbach
193c7c6980aSGerry Weißbach        // always enabled - JS and CSS will be cut out later.
194c7c6980aSGerry Weißbach        $this->enable('siteexport');
1957d101cc1SGerry Weißbach	}
1967d101cc1SGerry Weißbach
19765e0d1bfSGerry Weißbach   /**
19865e0d1bfSGerry Weißbach    * Disable the plugin
19965e0d1bfSGerry Weißbach    *
20065e0d1bfSGerry Weißbach    * @param string $plugin name of plugin
20165e0d1bfSGerry Weißbach    * @return bool; true allways.
20265e0d1bfSGerry Weißbach    */
20365e0d1bfSGerry Weißbach   public function disable($plugin) {
20465e0d1bfSGerry Weißbach	   $this->tmp_plugins[$plugin] = 0;
20565e0d1bfSGerry Weißbach	   return true;
2067d101cc1SGerry Weißbach   }
207c7c6980aSGerry Weißbach
20868901b7bSGerry Weißbach   /**
20968901b7bSGerry Weißbach    * Enable the plugin
21068901b7bSGerry Weißbach    *
21168901b7bSGerry Weißbach    * @param string $plugin name of plugin
21268901b7bSGerry Weißbach    * @return bool; true allways.
21368901b7bSGerry Weißbach    */
21468901b7bSGerry Weißbach   public function enable($plugin) {
21568901b7bSGerry Weißbach	   $this->tmp_plugins[$plugin] = 1;
21668901b7bSGerry Weißbach	   return true;
21768901b7bSGerry Weißbach   }
218c7c6980aSGerry Weißbach
219c7c6980aSGerry Weißbach   public function hasSiteexportHeaders() {
220c7c6980aSGerry Weißbach       $headers = function_exists('getallheaders') ? getallheaders() : null;
221c7c6980aSGerry Weißbach       return is_array($headers) && array_key_exists('X-Site-Exporter', $headers) && $headers['X-Site-Exporter'] = getSecurityToken();
222c7c6980aSGerry Weißbach   }
223c7c6980aSGerry Weißbach
224c7c6980aSGerry Weißbach   /**
2257fa31378SGerry Weißbach    * Filter the List of Plugins for the siteexport plugin
2267fa31378SGerry Weißbach    */
2277fa31378SGerry Weißbach   private function isSiteexportPlugin ($item) {
2287fa31378SGerry Weißbach        return $item != 'siteexport';
2297fa31378SGerry Weißbach   }
2307fa31378SGerry Weißbach
2317fa31378SGerry Weißbach    /**
232c7c6980aSGerry Weißbach     * Get the list of plugins, bute remove Siteexport from Style and
233c7c6980aSGerry Weißbach     * JS if in export Mode
234c7c6980aSGerry Weißbach     */
235c7c6980aSGerry Weißbach   public function getList($type='',$all=false) {
236c7c6980aSGerry Weißbach       $plugins = parent::getList($type, $all);
237c7c6980aSGerry Weißbach
238c7c6980aSGerry Weißbach       list(,, $caller) = debug_backtrace(false);
239c7c6980aSGerry Weißbach       if ( $this->hasSiteexportHeaders() && $caller != null && preg_match("/^(js|css)_/", $caller['function']) && preg_match("/(js|css)\.php$/", $caller['file']) ) {
2407fa31378SGerry Weißbach           $plugins = array_filter($plugins, array($this, 'isSiteexportPlugin'));
241c7c6980aSGerry Weißbach       }
242c7c6980aSGerry Weißbach
243c7c6980aSGerry Weißbach       return $plugins;
244c7c6980aSGerry Weißbach   }
2457d101cc1SGerry Weißbach}
2467d101cc1SGerry Weißbach
2477d101cc1SGerry Weißbach
2487d101cc1SGerry Weißbach?>
249