eventespresso / event-espresso-core

core/domain/services/contexts/RequestTypeContextCheckerInterface.php

Indentation +90 added lines, -90 removed lines

@@ -13,124 +13,124 @@
 interface RequestTypeContextCheckerInterface
 {
 
-    /**
-     * true if the current request involves some form of activation
-     *
-     * @return bool
-     */
-    public function isActivation();
+	/**
+	 * true if the current request involves some form of activation
+	 *
+	 * @return bool
+	 */
+	public function isActivation();
 
 
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation);
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation);
 
 
-    /**
-     * true if the current request is for the admin and is not being made via AJAX
-     *
-     * @return bool
-     */
-    public function isAdmin();
+	/**
+	 * true if the current request is for the admin and is not being made via AJAX
+	 *
+	 * @return bool
+	 */
+	public function isAdmin();
 
 
-    /**
-     * true if the current request is for the admin AND is being made via AJAX
-     * and the ajax request contains the request parameter "ee_admin_ajax"
-     *
-     * @return bool
-     */
-    public function isAdminAjax();
+	/**
+	 * true if the current request is for the admin AND is being made via AJAX
+	 * and the ajax request contains the request parameter "ee_admin_ajax"
+	 *
+	 * @return bool
+	 */
+	public function isAdminAjax();
 
 
-    /**
-     * true if the current request is being made via AJAX... any AJAX
-     *
-     * @return bool
-     */
-    public function isAjax();
+	/**
+	 * true if the current request is being made via AJAX... any AJAX
+	 *
+	 * @return bool
+	 */
+	public function isAjax();
 
 
-    /**
-     * true if the current request is for the EE REST API
-     *
-     * @return bool
-     */
-    public function isApi();
+	/**
+	 * true if the current request is for the EE REST API
+	 *
+	 * @return bool
+	 */
+	public function isApi();
 
 
-    /**
-     * true if the current request is from the command line
-     *
-     * @return bool
-     */
-    public function isCli();
+	/**
+	 * true if the current request is from the command line
+	 *
+	 * @return bool
+	 */
+	public function isCli();
 
 
-    /**
-     * true if the current request is for a WP_Cron
-     *
-     * @return bool
-     */
-    public function isCron();
+	/**
+	 * true if the current request is for a WP_Cron
+	 *
+	 * @return bool
+	 */
+	public function isCron();
 
 
-    /**
-     * true if the current request is for either the EE admin or EE frontend AND is being made via AJAX
-     *
-     * @return bool
-     */
-    public function isEeAjax();
+	/**
+	 * true if the current request is for either the EE admin or EE frontend AND is being made via AJAX
+	 *
+	 * @return bool
+	 */
+	public function isEeAjax();
 
 
-    /**
-     * true if the current request is for a feed (ie: RSS)
-     *
-     * @return bool
-     */
-    public function isFeed();
+	/**
+	 * true if the current request is for a feed (ie: RSS)
+	 *
+	 * @return bool
+	 */
+	public function isFeed();
 
 
-    /**
-     * true if the current request is for the frontend and is not being made via AJAX
-     *
-     * @return bool
-     */
-    public function isFrontend();
+	/**
+	 * true if the current request is for the frontend and is not being made via AJAX
+	 *
+	 * @return bool
+	 */
+	public function isFrontend();
 
 
-    /**
-     * @return bool
-     */
-    public function isFrontAjax();
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax();
 
 
-    /**
-     * @return bool
-     */
-    public function isIframe();
+	/**
+	 * @return bool
+	 */
+	public function isIframe();
 
 
-    /**
-     * true if the current request is being made via AJAX but is NOT for EE related logic
-     *
-     * @return bool
-     */
-    public function isOtherAjax();
+	/**
+	 * true if the current request is being made via AJAX but is NOT for EE related logic
+	 *
+	 * @return bool
+	 */
+	public function isOtherAjax();
 
 
-    /**
-     * true if the current request is a loopback sent from WP core to test for errors
-     *
-     * @return bool
-     */
-    public function isWordPressScrape();
+	/**
+	 * true if the current request is a loopback sent from WP core to test for errors
+	 *
+	 * @return bool
+	 */
+	public function isWordPressScrape();
 
 
-    /**
-     * @return string
-     */
-    public function slug();
+	/**
+	 * @return string
+	 */
+	public function slug();
 }

core/domain/services/contexts/RequestTypeContextChecker.php

Indentation +191 added lines, -191 removed lines

