xref: /plugin/embeddedphp/syntax/phpinline.php (revision d3666e41f8c4f409eb28c2f6cecc748440f90581)

<?php
/**
 * DokuWiki Plugin embeddedphp (Syntax Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author	fiwswe <dwplugin@fwml.de>
 */

class syntax_plugin_embeddedphp_phpinline extends \dokuwiki\Extension\SyntaxPlugin
{
	/**
	 * Return the tag this plugin instance reacts to
	 *
	 * @return string
	 */
	protected function GetTag(): string
	{
		return 'php';
	}

	/**
	 * Return the exit pattern as we need this more than once
	 *
	 * @return string
	 */
	protected function GetExitPattern(): string
	{
		return '</'.$this->GetTag().'>';
	}

	/** @inheritDoc */
	public function getType()
	{
		return 'protected';
	}

	/** @inheritDoc */
	public function getSort()
	{
		// The default <php>/<PHP> handler up to "Igor" has priority 180. By setting a
		// lower priority we override the built-in functionality.
		return 179;
	}


	/*
	 * Return the plugin Lexer mode
	 * This works fine for most trivial cases. But some plugins
	 * may need to override this method.
	 *
	 * @return string
	 */
	protected function getPluginModeName(): string
	{
		$x = ['plugin',
			  $this->getPluginName(),
			  $this->getPluginComponent()];	//	If component is empty it will be filtered later.

		return implode('_', array_filter($x));
	}

	/** @inheritDoc */
	public function connectTo($mode)
	{
		$p = '<'.$this->GetTag().'\b>(?=.*?'.$this->GetExitPattern().')';
		$m = $this->getPluginModeName();
		$this->Lexer->addEntryPattern($p, $mode, $m);
	}

	/** @inheritDoc */
	public function postConnect()
	{
		$m = $this->getPluginModeName();
		$this->Lexer->addExitPattern('.*?'.$this->GetExitPattern(), $m);
	}

	/** @inheritDoc */
	public function handle($match, $state, $pos, Doku_Handler $handler)
	{
		global $INPUT;

		// If we are parsing a submitted comment. Executing embedded PHP in comments is
		// not a good idea!
		if ($INPUT->has('comment')) {
			return false;
		}

		switch($state) {
			case DOKU_LEXER_EXIT:
				return [$state, substr($match, 0, -strlen($this->GetExitPattern()))];
		}

		return false;
	}

	/** @inheritDoc */
	public function render($mode, Doku_Renderer $renderer, $data)
	{
		if ($mode === 'xhtml') {
			if (is_array($data)) {
				@[$state, $phpsource] = $data;
				switch($state) {
					case DOKU_LEXER_EXIT:
						$this->php($phpsource, $renderer);

						return true;
				}
			}
		}

		return false;
	}

	/**
	 * Determine whether embedding PHP code is allowed
	 *
	 * @return	bool	true if executing embedded PHP code is allowed
	 */
	protected function allowEmbedding(): bool
	{
		$allow = ($this->getConf('embedphpok') == 1) &&
				 ($this->getConf('privatewiki') == 1);

		return $allow;
	}

	/**
	 * Execute PHP code if allowed
	 *
	 * @param  string $phpsource		 PHP code that is either executed or printed
	 * @param  Doku_Renderer $renderer	 Renderer used for output
	 */
	protected function php($phpsource, Doku_Renderer $renderer): void
	{
		if ($this->allowEmbedding()) {
			ob_start();
			eval($phpsource);
			$o = ob_get_contents();
			if (!empty($o)) {
				if ($this->isBlockElement()) {
					$renderer->doc .= '<div class="embeddedphp">'.$o.'</div>';
				} else {
					$renderer->doc .= '<span class="embeddedphp">'.$o.'</span>';
				}
			}
			ob_end_clean();
		} else {
			$wrapper = $this->isBlockElement() ? 'pre' : 'code';
			$renderer->doc .= /*'###.get_class($this)'.*/p_xhtml_cached_geshi($phpsource, 'php', $wrapper);
		}
	}

	/**
	 * Generic test to differentiate between inline and block modes
	 *
	 * @return bool true if this generates a block element, false otherwise.
	 */
	protected function isBlockElement(): bool
	{
		return false;
	}
}