wp-environments-plugin.php

<?php

defined( 'ABSPATH' ) OR exit;
/**
 * Environments
 *
 * @package Environments
 *
 * @global object $wpdb
 *
 * @author  Mike Minor
 * @version 0.0.5r5
 */
/*
Plugin Name: Environments
Plugin URI: https://github.com/pixelbacon/wp-environment
Description: Sets constants for local, staging, and production environments based on your input.
Version: 0.0.5r5
Author: (Mike Minor)
Author URI: http://www.pixelbacon.com

*/

// Constants
require_once( dirname( __FILE__ ) . '/lib/constants.php' );

/**
 * Class WP_Environments
 *
 * Wordpress plugin used to associate domains with environments for local, staging, and production.
 */
class WP_Environments {
	/**
	 * @var string Name used in code, and in DB.
	 */
	var $namespace = "wp-environments";

	/**
	 * @var string Easy to read name for plugin.
	 */
	var $friendly_name = "Environments";

	/**
	 * @var string Version number of plugin.
	 */
	var $version = WPE_VERSION;

	/**
	 * @var array Holds default values that are saved in options.
	 */
	var $defaults = array(
		'local_domains'          => array( 'localhost' ),
		'staging_domains'        => array(),
		'pre_production_domains' => array(),
		'production_domains'     => array(),
	);

	/**
	 * Constructor function. Sets up option name, loads php files in lib directory, and sets up hooks.
	 */
	function __construct() {
		// Name of the option_value to store plugin options in
		$this->option_name = $this->namespace . '--options';

		// Load all library files used by this plugin
		$libs = glob( WPE_DIRNAME . '/lib/*.php' );
		foreach ( $libs as $lib ) {
			include_once( $lib );
		}

		if ( is_admin() ):
			$this->admin_options_errors = array();
		endif;

		$this->_add_hooks();
	}


//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
//  Guts
//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
	/**
	 * Sets the constant WPE_ENV.
	 * @uses in_array
	 * @uses define
	 */
	private function _set_WPE_ENV() {

		if(defined( 'WPE_ENV' ))
			return;

		// Check for local/dev
		if ( in_array( $_SERVER['HTTP_HOST'], $this->_get_option( 'local_domains' ) ) ):
			define( 'WPE_ENV', WPE_ENV_LOCAL );
			return;
		endif;

		// Check staging
		if ( in_array( $_SERVER['HTTP_HOST'], $this->_get_option( 'staging_domains' ) ) ):
			define( 'WPE_ENV', WPE_ENV_STAGING );
			return;
		endif;

		// Check pre production
		if ( in_array( $_SERVER['HTTP_HOST'], $this->_get_option( 'pre_production_domains' ) ) ):
			define( 'WPE_ENV', WPE_ENV_PREPROD );
			return;
		endif;

		// Check production
		if ( in_array( $_SERVER['HTTP_HOST'], $this->_get_option( 'production_domains' ) ) ):
			define( 'WPE_ENV', WPE_ENV_PROD );
			return;
		endif;

		define( 'WPE_ENV', WPE_ENV_LOCAL );

	}

	/**
	 * Whether or not the server is a local development environment.
	 * @return bool
	 */
	public function isLocal() {
		if( !defined( 'WPE_ENV' ) )
			$this->_set_WPE_ENV();

		return WPE_ENV === WPE_ENV_LOCAL;
	}

	/**
	 * Whether or not the server is in a staging environment.
	 * @return bool
	 */
	public function isStaging() {
		if( !defined( 'WPE_ENV' ) )
			$this->_set_WPE_ENV();

		return WPE_ENV === WPE_ENV_STAGING;
	}

	/**
	 * Whether or not the server is in a pre-production environment.
	 * @return bool
	 */
	public function isPreProd() {
		if( !defined( 'WPE_ENV' ) )
			$this->_set_WPE_ENV();

		return WPE_ENV === WPE_ENV_PREPROD;
	}

