WP_PHP_Console\Plugin

Complexity

Total Complexity

33

Size/Duplication

Total Lines	324
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	7
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	29	4
A	set_locale()	0	9	1
B	connect()	0	32	2
A	get_options()	0	13	1
C	apply_options()	0	32	8
F	init()	0	80	15
A	print_notice_exception()	0	12	1
A	password_notice()	0	18	1

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 21 and the first side effect is on line 13.

/**
 * WP PHP Console Plugin Core Class
 *
 * @link    https://github.com/unfulvio/wp-php-console
 * @since   1.0.0
 * @package WP_PHP_Console
 */
namespace WP_PHP_Console;

use PhpConsole;

defined( 'ABSPATH' ) or exit;

Using logical operators such as or instead of || is generally not recommended.

/**
 * WP PHP Console main class.
 *
 * @since   1.0.0
 * @package WP_PHP_Console
 */
class Plugin {


	/**
	 * The plugin version.
	 *
	 * @since 1.5.0
	 * @const string
	 */
	CONST VERSION = '1.5.0';

	/**
	 * The plugin name.
	 *
	 * @since 1.5.0
	 * @const string
	 */
	CONST NAME = 'WP PHP Console';

	/**
	 * This plugin's settings options.
	 *
	 * @since  1.0.0
	 * @access protected
	 * @var    array $options Array of this plugin settings options.
	 */
	protected $options = array();

	/**
	 * Instance of PHP Console connector object.
	 *
	 * @since  1.4.1
	 * @access public
	 * @var    PhpConsole\Connector $connector Instance.
	 */
	public $connector;


	/**
	 * Load plugin and connect to PHP Console.
	 *
	 * @since 1.0.0
	 */
	public function __construct() {

		// Translations.
		add_action( 'plugins_loaded', array( $this, 'set_locale' ) );

		// Set options.
		$this->options = $this->get_options();

		// Load admin.
		if ( ! defined( 'DOING_AJAX' )  && is_admin() ) {
			require_once __DIR__ . '/class-wp-php-console-settings.php';
			new Settings( $this->options );
		}

		// Bail out if PHP Console can't be found.
		if ( ! class_exists( 'PhpConsole\Connector' ) ) {
			return;
		}

		// Connect to PHP Console.
		$this->connect();

		// Apply PHP Console options.
		$this->apply_options();

		// Delay further PHP Console initialisation to have more context during Remote PHP execution.
		add_action( 'wp_loaded', array( $this, 'init' ) );

	}


	/**
	 * Set plugin text domain.
	 *
	 * @since 1.0.0
	 */
	public function set_locale() {

		load_plugin_textdomain(
			'wp-php-console',
			false,
			dirname( plugin_basename( __FILE__ ) ) . '/languages/'
		);

	}


	/**
	 * Connect to PHP Console.
	 *
	 * @since 1.4.0
	 */
	private function connect() {

		// By default PHP Console uses PhpConsole\Storage\Session for postponed responses,
		// so all temporary data will be stored in $_SESSION.
		// But there is some problem with frameworks like WordPress that override PHP session handler.
		// PHP Console has alternative storage drivers for this - we will write to a temporary file:

		// TODO this generates "PHP Warning: session_start(): Cannot send session cache limiter - headers already sent"

		/**
		$phpcdir  = __DIR__ . '/tmp';
		$make_dir = wp_mkdir_p( $phpcdir );

		if ( true === $make_dir ) {

			try {
				$storage = @new PhpConsole\Storage\File( $phpcdir . '/' . md5( __FILE__ ) . '_pc.data' );
				PhpConsole\Connector::setPostponeStorage( $storage );
			} catch( \Exception $e ) {
				// TODO $storage is under DOCUMENT_ROOT - it's insecure but did not find another solution in WP
				$this->print_notice_exception( $e );
			}

		}
		**/

		// Perform PHP Console initialisation required asap for other code to be able to output to the JavaScript console.
		if ( ! $this->connector instanceof PhpConsole\Connector ) {
			$this->connector = PhpConsole\Connector::getInstance();
		}

	}


	/**
	 * Get WP PHP Console settings options.
	 *
	 * @since  1.4.0
	 * @return array
	 */
	protected function get_options() {

		$options = get_option( 'wp_php_console', array() );

		return wp_parse_args( $options, array(
			'ip'       => '',
			'password' => '',
			'register' => false,
			'short'    => false,
			'ssl'      => false,
			'stack'    => false,
		) );
	}


