class-wc-rate-limiter.php — WooCommerce 6.6.0

woocommerce / includes / class-wc-rate-limiter.php

woocommerce / includes Last commit date

class-wc-rate-limiter.php

174 lines

1	<?php
2	/**
3	* Provide basic rate limiting functionality via WP Options API.
4	*
5	* Currently only provides a simple limit by delaying action by X seconds.
6	*
7	* Example usage:
8	*
9	* When an action runs, call set_rate_limit, e.g.:
10	*
11	* WC_Rate_Limiter::set_rate_limit( "{$my_action_name}_{$user_id}", $delay );
12	*
13	* This sets a timestamp for future timestamp after which action can run again.
14	*
15	*
16	* Then before running the action again, check if the action is allowed to run, e.g.:
17	*
18	* if ( WC_Rate_Limiter::retried_too_soon( "{$my_action_name}_{$user_id}" ) ) {
19	* add_notice( 'Sorry, too soon!' );
20	* }
21	*
22	* @package WooCommerce\Classes
23	* @version 3.9.0
24	* @since 3.9.0
25	*/
26
27	defined( 'ABSPATH' ) \|\| exit;
28
29	/**
30	* Rate limit class.
31	*/
32	class WC_Rate_Limiter {
33
34	/**
35	* Cache group.
36	*/
37	const CACHE_GROUP = 'wc_rate_limit';
38
39	/**
40	* Hook in methods.
41	*/
42	public static function init() {
43	add_action( 'woocommerce_cleanup_rate_limits', array( __CLASS__, 'cleanup' ) );
44	}
45
46	/**
47	* Constructs key name from action identifier.
48	* Left in for backwards compatibility.
49	*
50	* @param string $action_id Identifier of the action.
51	* @return string
52	*/
53	public static function storage_id( $action_id ) {
54	return $action_id;
55	}
56
57	/**
58	* Gets a cache prefix.
59	*
60	* @param string $action_id Identifier of the action.
61	* @return string
62	*/
63	protected static function get_cache_key( $action_id ) {
64	return WC_Cache_Helper::get_cache_prefix( 'rate_limit' . $action_id );
65	}
66
67	/**
68	* Retrieve a cached rate limit.
69	*
70	* @param string $action_id Identifier of the action.
71	* @return bool\|int
72	*/
73	protected static function get_cached( $action_id ) {
74	return wp_cache_get( self::get_cache_key( $action_id ), self::CACHE_GROUP );
75	}
76
77	/**
78	* Cache a rate limit.
79	*
80	* @param string $action_id Identifier of the action.
81	* @param int $expiry Timestamp when the limit expires.
82	* @return bool
83	*/
84	protected static function set_cache( $action_id, $expiry ) {
85	return wp_cache_set( self::get_cache_key( $action_id ), $expiry, self::CACHE_GROUP );
86	}
87
88	/**
89	* Returns true if the action is not allowed to be run by the rate limiter yet, false otherwise.
90	*
91	* @param string $action_id Identifier of the action.
92	* @return bool
93	*/
94	public static function retried_too_soon( $action_id ) {
95	global $wpdb;
96
97	$next_try_allowed_at = self::get_cached( $action_id );
98
99	if ( false === $next_try_allowed_at ) {
100	$next_try_allowed_at = $wpdb->get_var(
101	$wpdb->prepare(
102	"
103	SELECT rate_limit_expiry
104	FROM {$wpdb->prefix}wc_rate_limits
105	WHERE rate_limit_key = %s
106	",
107	$action_id
108	)
109	);
110
111	self::set_cache( $action_id, $next_try_allowed_at );
112	}
113
114	// No record of action running, so action is allowed to run.
115	if ( null === $next_try_allowed_at ) {
116	return false;
117	}
118
119	// Before the next run is allowed, retry forbidden.
120	if ( time() <= $next_try_allowed_at ) {
121	return true;
122	}
123
124	// After the next run is allowed, retry allowed.
125	return false;
126	}
127
128	/**
129	* Sets the rate limit delay in seconds for action with identifier $id.
130	*
131	* @param string $action_id Identifier of the action.
132	* @param int $delay Delay in seconds.
133	* @return bool True if the option setting was successful, false otherwise.
134	*/
135	public static function set_rate_limit( $action_id, $delay ) {
136	global $wpdb;
137
138	$next_try_allowed_at = time() + $delay;
139
140	$result = $wpdb->replace(
141	$wpdb->prefix . 'wc_rate_limits',
142	array(
143	'rate_limit_key' => $action_id,
144	'rate_limit_expiry' => $next_try_allowed_at,
145	),
146	array( '%s', '%d' )
147	);
148
149	self::set_cache( $action_id, $next_try_allowed_at );
150
151	return false !== $result;
152	}
153
154	/**
155	* Cleanup expired rate limits from the database and clear caches.
156	*/
157	public static function cleanup() {
158	global $wpdb;
159
160	$wpdb->query(
161	$wpdb->prepare(
162	"DELETE FROM {$wpdb->prefix}wc_rate_limits WHERE rate_limit_expiry < %d",
163	time()
164	)
165	);
166
167	if ( class_exists( 'WC_Cache_Helper' ) ) {
168	WC_Cache_Helper::invalidate_cache_group( self::CACHE_GROUP );
169	}
170	}
171	}
172
173	WC_Rate_Limiter::init();
174