	/**
	 * Whether or not the server is in a production environment.
	 * @return bool
	 */
	public function isProd() {
		if( !defined( 'WPE_ENV' ) )
			$this->_set_WPE_ENV();

		return WPE_ENV === WPE_ENV_PROD;
	}


//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
//  Individual functions
//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
	/**
	 * Returns URL of WPE options page.
	 *
	 * return string
	 */
	public function getOptionsUrl(){
		return 'options-general.php?page=' . $this->namespace;
	}


	/**
	 * Checks whether a domain is already in the $env options.
	 * @param  string  $env    Which environment to check.
	 * @param  string  $domain Domain to check.
	 * @return boolean         Whether or not the passed $domain is in the $env array.
	 */
	private function _is_domain_in_array($env, &$domain){
		$domains = $this->_get_option( $env );

		if(empty($domains)):
			return false;
		endif;

		return in_array($domains, trim($domain));
	}


	/**
	 * Adds a domain to the specified environment.
	 *
	 * @param $env string WPE_LOCAL, WPE_STAGING, WPE_PREPROD, or WPE_PROD
	 * @param $domain
	 */
	private function _addDomain( $env, &$new_domains ) {
		$domains = $this->_get_option($env);

		// Passing single domain.
		if(is_string($new_domains)):
			if(!$this->_is_domain_in_array($env, $value) && !empty($new_domains)):
				array_push($domains, trim($new_domains));
			endif;

		// Passing array of domains.
		elseif (is_array($new_domains)):
			foreach ($new_domains as $key => &$value) {
				$value = trim($value);
				if( !$this->_is_domain_in_array($env, $value) && !empty($value)):
					array_push($domains, $value);
				endif;
			}
		endif;

		$this->update_option( $env, array_filter($domains) );
	}

	/**
	 * Adds a domain to the Local environment.
	 *
	 * @param $domain string
	 */
	public function addLocalDomain( $domain ) {
		$this->_addDomain( 'local_domains', $domain );
	}

	/**
	 * Adds a domain to the Staging environment.
	 *
	 * @param $domain string
	 */
	public function addStagingDomain( $domain ) {
		$this->_addDomain( 'staging_domains', $domain );
	}

	/**
	 * Adds a domain to the Production environment.
	 *
	 * @param $domain string
	 */
	public function addPreProdDomain( $domain ) {
		$this->_addDomain( 'pre_production_domains', $domain );
	}

	/**
	 * Adds a domain to the Production environment.
	 *
	 * @param $domain string
	 */
	public function addProdDomain( $domain ) {
		$this->_addDomain( 'production_domains', $domain );
	}


//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
//  STATIC METHODS
//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
	/**
	 * Hook into register_activation_hook action
	 */
	static function activate() {
	}

	/**
	 * Hook into register_deactivation_hook action
	 */
	static function deactivate() {
	}


//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
//  HOOKS
//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
	/**
	 * Adds hooks needed for working within the flow of Wordpress.
	 *
	 * Adds hooks for:
	 * - admin_menu
	 * - init
	 * - plugin_action_links
	 * - plugins_loaded
	 *
	 * @uses add_action
	 */
	private function _add_hooks() {
		// Options page for configuration
		add_action( 'admin_menu', array( &$this, 'wp_admin_menu' ) );

		// Route requests for form processing in Options
		add_action( 'init', array( &$this, 'wp_route' ) );

		// Add a settings link next to the "Deactivate" link on the plugin listing page
		add_filter( 'plugin_action_links', array( &$this, 'wp_admin_plugin_action_links' ), 10, 2 );

		add_action( 'plugins_loaded', array( &$this, 'wp_plugins_loaded' ) );

		add_action( 'after_setup_theme', array( &$this, 'wp_after_theme_setup' ) );

	}


//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
//  OPTIONS
//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
	/**
	 * Retrieve the stored plugin option or the default if no user specified value is defined
	 *
	 * @param string $option_name The name of the option you'd like to get.
	 *
	 * @uses get_option()
	 * @return mixed Returns the option value or false(boolean) if the option is not found
	 */
	public function _get_option( $option_name ) {
		// Load option values if they haven't been loaded already
		if ( ! isset( $this->options ) || empty( $this->options ) ):
			$this->options = get_option( $this->option_name, $this->defaults );
		endif;

		// print_r( $this->options );

		if ( isset( $this->options[$option_name] ) ) {
			return $this->options[$option_name]; // Return user's specified option value
		} elseif ( isset( $this->defaults[$option_name] ) ) {
			return $this->defaults[$option_name]; // Return default option value
		}

		return false;
	}