	/**
	 * Apply options.
	 *
	 * @since 1.4.1
	 */
	private function apply_options() {

apply_options uses the super-global variable $_SERVER which is generally not recommended.

		// Bail out if not connected yet to PHP Console.
		if ( ! $this->connector instanceof PhpConsole\Connector ) {
			return;
		}

		// Apply 'register' option to PHP Console
		if ( true === $this->options['register'] && ! class_exists( 'PC', false ) ) {
			// Only if PC not registered yet
			try {
				PhpConsole\Helper::register();
			} catch( \Exception $e ) {
				$this->print_notice_exception( $e );
			}
		}

		// Apply 'stack' option to PHP Console
		if ( true === $this->options['stack'] ) {
			$this->connector->getDebugDispatcher()->detectTraceAndSource = true;
		}

		// Apply 'short' option to PHP Console
		if ( true === $this->options['short'] ) {
			try {
				$this->connector->setSourcesBasePath( $_SERVER['DOCUMENT_ROOT'] );
			} catch ( \Exception $e ) {
				$this->print_notice_exception( $e );
			}
		}

	}


	/**
	 * Initialize PHP Console.
	 *
	 * @since 1.0.0
	 */
	public function init() {

		// Set PHP Console extension password.
		$password = $this->options['password'];

		if ( ! $password ) {
			// Display admin notice and abort if no password has been set.
			add_action( 'admin_notices', array( $this, 'password_notice' ) );
			return;
		}

		// Selectively remove slashes added by WordPress as expected by PhpConsole.
		if ( array_key_exists( PhpConsole\Connector::POST_VAR_NAME, $_POST ) ) {
			$_POST[ PhpConsole\Connector::POST_VAR_NAME ] = stripslashes_deep( $_POST[ PhpConsole\Connector::POST_VAR_NAME ] );
		}

		if ( ! $this->connector instanceof PhpConsole\Connector ) {
			$this->connector = PhpConsole\Connector::getInstance();
		}

		try {
			$this->connector->setPassword( $password );
		} catch ( \Exception $e ) {
			$this->print_notice_exception( $e );
		}

		// PhpConsole instance.
		$handler = PhpConsole\Handler::getInstance();

		if ( true !== PhpConsole\Handler::getInstance()->isStarted() ) {
			try {
				$handler->start();
			} catch( \Exception $e ) {
				$this->print_notice_exception( $e );
			}
		}

		// Enable SSL-only mode.
		if ( true === $this->options['ssl'] ) {
			$this->connector->enableSslOnlyMode();
		}

		// Restrict IP addresses.
		$allowedIpMasks = ! empty( $this->options['ip'] ) ? explode( ',', $this->options['ip'] ) : '';

		if ( is_array( $allowedIpMasks ) && count( $allowedIpMasks ) > 0 ) {
			$this->connector->setAllowedIpMasks( $allowedIpMasks );
		}

		$evalProvider = $this->connector->getEvalDispatcher()->getEvalProvider();

		try {
			$evalProvider->addSharedVar( 'uri', $_SERVER['REQUEST_URI'] );
		} catch ( \Exception $e ) {
			$this->print_notice_exception( $e );
		}

		try {
			$evalProvider->addSharedVarReference( 'post', $_POST );
		} catch ( \Exception $e ) {
			$this->print_notice_exception( $e );
		}

		$openBaseDirs = array( ABSPATH, get_template_directory() );

		try {
			$evalProvider->addSharedVarReference( 'dirs', $openBaseDirs );
		} catch ( \Exception $e ) {
			$this->print_notice_exception( $e );
		}

		$evalProvider->setOpenBaseDirs( $openBaseDirs );

		try {
			$this->connector->startEvalRequestsListener();
		} catch ( \Exception $e ) {
			$this->print_notice_exception( $e );
		}

	}


	/**
	 * Prints an exception message as WordPress admin notice.
	 *
	 * @since 1.4.0
	 * @param \Exception $e Exception object
	 */
	public function print_notice_exception( \Exception $e ) {

		add_action( 'admin_notices', function() use ( $e ) {

			?>
			<div class="error">
				<p><?php printf( '%1$s: %2$s', self::NAME, $e->getMessage() ); ?></p>
			</div>
			<?php

		} );
	}



	/**
	 * Admin password notice.
	 * Prompts user to set a password for PHP Console upon plugin activation.
	 *
	 * @since 1.3.2
	 */
	public function password_notice() {

		?>
		<div class="update-nag">
			<?php

			/* translators: Placeholders: %1$s - WP Php Console name, %2$s - opening HTML <a> link tag; %3$s closing HTML </a> link tag */
			printf( __( '%1$s: Please remember to %2$s set a password %3$s if you want to enable the terminal.', 'wp-php-console' ),
				'<strong>' . self::NAME . '</strong>',
				'<a href="' . esc_url( admin_url( 'options-general.php?page=wp-php-console' ) ) .'">',
				'</a>'
			);

			?>
		</div>
		<?php

	}


}