@@ -16,195 +16,195 @@
 class RequestTypeContextChecker extends ContextChecker implements RequestTypeContextCheckerInterface
 {
 
-    /**
-     * @var RequestTypeContext $request_type
-     */
-    private $request_type;
-
-
-    /**
-     * RequestTypeContextChecker constructor.
-     *
-     * @param RequestTypeContext $request_type
-     */
-    public function __construct(RequestTypeContext $request_type)
-    {
-        $this->request_type = $request_type;
-        parent::__construct(
-            'RequestTypeContextChecker',
-            $this->request_type->validRequestTypes()
-        );
-    }
-
-
-    /**
-     * true if the current request involves some form of activation
-     *
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * true if the current request is for the admin and is not being made via AJAX
-     *
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->slug() === RequestTypeContext::ADMIN;
-    }
-
-
-    /**
-     * true if the current request is for the admin AND is being made via AJAX
-     *
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->slug() === RequestTypeContext::AJAX_ADMIN;
-    }
-
-
-    /**
-     * true if the current request is being made via AJAX... any AJAX
-     *
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->isEeAjax() || $this->isOtherAjax();
-    }
-
-
-    /**
-     * true if the current request is for either the EE admin or EE frontend AND is being made via AJAX
-     *
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->isAdminAjax() || $this->isFrontAjax();
-    }
-
-
-    /**
-     * true if the current request is being made via AJAX but is NOT for EE related logic
-     *
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->slug() === RequestTypeContext::AJAX_OTHER;
-    }
-
-    /**
-     * true if the current request is for the EE REST API
-     *
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->slug() === RequestTypeContext::API;
-    }
-
-
-    /**
-     * true if the current request is from the command line
-     *
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->slug() === RequestTypeContext::CLI;
-    }
-
-
-    /**
-     * true if the current request is for a WP_Cron
-     *
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->slug() === RequestTypeContext::CRON;
-    }
-
-
-    /**
-     * true if the current request is for a feed (ie: RSS)
-     *
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->slug() === RequestTypeContext::FEED;
-    }
-
-
-    /**
-     * true if the current request is for the frontend and is not being made via AJAX
-     *
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->slug() === RequestTypeContext::FRONTEND;
-    }
-
-
-    /**
-     * true if the current request is for the frontend AND is being made via AJAX
-     *
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->slug() === RequestTypeContext::AJAX_FRONT;
-    }
-
-
-    /**
-     * true if the current request is for content that is to be displayed within an iframe
-     *
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->slug() === RequestTypeContext::IFRAME;
-    }
-
-
-    /**
-     * true if the current request is a loopback sent from WP core to test for errors
-     *
-     * @return bool
-     */
-    public function isWordPressScrape()
-    {
-        return $this->request_type->slug() === RequestTypeContext::WP_SCRAPE;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
+	/**
+	 * @var RequestTypeContext $request_type
+	 */
+	private $request_type;
+
+
+	/**
+	 * RequestTypeContextChecker constructor.
+	 *
+	 * @param RequestTypeContext $request_type
+	 */
+	public function __construct(RequestTypeContext $request_type)
+	{
+		$this->request_type = $request_type;
+		parent::__construct(
+			'RequestTypeContextChecker',
+			$this->request_type->validRequestTypes()
+		);
+	}
+
+
+	/**
+	 * true if the current request involves some form of activation
+	 *
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * true if the current request is for the admin and is not being made via AJAX
+	 *
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->slug() === RequestTypeContext::ADMIN;
+	}
+
+
+	/**
+	 * true if the current request is for the admin AND is being made via AJAX
+	 *
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->slug() === RequestTypeContext::AJAX_ADMIN;
+	}
+
+
+	/**
+	 * true if the current request is being made via AJAX... any AJAX
+	 *
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->isEeAjax() || $this->isOtherAjax();
+	}
+
+
+	/**
+	 * true if the current request is for either the EE admin or EE frontend AND is being made via AJAX
+	 *
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->isAdminAjax() || $this->isFrontAjax();
+	}
+
+
+	/**
+	 * true if the current request is being made via AJAX but is NOT for EE related logic
+	 *
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->slug() === RequestTypeContext::AJAX_OTHER;
+	}
+
+	/**
+	 * true if the current request is for the EE REST API
+	 *
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->slug() === RequestTypeContext::API;
+	}
+
+
+	/**
+	 * true if the current request is from the command line
+	 *
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->slug() === RequestTypeContext::CLI;
+	}
+
+
+	/**
+	 * true if the current request is for a WP_Cron
+	 *
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->slug() === RequestTypeContext::CRON;
+	}
+
+
+	/**
+	 * true if the current request is for a feed (ie: RSS)
+	 *
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->slug() === RequestTypeContext::FEED;
+	}
+
+
+	/**
+	 * true if the current request is for the frontend and is not being made via AJAX
+	 *
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->slug() === RequestTypeContext::FRONTEND;
+	}
+
+
+	/**
+	 * true if the current request is for the frontend AND is being made via AJAX
+	 *
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->slug() === RequestTypeContext::AJAX_FRONT;
+	}
+
+
+	/**
+	 * true if the current request is for content that is to be displayed within an iframe
+	 *
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->slug() === RequestTypeContext::IFRAME;
+	}
+
+
+	/**
+	 * true if the current request is a loopback sent from WP core to test for errors
+	 *
+	 * @return bool
+	 */
+	public function isWordPressScrape()
+	{
+		return $this->request_type->slug() === RequestTypeContext::WP_SCRAPE;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
 }

core/domain/services/contexts/RequestTypeContextDetector.php

Indentation +133 added lines, -133 removed lines

@@ -19,137 +19,137 @@
 class RequestTypeContextDetector
 {
 
-    /**
-     * @var RequestTypeContextFactory $factory
-     */
-    private $factory;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-
-    /**
-     * RequestTypeContextDetector constructor.
-     *
-     * @param RequestInterface          $request
-     * @param RequestTypeContextFactory $factory
-     */
-    public function __construct(RequestInterface $request, RequestTypeContextFactory $factory)
-    {
-        $this->request = $request;
-        $this->factory = $factory;
-    }
-
-
-    /**
-     * @return RequestTypeContext
-     * @throws InvalidArgumentException
-     */
-    public function detectRequestTypeContext()
-    {
-        // Detect error scrapes
-        if ($this->request->getRequestParam('wp_scrape_key') !== null
-            && $this->request->getRequestParam('wp_scrape_nonce') !== null
-        ) {
-            return $this->factory->create(RequestTypeContext::WP_SCRAPE);
-        }
-        // Detect EE REST API
-        if ($this->isEspressoRestApiRequest()) {
-            return $this->factory->create(RequestTypeContext::API);
-        }
-        // Detect AJAX
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            if (filter_var($this->request->getRequestParam('ee_front_ajax'), FILTER_VALIDATE_BOOLEAN)) {
-                return $this->factory->create(RequestTypeContext::AJAX_FRONT);
-            }
-            if (filter_var($this->request->getRequestParam('ee_admin_ajax'), FILTER_VALIDATE_BOOLEAN)) {
-                return $this->factory->create(RequestTypeContext::AJAX_ADMIN);
-            }
-            return $this->factory->create(RequestTypeContext::AJAX_OTHER);
-        }
-        // Detect WP_Cron
-        if ($this->isCronRequest()) {
-            return $this->factory->create(RequestTypeContext::CRON);
-        }
-        // Detect command line requests
-        if (defined('WP_CLI') && WP_CLI) {
-            return $this->factory->create(RequestTypeContext::CLI);
-        }
-        // detect WordPress admin (ie: "Dashboard")
-        if (is_admin()) {
-            return $this->factory->create(RequestTypeContext::ADMIN);
-        }
-        // Detect iFrames
-        if ($this->isIframeRoute()) {
-            return $this->factory->create(RequestTypeContext::IFRAME);
-        }
-        // Detect Feeds
-        if ($this->isFeedRequest()) {
-            return $this->factory->create(RequestTypeContext::FEED);
-        }
-        // and by process of elimination...
-        return $this->factory->create(RequestTypeContext::FRONTEND);
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isEspressoRestApiRequest()
-    {
-        $ee_rest_url_prefix = RecommendedVersions::compareWordPressVersion('4.4.0')
-            ? trim(rest_get_url_prefix(), '/')
-            : 'wp-json';
-        $ee_rest_url_prefix .= '/' . Domain::API_NAMESPACE;
-        return $this->uriPathMatches($ee_rest_url_prefix);
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isCronRequest()
-    {
-        return $this->uriPathMatches('wp-cron.php');
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isFeedRequest()
-    {
-        return $this->uriPathMatches('feed');
-    }
-
-
-    /**
-     * @param string $component
-     * @return bool
-     */
-    private function uriPathMatches($component)
-    {
-        $request_uri = $this->request->requestUri();
-        $parts = explode('?', $request_uri);
-        $path = trim(reset($parts), '/');
-        return strpos($path, $component) === 0;
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isIframeRoute()
-    {
-        $is_iframe_route = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_contexts_RequestTypeContextDetector__isIframeRoute',
-            $this->request->getRequestParam('event_list', '') === 'iframe'
-            || $this->request->getRequestParam('ticket_selector', '') === 'iframe'
-            || $this->request->getRequestParam('calendar', '') === 'iframe',
-            $this
-        );
-        return filter_var($is_iframe_route, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @var RequestTypeContextFactory $factory
+	 */
+	private $factory;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+
+	/**
+	 * RequestTypeContextDetector constructor.
+	 *
+	 * @param RequestInterface          $request
+	 * @param RequestTypeContextFactory $factory
+	 */
+	public function __construct(RequestInterface $request, RequestTypeContextFactory $factory)
+	{
+		$this->request = $request;
+		$this->factory = $factory;
+	}
+
+
+	/**
+	 * @return RequestTypeContext
+	 * @throws InvalidArgumentException
+	 */
+	public function detectRequestTypeContext()
+	{
+		// Detect error scrapes
+		if ($this->request->getRequestParam('wp_scrape_key') !== null
+			&& $this->request->getRequestParam('wp_scrape_nonce') !== null
+		) {
+			return $this->factory->create(RequestTypeContext::WP_SCRAPE);
+		}
+		// Detect EE REST API
+		if ($this->isEspressoRestApiRequest()) {
+			return $this->factory->create(RequestTypeContext::API);
+		}
+		// Detect AJAX
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			if (filter_var($this->request->getRequestParam('ee_front_ajax'), FILTER_VALIDATE_BOOLEAN)) {
+				return $this->factory->create(RequestTypeContext::AJAX_FRONT);
+			}
+			if (filter_var($this->request->getRequestParam('ee_admin_ajax'), FILTER_VALIDATE_BOOLEAN)) {
+				return $this->factory->create(RequestTypeContext::AJAX_ADMIN);
+			}
+			return $this->factory->create(RequestTypeContext::AJAX_OTHER);
+		}
+		// Detect WP_Cron
+		if ($this->isCronRequest()) {
+			return $this->factory->create(RequestTypeContext::CRON);
+		}
+		// Detect command line requests
+		if (defined('WP_CLI') && WP_CLI) {
+			return $this->factory->create(RequestTypeContext::CLI);
+		}
+		// detect WordPress admin (ie: "Dashboard")
+		if (is_admin()) {
+			return $this->factory->create(RequestTypeContext::ADMIN);
+		}
+		// Detect iFrames
+		if ($this->isIframeRoute()) {
+			return $this->factory->create(RequestTypeContext::IFRAME);
+		}
+		// Detect Feeds
+		if ($this->isFeedRequest()) {
+			return $this->factory->create(RequestTypeContext::FEED);
+		}
+		// and by process of elimination...
+		return $this->factory->create(RequestTypeContext::FRONTEND);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isEspressoRestApiRequest()
+	{
+		$ee_rest_url_prefix = RecommendedVersions::compareWordPressVersion('4.4.0')
+			? trim(rest_get_url_prefix(), '/')
+			: 'wp-json';
+		$ee_rest_url_prefix .= '/' . Domain::API_NAMESPACE;
+		return $this->uriPathMatches($ee_rest_url_prefix);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isCronRequest()
+	{
+		return $this->uriPathMatches('wp-cron.php');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isFeedRequest()
+	{
+		return $this->uriPathMatches('feed');
+	}
+
+
+	/**
+	 * @param string $component
+	 * @return bool
+	 */
+	private function uriPathMatches($component)
+	{
+		$request_uri = $this->request->requestUri();
+		$parts = explode('?', $request_uri);
+		$path = trim(reset($parts), '/');
+		return strpos($path, $component) === 0;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isIframeRoute()
+	{
+		$is_iframe_route = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_contexts_RequestTypeContextDetector__isIframeRoute',
+			$this->request->getRequestParam('event_list', '') === 'iframe'
+			|| $this->request->getRequestParam('ticket_selector', '') === 'iframe'
+			|| $this->request->getRequestParam('calendar', '') === 'iframe',
+			$this
+		);
+		return filter_var($is_iframe_route, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/domain/entities/contexts/RequestTypeContext.php

Indentation +139 added lines, -139 removed lines

@@ -16,143 +16,143 @@
 class RequestTypeContext extends Context
 {
 
-    /**
-     * indicates that the current request involves some form of activation
-     */
-    const ACTIVATION = 'activation-request';
-
-    /**
-     * indicates that the current request is for the admin but is not being made via AJAX
-     */
-    const ADMIN = 'non-ajax-admin-request';
-
-    /**
-     * indicates that the current request is for the admin AND is being made via AJAX
-     */
-    const AJAX_ADMIN = 'admin-ajax-request';
-
-    /**
-     * indicates that the current request is for the frontend AND is being made via AJAX
-     */
-    const AJAX_FRONT = 'frontend-ajax-request';
-
-    /**
-     * indicates that the current request is being made via AJAX, but is NOT for EE
-     */
-    const AJAX_OTHER = 'other-ajax-request';
-
-    /**
-     * indicates that the current request is for the EE REST API
-     */
-    const API = 'rest-api';
-
-    /**
-     * indicates that the current request is from the command line
-     */
-    const CLI = 'command-line';
-
-    /**
-     * indicates that the current request is for a WP_Cron
-     */
-    const CRON = 'wp-cron';
-
-    /**
-     * indicates that the current request is for a feed (ie: RSS)
-     */
-    const FEED = 'feed-request';
-
-    /**
-     * indicates that the current request is for the frontend but is not being made via AJAX
-     */
-    const FRONTEND = 'non-ajax-frontend-request';
-
-    /**
-     * indicates that the current request is for content that is to be displayed within an iframe
-     */
-    const IFRAME = 'iframe-request';
-
-    /**
-     * indicates that the current request is a loopback sent from WP core to test for errors
-     */
-    const WP_SCRAPE = 'wordpress-scrape';
-
-    /**
-     * @var boolean $is_activation
-     */
-    private $is_activation = false;
-
-    /**
-     * @var array $valid_request_types
-     */
-    private $valid_request_types = array();
-
-
-    /**
-     * RequestTypeContext constructor.
-     *
-     * @param string $slug
-     * @param string $description
-     * @throws InvalidArgumentException
-     */
-    public function __construct($slug, $description)
-    {
-        parent::__construct($slug, $description);
-        if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    var_export($this->validRequestTypes(), true)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function validRequestTypes()
-    {
-        if (empty($this->valid_request_types)) {
-            $this->valid_request_types = apply_filters(
-                'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
-                array(
-                    RequestTypeContext::ACTIVATION,
-                    RequestTypeContext::ADMIN,
-                    RequestTypeContext::AJAX_ADMIN,
-                    RequestTypeContext::AJAX_FRONT,
-                    RequestTypeContext::AJAX_OTHER,
-                    RequestTypeContext::API,
-                    RequestTypeContext::CLI,
-                    RequestTypeContext::CRON,
-                    RequestTypeContext::FEED,
-                    RequestTypeContext::FRONTEND,
-                    RequestTypeContext::IFRAME,
-                    RequestTypeContext::WP_SCRAPE,
-                )
-            );
-        }
-        return $this->valid_request_types;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->is_activation;
-    }
-
-
-    /**
-     * @param bool $is_activation
-     */
-    public function setIsActivation($is_activation)
-    {
-        $this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * indicates that the current request involves some form of activation
+	 */
+	const ACTIVATION = 'activation-request';
+
+	/**
+	 * indicates that the current request is for the admin but is not being made via AJAX
+	 */
+	const ADMIN = 'non-ajax-admin-request';
+
+	/**
+	 * indicates that the current request is for the admin AND is being made via AJAX
+	 */
+	const AJAX_ADMIN = 'admin-ajax-request';
+
+	/**
+	 * indicates that the current request is for the frontend AND is being made via AJAX
+	 */
+	const AJAX_FRONT = 'frontend-ajax-request';
+
+	/**
+	 * indicates that the current request is being made via AJAX, but is NOT for EE
+	 */
+	const AJAX_OTHER = 'other-ajax-request';
+
+	/**
+	 * indicates that the current request is for the EE REST API
+	 */
+	const API = 'rest-api';
+
+	/**
+	 * indicates that the current request is from the command line
+	 */
+	const CLI = 'command-line';
+
+	/**
+	 * indicates that the current request is for a WP_Cron
+	 */
+	const CRON = 'wp-cron';
+
+	/**
+	 * indicates that the current request is for a feed (ie: RSS)
+	 */
+	const FEED = 'feed-request';
+
+	/**
+	 * indicates that the current request is for the frontend but is not being made via AJAX
+	 */
+	const FRONTEND = 'non-ajax-frontend-request';
+
+	/**
+	 * indicates that the current request is for content that is to be displayed within an iframe
+	 */
+	const IFRAME = 'iframe-request';
+
+	/**
+	 * indicates that the current request is a loopback sent from WP core to test for errors
+	 */
+	const WP_SCRAPE = 'wordpress-scrape';
+
+	/**
+	 * @var boolean $is_activation
+	 */
+	private $is_activation = false;
+
+	/**
+	 * @var array $valid_request_types
+	 */
+	private $valid_request_types = array();
+
+
+	/**
+	 * RequestTypeContext constructor.
+	 *
+	 * @param string $slug
+	 * @param string $description
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($slug, $description)
+	{
+		parent::__construct($slug, $description);
+		if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
+						'event_espresso'
+					),
+					var_export($this->validRequestTypes(), true)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function validRequestTypes()
+	{
+		if (empty($this->valid_request_types)) {
+			$this->valid_request_types = apply_filters(
+				'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
+				array(
+					RequestTypeContext::ACTIVATION,
+					RequestTypeContext::ADMIN,
+					RequestTypeContext::AJAX_ADMIN,
+					RequestTypeContext::AJAX_FRONT,
+					RequestTypeContext::AJAX_OTHER,
+					RequestTypeContext::API,
+					RequestTypeContext::CLI,
+					RequestTypeContext::CRON,
+					RequestTypeContext::FEED,
+					RequestTypeContext::FRONTEND,
+					RequestTypeContext::IFRAME,
+					RequestTypeContext::WP_SCRAPE,
+				)
+			);
+		}
+		return $this->valid_request_types;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->is_activation;
+	}
+
+
+	/**
+	 * @param bool $is_activation
+	 */
+	public function setIsActivation($is_activation)
+	{
+		$this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/services/request/Request.php

Indentation +582 added lines, -582 removed lines

@@ -17,586 +17,586 @@
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array $get
-     */
-    private $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array $post
-     */
-    private $post;
-
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array $cookie
-     */
-    private $cookie;
-
-    /**
-     * $_SERVER parameters
-     *
-     * @var array $server
-     */
-    private $server;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array $request
-     */
-    private $request;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    private $request_type;
-
-    /**
-     * IP address for request
-     *
-     * @var string $ip_address
-     */
-    private $ip_address;
-
-    /**
-     * @var string $user_agent
-     */
-    private $user_agent;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool $is_bot
-     */
-    private $is_bot;
-
-
-    /**
-     * @param array $get
-     * @param array $post
-     * @param array $cookie
-     * @param array $server
-     */
-    public function __construct(array $get, array $post, array $cookie, array $server)
-    {
-        // grab request vars
-        $this->get = $get;
-        $this->post = $post;
-        $this->cookie = $cookie;
-        $this->server = $server;
-        $this->request = array_merge($this->get, $this->post);
-        $this->ip_address = $this->visitorIp();
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookie;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($key !== 'ee'
-            || ($key === 'ee' && empty($this->request['ee']))
-            || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
-        ) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param       $key
-     * @param null  $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null)
-    {
-        return $this->requestParameterDrillDown($key, $default, 'get');
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param       $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->requestParameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param null|mixed $default
-     * @return false|int
-     */
-    public function getMatch($pattern, $default = null)
-    {
-        return $this->requestParameterDrillDown($pattern, $default, 'match');
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     */
-    public function matches($pattern)
-    {
-        return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are:
-     *                                      'bool' will return true or false if match is found or not
-     *                                      'key' will return the first key found that matches the supplied pattern
-     *                                      'value' will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
-    {
-        $return = in_array($return, array('bool', 'key', 'value'), true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            array("\*", "\?"),
-            array('.*', '.'),
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === 'value') {
-                    return $request_params[ $key ];
-                }
-                // or actual key or true just to indicate it was found
-                return $return === 'key' ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === 'value' ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param array  $request_params
-     * @return bool|mixed|null
-     */
-    private function requestParameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        array $request_params = array()
-    ) {
-        $callback = in_array($callback, array('is_set', 'get', 'match'), true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, 'key');
-                $key = $real_key ? $real_key : $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->requestParameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        unset($this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function visitorIp()
-    {
-        $visitor_ip = '0.0.0.0';
-        $server_keys = array(
-            'HTTP_CLIENT_IP',
-            'HTTP_X_FORWARDED_FOR',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_FORWARDED',
-            'REMOTE_ADDR',
-        );
-        foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function requestUri()
-    {
-        $request_uri = filter_input(
-            INPUT_SERVER,
-            'REQUEST_URI',
-            FILTER_SANITIZE_URL,
-            FILTER_NULL_ON_FAILURE
-        );
-        if (empty($request_uri)) {
-            // fallback sanitization if the above fails
-            $request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
-        }
-        return $request_uri;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->user_agent;
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        if ($user_agent === '' || ! is_string($user_agent)) {
-            $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
-        }
-        $this->user_agent = $user_agent;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBot()
-    {
-        return $this->is_bot;
-    }
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->isAdmin();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->isAdminAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->request_type->isAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->request_type->isEeAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->isOtherAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->isApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->isCli();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->isCron();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->isFeed();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->isFrontend();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->isFrontAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressScrape()
-    {
-        return $this->request_type->isWordPressScrape();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array $get
+	 */
+	private $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array $post
+	 */
+	private $post;
+
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array $cookie
+	 */
+	private $cookie;
+
+	/**
+	 * $_SERVER parameters
+	 *
+	 * @var array $server
+	 */
+	private $server;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array $request
+	 */
+	private $request;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	private $request_type;
+
+	/**
+	 * IP address for request
+	 *
+	 * @var string $ip_address
+	 */
+	private $ip_address;
+
+	/**
+	 * @var string $user_agent
+	 */
+	private $user_agent;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool $is_bot
+	 */
+	private $is_bot;
+
+
+	/**
+	 * @param array $get
+	 * @param array $post
+	 * @param array $cookie
+	 * @param array $server
+	 */
+	public function __construct(array $get, array $post, array $cookie, array $server)
+	{
+		// grab request vars
+		$this->get = $get;
+		$this->post = $post;
+		$this->cookie = $cookie;
+		$this->server = $server;
+		$this->request = array_merge($this->get, $this->post);
+		$this->ip_address = $this->visitorIp();
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookie;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($key !== 'ee'
+			|| ($key === 'ee' && empty($this->request['ee']))
+			|| ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
+		) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param       $key
+	 * @param null  $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null)
+	{
+		return $this->requestParameterDrillDown($key, $default, 'get');
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param       $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->requestParameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param null|mixed $default
+	 * @return false|int
+	 */
+	public function getMatch($pattern, $default = null)
+	{
+		return $this->requestParameterDrillDown($pattern, $default, 'match');
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 */
+	public function matches($pattern)
+	{
+		return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are:
+	 *                                      'bool' will return true or false if match is found or not
+	 *                                      'key' will return the first key found that matches the supplied pattern
+	 *                                      'value' will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
+	{
+		$return = in_array($return, array('bool', 'key', 'value'), true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			array("\*", "\?"),
+			array('.*', '.'),
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === 'value') {
+					return $request_params[ $key ];
+				}
+				// or actual key or true just to indicate it was found
+				return $return === 'key' ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === 'value' ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param array  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function requestParameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		array $request_params = array()
+	) {
+		$callback = in_array($callback, array('is_set', 'get', 'match'), true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, 'key');
+				$key = $real_key ? $real_key : $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->requestParameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		unset($this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function visitorIp()
+	{
+		$visitor_ip = '0.0.0.0';
+		$server_keys = array(
+			'HTTP_CLIENT_IP',
+			'HTTP_X_FORWARDED_FOR',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_FORWARDED',
+			'REMOTE_ADDR',
+		);
+		foreach ($server_keys as $key) {
+			if (isset($this->server[ $key ])) {
+				foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function requestUri()
+	{
+		$request_uri = filter_input(
+			INPUT_SERVER,
+			'REQUEST_URI',
+			FILTER_SANITIZE_URL,
+			FILTER_NULL_ON_FAILURE
+		);
+		if (empty($request_uri)) {
+			// fallback sanitization if the above fails
+			$request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
+		}
+		return $request_uri;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->user_agent;
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		if ($user_agent === '' || ! is_string($user_agent)) {
+			$user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
+		}
+		$this->user_agent = $user_agent;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot()
+	{
+		return $this->is_bot;
+	}
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->isAdmin();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->isAdminAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->request_type->isAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->request_type->isEeAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->isOtherAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->isApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->isCli();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->isCron();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->isFeed();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->isFrontend();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->isFrontAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressScrape()
+	{
+		return $this->request_type->isWordPressScrape();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
 }

core/libraries/payment_methods/EE_Gateway.lib.php

Indentation +491 added lines, -491 removed lines

@@ -23,495 +23,495 @@
  */
 abstract class EE_Gateway
 {
-    /**
-     * a constant used as a possible value for $_currencies_supported to indicate
-     * that ALL currencies are supported by this gateway
-     */
-    const all_currencies_supported = 'all_currencies_supported';
-    /**
-     * Where values are 3-letter currency codes
-     *
-     * @var array
-     */
-    protected $_currencies_supported = array();
-    /**
-     * Whether or not this gateway can support SENDING a refund request (ie, initiated by
-     * admin in EE's wp-admin page)
-     *
-     * @var boolean
-     */
-    protected $_supports_sending_refunds = false;
-
-    /**
-     * Whether or not this gateway can support RECEIVING a refund request from the payment
-     * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
-     *
-     * @var boolean
-     */
-    protected $_supports_receiving_refunds = false;
-    /**
-     * Model for querying for existing payments
-     *
-     * @var EEMI_Payment
-     */
-    protected $_pay_model;
-
-    /**
-     * Model used for adding to the payments log
-     *
-     * @var EEMI_Payment_Log
-     */
-    protected $_pay_log;
-
-    /**
-     * Used for formatting some input to gateways
-     *
-     * @var EEHI_Template
-     */
-    protected $_template;
-
-    /**
-     * Concrete class that implements EEHI_Money, used by most gateways
-     *
-     * @var EEHI_Money
-     */
-    protected $_money;
-
-    /**
-     * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
-     *
-     * @var EEHI_Line_Item
-     */
-    protected $_line_item;
-
-    /**
-     * @var GatewayDataFormatterInterface
-     */
-    protected $_gateway_data_formatter;
-
-    /**
-     * @var FormatterInterface
-     */
-    protected $_unsupported_character_remover;
-
-    /**
-     * The ID of the payment method using this gateway
-     *
-     * @var int
-     */
-    protected $_ID;
-
-    /**
-     * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
-     */
-    protected $_debug_mode;
-    /**
-     *
-     * @var string $_name name to show for this payment method
-     */
-    protected $_name;
-    /**
-     *
-     * @var string name to show fir this payment method to admin-type users
-     */
-    protected $_admin_name;
-
-    /**
-     * @return EE_Gateway
-     */
-    public function __construct()
-    {
-    }
-
-    /**
-     * We don't want to serialize models as they often have circular structures
-     * (eg a payment model has a reference to each payment model object; and most
-     * payments have a transaction, most transactions have a payment method;
-     * most payment methods have a payment method type; most payment method types
-     * have a gateway. And if a gateway serializes its models, we start at the
-     * beginning again)
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_pay_model'], $properties['_pay_log']);
-        return array_keys($properties);
-    }
-
-    /**
-     * Returns whether or not this gateway should support SENDING refunds
-     * see $_supports_sending_refunds
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds()
-    {
-        return $this->_supports_sending_refunds;
-    }
-
-    /**
-     * Returns whether or not this gateway should support RECEIVING refunds
-     * see $_supports_receiving_refunds
-     *
-     * @return boolean
-     */
-    public function supports_receiving_refunds()
-    {
-        return $this->_supports_receiving_refunds;
-    }
-
-
-    /**
-     * Tries to refund the payment specified, taking into account the extra
-     * refund info. Note that if the gateway's _supports_sending_refunds is false,
-     * this should just throw an exception.
-     *
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @return EE_Payment for the refund
-     * @throws EE_Error
-     */
-    public function do_direct_refund(EE_Payment $payment, $refund_info = null)
-    {
-        return null;
-    }
-
-
-    /**
-     * Sets the payment method's settings so the gateway knows where to send the request
-     * etc
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        foreach ($settings_array as $name => $value) {
-            $property_name = "_" . $name;
-            $this->{$property_name} = $value;
-        }
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEMI_Payment $payment_model
-     */
-    public function set_payment_model($payment_model)
-    {
-        $this->_pay_model = $payment_model;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEMI_Payment_Log $payment_log_model
-     */
-    public function set_payment_log($payment_log_model)
-    {
-        $this->_pay_log = $payment_log_model;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Template $template_helper
-     */
-    public function set_template_helper($template_helper)
-    {
-        $this->_template = $template_helper;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Line_Item $line_item_helper
-     */
-    public function set_line_item_helper($line_item_helper)
-    {
-        $this->_line_item = $line_item_helper;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Money $money_helper
-     */
-    public function set_money_helper($money_helper)
-    {
-        $this->_money = $money_helper;
-    }
-
-
-    /**
-     * Sets the gateway data formatter helper
-     *
-     * @param GatewayDataFormatterInterface $gateway_data_formatter
-     * @throws InvalidEntityException if it's not set properly
-     */
-    public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
-    {
-        if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($gateway_data_formatter)
-                    ? get_class($gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        $this->_gateway_data_formatter = $gateway_data_formatter;
-    }
-
-    /**
-     * Gets the gateway data formatter
-     *
-     * @return GatewayDataFormatterInterface
-     * @throws InvalidEntityException if it's not set properly
-     */
-    protected function _get_gateway_formatter()
-    {
-        if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_gateway_data_formatter)
-                    ? get_class($this->_gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        return $this->_gateway_data_formatter;
-    }
-
-
-    /**
-     * Sets the helper which will remove unsupported characters for most gateways
-     *
-     * @param FormatterInterface $formatter
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    public function set_unsupported_character_remover(FormatterInterface $formatter)
-    {
-        if (! $formatter instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($formatter)
-                    ? get_class($formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        $this->_unsupported_character_remover = $formatter;
-    }
-
-    /**
-     * Gets the helper which removes characters which gateways might not support, like emojis etc.
-     *
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    protected function _get_unsupported_character_remover()
-    {
-        if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_unsupported_character_remover)
-                    ? get_class($this->_unsupported_character_remover)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        return $this->_unsupported_character_remover;
-    }
-
-
-    /**
-     * @param $message
-     * @param $payment
-     */
-    public function log($message, $object_logged)
-    {
-        if ($object_logged instanceof EEI_Payment) {
-            $type = 'Payment';
-            $id = $object_logged->ID();
-        } elseif ($object_logged instanceof EEI_Transaction) {
-            $type = 'Transaction';
-            $id = $object_logged->ID();
-        } else {
-            $type = 'Payment_Method';
-            $id = $this->_ID;
-        }
-        // only log if we're going to store it for longer than the minimum time
-        $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
-        if ($reg_config->gateway_log_lifespan !== '1 second') {
-            $this->_pay_log->gateway_log($message, $id, $type);
-        }
-    }
-
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     * @deprecated since 4.9.31 insetad use
-     *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
-     */
-    public function format_currency($amount)
-    {
-        return $this->_get_gateway_formatter()->formatCurrency($amount);
-    }
-
-    /**
-     * Returns either an array of all the currency codes supported,
-     * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
-     *
-     * @return mixed array or string
-     */
-    public function currencies_supported()
-    {
-        return $this->_currencies_supported;
-    }
-
-    /**
-     * Returns what a simple summing of items and taxes for this transaction. This
-     * can be used to determine if some more complex line items, like promotions,
-     * surcharges, or cancellations occurred (in which case we might want to forget
-     * about creating an itemized list of purchases and instead only send the total due)
-     *
-     * @param EE_Transaction $transaction
-     * @return float
-     */
-    protected function _sum_items_and_taxes(EE_Transaction $transaction)
-    {
-        $total_line_item = $transaction->total_line_item();
-        $total = 0;
-        foreach ($total_line_item->get_items() as $item_line_item) {
-            $total += max($item_line_item->total(), 0);
-        }
-        foreach ($total_line_item->tax_descendants() as $tax_line_item) {
-            $total += max($tax_line_item->total(), 0);
-        }
-        return $total;
-    }
-
-    /**
-     * Determines whether or not we can easily itemize the transaction using only
-     * items and taxes (ie, no promotions or surcharges or cancellations needed)
-     *
-     * @param EEI_Payment $payment
-     * @return boolean
-     */
-    protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
-    {
-        return $this->_money->compare_floats(
-            $this->_sum_items_and_taxes($payment->transaction()),
-            $payment->transaction()->total()
-        )
-               && $this->_money->compare_floats(
-                   $payment->amount(),
-                   $payment->transaction()->total()
-               );
-    }
-
-    /**
-     * Handles updating the transaction and any other related data based on the payment.
-     * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
-     * but doing so on those functions might be too early. It's possible that the changes
-     * you make to teh transaction or registration or line items may just get overwritten
-     * at that point. Instead, you should store any info you need on the payment during those
-     * functions, and use that information at this step, which client code will decide
-     * for you when it should be called.
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        // maybe update the transaction or line items or registrations
-        // but most gateways don't need to do this, because they only update the payment
-    }
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @param EEI_Payment $payment
-     * @return EEI_Event|null
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
-     */
-    protected function _get_first_event_for_payment(EEI_Payment $payment)
-    {
-        return $payment->get_first_event();
-    }
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
-     */
-    protected function _get_first_event_name_for_payment(EEI_Payment $payment)
-    {
-        return $payment->get_first_event_name();
-    }
-
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
-     * @param EE_Payment $payment
-     * @return string
-     */
-    protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
-    }
-
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
-     * @param EEI_Payment $payment
-     * @return string
-     */
-    protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
-    }
-
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
-     * @param EEI_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    protected function _format_line_item_name(EEI_Line_Item $line_item, EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
-    }
-
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
-     * @param EEI_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    protected function _format_line_item_desc(EEI_Line_Item $line_item, EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
-    }
-
-    /**
-     * Gets the order description that should generlly be sent to gateways
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
-     * @param EEI_Payment $payment
-     * @return type
-     */
-    protected function _format_order_description(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatOrderDescription($payment);
-    }
+	/**
+	 * a constant used as a possible value for $_currencies_supported to indicate
+	 * that ALL currencies are supported by this gateway
+	 */
+	const all_currencies_supported = 'all_currencies_supported';
+	/**
+	 * Where values are 3-letter currency codes
+	 *
+	 * @var array
+	 */
+	protected $_currencies_supported = array();
+	/**
+	 * Whether or not this gateway can support SENDING a refund request (ie, initiated by
+	 * admin in EE's wp-admin page)
+	 *
+	 * @var boolean
+	 */
+	protected $_supports_sending_refunds = false;
+
+	/**
+	 * Whether or not this gateway can support RECEIVING a refund request from the payment
+	 * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
+	 *
+	 * @var boolean
+	 */
+	protected $_supports_receiving_refunds = false;
+	/**
+	 * Model for querying for existing payments
+	 *
+	 * @var EEMI_Payment
+	 */
+	protected $_pay_model;
+
+	/**
+	 * Model used for adding to the payments log
+	 *
+	 * @var EEMI_Payment_Log
+	 */
+	protected $_pay_log;
+
+	/**
+	 * Used for formatting some input to gateways
+	 *
+	 * @var EEHI_Template
+	 */
+	protected $_template;
+
+	/**
+	 * Concrete class that implements EEHI_Money, used by most gateways
+	 *
+	 * @var EEHI_Money
+	 */
+	protected $_money;
+
+	/**
+	 * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
+	 *
+	 * @var EEHI_Line_Item
+	 */
+	protected $_line_item;
+
+	/**
+	 * @var GatewayDataFormatterInterface
+	 */
+	protected $_gateway_data_formatter;
+
+	/**
+	 * @var FormatterInterface
+	 */
+	protected $_unsupported_character_remover;
+
+	/**
+	 * The ID of the payment method using this gateway
+	 *
+	 * @var int
+	 */
+	protected $_ID;
+
+	/**
+	 * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
+	 */
+	protected $_debug_mode;
+	/**
+	 *
+	 * @var string $_name name to show for this payment method
+	 */
+	protected $_name;
+	/**
+	 *
+	 * @var string name to show fir this payment method to admin-type users
+	 */
+	protected $_admin_name;
+
+	/**
+	 * @return EE_Gateway
+	 */
+	public function __construct()
+	{
+	}
+
+	/**
+	 * We don't want to serialize models as they often have circular structures
+	 * (eg a payment model has a reference to each payment model object; and most
+	 * payments have a transaction, most transactions have a payment method;
+	 * most payment methods have a payment method type; most payment method types
+	 * have a gateway. And if a gateway serializes its models, we start at the
+	 * beginning again)
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_pay_model'], $properties['_pay_log']);
+		return array_keys($properties);
+	}
+
+	/**
+	 * Returns whether or not this gateway should support SENDING refunds
+	 * see $_supports_sending_refunds
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds()
+	{
+		return $this->_supports_sending_refunds;
+	}
+
+	/**
+	 * Returns whether or not this gateway should support RECEIVING refunds
+	 * see $_supports_receiving_refunds
+	 *
+	 * @return boolean
+	 */
+	public function supports_receiving_refunds()
+	{
+		return $this->_supports_receiving_refunds;
+	}
+
+
+	/**
+	 * Tries to refund the payment specified, taking into account the extra
+	 * refund info. Note that if the gateway's _supports_sending_refunds is false,
+	 * this should just throw an exception.
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @return EE_Payment for the refund
+	 * @throws EE_Error
+	 */
+	public function do_direct_refund(EE_Payment $payment, $refund_info = null)
+	{
+		return null;
+	}
+
+
+	/**
+	 * Sets the payment method's settings so the gateway knows where to send the request
+	 * etc
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		foreach ($settings_array as $name => $value) {
+			$property_name = "_" . $name;
+			$this->{$property_name} = $value;
+		}
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEMI_Payment $payment_model
+	 */
+	public function set_payment_model($payment_model)
+	{
+		$this->_pay_model = $payment_model;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEMI_Payment_Log $payment_log_model
+	 */
+	public function set_payment_log($payment_log_model)
+	{
+		$this->_pay_log = $payment_log_model;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Template $template_helper
+	 */
+	public function set_template_helper($template_helper)
+	{
+		$this->_template = $template_helper;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Line_Item $line_item_helper
+	 */
+	public function set_line_item_helper($line_item_helper)
+	{
+		$this->_line_item = $line_item_helper;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Money $money_helper
+	 */
+	public function set_money_helper($money_helper)
+	{
+		$this->_money = $money_helper;
+	}
+
+
+	/**
+	 * Sets the gateway data formatter helper
+	 *
+	 * @param GatewayDataFormatterInterface $gateway_data_formatter
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
+	{
+		if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($gateway_data_formatter)
+					? get_class($gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		$this->_gateway_data_formatter = $gateway_data_formatter;
+	}
+
+	/**
+	 * Gets the gateway data formatter
+	 *
+	 * @return GatewayDataFormatterInterface
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	protected function _get_gateway_formatter()
+	{
+		if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_gateway_data_formatter)
+					? get_class($this->_gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		return $this->_gateway_data_formatter;
+	}
+
+
+	/**
+	 * Sets the helper which will remove unsupported characters for most gateways
+	 *
+	 * @param FormatterInterface $formatter
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	public function set_unsupported_character_remover(FormatterInterface $formatter)
+	{
+		if (! $formatter instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($formatter)
+					? get_class($formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		$this->_unsupported_character_remover = $formatter;
+	}
+
+	/**
+	 * Gets the helper which removes characters which gateways might not support, like emojis etc.
+	 *
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	protected function _get_unsupported_character_remover()
+	{
+		if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_unsupported_character_remover)
+					? get_class($this->_unsupported_character_remover)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		return $this->_unsupported_character_remover;
+	}
+
+
+	/**
+	 * @param $message
+	 * @param $payment
+	 */
+	public function log($message, $object_logged)
+	{
+		if ($object_logged instanceof EEI_Payment) {
+			$type = 'Payment';
+			$id = $object_logged->ID();
+		} elseif ($object_logged instanceof EEI_Transaction) {
+			$type = 'Transaction';
+			$id = $object_logged->ID();
+		} else {
+			$type = 'Payment_Method';
+			$id = $this->_ID;
+		}
+		// only log if we're going to store it for longer than the minimum time
+		$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
+		if ($reg_config->gateway_log_lifespan !== '1 second') {
+			$this->_pay_log->gateway_log($message, $id, $type);
+		}
+	}
+
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 * @deprecated since 4.9.31 insetad use
+	 *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
+	 */
+	public function format_currency($amount)
+	{
+		return $this->_get_gateway_formatter()->formatCurrency($amount);
+	}
+
+	/**
+	 * Returns either an array of all the currency codes supported,
+	 * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
+	 *
+	 * @return mixed array or string
+	 */
+	public function currencies_supported()
+	{
+		return $this->_currencies_supported;
+	}
+
+	/**
+	 * Returns what a simple summing of items and taxes for this transaction. This
+	 * can be used to determine if some more complex line items, like promotions,
+	 * surcharges, or cancellations occurred (in which case we might want to forget
+	 * about creating an itemized list of purchases and instead only send the total due)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return float
+	 */
+	protected function _sum_items_and_taxes(EE_Transaction $transaction)
+	{
+		$total_line_item = $transaction->total_line_item();
+		$total = 0;
+		foreach ($total_line_item->get_items() as $item_line_item) {
+			$total += max($item_line_item->total(), 0);
+		}
+		foreach ($total_line_item->tax_descendants() as $tax_line_item) {
+			$total += max($tax_line_item->total(), 0);
+		}
+		return $total;
+	}
+
+	/**
+	 * Determines whether or not we can easily itemize the transaction using only
+	 * items and taxes (ie, no promotions or surcharges or cancellations needed)
+	 *
+	 * @param EEI_Payment $payment
+	 * @return boolean
+	 */
+	protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
+	{
+		return $this->_money->compare_floats(
+			$this->_sum_items_and_taxes($payment->transaction()),
+			$payment->transaction()->total()
+		)
+			   && $this->_money->compare_floats(
+				   $payment->amount(),
+				   $payment->transaction()->total()
+			   );
+	}
+
+	/**
+	 * Handles updating the transaction and any other related data based on the payment.
+	 * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
+	 * but doing so on those functions might be too early. It's possible that the changes
+	 * you make to teh transaction or registration or line items may just get overwritten
+	 * at that point. Instead, you should store any info you need on the payment during those
+	 * functions, and use that information at this step, which client code will decide
+	 * for you when it should be called.
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		// maybe update the transaction or line items or registrations
+		// but most gateways don't need to do this, because they only update the payment
+	}
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @param EEI_Payment $payment
+	 * @return EEI_Event|null
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
+	 */
+	protected function _get_first_event_for_payment(EEI_Payment $payment)
+	{
+		return $payment->get_first_event();
+	}
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
+	 */
+	protected function _get_first_event_name_for_payment(EEI_Payment $payment)
+	{
+		return $payment->get_first_event_name();
+	}
+
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
+	}
+
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
+	 * @param EEI_Payment $payment
+	 * @return string
+	 */
+	protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
+	}
+
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
+	 * @param EEI_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	protected function _format_line_item_name(EEI_Line_Item $line_item, EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
+	}
+
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
+	 * @param EEI_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	protected function _format_line_item_desc(EEI_Line_Item $line_item, EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
+	}
+
+	/**
+	 * Gets the order description that should generlly be sent to gateways
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
+	 * @param EEI_Payment $payment
+	 * @return type
+	 */
+	protected function _format_order_description(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatOrderDescription($payment);
+	}
 }

core/services/request/middleware/DetectFileEditorRequest.php

Indentation +19 added lines, -19 removed lines

@@ -17,23 +17,23 @@
 class DetectFileEditorRequest extends Middleware
 {
 
-    /**
-     * converts a Request to a Response
-     *
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     * @return ResponseInterface
-     */
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
-    {
-        $this->request  = $request;
-        $this->response = $response;
-        // can't store user data during WP error scrapes if no user exists
-        // so don't load the session since it's not going to work anyways
-        if ($this->request->isWordPressScrape()) {
-            add_filter('FHEE_load_EE_Session', '__return_false', 999);
-        }
-        $this->response = $this->processRequestStack($this->request, $this->response);
-        return $this->response;
-    }
+	/**
+	 * converts a Request to a Response
+	 *
+	 * @param RequestInterface  $request
+	 * @param ResponseInterface $response
+	 * @return ResponseInterface
+	 */
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
+	{
+		$this->request  = $request;
+		$this->response = $response;
+		// can't store user data during WP error scrapes if no user exists
+		// so don't load the session since it's not going to work anyways
+		if ($this->request->isWordPressScrape()) {
+			add_filter('FHEE_load_EE_Session', '__return_false', 999);
+		}
+		$this->response = $this->processRequestStack($this->request, $this->response);
+		return $this->response;
+	}
 }

caffeinated/modules/recaptcha_invisible/EED_Recaptcha_Invisible.module.php

Indentation +328 added lines, -328 removed lines

@@ -17,332 +17,332 @@
 class EED_Recaptcha_Invisible extends EED_Module
 {
 
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private static $config;
-
-
-    /**
-     * @return EED_Module|EED_Recaptcha
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function set_hooks()
-    {
-        EED_Recaptcha_Invisible::setProperties();
-        if (EED_Recaptcha_Invisible::useInvisibleRecaptcha()) {
-            if (EED_Recaptcha_Invisible::protectForm('ticket_selector')) {
-                // ticket selection
-                add_filter(
-                    'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-                    array('EED_Recaptcha_Invisible', 'ticketSelectorForm'),
-                    10,
-                    3
-                );
-                add_action(
-                    'EED_Ticket_Selector__process_ticket_selections__before',
-                    array('EED_Recaptcha_Invisible', 'processTicketSelectorForm')
-                );
-            }
-            if (EED_Recaptcha_Invisible::protectForm('registration_form')) {
-                // checkout
-                add_action(
-                    'AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form',
-                    array('EED_Recaptcha_Invisible', 'spcoRegStepForm')
-                );
-                add_filter(
-                    'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
-                    array('EED_Recaptcha_Invisible', 'receiveSpcoRegStepForm'),
-                    10,
-                    2
-                );
-            }
-            add_action('loop_end', array('EED_Recaptcha_Invisible', 'localizeScriptVars'));
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Recaptcha_Invisible::setProperties();
-        if (EED_Recaptcha_Invisible::protectForm('ticket_selector')) {
-            add_action(
-                'EED_Ticket_Selector__process_ticket_selections__before',
-                array('EED_Recaptcha_Invisible', 'processTicketSelectorForm')
-            );
-        }
-        if (EED_Recaptcha_Invisible::protectForm('registration_form')) {
-            add_filter(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
-                array('EED_Recaptcha_Invisible', 'receiveSpcoRegStepForm'),
-                10,
-                2
-            );
-        }
-        // admin settings
-        add_action(
-            'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
-            array('EED_Recaptcha_Invisible', 'adminSettings')
-        );
-        add_filter(
-            'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
-            array('EED_Recaptcha_Invisible', 'updateAdminSettings')
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function setProperties()
-    {
-
-        EED_Recaptcha_Invisible::$config = EE_Registry::instance()->CFG->registration;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public static function useInvisibleRecaptcha()
-    {
-        return EED_Recaptcha_Invisible::$config->use_captcha
-               && EED_Recaptcha_Invisible::$config->recaptcha_theme === 'invisible';
-    }
-
-
-    /**
-     * @param string $form
-     * @return boolean
-     */
-    public static function protectForm($form)
-    {
-        return is_array(EED_Recaptcha_Invisible::$config->recaptcha_protected_forms)
-               && in_array($form, EED_Recaptcha_Invisible::$config->recaptcha_protected_forms, true);
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function localizeScriptVars()
-    {
-        /** @var \EventEspresso\core\services\request\Request $request */
-        $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
-        // Invisible Recaptcha is ONLY ever required for the frontend and admin
-        // so we don't need to load any JS assets for other types of requests (like AJAX or API).
-        if (! ($request->isAdmin() || $request->isFrontend())) {
-            return;
-        }
-        wp_localize_script(
-            EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA,
-            'eeRecaptcha',
-            RecaptchaFactory::create()->getLocalizedVars()
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function assetsUrl()
-    {
-        return plugin_dir_url(__FILE__) . 'assets' . DS;
-    }
-
-
-    /**
-     * @param \WP $WP
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * @param EE_Request $request
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public static function verifyToken(EE_Request $request)
-    {
-        return RecaptchaFactory::create()->verifyToken($request);
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $reg_form
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     */
-    public static function spcoRegStepForm(EE_Form_Section_Proper $reg_form)
-    {
-        // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
-            return;
-        }
-        $default_hidden_inputs = $reg_form->get_subsection('default_hidden_inputs');
-        if ($default_hidden_inputs instanceof EE_Form_Section_Proper) {
-            $invisible_recaptcha = RecaptchaFactory::create();
-            $invisible_recaptcha->addToFormSection($default_hidden_inputs);
-        }
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $reg_form
-     * @return bool
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public static function processSpcoRegStepForm(EE_Form_Section_Proper $reg_form)
-    {
-        return strpos($reg_form->name(), 'reg-step-form') !== false
-               && ! RecaptchaFactory::create()->recaptchaPassed();
-    }
-
-
-    /**
-     * @param array|null             $req_data
-     * @param EE_Form_Section_Proper $reg_form
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public static function receiveSpcoRegStepForm($req_data = array(), EE_Form_Section_Proper $reg_form)
-    {
-        // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
-            return $req_data;
-        }
-        /** @var EE_Request $request */
-        $request = LoaderFactory::getLoader()->getShared('EE_Request');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
-            if ($request->isAjax()) {
-                $json_response = new EE_SPCO_JSON_Response();
-                $json_response->echoAndExit();
-            }
-            EEH_URL::safeRedirectAndExit(
-                EE_Registry::instance()->CFG->core->reg_page_url()
-            );
-        }
-        return $req_data;
-    }
-
-
-    /**
-     * @param string   $html
-     * @param EE_Event $event
-     * @param bool     $iframe
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws DomainException
-     */
-    public static function ticketSelectorForm($html = '', EE_Event $event, $iframe = false)
-    {
-        $recaptcha = RecaptchaFactory::create();
-        // do nothing if test has  already  been passed
-        if ($recaptcha->recaptchaPassed()) {
-            return $html;
-        }
-        $html .= $recaptcha->getInputHtml(
-            array(
-                'recaptcha_id'   => $event->ID(),
-                'iframe'         => $iframe,
-                'localized_vars' => $recaptcha->getLocalizedVars(),
-            )
-        );
-        return $html;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws RuntimeException
-     */
-    public static function processTicketSelectorForm()
-    {
-        // do nothing if test has  already  been passed
-        if (RecaptchaFactory::create()->recaptchaPassed()) {
-            return;
-        }
-        /** @var EE_Request $request */
-        $request = LoaderFactory::getLoader()->getShared('EE_Request');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
-            $event_id = $request->get('tkt-slctr-event-id');
-            $return_url = $request->is_set("tkt-slctr-return-url-{$event_id}")
-                ? $request->get("tkt-slctr-return-url-{$event_id}")
-                : get_permalink($event_id);
-            EEH_URL::safeRedirectAndExit($return_url);
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function adminSettings()
-    {
-        RecaptchaFactory::getAdminModule()->adminSettings();
-    }
-
-
-    /**
-     * @param EE_Registration_Config $EE_Registration_Config
-     * @return EE_Registration_Config
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function updateAdminSettings(EE_Registration_Config $EE_Registration_Config)
-    {
-        return RecaptchaFactory::getAdminModule()->updateAdminSettings($EE_Registration_Config);
-    }
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private static $config;
+
+
+	/**
+	 * @return EED_Module|EED_Recaptcha
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function set_hooks()
+	{
+		EED_Recaptcha_Invisible::setProperties();
+		if (EED_Recaptcha_Invisible::useInvisibleRecaptcha()) {
+			if (EED_Recaptcha_Invisible::protectForm('ticket_selector')) {
+				// ticket selection
+				add_filter(
+					'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+					array('EED_Recaptcha_Invisible', 'ticketSelectorForm'),
+					10,
+					3
+				);
+				add_action(
+					'EED_Ticket_Selector__process_ticket_selections__before',
+					array('EED_Recaptcha_Invisible', 'processTicketSelectorForm')
+				);
+			}
+			if (EED_Recaptcha_Invisible::protectForm('registration_form')) {
+				// checkout
+				add_action(
+					'AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form',
+					array('EED_Recaptcha_Invisible', 'spcoRegStepForm')
+				);
+				add_filter(
+					'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
+					array('EED_Recaptcha_Invisible', 'receiveSpcoRegStepForm'),
+					10,
+					2
+				);
+			}
+			add_action('loop_end', array('EED_Recaptcha_Invisible', 'localizeScriptVars'));
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Recaptcha_Invisible::setProperties();
+		if (EED_Recaptcha_Invisible::protectForm('ticket_selector')) {
+			add_action(
+				'EED_Ticket_Selector__process_ticket_selections__before',
+				array('EED_Recaptcha_Invisible', 'processTicketSelectorForm')
+			);
+		}
+		if (EED_Recaptcha_Invisible::protectForm('registration_form')) {
+			add_filter(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
+				array('EED_Recaptcha_Invisible', 'receiveSpcoRegStepForm'),
+				10,
+				2
+			);
+		}
+		// admin settings
+		add_action(
+			'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
+			array('EED_Recaptcha_Invisible', 'adminSettings')
+		);
+		add_filter(
+			'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
+			array('EED_Recaptcha_Invisible', 'updateAdminSettings')
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function setProperties()
+	{
+
+		EED_Recaptcha_Invisible::$config = EE_Registry::instance()->CFG->registration;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public static function useInvisibleRecaptcha()
+	{
+		return EED_Recaptcha_Invisible::$config->use_captcha
+			   && EED_Recaptcha_Invisible::$config->recaptcha_theme === 'invisible';
+	}
+
+
+	/**
+	 * @param string $form
+	 * @return boolean
+	 */
+	public static function protectForm($form)
+	{
+		return is_array(EED_Recaptcha_Invisible::$config->recaptcha_protected_forms)
+			   && in_array($form, EED_Recaptcha_Invisible::$config->recaptcha_protected_forms, true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function localizeScriptVars()
+	{
+		/** @var \EventEspresso\core\services\request\Request $request */
+		$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
+		// Invisible Recaptcha is ONLY ever required for the frontend and admin
+		// so we don't need to load any JS assets for other types of requests (like AJAX or API).
+		if (! ($request->isAdmin() || $request->isFrontend())) {
+			return;
+		}
+		wp_localize_script(
+			EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA,
+			'eeRecaptcha',
+			RecaptchaFactory::create()->getLocalizedVars()
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function assetsUrl()
+	{
+		return plugin_dir_url(__FILE__) . 'assets' . DS;
+	}
+
+
+	/**
+	 * @param \WP $WP
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * @param EE_Request $request
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public static function verifyToken(EE_Request $request)
+	{
+		return RecaptchaFactory::create()->verifyToken($request);
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $reg_form
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 */
+	public static function spcoRegStepForm(EE_Form_Section_Proper $reg_form)
+	{
+		// do nothing if form isn't for a reg step or test has already been passed
+		if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+			return;
+		}
+		$default_hidden_inputs = $reg_form->get_subsection('default_hidden_inputs');
+		if ($default_hidden_inputs instanceof EE_Form_Section_Proper) {
+			$invisible_recaptcha = RecaptchaFactory::create();
+			$invisible_recaptcha->addToFormSection($default_hidden_inputs);
+		}
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $reg_form
+	 * @return bool
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public static function processSpcoRegStepForm(EE_Form_Section_Proper $reg_form)
+	{
+		return strpos($reg_form->name(), 'reg-step-form') !== false
+			   && ! RecaptchaFactory::create()->recaptchaPassed();
+	}
+
+
+	/**
+	 * @param array|null             $req_data
+	 * @param EE_Form_Section_Proper $reg_form
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public static function receiveSpcoRegStepForm($req_data = array(), EE_Form_Section_Proper $reg_form)
+	{
+		// do nothing if form isn't for a reg step or test has already been passed
+		if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+			return $req_data;
+		}
+		/** @var EE_Request $request */
+		$request = LoaderFactory::getLoader()->getShared('EE_Request');
+		if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+			if ($request->isAjax()) {
+				$json_response = new EE_SPCO_JSON_Response();
+				$json_response->echoAndExit();
+			}
+			EEH_URL::safeRedirectAndExit(
+				EE_Registry::instance()->CFG->core->reg_page_url()
+			);
+		}
+		return $req_data;
+	}
+
+
+	/**
+	 * @param string   $html
+	 * @param EE_Event $event
+	 * @param bool     $iframe
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws DomainException
+	 */
+	public static function ticketSelectorForm($html = '', EE_Event $event, $iframe = false)
+	{
+		$recaptcha = RecaptchaFactory::create();
+		// do nothing if test has  already  been passed
+		if ($recaptcha->recaptchaPassed()) {
+			return $html;
+		}
+		$html .= $recaptcha->getInputHtml(
+			array(
+				'recaptcha_id'   => $event->ID(),
+				'iframe'         => $iframe,
+				'localized_vars' => $recaptcha->getLocalizedVars(),
+			)
+		);
+		return $html;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws RuntimeException
+	 */
+	public static function processTicketSelectorForm()
+	{
+		// do nothing if test has  already  been passed
+		if (RecaptchaFactory::create()->recaptchaPassed()) {
+			return;
+		}
+		/** @var EE_Request $request */
+		$request = LoaderFactory::getLoader()->getShared('EE_Request');
+		if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+			$event_id = $request->get('tkt-slctr-event-id');
+			$return_url = $request->is_set("tkt-slctr-return-url-{$event_id}")
+				? $request->get("tkt-slctr-return-url-{$event_id}")
+				: get_permalink($event_id);
+			EEH_URL::safeRedirectAndExit($return_url);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function adminSettings()
+	{
+		RecaptchaFactory::getAdminModule()->adminSettings();
+	}
+
+
+	/**
+	 * @param EE_Registration_Config $EE_Registration_Config
+	 * @return EE_Registration_Config
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function updateAdminSettings(EE_Registration_Config $EE_Registration_Config)
+	{
+		return RecaptchaFactory::getAdminModule()->updateAdminSettings($EE_Registration_Config);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -154,7 +154,7 @@ 
         $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
         // Invisible Recaptcha is ONLY ever required for the frontend and admin
         // so we don't need to load any JS assets for other types of requests (like AJAX or API).
-        if (! ($request->isAdmin() || $request->isFrontend())) {
+        if ( ! ($request->isAdmin() || $request->isFrontend())) {
             return;
         }
         wp_localize_script(
@@ -170,7 +170,7 @@ 
      */
     public static function assetsUrl()
     {
-        return plugin_dir_url(__FILE__) . 'assets' . DS;
+        return plugin_dir_url(__FILE__).'assets'.DS;
     }
 
 
@@ -208,7 +208,7 @@ 
     public static function spcoRegStepForm(EE_Form_Section_Proper $reg_form)
     {
         // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+        if ( ! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
             return;
         }
         $default_hidden_inputs = $reg_form->get_subsection('default_hidden_inputs');
@@ -247,12 +247,12 @@ 
     public static function receiveSpcoRegStepForm($req_data = array(), EE_Form_Section_Proper $reg_form)
     {
         // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+        if ( ! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
             return $req_data;
         }
         /** @var EE_Request $request */
         $request = LoaderFactory::getLoader()->getShared('EE_Request');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+        if ( ! EED_Recaptcha_Invisible::verifyToken($request)) {
             if ($request->isAjax()) {
                 $json_response = new EE_SPCO_JSON_Response();
                 $json_response->echoAndExit();
@@ -310,7 +310,7 @@ 
         }
         /** @var EE_Request $request */
         $request = LoaderFactory::getLoader()->getShared('EE_Request');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+        if ( ! EED_Recaptcha_Invisible::verifyToken($request)) {
             $event_id = $request->get('tkt-slctr-event-id');
             $return_url = $request->is_set("tkt-slctr-return-url-{$event_id}")
                 ? $request->get("tkt-slctr-return-url-{$event_id}")

core/db_models/EEM_System_Status.model.php

Indentation +273 added lines, -273 removed lines

@@ -6,79 +6,79 @@ 
 class EEM_System_Status
 {
 
-    // private instance of the EEM_System_Status object
-    protected static $_instance = null;
+	// private instance of the EEM_System_Status object
+	protected static $_instance = null;
 
 
 
-    /**
-     *      This function is a singleton method used to instantiate the EEM_Attendee object
-     *
-     *      @access public
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return EEM_System_Status
-     */
-    public static function instance()
-    {
+	/**
+	 *      This function is a singleton method used to instantiate the EEM_Attendee object
+	 *
+	 *      @access public
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return EEM_System_Status
+	 */
+	public static function instance()
+	{
 
-        // check if instance of EEM_System_Status already exists
-        if (self::$_instance === null) {
-            // instantiate EEM_System_Status
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-    private function __construct()
-    {
-    }
-    /**
-     *
-     * @return array where each key is a function name on this class, and each value is SOMETHING--
-     * it might be a value, an array, or an object
-     */
-    public function get_system_stati()
-    {
-        return apply_filters(
-            'FHEE__EEM_System_Status__get_system_stati',
-            array(
-                'ee_version'=>$this->get_ee_version(),
-                'ee_activation_history'=>$this->get_ee_activation_history(),
-                'ee_config'=>$this->get_ee_config(),
-                'ee_migration_history'=>$this->get_ee_migration_history(),
-                'active_plugins'=>$this->get_active_plugins(),
-                'wp_settings'=>$this->get_wp_settings(),
-                'wp_maintenance_mode' => $this->get_wp_maintenance_mode(),
-                'https_enabled'=>$this->get_https_enabled(),
-                'logging_enabled' => $this->get_logging_enabled(),
-                'remote_posting' => $this->get_remote_posting(),
-                'php_version'=>$this->php_version(),
-                'php.ini_settings'=>$this->get_php_ini_all(),
-                'php_info'=>$this->get_php_info(),
-            ),
-            $this
-        );
-    }
-    /**
-     *
-     * @return string
-     */
-    public function get_ee_version()
-    {
-        return espresso_version();
-    }
-    /**
-     *
-     * @return string
-     */
-    public function php_version()
-    {
-        return phpversion();
-    }
-    /**
-     *
-     * @return array, where each key is a plugin name (lower-cased), values are sub-arrays.
-     * Sub-arrays like described in wp function get_plugin_data. Ie,     *
-     *  'Name' => 'Plugin Name',
+		// check if instance of EEM_System_Status already exists
+		if (self::$_instance === null) {
+			// instantiate EEM_System_Status
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+	private function __construct()
+	{
+	}
+	/**
+	 *
+	 * @return array where each key is a function name on this class, and each value is SOMETHING--
+	 * it might be a value, an array, or an object
+	 */
+	public function get_system_stati()
+	{
+		return apply_filters(
+			'FHEE__EEM_System_Status__get_system_stati',
+			array(
+				'ee_version'=>$this->get_ee_version(),
+				'ee_activation_history'=>$this->get_ee_activation_history(),
+				'ee_config'=>$this->get_ee_config(),
+				'ee_migration_history'=>$this->get_ee_migration_history(),
+				'active_plugins'=>$this->get_active_plugins(),
+				'wp_settings'=>$this->get_wp_settings(),
+				'wp_maintenance_mode' => $this->get_wp_maintenance_mode(),
+				'https_enabled'=>$this->get_https_enabled(),
+				'logging_enabled' => $this->get_logging_enabled(),
+				'remote_posting' => $this->get_remote_posting(),
+				'php_version'=>$this->php_version(),
+				'php.ini_settings'=>$this->get_php_ini_all(),
+				'php_info'=>$this->get_php_info(),
+			),
+			$this
+		);
+	}
+	/**
+	 *
+	 * @return string
+	 */
+	public function get_ee_version()
+	{
+		return espresso_version();
+	}
+	/**
+	 *
+	 * @return string
+	 */
+	public function php_version()
+	{
+		return phpversion();
+	}
+	/**
+	 *
+	 * @return array, where each key is a plugin name (lower-cased), values are sub-arrays.
+	 * Sub-arrays like described in wp function get_plugin_data. Ie,     *
+	 *  'Name' => 'Plugin Name',
         'PluginURI' => 'Plugin URI',
         'Version' => 'Version',
         'Description' => 'Description',
@@ -87,221 +87,221 @@ 
         'TextDomain' => 'Text Domain',
         'DomainPath' => 'Domain Path',
         'Network' => 'Network',
-     */
-    public function get_active_plugins()
-    {
-        $active_plugins = (array) get_option('active_plugins', array());
-        if (is_multisite()) {
-            $active_plugins = array_merge($active_plugins, get_site_option('active_sitewide_plugins', array()));
-        }
-        $active_plugins = array_map('strtolower', $active_plugins);
-        $plugin_info = array();
-        foreach ($active_plugins as $plugin) {
-                $plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
+	 */
+	public function get_active_plugins()
+	{
+		$active_plugins = (array) get_option('active_plugins', array());
+		if (is_multisite()) {
+			$active_plugins = array_merge($active_plugins, get_site_option('active_sitewide_plugins', array()));
+		}
+		$active_plugins = array_map('strtolower', $active_plugins);
+		$plugin_info = array();
+		foreach ($active_plugins as $plugin) {
+				$plugin_data = @get_plugin_data(WP_PLUGIN_DIR . '/' . $plugin);
 
-                $plugin_info[ $plugin ] = $plugin_data;
-        }
-        return $plugin_info;
-    }
+				$plugin_info[ $plugin ] = $plugin_data;
+		}
+		return $plugin_info;
+	}
 
-    /**
-     *
-     * @return array with keys 'home_url' and 'site_url'
-     */
-    public function get_wp_settings()
-    {
-        $wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
-        if ($wp_memory_int < 67108864) {
-            $wp_memory_to_display = '<mark class="error">' . sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"') . '</mark>';
-        } else {
-            $wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
-        }
-        return array(
-            'name'=>get_bloginfo('name', 'display'),
-            'is_multisite'=>is_multisite(),
-            'version'=>  get_bloginfo('version', 'display'),
-            'home_url'=>home_url(),
-            'site_url'=>site_url(),
-            'WP_DEBUG'=>WP_DEBUG,
-            'permalink_structure'=>get_option('permalink_structure'),
-            'theme'=>wp_get_theme(),
-            'gmt_offset'=>get_option('gmt_offset'),
-            'timezone_string'=>get_option('timezone_string'),
-            'admin_email'=>  get_bloginfo('admin_email', 'display'),
-            'language'=>get_bloginfo('language', 'display'),
-            'wp_max_upload_size' => size_format(wp_max_upload_size()),
-            'wp_memory' => $wp_memory_to_display
-            );
-    }
+	/**
+	 *
+	 * @return array with keys 'home_url' and 'site_url'
+	 */
+	public function get_wp_settings()
+	{
+		$wp_memory_int = $this->let_to_num(WP_MEMORY_LIMIT);
+		if ($wp_memory_int < 67108864) {
+			$wp_memory_to_display = '<mark class="error">' . sprintf(__('%s - We recommend setting memory to at least 64MB. See: %s Increasing memory allocated to PHP %s', 'event_espresso'), WP_MEMORY_LIMIT, '<a href="http://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP">', '</a>"') . '</mark>';
+		} else {
+			$wp_memory_to_display = '<mark class="yes">' . size_format($wp_memory_int) . '</mark>';
+		}
+		return array(
+			'name'=>get_bloginfo('name', 'display'),
+			'is_multisite'=>is_multisite(),
+			'version'=>  get_bloginfo('version', 'display'),
+			'home_url'=>home_url(),
+			'site_url'=>site_url(),
+			'WP_DEBUG'=>WP_DEBUG,
+			'permalink_structure'=>get_option('permalink_structure'),
+			'theme'=>wp_get_theme(),
+			'gmt_offset'=>get_option('gmt_offset'),
+			'timezone_string'=>get_option('timezone_string'),
+			'admin_email'=>  get_bloginfo('admin_email', 'display'),
+			'language'=>get_bloginfo('language', 'display'),
+			'wp_max_upload_size' => size_format(wp_max_upload_size()),
+			'wp_memory' => $wp_memory_to_display
+			);
+	}
 
-    /**
-     * Gets an array of information about the history of ee versions installed
-     * @return array
-     */
-    public function get_ee_activation_history()
-    {
-        return get_option('espresso_db_update');
-    }
+	/**
+	 * Gets an array of information about the history of ee versions installed
+	 * @return array
+	 */
+	public function get_ee_activation_history()
+	{
+		return get_option('espresso_db_update');
+	}
 
 
-    /**
-     * Gets an array where keys are ee versions, and their values are arrays indicating all the different times that version was installed
-     * @return EE_Data_Migration_Script_Base[]
-     */
-    public function get_ee_migration_history()
-    {
-        $options = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
-        $presentable_migration_scripts = array();
-        foreach ($options as $option_array) {
-            $presentable_migration_scripts[ str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name']) ] = maybe_unserialize($option_array['option_value']);
-        }
-        return $presentable_migration_scripts;
+	/**
+	 * Gets an array where keys are ee versions, and their values are arrays indicating all the different times that version was installed
+	 * @return EE_Data_Migration_Script_Base[]
+	 */
+	public function get_ee_migration_history()
+	{
+		$options = EE_Data_Migration_Manager::instance()->get_all_migration_script_options();
+		$presentable_migration_scripts = array();
+		foreach ($options as $option_array) {
+			$presentable_migration_scripts[ str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_array['option_name']) ] = maybe_unserialize($option_array['option_value']);
+		}
+		return $presentable_migration_scripts;
 //      return get_option(EE_Data_Migration_Manager::data_migrations_option_name);//EE_Data_Migration_Manager::instance()->get_data_migrations_ran();
-    }
+	}
 
-    /**
-     *
-     * @return array like EE_Config class
-     */
-    public function get_ee_config()
-    {
-        return EE_Config::instance();
-    }
+	/**
+	 *
+	 * @return array like EE_Config class
+	 */
+	public function get_ee_config()
+	{
+		return EE_Config::instance();
+	}
 
-    /**
-     * Gets an array of php setup info, pilfered from http://www.php.net/manual/en/function.phpinfo.php#87463
-     * @return array like the output of phpinfo(), but in an array
-     */
-    public function get_php_info()
-    {
-        ob_start();
-        phpinfo(-1);
+	/**
+	 * Gets an array of php setup info, pilfered from http://www.php.net/manual/en/function.phpinfo.php#87463
+	 * @return array like the output of phpinfo(), but in an array
+	 */
+	public function get_php_info()
+	{
+		ob_start();
+		phpinfo(-1);
 
-        $pi = preg_replace(
-            array('#^.*<body>(.*)</body>.*$#ms', '#<h2>PHP License</h2>.*$#ms',
-            '#<h1>Configuration</h1>#',  "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
-            "#[ \t]+#", '#&nbsp;#', '#  +#', '# class=".*?"#', '%&#039;%',
-            '#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
-            .'<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
-            '#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
-            '#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
-            "# +#", '#<tr>#', '#</tr>#'),
-            array('$1', '', '', '', '</$1>' . "\n", '<', ' ', ' ', ' ', '', ' ',
-            '<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
-            "\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
-            '<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
-            '<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
-            '<tr><td>Zend Egg</td><td>$1</td></tr>', ' ', '%S%', '%E%'),
-            ob_get_clean()
-        );
+		$pi = preg_replace(
+			array('#^.*<body>(.*)</body>.*$#ms', '#<h2>PHP License</h2>.*$#ms',
+			'#<h1>Configuration</h1>#',  "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
+			"#[ \t]+#", '#&nbsp;#', '#  +#', '# class=".*?"#', '%&#039;%',
+			'#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
+			.'<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
+			'#<h1><a href="(?:.*?)\?=(.*?)">PHP Credits</a></h1>#',
+			'#<tr>(?:.*?)" src="(?:.*?)=(.*?)"(?:.*?)Zend Engine (.*?),(?:.*?)</tr>#',
+			"# +#", '#<tr>#', '#</tr>#'),
+			array('$1', '', '', '', '</$1>' . "\n", '<', ' ', ' ', ' ', '', ' ',
+			'<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
+			"\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
+			'<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
+			'<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" .
+			'<tr><td>Zend Egg</td><td>$1</td></tr>', ' ', '%S%', '%E%'),
+			ob_get_clean()
+		);
 
-        $sections = explode('<h2>', strip_tags($pi, '<h2><th><td>'));
-        unset($sections[0]);
+		$sections = explode('<h2>', strip_tags($pi, '<h2><th><td>'));
+		unset($sections[0]);
 
-        $pi = array();
-        foreach ($sections as $section) {
-            $n = substr($section, 0, strpos($section, '</h2>'));
-            preg_match_all(
-                '#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
-                $section,
-                $askapache,
-                PREG_SET_ORDER
-            );
-            foreach ($askapache as $m) {
-                $m2 = isset($m[2]) ? $m[2] : null;
-            }
-              $pi[ $n ][ $m[1] ]=(!isset($m[3])||$m2==$m[3]) ? $m2 : array_slice($m, 2);
-        }
+		$pi = array();
+		foreach ($sections as $section) {
+			$n = substr($section, 0, strpos($section, '</h2>'));
+			preg_match_all(
+				'#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
+				$section,
+				$askapache,
+				PREG_SET_ORDER
+			);
+			foreach ($askapache as $m) {
+				$m2 = isset($m[2]) ? $m[2] : null;
+			}
+			  $pi[ $n ][ $m[1] ]=(!isset($m[3])||$m2==$m[3]) ? $m2 : array_slice($m, 2);
+		}
 
-        return $pi;
-    }
+		return $pi;
+	}
 
-    /**
-     * Checks if site responds ot HTTPS
-     * @return boolean
-     */
-    public function get_https_enabled()
-    {
-        $home = str_replace("http://", "https://", home_url());
-        $response = wp_remote_get($home);
-        if ($response instanceof WP_Error) {
-            $error_string = '';
-            foreach ($response->errors as $short_name => $description_array) {
-                $error_string .= "<b>$short_name</b>: ".implode(", ", $description_array);
-            }
-            return $error_string;
-        }
-        return "ok!";
-    }
-    /**
-     * Whether or not a .maintenance file is detected
-     * @return string descripting wp_maintenance_mode status
-     */
-    public function get_wp_maintenance_mode()
-    {
-        $opened = file_exists(ABSPATH . '.maintenance');
-        return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
-    }
-    /**
-     * Whether or not logging is enabled
-     * @return string descripting logging's status
-     */
-    public function get_logging_enabled()
-    {
-            $opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
-            return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>') ;
-    }
-    /**
-     *  Whether curl ro fsock works
-     * @return string describing posting's status
-     */
-    public function get_remote_posting()
-    {
-        $fsock_works = function_exists('fsockopen');
-        $curl_works = function_exists('curl_init');
-        if ($fsock_works && $curl_works) {
-            $status = __('Your server has fsockopen and cURL enabled.', 'event_espresso');
-        } elseif ($fsock_works) {
-            $status = __('Your server has fsockopen enabled, cURL is disabled.', 'event_espresso');
-        } elseif ($curl_works) {
-            $status = __('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
-        } else {
-            $status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso'). '</mark>';
-        }
-        return $status;
-    }
-    /**
-     * Gets all the php.ini settings
-     * @return array
-     */
-    public function get_php_ini_all()
-    {
-        return ini_get_all();
-    }
-    /**
-     * Transforms the php.ini notation for numbers (like '2M') to an integer.
-     *
-     * @param type $size
-     * @return int
-     */
-    public function let_to_num($size)
-    {
-        $l      = substr($size, -1);
-        $ret    = substr($size, 0, -1);
-        // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-        switch (strtoupper($l)) {
-            case 'P':
-                $ret *= 1024;
-            case 'T':
-                $ret *= 1024;
-            case 'G':
-                $ret *= 1024;
-            case 'M':
-                $ret *= 1024;
-            case 'K':
-                $ret *= 1024;
-        }
-        // phpcs:enable
-        return $ret;
-    }
+	/**
+	 * Checks if site responds ot HTTPS
+	 * @return boolean
+	 */
+	public function get_https_enabled()
+	{
+		$home = str_replace("http://", "https://", home_url());
+		$response = wp_remote_get($home);
+		if ($response instanceof WP_Error) {
+			$error_string = '';
+			foreach ($response->errors as $short_name => $description_array) {
+				$error_string .= "<b>$short_name</b>: ".implode(", ", $description_array);
+			}
+			return $error_string;
+		}
+		return "ok!";
+	}
+	/**
+	 * Whether or not a .maintenance file is detected
+	 * @return string descripting wp_maintenance_mode status
+	 */
+	public function get_wp_maintenance_mode()
+	{
+		$opened = file_exists(ABSPATH . '.maintenance');
+		return $opened ? sprintf(__('%s.maintenance file detected.%s Wordpress may have a failed auto-update which could prevent Event Espresso from updating the database correctly.', 'event_espresso'), '<strong>', '</strong>') : __('.maintenance file not detected. WordPress is not in maintenance mode.', 'event_espresso')  ;
+	}
+	/**
+	 * Whether or not logging is enabled
+	 * @return string descripting logging's status
+	 */
+	public function get_logging_enabled()
+	{
+			$opened = @fopen(EVENT_ESPRESSO_UPLOAD_DIR . '/logs/espresso_log.txt', 'a');
+			return $opened ? __('Log Directory is writable', 'event_espresso') : sprintf(__('%sLog directory is NOT writable%s', 'event_espresso'), '<mark class="error"', '</mark>') ;
+	}
+	/**
+	 *  Whether curl ro fsock works
+	 * @return string describing posting's status
+	 */
+	public function get_remote_posting()
+	{
+		$fsock_works = function_exists('fsockopen');
+		$curl_works = function_exists('curl_init');
+		if ($fsock_works && $curl_works) {
+			$status = __('Your server has fsockopen and cURL enabled.', 'event_espresso');
+		} elseif ($fsock_works) {
+			$status = __('Your server has fsockopen enabled, cURL is disabled.', 'event_espresso');
+		} elseif ($curl_works) {
+			$status = __('Your server has cURL enabled, fsockopen is disabled.', 'event_espresso');
+		} else {
+			$status = __('Your server does not have fsockopen or cURL enabled - PayPal IPN and other scripts which communicate with other servers will not work. Contact your hosting provider.', 'event_espresso'). '</mark>';
+		}
+		return $status;
+	}
+	/**
+	 * Gets all the php.ini settings
+	 * @return array
+	 */
+	public function get_php_ini_all()
+	{
+		return ini_get_all();
+	}
+	/**
+	 * Transforms the php.ini notation for numbers (like '2M') to an integer.
+	 *
+	 * @param type $size
+	 * @return int
+	 */
+	public function let_to_num($size)
+	{
+		$l      = substr($size, -1);
+		$ret    = substr($size, 0, -1);
+		// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+		switch (strtoupper($l)) {
+			case 'P':
+				$ret *= 1024;
+			case 'T':
+				$ret *= 1024;
+			case 'G':
+				$ret *= 1024;
+			case 'M':
+				$ret *= 1024;
+			case 'K':
+				$ret *= 1024;
+		}
+		// phpcs:enable
+		return $ret;
+	}
 }