	/**
	 * Updates the options associated with the plugin.
	 * @param  string $option_name Name of option that will be saved.
	 * @param  [type] $value       Value of option that will be saved.
	 */
	private function _update_option( $option_name, &$value ) {
		if ( ! isset( $this->options ) || empty( $this->options ) ):
			$this->options = get_option( $this->option_name, $this->defaults );
		endif;

		if ( is_string( $value ) ):
			$value = trim( $value );
		endif;

		$this->options[$option_name] = $this->_sanitize( $value );

		update_option( $this->option_name, $this->options );
	}


//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
//  WordPress Integration
//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
	/**
	 * Called when 'plugins_loaded' hook is fired.
	 *
	 * @see http://codex.wordpress.org/Plugin_API/Action_Reference/plugins_loaded
	 */
	public function wp_plugins_loaded() {
		$this->_set_WPE_ENV();
		do_action( 'WPE_ready' );
	}

	/**
	* Called once theme is loaded, extra hook for after WPE is ready and theme is loaded.
	 *
	 * @see http://codex.wordpress.org/Plugin_API/Action_Reference/after_theme_loaded
	*/
	public function wp_after_theme_setup(){
		do_action( 'WPE_after_theme_setup' );
	}


//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
//  WP - ADMIN
//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------

	/**
	 * Add WPE status to Admin bar.
	 */
	function wp_admin_bar_menu( $wp_admin_bar ){
		$args = array(
	        'id' => 'custom-node',
	        'title' => 'Custom Node',
	        'href' => '#',
	        'meta' => array(
	            'class' => 'custom-node-class'
	        )
	    );
	    $wp_admin_bar->add_node( $args );
	}

	/**
	 * Define the admin menu options for this plugin
	 *
	 * @uses add_action()
	 * @uses add_options_page()
	 */
	function wp_admin_menu() {
		if ( ! current_user_can( 'manage_options' ) ):
			wp_die( 'You do not have sufficient permissions to access this page.' );

			return;
		endif;

		$page_hook = add_options_page(
			$this->friendly_name,
			$this->friendly_name,
			'administrator',
			$this->namespace,
			array( &$this, 'wp_admin_options_page' )
		);

		$this->admin_options_errors = array();

		// Add print scripts and styles action based off the option page hook
		add_action( 'admin_print_scripts-' . $page_hook, array( &$this, 'wp_admin_enqueue_scripts' ) );
		add_action( 'admin_print_styles-' . $page_hook, array( &$this, 'wp_admin_enqueue_styles' ) );
	}

	/**
	 * Admin - Enqueue JS file(s).
	 *
	 * @uses wp_register_style()
	 * @uses wp_enqueue_style()
	 */
	function wp_admin_enqueue_scripts() {
		wp_register_script( "{$this->namespace}-js-admin", WPE_URLPATH . "/js/admin.js", array( 'jquery' ), $this->version, true );
		wp_enqueue_script( "{$this->namespace}-js-admin" );
	}

	/**
	 * Admin - Enqueue CSS file(s).
	 *
	 * @uses wp_register_style()
	 * @uses wp_enqueue_style()
	 */
	function wp_admin_enqueue_styles() {
		wp_register_style( "{$this->namespace}-css-admin", WPE_URLPATH . "/css/admin.css", array(), $this->version, 'screen' );
		wp_enqueue_style( "{$this->namespace}-css-admin" );
	}

	/**
	 * Hook into plugin_action_links filter
	 *
	 * Adds a "Settings" link next to the "Deactivate" link in the plugin listing page
	 * when the plugin is active.
	 *
	 * @param object $links An array of the links to show, this will be the modified variable
	 * @param string $file  The name of the file being processed in the filter
	 *
	 * @return array Links after after adding the plugin's Settings link.
	 */
	function wp_admin_plugin_action_links( $links, $file ) {
		if ( $file == plugin_basename( WPE_DIRNAME . '/' . basename( __FILE__ ) ) ) {
			$old_links = $links;
			$new_links = array(
				"settings" => '<a href="options-general.php?page=' . $this->namespace . '">' . __( 'Settings' ) . '</a>'
			);
			$links     = array_merge( $new_links, $old_links );
		}

		return $links;
	}


