ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / lab2454c / carbonbullion.net / wp-content / plugins / woocommerce / includes

<?php
/**
 * Provide basic rate limiting functionality via WP Options API.
 *
 * Currently only provides a simple limit by delaying action by X seconds.
 *
 * Example usage:
 *
 * When an action runs, call set_rate_limit, e.g.:
 *
 * WC_Rate_Limiter::set_rate_limit( "{$my_action_name}_{$user_id}", $delay );
 *
 * This sets a timestamp for future timestamp after which action can run again.
 *
 *
 * Then before running the action again, check if the action is allowed to run, e.g.:
 *
 * if ( WC_Rate_Limiter::retried_too_soon( "{$my_action_name}_{$user_id}" ) ) {
 *     add_notice( 'Sorry, too soon!' );
 * }
 *
 * @package WooCommerce\Classes
 * @version 3.9.0
 * @since   3.9.0
 */

defined( 'ABSPATH' ) || exit;

/**
 * Rate limit class.
 */
class WC_Rate_Limiter {

/**
	 * Cache group.
	 */
	const CACHE_GROUP = 'wc_rate_limit';

/**
	 * Hook in methods.
	 */
	public static function init() {
		add_action( 'woocommerce_cleanup_rate_limits', array( __CLASS__, 'cleanup' ) );
	}

/**
	 * Constructs key name from action identifier.
	 * Left in for backwards compatibility.
	 *
	 * @param string $action_id Identifier of the action.
	 * @return string
	 */
	public static function storage_id( $action_id ) {
		return $action_id;
	}

/**
	 * Gets a cache prefix.
	 *
	 * @param string $action_id Identifier of the action.
	 * @return string
	 */
	protected static function get_cache_key( $action_id ) {
		return WC_Cache_Helper::get_cache_prefix( 'rate_limit' . $action_id );
	}

/**
	 * Retrieve a cached rate limit.
	 *
	 * @param string $action_id Identifier of the action.
	 * @return bool|int
	 */
	protected static function get_cached( $action_id ) {
		return wp_cache_get( self::get_cache_key( $action_id ), self::CACHE_GROUP );
	}

/**
	 * Cache a rate limit.
	 *
	 * @param string $action_id Identifier of the action.
	 * @param int    $expiry Timestamp when the limit expires.
	 * @return bool
	 */
	protected static function set_cache( $action_id, $expiry ) {
		return wp_cache_set( self::get_cache_key( $action_id ), $expiry, self::CACHE_GROUP );
	}

/**
	 * Returns true if the action is not allowed to be run by the rate limiter yet, false otherwise.
	 *
	 * @param string $action_id Identifier of the action.
	 * @return bool
	 */
	public static function retried_too_soon( $action_id ) {
		global $wpdb;

$next_try_allowed_at = self::get_cached( $action_id );

if ( false === $next_try_allowed_at ) {
			$next_try_allowed_at = $wpdb->get_var(
				$wpdb->prepare(
					"
						SELECT rate_limit_expiry
						FROM {$wpdb->prefix}wc_rate_limits
						WHERE rate_limit_key = %s
					",
					$action_id
				)
			);

self::set_cache( $action_id, $next_try_allowed_at );
		}

// No record of action running, so action is allowed to run.
		if ( null === $next_try_allowed_at ) {
			return false;
		}

// Before the next run is allowed, retry forbidden.
		if ( time() <= $next_try_allowed_at ) {
			return true;
		}

// After the next run is allowed, retry allowed.
		return false;
	}

/**
	 * Sets the rate limit delay in seconds for action with identifier $id.
	 *
	 * @param string $action_id Identifier of the action.
	 * @param int    $delay Delay in seconds.
	 * @return bool True if the option setting was successful, false otherwise.
	 */
	public static function set_rate_limit( $action_id, $delay ) {
		global $wpdb;

$next_try_allowed_at = time() + $delay;

$result = $wpdb->replace(
			$wpdb->prefix . 'wc_rate_limits',
			array(
				'rate_limit_key'    => $action_id,
				'rate_limit_expiry' => $next_try_allowed_at,
			),
			array( '%s', '%d' )
		);

self::set_cache( $action_id, $next_try_allowed_at );

return false !== $result;
	}

/**
	 * Cleanup expired rate limits from the database and clear caches.
	 */
	public static function cleanup() {
		global $wpdb;

$wpdb->query(
			$wpdb->prepare(
				"DELETE FROM {$wpdb->prefix}wc_rate_limits WHERE rate_limit_expiry < %d",
				time()
			)
		);

if ( class_exists( 'WC_Cache_Helper' ) ) {
			WC_Cache_Helper::invalidate_cache_group( self::CACHE_GROUP );
		}
	}
}

WC_Rate_Limiter::init();

