eventespresso / event-espresso-core

core/EE_Session.core.php

Unused Use Statements -1 removed lines

@@ -6,7 +6,6 @@
 use EventEspresso\core\exceptions\InvalidInterfaceException;
 use EventEspresso\core\exceptions\InvalidSessionDataException;
 use EventEspresso\core\services\cache\CacheStorageInterface;
-use EventEspresso\core\services\loaders\LoaderFactory;
 use EventEspresso\core\services\request\RequestInterface;
 use EventEspresso\core\services\session\SessionStartHandler;
 

Indentation +1261 added lines, -1261 removed lines

@@ -25,1259 +25,1259 @@ 
 class EE_Session implements SessionIdentifierInterface
 {
 
-    const session_id_prefix = 'ee_ssn_';
-
-    const hash_check_prefix = 'ee_shc_';
-
-    const OPTION_NAME_SETTINGS = 'ee_session_settings';
-
-    const STATUS_CLOSED = 0;
-
-    const STATUS_OPEN = 1;
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @var EE_Session
-     */
-    private static $_instance;
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    protected $cache_storage;
-
-    /**
-     * @var EE_Encryption $encryption
-     */
-    protected $encryption;
-
-    /**
-     * @var SessionStartHandler $session_start_handler
-     */
-    protected $session_start_handler;
-
-    /**
-     * the session id
-     *
-     * @var string
-     */
-    private $_sid;
-
-    /**
-     * session id salt
-     *
-     * @var string
-     */
-    private $_sid_salt;
-
-    /**
-     * session data
-     *
-     * @var array
-     */
-    private $_session_data = array();
-
-    /**
-     * how long an EE session lasts
-     * default session lifespan of 1 hour (for not so instant IPNs)
-     *
-     * @var SessionLifespan $session_lifespan
-     */
-    private $session_lifespan;
-
-    /**
-     * session expiration time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_expiration;
-
-    /**
-     * whether or not session has expired at some point
-     *
-     * @var boolean
-     */
-    private $_expired = false;
-
-    /**
-     * current time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_time;
-
-    /**
-     * whether to encrypt session data
-     *
-     * @var bool
-     */
-    private $_use_encryption;
-
-    /**
-     * well... according to the server...
-     *
-     * @var null
-     */
-    private $_user_agent;
-
-    /**
-     * do you really trust the server ?
-     *
-     * @var null
-     */
-    private $_ip_address;
-
-    /**
-     * current WP user_id
-     *
-     * @var null
-     */
-    private $_wp_user_id;
-
-    /**
-     * array for defining default session vars
-     *
-     * @var array
-     */
-    private $_default_session_vars = array(
-        'id'            => null,
-        'user_id'       => null,
-        'ip_address'    => null,
-        'user_agent'    => null,
-        'init_access'   => null,
-        'last_access'   => null,
-        'expiration'    => null,
-        'pages_visited' => array(),
-    );
-
-    /**
-     * timestamp for when last garbage collection cycle was performed
-     *
-     * @var int $_last_gc
-     */
-    private $_last_gc;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * whether session is active or not
-     *
-     * @var int $status
-     */
-    private $status = EE_Session::STATUS_CLOSED;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan|null  $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param EE_Encryption         $encryption
-     * @return EE_Session
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instance(
-        CacheStorageInterface $cache_storage = null,
-        SessionLifespan $lifespan = null,
-        RequestInterface $request = null,
-        SessionStartHandler $session_start_handler = null,
-        EE_Encryption $encryption = null
-    ) {
-        // check if class object is instantiated
-        // session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
-        // add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
-            self::$_instance = new self(
-                $cache_storage,
-                $lifespan,
-                $request,
-                $session_start_handler,
-                $encryption
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan       $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param EE_Encryption         $encryption
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function __construct(
-        CacheStorageInterface $cache_storage,
-        SessionLifespan $lifespan,
-        RequestInterface $request,
-        SessionStartHandler $session_start_handler,
-        EE_Encryption $encryption = null
-    ) {
-        // session loading is turned ON by default,
-        // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
-        // (which currently fires on the init hook at priority 9),
-        // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
-            return;
-        }
-        $this->session_start_handler = $session_start_handler;
-        $this->session_lifespan = $lifespan;
-        $this->request = $request;
-        if (! defined('ESPRESSO_SESSION')) {
-            define('ESPRESSO_SESSION', true);
-        }
-        // retrieve session options from db
-        $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
-            // cycle though existing session options
-            foreach ($session_settings as $var_name => $session_setting) {
-                // set values for class properties
-                $var_name = '_' . $var_name;
-                $this->{$var_name} = $session_setting;
-            }
-        }
-        $this->cache_storage = $cache_storage;
-        // are we using encryption?
-        $this->_use_encryption = $encryption instanceof EE_Encryption
-                                 && EE_Registry::instance()->CFG->admin->encode_session_data();
-        // encrypt data via: $this->encryption->encrypt();
-        $this->encryption = $encryption;
-        // filter hook allows outside functions/classes/plugins to change default empty cart
-        $extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
-        array_merge($this->_default_session_vars, $extra_default_session_vars);
-        // apply default session vars
-        $this->_set_defaults();
-        add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
-        // check request for 'clear_session' param
-        add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
-        // once everything is all said and done,
-        add_action('shutdown', array($this, 'update'), 100);
-        add_action('shutdown', array($this, 'garbageCollection'), 1000);
-        $this->configure_garbage_collection_filters();
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function isLoadedAndActive()
-    {
-        return did_action('AHEE__EE_System__core_loaded_and_ready')
-               && EE_Session::instance() instanceof EE_Session
-               && EE_Session::instance()->isActive();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActive()
-    {
-        return $this->status === EE_Session::STATUS_OPEN;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     */
-    public function open_session()
-    {
-        // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
-            // or just start a new one
-            $this->_create_espresso_session();
-        }
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function expired()
-    {
-        return $this->_expired;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function reset_expired()
-    {
-        $this->_expired = false;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function expiration()
-    {
-        return $this->_expiration;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function extension()
-    {
-        return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
-    }
-
-
-    /**
-     * @param int $time number of seconds to add to session expiration
-     */
-    public function extend_expiration($time = 0)
-    {
-        $time = $time ? $time : $this->extension();
-        $this->_expiration += absint($time);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function lifespan()
-    {
-        return $this->session_lifespan->inSeconds();
-    }
-
-
-    /**
-     * This just sets some defaults for the _session data property
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        // set some defaults
-        foreach ($this->_default_session_vars as $key => $default_var) {
-            if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
-            } else {
-                $this->_session_data[ $key ] = '';
-            }
-        }
-    }
-
-
-    /**
-     * @retrieve  session data
-     * @access    public
-     * @return    string
-     */
-    public function id()
-    {
-        return $this->_sid;
-    }
-
-
-    /**
-     * @param \EE_Cart $cart
-     * @return bool
-     */
-    public function set_cart(EE_Cart $cart)
-    {
-        $this->_session_data['cart'] = $cart;
-        return true;
-    }
-
-
-    /**
-     * reset_cart
-     */
-    public function reset_cart()
-    {
-        do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
-        $this->_session_data['cart'] = null;
-    }
-
-
-    /**
-     * @return \EE_Cart
-     */
-    public function cart()
-    {
-        return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
-            ? $this->_session_data['cart']
-            : null;
-    }
-
-
-    /**
-     * @param \EE_Checkout $checkout
-     * @return bool
-     */
-    public function set_checkout(EE_Checkout $checkout)
-    {
-        $this->_session_data['checkout'] = $checkout;
-        return true;
-    }
-
-
-    /**
-     * reset_checkout
-     */
-    public function reset_checkout()
-    {
-        do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
-        $this->_session_data['checkout'] = null;
-    }
-
-
-    /**
-     * @return \EE_Checkout
-     */
-    public function checkout()
-    {
-        return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
-            ? $this->_session_data['checkout']
-            : null;
-    }
-
-
-    /**
-     * @param \EE_Transaction $transaction
-     * @return bool
-     * @throws EE_Error
-     */
-    public function set_transaction(EE_Transaction $transaction)
-    {
-        // first remove the session from the transaction before we save the transaction in the session
-        $transaction->set_txn_session_data(null);
-        $this->_session_data['transaction'] = $transaction;
-        return true;
-    }
-
-
-    /**
-     * reset_transaction
-     */
-    public function reset_transaction()
-    {
-        do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
-        $this->_session_data['transaction'] = null;
-    }
-
-
-    /**
-     * @return \EE_Transaction
-     */
-    public function transaction()
-    {
-        return isset($this->_session_data['transaction'])
-               && $this->_session_data['transaction'] instanceof EE_Transaction
-            ? $this->_session_data['transaction']
-            : null;
-    }
-
-
-    /**
-     * retrieve session data
-     *
-     * @param null $key
-     * @param bool $reset_cache
-     * @return array
-     */
-    public function get_session_data($key = null, $reset_cache = false)
-    {
-        if ($reset_cache) {
-            $this->reset_cart();
-            $this->reset_checkout();
-            $this->reset_transaction();
-        }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
-        }
-        return $this->_session_data;
-    }
-
-
-    /**
-     * Returns TRUE on success, FALSE on fail
-     *
-     * @param array $data
-     * @return bool
-     */
-    public function set_session_data($data)
-    {
-        // nothing ??? bad data ??? go home!
-        if (empty($data) || ! is_array($data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data or invalid session data was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Sorry! %s is a default session datum and can not be reset.',
-                            'event_espresso'
-                        ),
-                        $key
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $this->_session_data[ $key ] = $value;
-        }
-        return true;
-    }
-
-
-    /**
-     * @initiate session
-     * @access   private
-     * @return TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     */
-    private function _espresso_session()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->session_start_handler->startSession();
-        $this->status = EE_Session::STATUS_OPEN;
-        // get our modified session ID
-        $this->_sid = $this->_generate_session_id();
-        // and the visitors IP
-        $this->_ip_address = $this->request->ipAddress();
-        // set the "user agent"
-        $this->_user_agent = $this->request->userAgent();
-        // now let's retrieve what's in the db
-        $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
-            // get the current time in UTC
-            $this->_time = $this->_time !== null ? $this->_time : time();
-            // and reset the session expiration
-            $this->_expiration = isset($session_data['expiration'])
-                ? $session_data['expiration']
-                : $this->_time + $this->session_lifespan->inSeconds();
-        } else {
-            // set initial site access time and the session expiration
-            $this->_set_init_access_and_expiration();
-            // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = isset($_SERVER['HTTP_REFERER'])
-                ? esc_attr($_SERVER['HTTP_REFERER'])
-                : '';
-            // no previous session = go back and create one (on top of the data above)
-            return false;
-        }
-        // now the user agent
-        if ($session_data['user_agent'] !== $this->_user_agent) {
-            return false;
-        }
-        // wait a minute... how old are you?
-        if ($this->_time > $this->_expiration) {
-            // yer too old fer me!
-            $this->_expired = true;
-            // wipe out everything that isn't a default session datum
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // make event espresso session data available to plugin
-        $this->_session_data = array_merge($this->_session_data, $session_data);
-        return true;
-    }
-
-
-    /**
-     * _get_session_data
-     * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
-     * databases
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidSessionDataException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _retrieve_session_data()
-    {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
-        try {
-            // we're using WP's Transient API to store session data using the PHP session ID as the option name
-            $session_data = $this->cache_storage->get($ssn_key, false);
-            if (empty($session_data)) {
-                return array();
-            }
-            if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-                $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
-                    false
-                );
-                if ($hash_check && $hash_check !== md5($session_data)) {
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
-                                'event_espresso'
-                            ),
-                            EE_Session::session_id_prefix . $this->_sid
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        } catch (Exception $e) {
-            // let's just eat that error for now and attempt to correct any corrupted data
-            global $wpdb;
-            $row = $wpdb->get_row(
-                $wpdb->prepare(
-                    "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
-                )
-            );
-            $session_data = is_object($row) ? $row->option_value : null;
-            if ($session_data) {
-                $session_data = preg_replace_callback(
-                    '!s:(d+):"(.*?)";!',
-                    function ($match) {
-                        return $match[1] === strlen($match[2])
-                            ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
-                    },
-                    $session_data
-                );
-            }
-            $session_data = maybe_unserialize($session_data);
-        }
-        // in case the data is encoded... try to decode it
-        $session_data = $this->encryption instanceof EE_Encryption
-            ? $this->encryption->base64_string_decode($session_data)
-            : $session_data;
-        if (! is_array($session_data)) {
-            try {
-                $session_data = maybe_unserialize($session_data);
-            } catch (Exception $e) {
-                $msg = esc_html__(
-                    'An error occurred while attempting to unserialize the session data.',
-                    'event_espresso'
-                );
-                $msg .= WP_DEBUG
-                    ? '<br><pre>'
-                      . print_r($session_data, true)
-                      . '</pre><br>'
-                      . $this->find_serialize_error($session_data)
-                    : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-                throw new InvalidSessionDataException($msg, 0, $e);
-            }
-        }
-        // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
-            // no?!?! then something is wrong
-            $msg = esc_html__(
-                'The session data is missing, invalid, or corrupted.',
-                'event_espresso'
-            );
-            $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
-                : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-            throw new InvalidSessionDataException($msg);
-        }
-        if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
-            $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
-                $session_data['transaction']
-            );
-        }
-        return $session_data;
-    }
-
-
-    /**
-     * _generate_session_id
-     * Retrieves the PHP session id either directly from the PHP session,
-     * or from the $_REQUEST array if it was passed in from an AJAX request.
-     * The session id is then salted and hashed (mmm sounds tasty)
-     * so that it can be safely used as a $_REQUEST param
-     *
-     * @return string
-     */
-    protected function _generate_session_id()
-    {
-        // check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
-        if (isset($_REQUEST['EESID'])) {
-            $session_id = sanitize_text_field($_REQUEST['EESID']);
-        } else {
-            $session_id = md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
-        }
-        return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
-    }
-
-
-    /**
-     * _get_sid_salt
-     *
-     * @return string
-     */
-    protected function _get_sid_salt()
-    {
-        // was session id salt already saved to db ?
-        if (empty($this->_sid_salt)) {
-            // no?  then maybe use WP defined constant
-            if (defined('AUTH_SALT')) {
-                $this->_sid_salt = AUTH_SALT;
-            }
-            // if salt doesn't exist or is too short
-            if (strlen($this->_sid_salt) < 32) {
-                // create a new one
-                $this->_sid_salt = wp_generate_password(64);
-            }
-            // and save it as a permanent session setting
-            $this->updateSessionSettings(array('sid_salt' => $this->_sid_salt));
-        }
-        return $this->_sid_salt;
-    }
-
-
-    /**
-     * _set_init_access_and_expiration
-     *
-     * @return void
-     */
-    protected function _set_init_access_and_expiration()
-    {
-        $this->_time = time();
-        $this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
-        // set initial site access time
-        $this->_session_data['init_access'] = $this->_time;
-        // and the session expiration
-        $this->_session_data['expiration'] = $this->_expiration;
-    }
-
-
-    /**
-     * @update session data  prior to saving to the db
-     * @access public
-     * @param bool $new_session
-     * @return TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update($new_session = false)
-    {
-        $this->_session_data = $this->_session_data !== null
-                               && is_array($this->_session_data)
-                               && isset($this->_session_data['id'])
-            ? $this->_session_data
-            : array();
-        if (empty($this->_session_data)) {
-            $this->_set_defaults();
-        }
-        $session_data = array();
-        foreach ($this->_session_data as $key => $value) {
-            switch ($key) {
-                case 'id':
-                    // session ID
-                    $session_data['id'] = $this->_sid;
-                    break;
-                case 'ip_address':
-                    // visitor ip address
-                    $session_data['ip_address'] = $this->request->ipAddress();
-                    break;
-                case 'user_agent':
-                    // visitor user_agent
-                    $session_data['user_agent'] = $this->_user_agent;
-                    break;
-                case 'init_access':
-                    $session_data['init_access'] = absint($value);
-                    break;
-                case 'last_access':
-                    // current access time
-                    $session_data['last_access'] = $this->_time;
-                    break;
-                case 'expiration':
-                    // when the session expires
-                    $session_data['expiration'] = ! empty($this->_expiration)
-                        ? $this->_expiration
-                        : $session_data['init_access'] + $this->session_lifespan->inSeconds();
-                    break;
-                case 'user_id':
-                    // current user if logged in
-                    $session_data['user_id'] = $this->_wp_user_id();
-                    break;
-                case 'pages_visited':
-                    $page_visit = $this->_get_page_visit();
-                    if ($page_visit) {
-                        // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
-                        // we'll only save the last 10 page visits.
-                        $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
-                    }
-                    break;
-                default:
-                    // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
-            }
-        }
-        $this->_session_data = $session_data;
-        // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
-            // ready? let's save
-            if ($this->_save_session_to_db()) {
-                return true;
-            }
-            return false;
-        }
-        // meh, why not?
-        return true;
-    }
-
-
-    /**
-     * @create session data array
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _create_espresso_session()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
-        // use the update function for now with $new_session arg set to TRUE
-        return $this->update(true) ? true : false;
-    }
-
-    /**
-     * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
-     * too). This is used when determining if we want to save the session or not.
-     * @since 4.9.67.p
-     * @return bool
-     */
-    private function sessionHasStuffWorthSaving()
-    {
-        return $this->cart() instanceof EE_Cart
-            || (
-                isset($this->_session_data['ee_notices'])
-                && (
-                    ! empty($this->_session_data['ee_notices']['attention'])
-                    || !empty($this->_session_data['ee_notices']['errors'])
-                    || !empty($this->_session_data['ee_notices']['success'])
-                )
-            );
-    }
-    /**
-     * _save_session_to_db
-     *
-     * @param bool $clear_session
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _save_session_to_db($clear_session = false)
-    {
-        // don't save sessions for crawlers
-        // and unless we're deleting the session data, don't save anything if there isn't a cart
-        if ($this->request->isBot()
-            || (
-                ! $clear_session
-                && ! $this->sessionHasStuffWorthSaving()
-                && apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
-            )
-        ) {
-            return false;
-        }
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
-                $transaction->save();
-            }
-            $this->_session_data['transaction'] = $transaction->ID();
-        }
-        // then serialize all of our session data
-        $session_data = serialize($this->_session_data);
-        // do we need to also encode it to avoid corrupted data when saved to the db?
-        $session_data = $this->_use_encryption
-            ? $this->encryption->base64_string_encode($session_data)
-            : $session_data;
-        // maybe save hash check
-        if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-            $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
-                md5($session_data),
-                $this->session_lifespan->inSeconds()
-            );
-        }
-        // we're using the Transient API for storing session data,
-        return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
-            $session_data,
-            $this->session_lifespan->inSeconds()
-        );
-    }
-
-
-    /**
-     * @get    the full page request the visitor is accessing
-     * @access public
-     * @return string
-     */
-    public function _get_page_visit()
-    {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
-        // check for request url
-        if (isset($_SERVER['REQUEST_URI'])) {
-            $http_host = '';
-            $page_id = '?';
-            $e_reg = '';
-            $request_uri = esc_url($_SERVER['REQUEST_URI']);
-            $ru_bits = explode('?', $request_uri);
-            $request_uri = $ru_bits[0];
-            // check for and grab host as well
-            if (isset($_SERVER['HTTP_HOST'])) {
-                $http_host = esc_url($_SERVER['HTTP_HOST']);
-            }
-            // check for page_id in SERVER REQUEST
-            if (isset($_REQUEST['page_id'])) {
-                // rebuild $e_reg without any of the extra parameters
-                $page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
-            }
-            // check for $e_reg in SERVER REQUEST
-            if (isset($_REQUEST['ee'])) {
-                // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
-            }
-            $page_visit = rtrim($http_host . $request_uri . $page_id . $e_reg, '?');
-        }
-        return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
-    }
-
-
-    /**
-     * @the    current wp user id
-     * @access public
-     * @return int
-     */
-    public function _wp_user_id()
-    {
-        // if I need to explain the following lines of code, then you shouldn't be looking at this!
-        $this->_wp_user_id = get_current_user_id();
-        return $this->_wp_user_id;
-    }
-
-
-    /**
-     * Clear EE_Session data
-     *
-     * @access public
-     * @param string $class
-     * @param string $function
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function clear_session($class = '', $function = '')
-    {
+	const session_id_prefix = 'ee_ssn_';
+
+	const hash_check_prefix = 'ee_shc_';
+
+	const OPTION_NAME_SETTINGS = 'ee_session_settings';
+
+	const STATUS_CLOSED = 0;
+
+	const STATUS_OPEN = 1;
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @var EE_Session
+	 */
+	private static $_instance;
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	protected $cache_storage;
+
+	/**
+	 * @var EE_Encryption $encryption
+	 */
+	protected $encryption;
+
+	/**
+	 * @var SessionStartHandler $session_start_handler
+	 */
+	protected $session_start_handler;
+
+	/**
+	 * the session id
+	 *
+	 * @var string
+	 */
+	private $_sid;
+
+	/**
+	 * session id salt
+	 *
+	 * @var string
+	 */
+	private $_sid_salt;
+
+	/**
+	 * session data
+	 *
+	 * @var array
+	 */
+	private $_session_data = array();
+
+	/**
+	 * how long an EE session lasts
+	 * default session lifespan of 1 hour (for not so instant IPNs)
+	 *
+	 * @var SessionLifespan $session_lifespan
+	 */
+	private $session_lifespan;
+
+	/**
+	 * session expiration time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_expiration;
+
+	/**
+	 * whether or not session has expired at some point
+	 *
+	 * @var boolean
+	 */
+	private $_expired = false;
+
+	/**
+	 * current time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_time;
+
+	/**
+	 * whether to encrypt session data
+	 *
+	 * @var bool
+	 */
+	private $_use_encryption;
+
+	/**
+	 * well... according to the server...
+	 *
+	 * @var null
+	 */
+	private $_user_agent;
+
+	/**
+	 * do you really trust the server ?
+	 *
+	 * @var null
+	 */
+	private $_ip_address;
+
+	/**
+	 * current WP user_id
+	 *
+	 * @var null
+	 */
+	private $_wp_user_id;
+
+	/**
+	 * array for defining default session vars
+	 *
+	 * @var array
+	 */
+	private $_default_session_vars = array(
+		'id'            => null,
+		'user_id'       => null,
+		'ip_address'    => null,
+		'user_agent'    => null,
+		'init_access'   => null,
+		'last_access'   => null,
+		'expiration'    => null,
+		'pages_visited' => array(),
+	);
+
+	/**
+	 * timestamp for when last garbage collection cycle was performed
+	 *
+	 * @var int $_last_gc
+	 */
+	private $_last_gc;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * whether session is active or not
+	 *
+	 * @var int $status
+	 */
+	private $status = EE_Session::STATUS_CLOSED;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan|null  $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param EE_Encryption         $encryption
+	 * @return EE_Session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function instance(
+		CacheStorageInterface $cache_storage = null,
+		SessionLifespan $lifespan = null,
+		RequestInterface $request = null,
+		SessionStartHandler $session_start_handler = null,
+		EE_Encryption $encryption = null
+	) {
+		// check if class object is instantiated
+		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
+		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
+			self::$_instance = new self(
+				$cache_storage,
+				$lifespan,
+				$request,
+				$session_start_handler,
+				$encryption
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan       $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param EE_Encryption         $encryption
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function __construct(
+		CacheStorageInterface $cache_storage,
+		SessionLifespan $lifespan,
+		RequestInterface $request,
+		SessionStartHandler $session_start_handler,
+		EE_Encryption $encryption = null
+	) {
+		// session loading is turned ON by default,
+		// but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
+		// (which currently fires on the init hook at priority 9),
+		// can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! apply_filters('FHEE_load_EE_Session', true)) {
+			return;
+		}
+		$this->session_start_handler = $session_start_handler;
+		$this->session_lifespan = $lifespan;
+		$this->request = $request;
+		if (! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
+		}
+		// retrieve session options from db
+		$session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		if (! empty($session_settings)) {
+			// cycle though existing session options
+			foreach ($session_settings as $var_name => $session_setting) {
+				// set values for class properties
+				$var_name = '_' . $var_name;
+				$this->{$var_name} = $session_setting;
+			}
+		}
+		$this->cache_storage = $cache_storage;
+		// are we using encryption?
+		$this->_use_encryption = $encryption instanceof EE_Encryption
+								 && EE_Registry::instance()->CFG->admin->encode_session_data();
+		// encrypt data via: $this->encryption->encrypt();
+		$this->encryption = $encryption;
+		// filter hook allows outside functions/classes/plugins to change default empty cart
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
+		// apply default session vars
+		$this->_set_defaults();
+		add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
+		// check request for 'clear_session' param
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
+		// once everything is all said and done,
+		add_action('shutdown', array($this, 'update'), 100);
+		add_action('shutdown', array($this, 'garbageCollection'), 1000);
+		$this->configure_garbage_collection_filters();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function isLoadedAndActive()
+	{
+		return did_action('AHEE__EE_System__core_loaded_and_ready')
+			   && EE_Session::instance() instanceof EE_Session
+			   && EE_Session::instance()->isActive();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActive()
+	{
+		return $this->status === EE_Session::STATUS_OPEN;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 */
+	public function open_session()
+	{
+		// check for existing session and retrieve it from db
+		if (! $this->_espresso_session()) {
+			// or just start a new one
+			$this->_create_espresso_session();
+		}
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function expired()
+	{
+		return $this->_expired;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function reset_expired()
+	{
+		$this->_expired = false;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function expiration()
+	{
+		return $this->_expiration;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function extension()
+	{
+		return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
+	}
+
+
+	/**
+	 * @param int $time number of seconds to add to session expiration
+	 */
+	public function extend_expiration($time = 0)
+	{
+		$time = $time ? $time : $this->extension();
+		$this->_expiration += absint($time);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function lifespan()
+	{
+		return $this->session_lifespan->inSeconds();
+	}
+
+
+	/**
+	 * This just sets some defaults for the _session data property
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		// set some defaults
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[ $key ] = array();
+			} else {
+				$this->_session_data[ $key ] = '';
+			}
+		}
+	}
+
+
+	/**
+	 * @retrieve  session data
+	 * @access    public
+	 * @return    string
+	 */
+	public function id()
+	{
+		return $this->_sid;
+	}
+
+
+	/**
+	 * @param \EE_Cart $cart
+	 * @return bool
+	 */
+	public function set_cart(EE_Cart $cart)
+	{
+		$this->_session_data['cart'] = $cart;
+		return true;
+	}
+
+
+	/**
+	 * reset_cart
+	 */
+	public function reset_cart()
+	{
+		do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
+		$this->_session_data['cart'] = null;
+	}
+
+
+	/**
+	 * @return \EE_Cart
+	 */
+	public function cart()
+	{
+		return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
+			? $this->_session_data['cart']
+			: null;
+	}
+
+
+	/**
+	 * @param \EE_Checkout $checkout
+	 * @return bool
+	 */
+	public function set_checkout(EE_Checkout $checkout)
+	{
+		$this->_session_data['checkout'] = $checkout;
+		return true;
+	}
+
+
+	/**
+	 * reset_checkout
+	 */
+	public function reset_checkout()
+	{
+		do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
+		$this->_session_data['checkout'] = null;
+	}
+
+
+	/**
+	 * @return \EE_Checkout
+	 */
+	public function checkout()
+	{
+		return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
+			? $this->_session_data['checkout']
+			: null;
+	}
+
+
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function set_transaction(EE_Transaction $transaction)
+	{
+		// first remove the session from the transaction before we save the transaction in the session
+		$transaction->set_txn_session_data(null);
+		$this->_session_data['transaction'] = $transaction;
+		return true;
+	}
+
+
+	/**
+	 * reset_transaction
+	 */
+	public function reset_transaction()
+	{
+		do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
+		$this->_session_data['transaction'] = null;
+	}
+
+
+	/**
+	 * @return \EE_Transaction
+	 */
+	public function transaction()
+	{
+		return isset($this->_session_data['transaction'])
+			   && $this->_session_data['transaction'] instanceof EE_Transaction
+			? $this->_session_data['transaction']
+			: null;
+	}
+
+
+	/**
+	 * retrieve session data
+	 *
+	 * @param null $key
+	 * @param bool $reset_cache
+	 * @return array
+	 */
+	public function get_session_data($key = null, $reset_cache = false)
+	{
+		if ($reset_cache) {
+			$this->reset_cart();
+			$this->reset_checkout();
+			$this->reset_transaction();
+		}
+		if (! empty($key)) {
+			return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+		}
+		return $this->_session_data;
+	}
+
+
+	/**
+	 * Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array $data
+	 * @return bool
+	 */
+	public function set_session_data($data)
+	{
+		// nothing ??? bad data ??? go home!
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data or invalid session data was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		foreach ($data as $key => $value) {
+			if (isset($this->_default_session_vars[ $key ])) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Sorry! %s is a default session datum and can not be reset.',
+							'event_espresso'
+						),
+						$key
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$this->_session_data[ $key ] = $value;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @initiate session
+	 * @access   private
+	 * @return TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 */
+	private function _espresso_session()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->session_start_handler->startSession();
+		$this->status = EE_Session::STATUS_OPEN;
+		// get our modified session ID
+		$this->_sid = $this->_generate_session_id();
+		// and the visitors IP
+		$this->_ip_address = $this->request->ipAddress();
+		// set the "user agent"
+		$this->_user_agent = $this->request->userAgent();
+		// now let's retrieve what's in the db
+		$session_data = $this->_retrieve_session_data();
+		if (! empty($session_data)) {
+			// get the current time in UTC
+			$this->_time = $this->_time !== null ? $this->_time : time();
+			// and reset the session expiration
+			$this->_expiration = isset($session_data['expiration'])
+				? $session_data['expiration']
+				: $this->_time + $this->session_lifespan->inSeconds();
+		} else {
+			// set initial site access time and the session expiration
+			$this->_set_init_access_and_expiration();
+			// set referer
+			$this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = isset($_SERVER['HTTP_REFERER'])
+				? esc_attr($_SERVER['HTTP_REFERER'])
+				: '';
+			// no previous session = go back and create one (on top of the data above)
+			return false;
+		}
+		// now the user agent
+		if ($session_data['user_agent'] !== $this->_user_agent) {
+			return false;
+		}
+		// wait a minute... how old are you?
+		if ($this->_time > $this->_expiration) {
+			// yer too old fer me!
+			$this->_expired = true;
+			// wipe out everything that isn't a default session datum
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// make event espresso session data available to plugin
+		$this->_session_data = array_merge($this->_session_data, $session_data);
+		return true;
+	}
+
+
+	/**
+	 * _get_session_data
+	 * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
+	 * databases
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidSessionDataException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _retrieve_session_data()
+	{
+		$ssn_key = EE_Session::session_id_prefix . $this->_sid;
+		try {
+			// we're using WP's Transient API to store session data using the PHP session ID as the option name
+			$session_data = $this->cache_storage->get($ssn_key, false);
+			if (empty($session_data)) {
+				return array();
+			}
+			if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+				$hash_check = $this->cache_storage->get(
+					EE_Session::hash_check_prefix . $this->_sid,
+					false
+				);
+				if ($hash_check && $hash_check !== md5($session_data)) {
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
+								'event_espresso'
+							),
+							EE_Session::session_id_prefix . $this->_sid
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		} catch (Exception $e) {
+			// let's just eat that error for now and attempt to correct any corrupted data
+			global $wpdb;
+			$row = $wpdb->get_row(
+				$wpdb->prepare(
+					"SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
+					'_transient_' . $ssn_key
+				)
+			);
+			$session_data = is_object($row) ? $row->option_value : null;
+			if ($session_data) {
+				$session_data = preg_replace_callback(
+					'!s:(d+):"(.*?)";!',
+					function ($match) {
+						return $match[1] === strlen($match[2])
+							? $match[0]
+							: 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+					},
+					$session_data
+				);
+			}
+			$session_data = maybe_unserialize($session_data);
+		}
+		// in case the data is encoded... try to decode it
+		$session_data = $this->encryption instanceof EE_Encryption
+			? $this->encryption->base64_string_decode($session_data)
+			: $session_data;
+		if (! is_array($session_data)) {
+			try {
+				$session_data = maybe_unserialize($session_data);
+			} catch (Exception $e) {
+				$msg = esc_html__(
+					'An error occurred while attempting to unserialize the session data.',
+					'event_espresso'
+				);
+				$msg .= WP_DEBUG
+					? '<br><pre>'
+					  . print_r($session_data, true)
+					  . '</pre><br>'
+					  . $this->find_serialize_error($session_data)
+					: '';
+				$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+				throw new InvalidSessionDataException($msg, 0, $e);
+			}
+		}
+		// just a check to make sure the session array is indeed an array
+		if (! is_array($session_data)) {
+			// no?!?! then something is wrong
+			$msg = esc_html__(
+				'The session data is missing, invalid, or corrupted.',
+				'event_espresso'
+			);
+			$msg .= WP_DEBUG
+				? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+				: '';
+			$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+			throw new InvalidSessionDataException($msg);
+		}
+		if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
+			$session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
+				$session_data['transaction']
+			);
+		}
+		return $session_data;
+	}
+
+
+	/**
+	 * _generate_session_id
+	 * Retrieves the PHP session id either directly from the PHP session,
+	 * or from the $_REQUEST array if it was passed in from an AJAX request.
+	 * The session id is then salted and hashed (mmm sounds tasty)
+	 * so that it can be safely used as a $_REQUEST param
+	 *
+	 * @return string
+	 */
+	protected function _generate_session_id()
+	{
+		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
+		if (isset($_REQUEST['EESID'])) {
+			$session_id = sanitize_text_field($_REQUEST['EESID']);
+		} else {
+			$session_id = md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+		}
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
+	}
+
+
+	/**
+	 * _get_sid_salt
+	 *
+	 * @return string
+	 */
+	protected function _get_sid_salt()
+	{
+		// was session id salt already saved to db ?
+		if (empty($this->_sid_salt)) {
+			// no?  then maybe use WP defined constant
+			if (defined('AUTH_SALT')) {
+				$this->_sid_salt = AUTH_SALT;
+			}
+			// if salt doesn't exist or is too short
+			if (strlen($this->_sid_salt) < 32) {
+				// create a new one
+				$this->_sid_salt = wp_generate_password(64);
+			}
+			// and save it as a permanent session setting
+			$this->updateSessionSettings(array('sid_salt' => $this->_sid_salt));
+		}
+		return $this->_sid_salt;
+	}
+
+
+	/**
+	 * _set_init_access_and_expiration
+	 *
+	 * @return void
+	 */
+	protected function _set_init_access_and_expiration()
+	{
+		$this->_time = time();
+		$this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
+		// set initial site access time
+		$this->_session_data['init_access'] = $this->_time;
+		// and the session expiration
+		$this->_session_data['expiration'] = $this->_expiration;
+	}
+
+
+	/**
+	 * @update session data  prior to saving to the db
+	 * @access public
+	 * @param bool $new_session
+	 * @return TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update($new_session = false)
+	{
+		$this->_session_data = $this->_session_data !== null
+							   && is_array($this->_session_data)
+							   && isset($this->_session_data['id'])
+			? $this->_session_data
+			: array();
+		if (empty($this->_session_data)) {
+			$this->_set_defaults();
+		}
+		$session_data = array();
+		foreach ($this->_session_data as $key => $value) {
+			switch ($key) {
+				case 'id':
+					// session ID
+					$session_data['id'] = $this->_sid;
+					break;
+				case 'ip_address':
+					// visitor ip address
+					$session_data['ip_address'] = $this->request->ipAddress();
+					break;
+				case 'user_agent':
+					// visitor user_agent
+					$session_data['user_agent'] = $this->_user_agent;
+					break;
+				case 'init_access':
+					$session_data['init_access'] = absint($value);
+					break;
+				case 'last_access':
+					// current access time
+					$session_data['last_access'] = $this->_time;
+					break;
+				case 'expiration':
+					// when the session expires
+					$session_data['expiration'] = ! empty($this->_expiration)
+						? $this->_expiration
+						: $session_data['init_access'] + $this->session_lifespan->inSeconds();
+					break;
+				case 'user_id':
+					// current user if logged in
+					$session_data['user_id'] = $this->_wp_user_id();
+					break;
+				case 'pages_visited':
+					$page_visit = $this->_get_page_visit();
+					if ($page_visit) {
+						// set pages visited where the first will be the http referrer
+						$this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+						// we'll only save the last 10 page visits.
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
+					}
+					break;
+				default:
+					// carry any other data over
+					$session_data[ $key ] = $this->_session_data[ $key ];
+			}
+		}
+		$this->_session_data = $session_data;
+		// creating a new session does not require saving to the db just yet
+		if (! $new_session) {
+			// ready? let's save
+			if ($this->_save_session_to_db()) {
+				return true;
+			}
+			return false;
+		}
+		// meh, why not?
+		return true;
+	}
+
+
+	/**
+	 * @create session data array
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _create_espresso_session()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
+		// use the update function for now with $new_session arg set to TRUE
+		return $this->update(true) ? true : false;
+	}
+
+	/**
+	 * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
+	 * too). This is used when determining if we want to save the session or not.
+	 * @since 4.9.67.p
+	 * @return bool
+	 */
+	private function sessionHasStuffWorthSaving()
+	{
+		return $this->cart() instanceof EE_Cart
+			|| (
+				isset($this->_session_data['ee_notices'])
+				&& (
+					! empty($this->_session_data['ee_notices']['attention'])
+					|| !empty($this->_session_data['ee_notices']['errors'])
+					|| !empty($this->_session_data['ee_notices']['success'])
+				)
+			);
+	}
+	/**
+	 * _save_session_to_db
+	 *
+	 * @param bool $clear_session
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _save_session_to_db($clear_session = false)
+	{
+		// don't save sessions for crawlers
+		// and unless we're deleting the session data, don't save anything if there isn't a cart
+		if ($this->request->isBot()
+			|| (
+				! $clear_session
+				&& ! $this->sessionHasStuffWorthSaving()
+				&& apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
+			)
+		) {
+			return false;
+		}
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			if (! $transaction->ID()) {
+				$transaction->save();
+			}
+			$this->_session_data['transaction'] = $transaction->ID();
+		}
+		// then serialize all of our session data
+		$session_data = serialize($this->_session_data);
+		// do we need to also encode it to avoid corrupted data when saved to the db?
+		$session_data = $this->_use_encryption
+			? $this->encryption->base64_string_encode($session_data)
+			: $session_data;
+		// maybe save hash check
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+			$this->cache_storage->add(
+				EE_Session::hash_check_prefix . $this->_sid,
+				md5($session_data),
+				$this->session_lifespan->inSeconds()
+			);
+		}
+		// we're using the Transient API for storing session data,
+		return $this->cache_storage->add(
+			EE_Session::session_id_prefix . $this->_sid,
+			$session_data,
+			$this->session_lifespan->inSeconds()
+		);
+	}
+
+
+	/**
+	 * @get    the full page request the visitor is accessing
+	 * @access public
+	 * @return string
+	 */
+	public function _get_page_visit()
+	{
+		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		// check for request url
+		if (isset($_SERVER['REQUEST_URI'])) {
+			$http_host = '';
+			$page_id = '?';
+			$e_reg = '';
+			$request_uri = esc_url($_SERVER['REQUEST_URI']);
+			$ru_bits = explode('?', $request_uri);
+			$request_uri = $ru_bits[0];
+			// check for and grab host as well
+			if (isset($_SERVER['HTTP_HOST'])) {
+				$http_host = esc_url($_SERVER['HTTP_HOST']);
+			}
+			// check for page_id in SERVER REQUEST
+			if (isset($_REQUEST['page_id'])) {
+				// rebuild $e_reg without any of the extra parameters
+				$page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
+			}
+			// check for $e_reg in SERVER REQUEST
+			if (isset($_REQUEST['ee'])) {
+				// rebuild $e_reg without any of the extra parameters
+				$e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
+			}
+			$page_visit = rtrim($http_host . $request_uri . $page_id . $e_reg, '?');
+		}
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
+	}
+
+
+	/**
+	 * @the    current wp user id
+	 * @access public
+	 * @return int
+	 */
+	public function _wp_user_id()
+	{
+		// if I need to explain the following lines of code, then you shouldn't be looking at this!
+		$this->_wp_user_id = get_current_user_id();
+		return $this->_wp_user_id;
+	}
+
+
+	/**
+	 * Clear EE_Session data
+	 *
+	 * @access public
+	 * @param string $class
+	 * @param string $function
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function clear_session($class = '', $function = '')
+	{
 //         echo '
 // <h3 style="color:#999;line-height:.9em;">
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
-        $this->reset_cart();
-        $this->reset_checkout();
-        $this->reset_transaction();
-        // wipe out everything that isn't a default session datum
-        $this->reset_data(array_keys($this->_session_data));
-        // reset initial site access time and the session expiration
-        $this->_set_init_access_and_expiration();
-        $this->_save_session_to_db(true);
-    }
-
-
-    /**
-     * resets all non-default session vars. Returns TRUE on success, FALSE on fail
-     *
-     * @param array|mixed $data_to_reset
-     * @param bool        $show_all_notices
-     * @return bool
-     */
-    public function reset_data($data_to_reset = array(), $show_all_notices = false)
-    {
-        // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
-            $data_to_reset = array($data_to_reset);
-        }
-        // nothing ??? go home!
-        if (empty($data_to_reset)) {
-            EE_Error::add_error(
-                __(
-                    'No session data could be reset, because no session var name was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $return_value = true;
-        // since $data_to_reset is an array, cycle through the values
-        foreach ($data_to_reset as $reset) {
-            // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
-                // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
-                    // remove session var
-                    unset($this->_session_data[ $reset ]);
-                    if ($show_all_notices) {
-                        EE_Error::add_success(
-                            sprintf(
-                                __('The session variable %s was removed.', 'event_espresso'),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                } else {
-                    // yeeeeeeeeerrrrrrrrrrr OUT !!!!
-                    if ($show_all_notices) {
-                        EE_Error::add_error(
-                            sprintf(
-                                __(
-                                    'Sorry! %s is a default session datum and can not be reset.',
-                                    'event_espresso'
-                                ),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                    $return_value = false;
-                }
-            } elseif ($show_all_notices) {
-                // oops! that session var does not exist!
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The session item provided, %s, is invalid or does not exist.',
-                            'event_espresso'
-                        ),
-                        $reset
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $return_value = false;
-            }
-        } // end of foreach
-        return $return_value;
-    }
-
-
-    /**
-     *   wp_loaded
-     *
-     * @access public
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function wp_loaded()
-    {
-        if ($this->request->requestParamIsSet('clear_session')) {
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-    }
-
-
-    /**
-     * Used to reset the entire object (for tests).
-     *
-     * @since 4.3.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function reset_instance()
-    {
-        $this->clear_session();
-        self::$_instance = null;
-    }
-
-
-    public function configure_garbage_collection_filters()
-    {
-        // run old filter we had for controlling session cleanup
-        $expired_session_transient_delete_query_limit = absint(
-            apply_filters(
-                'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                50
-            )
-        );
-        // is there a value? or one that is different than the default 50 records?
-        if ($expired_session_transient_delete_query_limit === 0) {
-            // hook into TransientCacheStorage in case Session cleanup was turned off
-            add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
-        } elseif ($expired_session_transient_delete_query_limit !== 50) {
-            // or use that for the new transient cleanup query limit
-            add_filter(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
-                    return $expired_session_transient_delete_query_limit;
-                }
-            );
-        }
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
-     * @param $data1
-     * @return string
-     */
-    private function find_serialize_error($data1)
-    {
-        $error = '<pre>';
-        $data2 = preg_replace_callback(
-            '!s:(\d+):"(.*?)";!',
-            function ($match) {
-                return ($match[1] === strlen($match[2]))
-                    ? $match[0]
-                    : 's:'
-                      . strlen($match[2])
-                      . ':"'
-                      . $match[2]
-                      . '";';
-            },
-            $data1
-        );
-        $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
-        for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error .= "\t-> Line Number = $i" . PHP_EOL;
-                $start = ($i - 20);
-                $start = ($start < 0) ? 0 : $start;
-                $length = 40;
-                $point = $max - $i;
-                if ($point < 20) {
-                    $rlength = 1;
-                    $rpoint = -$point;
-                } else {
-                    $rpoint = $length - 20;
-                    $rlength = 1;
-                }
-                $error .= "\t-> Section Data1  = ";
-                $error .= substr_replace(
-                    substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-                $error .= "\t-> Section Data2  = ";
-                $error .= substr_replace(
-                    substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-            }
-        }
-        $error .= '</pre>';
-        return $error;
-    }
-
-
-    /**
-     * Saves an  array of settings used for configuring aspects of session behaviour
-     *
-     * @param array $updated_settings
-     */
-    private function updateSessionSettings(array $updated_settings = array())
-    {
-        // add existing settings, but only if not included in incoming $updated_settings array
-        $updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
-    }
-
-
-    /**
-     * garbage_collection
-     */
-    public function garbageCollection()
-    {
-        // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
-            $this->_last_gc = time();
-            $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
-            /** @type WPDB $wpdb */
-            global $wpdb;
-            // filter the query limit. Set to 0 to turn off garbage collection
-            $expired_session_transient_delete_query_limit = absint(
-                apply_filters(
-                    'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                    50
-                )
-            );
-            // non-zero LIMIT means take out the trash
-            if ($expired_session_transient_delete_query_limit) {
-                $session_key = str_replace('_', '\_', EE_Session::session_id_prefix);
-                $hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
-                // since transient expiration timestamps are set in the future, we can compare against NOW
-                // but we only want to pick up any trash that's been around for more than a day
-                $expiration = time() - DAY_IN_SECONDS;
-                $SQL = "
+		do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+		$this->reset_cart();
+		$this->reset_checkout();
+		$this->reset_transaction();
+		// wipe out everything that isn't a default session datum
+		$this->reset_data(array_keys($this->_session_data));
+		// reset initial site access time and the session expiration
+		$this->_set_init_access_and_expiration();
+		$this->_save_session_to_db(true);
+	}
+
+
+	/**
+	 * resets all non-default session vars. Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array|mixed $data_to_reset
+	 * @param bool        $show_all_notices
+	 * @return bool
+	 */
+	public function reset_data($data_to_reset = array(), $show_all_notices = false)
+	{
+		// if $data_to_reset is not in an array, then put it in one
+		if (! is_array($data_to_reset)) {
+			$data_to_reset = array($data_to_reset);
+		}
+		// nothing ??? go home!
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(
+				__(
+					'No session data could be reset, because no session var name was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$return_value = true;
+		// since $data_to_reset is an array, cycle through the values
+		foreach ($data_to_reset as $reset) {
+			// first check to make sure it is a valid session var
+			if (isset($this->_session_data[ $reset ])) {
+				// then check to make sure it is not a default var
+				if (! array_key_exists($reset, $this->_default_session_vars)) {
+					// remove session var
+					unset($this->_session_data[ $reset ]);
+					if ($show_all_notices) {
+						EE_Error::add_success(
+							sprintf(
+								__('The session variable %s was removed.', 'event_espresso'),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				} else {
+					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
+					if ($show_all_notices) {
+						EE_Error::add_error(
+							sprintf(
+								__(
+									'Sorry! %s is a default session datum and can not be reset.',
+									'event_espresso'
+								),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+					$return_value = false;
+				}
+			} elseif ($show_all_notices) {
+				// oops! that session var does not exist!
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The session item provided, %s, is invalid or does not exist.',
+							'event_espresso'
+						),
+						$reset
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$return_value = false;
+			}
+		} // end of foreach
+		return $return_value;
+	}
+
+
+	/**
+	 *   wp_loaded
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function wp_loaded()
+	{
+		if ($this->request->requestParamIsSet('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+	}
+
+
+	/**
+	 * Used to reset the entire object (for tests).
+	 *
+	 * @since 4.3.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function reset_instance()
+	{
+		$this->clear_session();
+		self::$_instance = null;
+	}
+
+
+	public function configure_garbage_collection_filters()
+	{
+		// run old filter we had for controlling session cleanup
+		$expired_session_transient_delete_query_limit = absint(
+			apply_filters(
+				'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+				50
+			)
+		);
+		// is there a value? or one that is different than the default 50 records?
+		if ($expired_session_transient_delete_query_limit === 0) {
+			// hook into TransientCacheStorage in case Session cleanup was turned off
+			add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
+		} elseif ($expired_session_transient_delete_query_limit !== 50) {
+			// or use that for the new transient cleanup query limit
+			add_filter(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				function () use ($expired_session_transient_delete_query_limit) {
+					return $expired_session_transient_delete_query_limit;
+				}
+			);
+		}
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
+	 * @param $data1
+	 * @return string
+	 */
+	private function find_serialize_error($data1)
+	{
+		$error = '<pre>';
+		$data2 = preg_replace_callback(
+			'!s:(\d+):"(.*?)";!',
+			function ($match) {
+				return ($match[1] === strlen($match[2]))
+					? $match[0]
+					: 's:'
+					  . strlen($match[2])
+					  . ':"'
+					  . $match[2]
+					  . '";';
+			},
+			$data1
+		);
+		$max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+		$error .= $data1 . PHP_EOL;
+		$error .= $data2 . PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[ $i ] !== @$data2[ $i ]) {
+				$error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
+				$error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
+				$error .= "\t-> Line Number = $i" . PHP_EOL;
+				$start = ($i - 20);
+				$start = ($start < 0) ? 0 : $start;
+				$length = 40;
+				$point = $max - $i;
+				if ($point < 20) {
+					$rlength = 1;
+					$rpoint = -$point;
+				} else {
+					$rpoint = $length - 20;
+					$rlength = 1;
+				}
+				$error .= "\t-> Section Data1  = ";
+				$error .= substr_replace(
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+				$error .= "\t-> Section Data2  = ";
+				$error .= substr_replace(
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+			}
+		}
+		$error .= '</pre>';
+		return $error;
+	}
+
+
+	/**
+	 * Saves an  array of settings used for configuring aspects of session behaviour
+	 *
+	 * @param array $updated_settings
+	 */
+	private function updateSessionSettings(array $updated_settings = array())
+	{
+		// add existing settings, but only if not included in incoming $updated_settings array
+		$updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
+	}
+
+
+	/**
+	 * garbage_collection
+	 */
+	public function garbageCollection()
+	{
+		// only perform during regular requests if last garbage collection was over an hour ago
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+			$this->_last_gc = time();
+			$this->updateSessionSettings(array('last_gc' => $this->_last_gc));
+			/** @type WPDB $wpdb */
+			global $wpdb;
+			// filter the query limit. Set to 0 to turn off garbage collection
+			$expired_session_transient_delete_query_limit = absint(
+				apply_filters(
+					'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+					50
+				)
+			);
+			// non-zero LIMIT means take out the trash
+			if ($expired_session_transient_delete_query_limit) {
+				$session_key = str_replace('_', '\_', EE_Session::session_id_prefix);
+				$hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
+				// since transient expiration timestamps are set in the future, we can compare against NOW
+				// but we only want to pick up any trash that's been around for more than a day
+				$expiration = time() - DAY_IN_SECONDS;
+				$SQL = "
                     SELECT option_name
                     FROM {$wpdb->options}
                     WHERE
@@ -1286,17 +1286,17 @@ 
                     AND option_value < {$expiration}
                     LIMIT {$expired_session_transient_delete_query_limit}
                 ";
-                // produces something like:
-                // SELECT option_name FROM wp_options
-                // WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
-                // OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
-                // AND option_value < 1508368198 LIMIT 50
-                $expired_sessions = $wpdb->get_col($SQL);
-                // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
-                    $this->cache_storage->deleteMany($expired_sessions, true);
-                }
-            }
-        }
-    }
+				// produces something like:
+				// SELECT option_name FROM wp_options
+				// WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
+				// OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
+				// AND option_value < 1508368198 LIMIT 50
+				$expired_sessions = $wpdb->get_col($SQL);
+				// valid results?
+				if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+					$this->cache_storage->deleteMany($expired_sessions, true);
+				}
+			}
+		}
+	}
 }

Spacing +55 added lines, -55 removed lines

@@ -193,7 +193,7 @@ 
         // check if class object is instantiated
         // session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
         // add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
             self::$_instance = new self(
                 $cache_storage,
                 $lifespan,
@@ -229,22 +229,22 @@ 
         // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
         // (which currently fires on the init hook at priority 9),
         // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! apply_filters('FHEE_load_EE_Session', true)) {
             return;
         }
         $this->session_start_handler = $session_start_handler;
         $this->session_lifespan = $lifespan;
         $this->request = $request;
-        if (! defined('ESPRESSO_SESSION')) {
+        if ( ! defined('ESPRESSO_SESSION')) {
             define('ESPRESSO_SESSION', true);
         }
         // retrieve session options from db
         $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
+        if ( ! empty($session_settings)) {
             // cycle though existing session options
             foreach ($session_settings as $var_name => $session_setting) {
                 // set values for class properties
-                $var_name = '_' . $var_name;
+                $var_name = '_'.$var_name;
                 $this->{$var_name} = $session_setting;
             }
         }
@@ -303,7 +303,7 @@ 
     public function open_session()
     {
         // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
+        if ( ! $this->_espresso_session()) {
             // or just start a new one
             $this->_create_espresso_session();
         }
@@ -376,9 +376,9 @@ 
         // set some defaults
         foreach ($this->_default_session_vars as $key => $default_var) {
             if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
+                $this->_session_data[$key] = array();
             } else {
-                $this->_session_data[ $key ] = '';
+                $this->_session_data[$key] = '';
             }
         }
     }
@@ -509,8 +509,8 @@ 
             $this->reset_checkout();
             $this->reset_transaction();
         }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+        if ( ! empty($key)) {
+            return isset($this->_session_data[$key]) ? $this->_session_data[$key] : null;
         }
         return $this->_session_data;
     }
@@ -538,7 +538,7 @@ 
             return false;
         }
         foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
+            if (isset($this->_default_session_vars[$key])) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -553,7 +553,7 @@ 
                 );
                 return false;
             }
-            $this->_session_data[ $key ] = $value;
+            $this->_session_data[$key] = $value;
         }
         return true;
     }
@@ -582,7 +582,7 @@ 
         $this->_user_agent = $this->request->userAgent();
         // now let's retrieve what's in the db
         $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
+        if ( ! empty($session_data)) {
             // get the current time in UTC
             $this->_time = $this->_time !== null ? $this->_time : time();
             // and reset the session expiration
@@ -593,7 +593,7 @@ 
             // set initial site access time and the session expiration
             $this->_set_init_access_and_expiration();
             // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = isset($_SERVER['HTTP_REFERER'])
+            $this->_session_data['pages_visited'][$this->_session_data['init_access']] = isset($_SERVER['HTTP_REFERER'])
                 ? esc_attr($_SERVER['HTTP_REFERER'])
                 : '';
             // no previous session = go back and create one (on top of the data above)
@@ -630,7 +630,7 @@ 
      */
     protected function _retrieve_session_data()
     {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+        $ssn_key = EE_Session::session_id_prefix.$this->_sid;
         try {
             // we're using WP's Transient API to store session data using the PHP session ID as the option name
             $session_data = $this->cache_storage->get($ssn_key, false);
@@ -639,7 +639,7 @@ 
             }
             if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
                 $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
+                    EE_Session::hash_check_prefix.$this->_sid,
                     false
                 );
                 if ($hash_check && $hash_check !== md5($session_data)) {
@@ -649,7 +649,7 @@ 
                                 'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
                                 'event_espresso'
                             ),
-                            EE_Session::session_id_prefix . $this->_sid
+                            EE_Session::session_id_prefix.$this->_sid
                         ),
                         __FILE__,
                         __FUNCTION__,
@@ -663,17 +663,17 @@ 
             $row = $wpdb->get_row(
                 $wpdb->prepare(
                     "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
+                    '_transient_'.$ssn_key
                 )
             );
             $session_data = is_object($row) ? $row->option_value : null;
             if ($session_data) {
                 $session_data = preg_replace_callback(
                     '!s:(d+):"(.*?)";!',
-                    function ($match) {
+                    function($match) {
                         return $match[1] === strlen($match[2])
                             ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                            : 's:'.strlen($match[2]).':"'.$match[2].'";';
                     },
                     $session_data
                 );
@@ -684,7 +684,7 @@ 
         $session_data = $this->encryption instanceof EE_Encryption
             ? $this->encryption->base64_string_decode($session_data)
             : $session_data;
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             try {
                 $session_data = maybe_unserialize($session_data);
             } catch (Exception $e) {
@@ -698,21 +698,21 @@ 
                       . '</pre><br>'
                       . $this->find_serialize_error($session_data)
                     : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+                $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
                 throw new InvalidSessionDataException($msg, 0, $e);
             }
         }
         // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             // no?!?! then something is wrong
             $msg = esc_html__(
                 'The session data is missing, invalid, or corrupted.',
                 'event_espresso'
             );
             $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                 : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+            $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
             throw new InvalidSessionDataException($msg);
         }
         if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
@@ -739,7 +739,7 @@ 
         if (isset($_REQUEST['EESID'])) {
             $session_id = sanitize_text_field($_REQUEST['EESID']);
         } else {
-            $session_id = md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+            $session_id = md5(session_id().get_current_blog_id().$this->_get_sid_salt());
         }
         return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
     }
@@ -842,19 +842,19 @@ 
                     $page_visit = $this->_get_page_visit();
                     if ($page_visit) {
                         // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+                        $this->_session_data['pages_visited'][$this->_time] = $page_visit;
                         // we'll only save the last 10 page visits.
                         $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
                     }
                     break;
                 default:
                     // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
+                    $session_data[$key] = $this->_session_data[$key];
             }
         }
         $this->_session_data = $session_data;
         // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
+        if ( ! $new_session) {
             // ready? let's save
             if ($this->_save_session_to_db()) {
                 return true;
@@ -895,8 +895,8 @@ 
                 isset($this->_session_data['ee_notices'])
                 && (
                     ! empty($this->_session_data['ee_notices']['attention'])
-                    || !empty($this->_session_data['ee_notices']['errors'])
-                    || !empty($this->_session_data['ee_notices']['success'])
+                    || ! empty($this->_session_data['ee_notices']['errors'])
+                    || ! empty($this->_session_data['ee_notices']['success'])
                 )
             );
     }
@@ -925,7 +925,7 @@ 
         }
         $transaction = $this->transaction();
         if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
+            if ( ! $transaction->ID()) {
                 $transaction->save();
             }
             $this->_session_data['transaction'] = $transaction->ID();
@@ -939,14 +939,14 @@ 
         // maybe save hash check
         if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
             $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
+                EE_Session::hash_check_prefix.$this->_sid,
                 md5($session_data),
                 $this->session_lifespan->inSeconds()
             );
         }
         // we're using the Transient API for storing session data,
         return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->session_lifespan->inSeconds()
         );
@@ -960,7 +960,7 @@ 
      */
     public function _get_page_visit()
     {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+        $page_visit = home_url('/').'wp-admin/admin-ajax.php';
         // check for request url
         if (isset($_SERVER['REQUEST_URI'])) {
             $http_host = '';
@@ -976,14 +976,14 @@ 
             // check for page_id in SERVER REQUEST
             if (isset($_REQUEST['page_id'])) {
                 // rebuild $e_reg without any of the extra parameters
-                $page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
+                $page_id = '?page_id='.esc_attr($_REQUEST['page_id']).'&amp;';
             }
             // check for $e_reg in SERVER REQUEST
             if (isset($_REQUEST['ee'])) {
                 // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
+                $e_reg = 'ee='.esc_attr($_REQUEST['ee']);
             }
-            $page_visit = rtrim($http_host . $request_uri . $page_id . $e_reg, '?');
+            $page_visit = rtrim($http_host.$request_uri.$page_id.$e_reg, '?');
         }
         return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
     }
@@ -1021,7 +1021,7 @@ 
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
         $this->reset_cart();
         $this->reset_checkout();
         $this->reset_transaction();
@@ -1043,7 +1043,7 @@ 
     public function reset_data($data_to_reset = array(), $show_all_notices = false)
     {
         // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
+        if ( ! is_array($data_to_reset)) {
             $data_to_reset = array($data_to_reset);
         }
         // nothing ??? go home!
@@ -1063,11 +1063,11 @@ 
         // since $data_to_reset is an array, cycle through the values
         foreach ($data_to_reset as $reset) {
             // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
+            if (isset($this->_session_data[$reset])) {
                 // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
+                if ( ! array_key_exists($reset, $this->_default_session_vars)) {
                     // remove session var
-                    unset($this->_session_data[ $reset ]);
+                    unset($this->_session_data[$reset]);
                     if ($show_all_notices) {
                         EE_Error::add_success(
                             sprintf(
@@ -1168,7 +1168,7 @@ 
             // or use that for the new transient cleanup query limit
             add_filter(
                 'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
+                function() use ($expired_session_transient_delete_query_limit) {
                     return $expired_session_transient_delete_query_limit;
                 }
             );
@@ -1186,7 +1186,7 @@ 
         $error = '<pre>';
         $data2 = preg_replace_callback(
             '!s:(\d+):"(.*?)";!',
-            function ($match) {
+            function($match) {
                 return ($match[1] === strlen($match[2]))
                     ? $match[0]
                     : 's:'
@@ -1198,13 +1198,13 @@ 
             $data1
         );
         $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
+        $error .= $data1.PHP_EOL;
+        $error .= $data2.PHP_EOL;
         for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error .= "\t-> Line Number = $i" . PHP_EOL;
+            if (@$data1[$i] !== @$data2[$i]) {
+                $error .= 'Difference '.@$data1[$i].' != '.@$data2[$i].PHP_EOL;
+                $error .= "\t-> ORD number ".ord(@$data1[$i]).' != '.ord(@$data2[$i]).PHP_EOL;
+                $error .= "\t-> Line Number = $i".PHP_EOL;
                 $start = ($i - 20);
                 $start = ($start < 0) ? 0 : $start;
                 $length = 40;
@@ -1219,7 +1219,7 @@ 
                 $error .= "\t-> Section Data1  = ";
                 $error .= substr_replace(
                     substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
+                    "<b style=\"color:green\">{$data1[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1227,7 +1227,7 @@ 
                 $error .= "\t-> Section Data2  = ";
                 $error .= substr_replace(
                     substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
+                    "<b style=\"color:red\">{$data2[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1258,7 +1258,7 @@ 
     public function garbageCollection()
     {
         // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
             $this->_last_gc = time();
             $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
             /** @type WPDB $wpdb */
@@ -1293,7 +1293,7 @@ 
                 // AND option_value < 1508368198 LIMIT 50
                 $expired_sessions = $wpdb->get_col($SQL);
                 // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+                if ( ! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
                     $this->cache_storage->deleteMany($expired_sessions, true);
                 }
             }

core/services/session/SessionStartHandler.php

Indentation +216 added lines, -216 removed lines

@@ -27,234 +27,234 @@
  */
 class SessionStartHandler
 {
-    const OPTION_NAME_SESSION_SAVE_HANDLER_STATUS = 'ee_session_save_handler_status';
-    const REQUEST_PARAM_RETRY_SESSION = 'ee_retry_session';
-    const SESSION_SAVE_HANDLER_STATUS_FAILED = 'session_save_handler_failed';
-    const SESSION_SAVE_HANDLER_STATUS_SUCCESS = 'session_save_handler_success';
-    const SESSION_SAVE_HANDLER_STATUS_UNKNOWN = 'session_save_handler_untested';
+	const OPTION_NAME_SESSION_SAVE_HANDLER_STATUS = 'ee_session_save_handler_status';
+	const REQUEST_PARAM_RETRY_SESSION = 'ee_retry_session';
+	const SESSION_SAVE_HANDLER_STATUS_FAILED = 'session_save_handler_failed';
+	const SESSION_SAVE_HANDLER_STATUS_SUCCESS = 'session_save_handler_success';
+	const SESSION_SAVE_HANDLER_STATUS_UNKNOWN = 'session_save_handler_untested';
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
-    /**
-     * StartSession constructor.
-     *
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * StartSession constructor.
+	 *
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
 
-    /**
-     * Check if a custom session save handler is in play
-     * and attempt to start the PHP session
-     *
-     * @since $VID:$
-     */
-    public function startSession()
-    {
-        // check that session has started
-        if (session_id() === '') {
-            // starts a new session if one doesn't already exist, or re-initiates an existing one
-            if ($this->hasKnownCustomSessionSaveHandler()) {
-                $this->checkCustomSessionSaveHandler();
-            } else {
-                session_start();
-            }
-        }
-    }
+	/**
+	 * Check if a custom session save handler is in play
+	 * and attempt to start the PHP session
+	 *
+	 * @since $VID:$
+	 */
+	public function startSession()
+	{
+		// check that session has started
+		if (session_id() === '') {
+			// starts a new session if one doesn't already exist, or re-initiates an existing one
+			if ($this->hasKnownCustomSessionSaveHandler()) {
+				$this->checkCustomSessionSaveHandler();
+			} else {
+				session_start();
+			}
+		}
+	}
 
-    /**
-     * Returns `true` if the 'session.save_handler' ini setting matches a known custom handler
-     *
-     * @since $VID:$
-     * @return bool
-     */
-    private function hasKnownCustomSessionSaveHandler()
-    {
-        return in_array(
-            ini_get('session.save_handler'),
-            array(
-                'user',
-            ),
-            true
-        );
-    }
+	/**
+	 * Returns `true` if the 'session.save_handler' ini setting matches a known custom handler
+	 *
+	 * @since $VID:$
+	 * @return bool
+	 */
+	private function hasKnownCustomSessionSaveHandler()
+	{
+		return in_array(
+			ini_get('session.save_handler'),
+			array(
+				'user',
+			),
+			true
+		);
+	}
 
-    /**
-     * Attempt to start the PHP session when a custom Session Save Handler is known to be set.
-     *
-     * @since $VID:$
-     */
-    private function checkCustomSessionSaveHandler()
-    {
-        // If we've already successfully tested the session save handler
-        // on a previous request then just start the session
-        if ($this->sessionSaveHandlerIsValid()) {
-            session_start();
-            return;
-        }
-        // If not, then attempt to deal with any errors,
-        // otherwise, try to hobble along without the session
-        if (! $this->handleSessionSaveHandlerErrors()) {
-            return;
-        }
-        // there is no record of a fatal error while trying to start the session
-        // so let's see if there's a custom session save handler. Proceed with caution
-        $this->initializeSessionSaveHandlerStatus();
-        // hold your breath, the custom session save handler might cause a fatal here...
-        session_start();
-        // phew! we made it! the custom session handler is a-ok
-        $this->setSessionSaveHandlerStatusToValid();
-    }
+	/**
+	 * Attempt to start the PHP session when a custom Session Save Handler is known to be set.
+	 *
+	 * @since $VID:$
+	 */
+	private function checkCustomSessionSaveHandler()
+	{
+		// If we've already successfully tested the session save handler
+		// on a previous request then just start the session
+		if ($this->sessionSaveHandlerIsValid()) {
+			session_start();
+			return;
+		}
+		// If not, then attempt to deal with any errors,
+		// otherwise, try to hobble along without the session
+		if (! $this->handleSessionSaveHandlerErrors()) {
+			return;
+		}
+		// there is no record of a fatal error while trying to start the session
+		// so let's see if there's a custom session save handler. Proceed with caution
+		$this->initializeSessionSaveHandlerStatus();
+		// hold your breath, the custom session save handler might cause a fatal here...
+		session_start();
+		// phew! we made it! the custom session handler is a-ok
+		$this->setSessionSaveHandlerStatusToValid();
+	}
 
 
-    /**
-     * retrieves the value for the 'ee_session_save_handler_status' WP option.
-     * default value = 'session_save_handler_untested'
-     *
-     * @since $VID:$
-     * @return string
-     */
-    private function getSessionSaveHandlerStatus()
-    {
-        return get_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
-        );
-    }
+	/**
+	 * retrieves the value for the 'ee_session_save_handler_status' WP option.
+	 * default value = 'session_save_handler_untested'
+	 *
+	 * @since $VID:$
+	 * @return string
+	 */
+	private function getSessionSaveHandlerStatus()
+	{
+		return get_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
+		);
+	}
 
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_failed'
-     * which can then be upgraded is everything works correctly
-     *
-     * @since $VID:$
-     * @return bool
-     */
-    private function initializeSessionSaveHandlerStatus()
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED
-        );
-    }
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_failed'
+	 * which can then be upgraded is everything works correctly
+	 *
+	 * @since $VID:$
+	 * @return bool
+	 */
+	private function initializeSessionSaveHandlerStatus()
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED
+		);
+	}
 
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_success'
-     *
-     * @since $VID:$
-     * @return bool
-     */
-    private function setSessionSaveHandlerStatusToValid()
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS
-        );
-    }
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_success'
+	 *
+	 * @since $VID:$
+	 * @return bool
+	 */
+	private function setSessionSaveHandlerStatusToValid()
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS
+		);
+	}
 
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_untested'
-     *
-     * @since $VID:$
-     * @return bool
-     */
-    private function resetSessionSaveHandlerStatus()
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
-        );
-    }
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_untested'
+	 *
+	 * @since $VID:$
+	 * @return bool
+	 */
+	private function resetSessionSaveHandlerStatus()
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
+		);
+	}
 
-    /**
-     * Returns `true` if the 'ee_session_save_handler_status' WP option value
-     * is equal to 'session_save_handler_success'
-     *
-     * @since $VID:$
-     * @return bool
-     */
-    private function sessionSaveHandlerIsValid()
-    {
-        return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS;
-    }
+	/**
+	 * Returns `true` if the 'ee_session_save_handler_status' WP option value
+	 * is equal to 'session_save_handler_success'
+	 *
+	 * @since $VID:$
+	 * @return bool
+	 */
+	private function sessionSaveHandlerIsValid()
+	{
+		return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS;
+	}
 
-    /**
-     * Returns `true` if the 'ee_session_save_handler_status' WP option value
-     * is equal to 'session_save_handler_failed'
-     *
-     * @since $VID:$
-     * @return bool
-     */
-    private function sessionSaveHandlerFailed()
-    {
-        return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED;
-    }
+	/**
+	 * Returns `true` if the 'ee_session_save_handler_status' WP option value
+	 * is equal to 'session_save_handler_failed'
+	 *
+	 * @since $VID:$
+	 * @return bool
+	 */
+	private function sessionSaveHandlerFailed()
+	{
+		return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED;
+	}
 
-    /**
-     * Returns `true` if no errors were detected with the session save handler,
-     * otherwise attempts to work notify the appropriate authorities
-     * with a suggestion for how to fix the issue, and returns `false`.
-     *
-     *
-     * @since $VID:$
-     * @return bool
-     */
-    private function handleSessionSaveHandlerErrors()
-    {
-        // Check if we had a fatal error last time while trying to start the session
-        if ($this->sessionSaveHandlerFailed()) {
-            // apparently, last time we tried using the custom session save handler there was a fatal
-            if ($this->request->requestParamIsSet(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION)) {
-                $this->resetSessionSaveHandlerStatus();
-                // remove "ee_retry_session", otherwise if the problem still isn't fixed,
-                // we'll just keep getting the fatal error over and over.
-                // Better to remove it and redirect, and try on the next request
-                EEH_URL::safeRedirectAndExit(
-                    remove_query_arg(
-                        array(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION),
-                        EEH_URL::current_url()
-                    )
-                );
-            }
-            // so the session is broken, don't try it again,
-            // just show a message to users that can fix it
-            $this->displaySessionSaveHandlerErrorNotice();
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * Returns `true` if no errors were detected with the session save handler,
+	 * otherwise attempts to work notify the appropriate authorities
+	 * with a suggestion for how to fix the issue, and returns `false`.
+	 *
+	 *
+	 * @since $VID:$
+	 * @return bool
+	 */
+	private function handleSessionSaveHandlerErrors()
+	{
+		// Check if we had a fatal error last time while trying to start the session
+		if ($this->sessionSaveHandlerFailed()) {
+			// apparently, last time we tried using the custom session save handler there was a fatal
+			if ($this->request->requestParamIsSet(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION)) {
+				$this->resetSessionSaveHandlerStatus();
+				// remove "ee_retry_session", otherwise if the problem still isn't fixed,
+				// we'll just keep getting the fatal error over and over.
+				// Better to remove it and redirect, and try on the next request
+				EEH_URL::safeRedirectAndExit(
+					remove_query_arg(
+						array(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION),
+						EEH_URL::current_url()
+					)
+				);
+			}
+			// so the session is broken, don't try it again,
+			// just show a message to users that can fix it
+			$this->displaySessionSaveHandlerErrorNotice();
+			return false;
+		}
+		return true;
+	}
 
-    /**
-     * Generates an EE_Error notice regarding the current session woes
-     * but only if the current user is an admin with permission to 'install_plugins'.
-     *
-     * @since $VID:$
-     */
-    private function displaySessionSaveHandlerErrorNotice()
-    {
-        if (current_user_can('install_plugins')) {
-            $retry_session_url = add_query_arg(
-                array(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION => true),
-                EEH_URL::current_url()
-            );
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'It appears there was a fatal error while starting the session, so Event Espresso is not able to process registrations normally. Some hosting companies, like Pantheon, require an extra plugin for Event Espresso to work. Please install the %1$sWordPress Native PHP Sessions plugin%2$s, then %3$sclick here to check if the problem is resolved.%2$s',
-                        'event_espresso'
-                    ),
-                    '<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
-                    '</a>',
-                    '<a href="' . $retry_session_url . '">'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
+	/**
+	 * Generates an EE_Error notice regarding the current session woes
+	 * but only if the current user is an admin with permission to 'install_plugins'.
+	 *
+	 * @since $VID:$
+	 */
+	private function displaySessionSaveHandlerErrorNotice()
+	{
+		if (current_user_can('install_plugins')) {
+			$retry_session_url = add_query_arg(
+				array(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION => true),
+				EEH_URL::current_url()
+			);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'It appears there was a fatal error while starting the session, so Event Espresso is not able to process registrations normally. Some hosting companies, like Pantheon, require an extra plugin for Event Espresso to work. Please install the %1$sWordPress Native PHP Sessions plugin%2$s, then %3$sclick here to check if the problem is resolved.%2$s',
+						'event_espresso'
+					),
+					'<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
+					'</a>',
+					'<a href="' . $retry_session_url . '">'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -99,7 +99,7 @@ 
         }
         // If not, then attempt to deal with any errors,
         // otherwise, try to hobble along without the session
-        if (! $this->handleSessionSaveHandlerErrors()) {
+        if ( ! $this->handleSessionSaveHandlerErrors()) {
             return;
         }
         // there is no record of a fatal error while trying to start the session
@@ -249,7 +249,7 @@ 
                     ),
                     '<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
                     '</a>',
-                    '<a href="' . $retry_session_url . '">'
+                    '<a href="'.$retry_session_url.'">'
                 ),
                 __FILE__,
                 __FUNCTION__,

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/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}")