	/**
	 * The admin section options page rendering method
	 *
	 * @uses current_user_can()
	 */
	function wp_admin_options_page() {
		global $WPE;

		if ( ! current_user_can( 'manage_options' ) ) {
			require( WPE_DIRNAME . "/views/admin_no_options.php" );

			return;
		}

		$page_title = $this->friendly_name . ' - Options';
		$namespace  = $this->namespace;

		// Retrieve admin errors since we use wp_safe_redirect to show this page.
		$this->admin_options_errors = isset( $_GET[$this->namespace . '-errors'] ) ? $_GET[$this->namespace . '-errors'] : array();

		include( WPE_DIRNAME . "/views/admin_options.php" );
	}

	/**
	 * Process update page form submissions
	 *
	 * @uses WP_Environments::sanitize()
	 * @uses wp_redirect()
	 * @uses wp_verify_nonce()
	 *
	 * @todo Use regex to validate domain input.
	 */
	private function _wp_admin_options_update() {
		// Verify submission for processing using wp_nonce
		if ( wp_verify_nonce( $_REQUEST['_wpnonce'], "{$this->namespace}-update-options" ) ) {
			$data = array();

			/*
			 * Loop through each POSTed value and sanitize it to protect against malicious code. Please
			 * note that rich text (or full HTML fields) should not be processed by this function and
			 * dealt with directly.
			 */

			foreach ( $_POST['data'] as $key => &$val ) {
				// Assume the value is not clean until we actually process it.
				$isValid = false;

				$data[$key] = $this->_sanitize( $val );

				switch ( $key ) {
					default:
						{
						$isValid = true;
						break;
						}
				}

				// If the value is not valid, unset it from the array so we don't save it.
				if ( ! $isValid ):
					array_push( $this->admin_options_errors, $this->_get_error_code( $key ) );
					unset( $data[$key] );
				endif;
			}

			update_option( $this->option_name, $data );

			$_POST['_wp_http_referer'] = add_query_arg( $this->namespace . '-errors', $this->admin_options_errors, $_POST['_wp_http_referer'] );
			if ( count( $this->admin_options_errors ) === 0 ):
				$_POST['_wp_http_referer'] = add_query_arg( 'message', '1' );
			endif;

			wp_safe_redirect( $_POST['_wp_http_referer'] );
			exit;
		}
	}

	/**
	 * Sanitize data
	 *
	 * @param string|array $str The data to be sanitized
	 *
	 * @uses wp_kses()
	 * @return mixed The sanitized version of the data
	 */
	private function _sanitize( $str ) {
		if ( ! function_exists( 'wp_kses' ) ):
			require_once( ABSPATH . 'wp-includes/kses.php' );
		endif;

		global $allowedposttags;
		global $allowedprotocols;

		if ( is_string( $str ) ) {
			$str = wp_kses( $str, $allowedposttags, $allowedprotocols );
		} elseif ( is_array( $str ) ) {
			$arr = array();
			foreach ( (array) $str as $key => $val ) {
				$arr[$key] = $this->_sanitize( $val );
			}
			$str = $arr;
		}

		return $str;
	}

	/**
	 * Validates a domain.
	 *
	 * @param string $domain_name
	 *
	 * @return bool
	 */
	private function _is_domain_valid( $domain_name ) {
		return ( preg_match( "/^([a-z\d](-*[a-z\d])*)(\.([a-z\d](-*[a-z\d])*))*$/i", $domain_name ) //valid chars check
				&& preg_match( "/^.{1,253}$/", $domain_name ) //overall length check
				&& preg_match( "/^[^\.]{1,63}(\.[^\.]{1,63})*$/", $domain_name ) ); //length of each label
	}