[+] ..
[-] wc-page-functions.php [edit]
[-] class-wc-countries.php [edit]
[-] class-wc-ajax.php [edit]
[-] class-wc-privacy.php [edit]
[+] customizer
[+] gateways
[-] class-wc-order-refund.php [edit]
[-] wc-stock-functions.php [edit]
[-] class-wc-cart.php [edit]
[-] class-wc-tracker.php [edit]
[-] class-wc-frontend-scripts.php [edit]
[-] class-wc-product-download.php [edit]
[+] widgets
[+] admin
[-] class-wc-auth.php [edit]
[-] class-wc-rest-authentication.php [edit]
[-] class-wc-data-exception.php [edit]
[-] class-wc-log-levels.php [edit]
[-] wc-coupon-functions.php [edit]
[-] class-wc-order-item-shipping.php [edit]
[+] integrations
[-] class-wc-payment-gateways.php [edit]
[-] wc-order-functions.php [edit]
[+] shipping
[-] class-wc-order-item-coupon.php [edit]
[-] class-wc-payment-tokens.php [edit]
[-] wc-deprecated-functions.php [edit]
[-] class-wc-product-grouped.php [edit]
[+] tracks
[-] wc-product-functions.php [edit]
[-] class-wc-datetime.php [edit]
[-] wc-user-functions.php [edit]
[-] wc-widget-functions.php [edit]
[-] class-wc-breadcrumb.php [edit]
[-] class-wc-customer-download-log.php [edit]
[-] class-wc-order-query.php [edit]
[-] wc-template-hooks.php [edit]
[-] class-wc-https.php [edit]
[-] class-wc-order.php [edit]
[-] wc-attribute-functions.php [edit]
[-] class-wc-session-handler.php [edit]
[-] class-wc-product-variation.php [edit]
[-] class-wc-query.php [edit]
[-] class-wc-coupon.php [edit]
[-] class-wc-shipping-zone.php [edit]
[-] wc-account-functions.php [edit]
[-] wc-formatting-functions.php [edit]
[-] class-wc-integrations.php [edit]
[-] class-wc-validation.php [edit]
[-] class-wc-webhook.php [edit]
[+] traits
[-] class-wc-checkout.php [edit]
[-] wc-core-functions.php [edit]
[+] emails
[-] wc-cart-functions.php [edit]
[-] class-wc-shipping.php [edit]
[-] class-wc-customer-download.php [edit]
[-] class-wc-geolite-integration.php [edit]
[-] class-wc-data-store.php [edit]
[-] class-wc-order-item-tax.php [edit]
[-] class-wc-customer.php [edit]
[-] class-wc-product-attribute.php [edit]
[+] legacy
[+] import
[-] class-wc-cli.php [edit]
[+] wccom-site
[-] class-wc-form-handler.php [edit]
[-] class-wc-tax.php [edit]
[-] wc-order-item-functions.php [edit]
[+] blocks
[-] class-wc-cache-helper.php [edit]
[-] class-wc-cart-totals.php [edit]
[-] class-wc-emails.php [edit]
[-] class-wc-product-query.php [edit]
[-] class-wc-download-handler.php [edit]
[-] class-wc-product-external.php [edit]
[-] class-woocommerce.php [edit]
[-] class-wc-logger.php [edit]
[-] class-wc-shipping-zones.php [edit]
[-] class-wc-order-item-meta.php [edit]
[+] walkers
[+] shortcodes
[-] class-wc-cart-session.php [edit]
[+] rest-api
[-] class-wc-autoloader.php [edit]
[-] class-wc-meta-data.php [edit]
[-] wc-notice-functions.php [edit]
[+] queue
[+] react-admin
[-] class-wc-order-item.php [edit]
[-] class-wc-shortcodes.php [edit]
[-] wc-term-functions.php [edit]
[-] wc-webhook-functions.php [edit]
[-] class-wc-privacy-exporters.php [edit]
[-] class-wc-privacy-background-process.php [edit]
[-] class-wc-regenerate-images-request.php [edit]
[-] class-wc-deprecated-filter-hooks.php [edit]
[+] interfaces
[-] class-wc-background-emailer.php [edit]
[-] class-wc-geo-ip.php [edit]
[+] data-stores
[-] class-wc-comments.php [edit]
[-] wc-conditional-functions.php [edit]
[-] class-wc-product-factory.php [edit]
[+] theme-support
[+] libraries
[-] class-wc-structured-data.php [edit]
[-] class-wc-order-factory.php [edit]
[-] class-wc-cart-fees.php [edit]
[-] class-wc-deprecated-action-hooks.php [edit]
[-] class-wc-order-item-fee.php [edit]
[+] cli
[-] class-wc-background-updater.php [edit]
[-] class-wc-discounts.php [edit]
[-] class-wc-rate-limiter.php [edit]
[-] class-wc-geolocation.php [edit]
[-] class-wc-privacy-erasers.php [edit]
[-] class-wc-post-types.php [edit]
[+] export
[+] log-handlers
[-] class-wc-regenerate-images.php [edit]
[+] abstracts
[-] class-wc-rest-exception.php [edit]
[-] class-wc-order-item-product.php [edit]
[-] class-wc-product-simple.php [edit]
[-] wc-rest-functions.php [edit]
[-] class-wc-post-data.php [edit]
[-] class-wc-embed.php [edit]
[+] payment-tokens
[-] class-wc-template-loader.php [edit]
[-] class-wc-product-variable.php [edit]
[-] class-wc-install.php [edit]
[-] class-wc-shipping-rate.php [edit]
[-] class-wc-api.php [edit]
[-] wc-template-functions.php [edit]
[-] wc-update-functions.php [edit]
[-] class-wc-register-wp-admin-settings.php [edit]