File: /home/d5123/myboofola_com/wp-content/plugins/classified-listing/app/Controllers/SessionHandler.php
<?php
namespace Rtcl\Controllers;
use Rtcl\Helpers\Cache;
use Rtcl\Abstracts\Session;
use Rtcl\Helpers\Functions;
class SessionHandler extends Session {
/**
* Cookie name used for the session.
*
* @var string cookie name
*/
protected $_cookie;
/**
* Stores session expiry.
*
* @var string session due to expire timestamp
*/
protected $_session_expiring;
/**
* Stores session due to expire timestamp.
*
* @var string session expiration timestamp
*/
protected $_session_expiration;
/**
* True when the cookie exists.
*
* @var bool Based on whether a cookie exists.
*/
protected $_has_cookie = false;
/**
* Table name for session data.
*
* @var string Custom session table name
*/
protected $_table;
/**
* Constructor for the session class.
*/
public function __construct() {
$this->_cookie = apply_filters( 'rtcl_cookie', 'wp_rtcl_session_' . COOKIEHASH );
$this->_table = $GLOBALS['wpdb']->prefix . 'rtcl_sessions';
}
/**
* Init hooks and session data.
*
* @since 1.0.0
*/
public function init() {
$cookie = $this->get_session_cookie();
if ( $cookie ) {
$this->_customer_id = $cookie[0];
$this->_session_expiration = $cookie[1];
$this->_session_expiring = $cookie[2];
$this->_has_cookie = true;
$this->_data = $this->get_session_data();
// If the user logs in, update session.
if ( is_user_logged_in() && strval( get_current_user_id() ) !== $this->_customer_id ) {
$guest_session_id = $this->_customer_id;
$this->_customer_id = strval( get_current_user_id() );
$this->_dirty = true;
$this->save_data( $guest_session_id );
$this->set_customer_session_cookie( true );
}
// Update session if its close to expiring.
if ( time() > $this->_session_expiring ) {
$this->set_session_expiration();
$this->update_session_timestamp( $this->_customer_id, $this->_session_expiration );
}
} else {
$this->set_session_expiration();
$this->_customer_id = $this->generate_customer_id();
$this->_data = $this->get_session_data();
if ( ! is_user_logged_in() && apply_filters('wp_rtcl_session_allow_guest_user', true)) {
$this->set_customer_session_cookie( true );
}
}
//add_action( 'rtcl_set_cart_cookies', array( $this, 'set_customer_session_cookie' ), 10 ); // TODO :
add_action( 'shutdown', [ $this, 'save_data' ], 20 );
add_action( 'wp_logout', [ $this, 'destroy_session' ] );
if ( ! is_user_logged_in() ) {
add_filter( 'nonce_user_logged_out', [ $this, 'nonce_user_logged_out' ] );
}
}
/**
* Sets the session cookie on-demand (usually after adding an item to the cart).
*
* Warning: Cookies will only be set if this is called before the headers are sent.
*
* @param bool $set Should the session cookie be set.
*/
public function set_customer_session_cookie( $set ) {
if ( $set ) {
$to_hash = $this->_customer_id . '|' . $this->_session_expiration;
$cookie_hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
$cookie_value = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash;
$this->_has_cookie = true;
Functions::setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, apply_filters( 'rtcl_session_use_secure_cookie', false ) );
}
}
/**
* Return true if the current user has an active session, i.e. a cookie to retrieve values.
*
* @return bool
*/
public function has_session() {
return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine.
}
/**
* Set session expiration.
*/
public function set_session_expiration() {
$this->_session_expiring = time() + intval( apply_filters( 'rtcl_session_expiring', 60 * 60 * 47 ) ); // 47 Hours.
$this->_session_expiration = time() + intval( apply_filters( 'rtcl_session_expiration', 60 * 60 * 48 ) ); // 48 Hours.
}
/**
* Generate a unique customer ID for guests, or return user ID if logged in.
*
* Uses Portable PHP password hashing framework to generate a unique cryptographically strong ID.
*
* @return string
*/
public function generate_customer_id() {
$customer_id = '';
if ( is_user_logged_in() ) {
$customer_id = get_current_user_id();
}
if ( empty( $customer_id ) ) {
require_once ABSPATH . 'wp-includes/class-phpass.php';
$hasher = new \PasswordHash( 8, false );
$customer_id = md5( $hasher->get_random_bytes( 32 ) );
}
return $customer_id;
}
/**
* Get the session cookie, if set. Otherwise return false.
*
* Session cookies without a customer ID are invalid.
*
* @return bool|array
*/
public function get_session_cookie() {
$cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine.
if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) {
return false;
}
list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value );
if ( empty( $customer_id ) ) {
return false;
}
// Validate hash.
$to_hash = $customer_id . '|' . $session_expiration;
$hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) {
return false;
}
return [ $customer_id, $session_expiration, $session_expiring, $cookie_hash ];
}
/**
* Get session data.
*
* @return array
*/
public function get_session_data() {
return $this->has_session() ? (array) $this->get_session( $this->_customer_id, [] ) : [];
}
/**
* Gets a cache prefix. This is used in session names so the entire cache can be invalidated with 1 function call.
*
* @return string
*/
private function get_cache_prefix() {
return Cache::get_cache_prefix( RTCL_SESSION_CACHE_GROUP );
}
/**
* Save data and delete guest session.
*
* @param int $old_session_key session ID before user logs in.
*/
public function save_data( $old_session_key = 0 ) {
// Dirty if something changed - prevents saving nothing new.
if ( $this->_dirty && $this->has_session() ) {
global $wpdb;
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
$wpdb->query(
$wpdb->prepare(
"INSERT INTO {$wpdb->prefix}rtcl_sessions (`session_key`, `session_value`, `session_expiry`) VALUES (%s, %s, %d)
ON DUPLICATE KEY UPDATE `session_value` = VALUES(`session_value`), `session_expiry` = VALUES(`session_expiry`)",
$this->_customer_id,
maybe_serialize( $this->_data ),
$this->_session_expiration
)
);
wp_cache_set( $this->get_cache_prefix() . $this->_customer_id, $this->_data, RTCL_SESSION_CACHE_GROUP, $this->_session_expiration - time() );
$this->_dirty = false;
if ( get_current_user_id() != $old_session_key && ! is_object( get_user_by( 'id', $old_session_key ) ) ) {
$this->delete_session( $old_session_key );
}
}
}
/**
* Destroy all session data.
*/
public function destroy_session() {
Functions::setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, apply_filters( 'rtcl_session_use_secure_cookie', false ) );
$this->delete_session( $this->_customer_id );
$this->_data = [];
$this->_dirty = false;
$this->_customer_id = $this->generate_customer_id();
}
/**
* When a user is logged out, ensure they have a unique nonce by using the customer/session ID.
*
* @param int $uid User ID.
*
* @return string
*/
public function nonce_user_logged_out( $uid ) {
return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid;
}
/**
* Cleanup session data from the database and clear caches.
*/
public function cleanup_sessions() {
global $wpdb;
$wpdb->query( $wpdb->prepare( "DELETE FROM $this->_table WHERE session_expiry < %d", time() ) ); // @codingStandardsIgnoreLine.
if ( class_exists( Cache::class ) ) {
Cache::invalidate_cache_group( RTCL_SESSION_CACHE_GROUP );
}
}
/**
* Returns the session.
*
* @param string $customer_id Custo ID.
* @param mixed $default Default session value.
*
* @return string|array
*/
public function get_session( $customer_id, $default = false ) {
global $wpdb;
if ( defined( 'WP_SETUP_CONFIG' ) ) {
return false;
}
// Try to get it from the cache, it will return false if not present or if object cache not in use.
$value = wp_cache_get( $this->get_cache_prefix() . $customer_id, RTCL_SESSION_CACHE_GROUP );
if ( false === $value ) {
$value = $wpdb->get_var( $wpdb->prepare( "SELECT session_value FROM $this->_table WHERE session_key = %s", $customer_id ) ); // @codingStandardsIgnoreLine.
if ( is_null( $value ) ) {
$value = $default;
}
wp_cache_add( $this->get_cache_prefix() . $customer_id, $value, RTCL_SESSION_CACHE_GROUP, $this->_session_expiration - time() );
}
return maybe_unserialize( $value );
}
/**
* Delete the session from the cache and database.
*
* @param int $customer_id Customer ID.
*/
public function delete_session( $customer_id ) {
global $wpdb;
wp_cache_delete( $this->get_cache_prefix() . $customer_id, RTCL_SESSION_CACHE_GROUP );
$wpdb->delete( // @codingStandardsIgnoreLine.
$this->_table,
[ 'session_key' => $customer_id, ]
);
}
/**
* Update the session expiry timestamp.
*
* @param string $customer_id Customer ID.
* @param int $timestamp Timestamp to expire the cookie.
*/
public function update_session_timestamp( $customer_id, $timestamp ) {
global $wpdb;
// @codingStandardsIgnoreStart.
$wpdb->update(
$this->_table,
[ 'session_expiry' => $timestamp, ],
[ 'session_key' => $customer_id, ],
[ '%d' ]
);
// @codingStandardsIgnoreEnd.
}
}