	/**
	 * Returns a string based on the key passed. For generic errors only.
	 *
	 * @param string $key
	 *
	 * @return string
	 */
	private function _get_error_code( $key ) {
		switch ( $key ) {
			default:
				{
				return 'Generic Error...';
				break;
				}
		}
	}


//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
//  ROUTING
//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------

	/**
	 * Route the user based off of environment conditions
	 *
	 * This function will handling routing of form submissions to the appropriate
	 * form processor.
	 *
	 * @uses WP_Environments->_wp_admin_options_update()
	 */
	function wp_route() {
		$uri      = $_SERVER['REQUEST_URI'];
		$protocol = isset( $_SERVER['HTTPS'] ) ? 'https' : 'http';
		$hostname = $_SERVER['HTTP_HOST'];
		$url      = "{$protocol}://{$hostname}{$uri}";
		$is_post  = (bool) ( strtoupper( $_SERVER['REQUEST_METHOD'] ) == "POST" );

		// Check if a nonce was passed in the request
		if ( isset( $_REQUEST['_wpnonce'] ) ) {
			$nonce = $_REQUEST['_wpnonce'];

			// Handle POST requests
			if ( $is_post ) {
				if ( wp_verify_nonce( $nonce, "{$this->namespace}-update-options" ) ) {
					$this->_wp_admin_options_update();
				}
			} // Handle GET requests
			else {

			}
		}
	}


//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
//  UTILITIES
//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
	/**
	 * Clears out the passed array of blank quotes and null instances.
	 *
	 * @param array $array
	 *
	 * @return array An array with no emptry or null values.
	 */
	public function clean_array( &$array ) {
		return array_slice( array_filter( $array ), 0 );
	}


//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------
//  SINGLETON INSTANCE
//-----------------------------------------------------------------------------------------------------------
//-----------------------------------------------------------------------------------------------------------

	/**
	 * Initialization function to hook into the WordPress init action
	 *
	 * Instantiates the class on a global variable and sets the class, actions
	 * etc. up for use.
	 */
	static function instance() {
		global $WPE;

		// Only instantiate the Class if it hasn't been already
		if ( ! isset( $WPE ) ) $WPE = new WP_Environments();
	}
}
/** Set instance. */
if ( ! isset( $WPE ) ) {
	WP_Environments::instance();
}


/**
 * Returns the URL of the WPE options page.
 * @return string
 */
function WPE_getOptionsUrl(){
	global $WPE;
	return $WPE->getOptionsUrl();
}


/**
 * Whether or not the server is a local development environment.
 * @return bool
 */
function WPE_isLocal() {
	global $WPE;
	return $WPE->isLocal();
}

/**
 * Adds domain to Local environment.
 *
 * @param $domain string|array
 */
function WPE_addLocalDomain( $domain ) {
	global $WPE;
	$WPE->addLocalDomain( $domain );
}

/**
 * Whether or not the server is in a staging environment.
 * @return bool
 */
function WPE_isStaging() {
	global $WPE;
	return $WPE->isStaging();
}

/**
 * Adds domain to Staging environment.
 *
 * @param $domain string|array
 */
function WPE_addStagingDomain( $domain ) {
	global $WPE;
	$WPE->addStagingDomain( $domain );
}

/**
 * Whether or not the server is in a pre-production environment.
 * @return bool
 */
function WPE_isPreProd() {
	global $WPE;
	return $WPE->isPreProd();
}

/**
 * Adds domain to Pre-Production environment.
 *
 * @param $domain string|array
 */
function WPE_addPreProdDomain( $domain ) {
	global $WPE;
	$WPE->addPreProdDomain( $domain );
}

/**
 * Whether or not the server is in a production environment.
 * @return bool
 */
function WPE_isProd() {
	global $WPE;
	return $WPE->isProd();
}

/**
 * Adds domain to Production environment.
 *
 * @param $domain string|array
 */
function WPE_addProdDomain( $domain ) {
	global $WPE;
	$WPE->addProdDomain( $domain );
}

register_activation_hook( __FILE__, array( 'WP_Environments', 'activate' ) );
register_deactivation_hook( __FILE__, array( 'WP_Environments', 'deactivate' ) );

?>