abstracts
6 years ago
admin
6 years ago
cli
6 years ago
customizer
6 years ago
data-stores
6 years ago
emails
6 years ago
export
6 years ago
gateways
6 years ago
import
6 years ago
integrations
6 years ago
interfaces
6 years ago
legacy
6 years ago
libraries
6 years ago
log-handlers
6 years ago
payment-tokens
6 years ago
queue
7 years ago
shipping
6 years ago
shortcodes
6 years ago
theme-support
6 years ago
tracks
6 years ago
traits
6 years ago
walkers
8 years ago
wccom-site
6 years ago
widgets
6 years ago
class-wc-ajax.php
6 years ago
class-wc-api.php
6 years ago
class-wc-auth.php
7 years ago
class-wc-autoloader.php
6 years ago
class-wc-background-emailer.php
6 years ago
class-wc-background-updater.php
7 years ago
class-wc-breadcrumb.php
7 years ago
class-wc-cache-helper.php
6 years ago
class-wc-cart-fees.php
6 years ago
class-wc-cart-session.php
6 years ago
class-wc-cart-totals.php
6 years ago
class-wc-cart.php
6 years ago
class-wc-checkout.php
6 years ago
class-wc-cli.php
8 years ago
class-wc-comments.php
6 years ago
class-wc-countries.php
6 years ago
class-wc-coupon.php
6 years ago
class-wc-customer-download-log.php
8 years ago
class-wc-customer-download.php
6 years ago
class-wc-customer.php
7 years ago
class-wc-data-exception.php
8 years ago
class-wc-data-store.php
6 years ago
class-wc-datetime.php
7 years ago
class-wc-deprecated-action-hooks.php
8 years ago
class-wc-deprecated-filter-hooks.php
7 years ago
class-wc-discounts.php
6 years ago
class-wc-download-handler.php
6 years ago
class-wc-emails.php
6 years ago
class-wc-embed.php
8 years ago
class-wc-form-handler.php
6 years ago
class-wc-frontend-scripts.php
6 years ago
class-wc-geo-ip.php
8 years ago
class-wc-geolite-integration.php
6 years ago
class-wc-geolocation.php
6 years ago
class-wc-https.php
8 years ago
class-wc-install.php
6 years ago
class-wc-integrations.php
6 years ago
class-wc-log-levels.php
7 years ago
class-wc-logger.php
6 years ago
class-wc-meta-data.php
7 years ago
class-wc-order-factory.php
6 years ago
class-wc-order-item-coupon.php
7 years ago
class-wc-order-item-fee.php
7 years ago
class-wc-order-item-meta.php
7 years ago
class-wc-order-item-product.php
6 years ago
class-wc-order-item-shipping.php
7 years ago
class-wc-order-item-tax.php
6 years ago
class-wc-order-item.php
6 years ago
class-wc-order-query.php
7 years ago
class-wc-order-refund.php
8 years ago
class-wc-order.php
6 years ago
class-wc-payment-gateways.php
6 years ago
class-wc-payment-tokens.php
6 years ago
class-wc-post-data.php
6 years ago
class-wc-post-types.php
7 years ago
class-wc-privacy-background-process.php
8 years ago
class-wc-privacy-erasers.php
6 years ago
class-wc-privacy-exporters.php
6 years ago
class-wc-privacy.php
6 years ago
class-wc-product-attribute.php
7 years ago
class-wc-product-download.php
6 years ago
class-wc-product-external.php
8 years ago
class-wc-product-factory.php
7 years ago
class-wc-product-grouped.php
8 years ago
class-wc-product-query.php
7 years ago
class-wc-product-simple.php
6 years ago
class-wc-product-variable.php
6 years ago
class-wc-product-variation.php
7 years ago
class-wc-query.php
6 years ago
class-wc-rate-limiter.php
6 years ago
class-wc-regenerate-images-request.php
7 years ago
class-wc-regenerate-images.php
7 years ago
class-wc-register-wp-admin-settings.php
8 years ago
class-wc-rest-authentication.php
6 years ago
class-wc-rest-exception.php
6 years ago
class-wc-session-handler.php
6 years ago
class-wc-shipping-rate.php
8 years ago
class-wc-shipping-zone.php
6 years ago
class-wc-shipping-zones.php
6 years ago
class-wc-shipping.php
6 years ago
class-wc-shortcodes.php
6 years ago
class-wc-structured-data.php
6 years ago
class-wc-tax.php
6 years ago
class-wc-template-loader.php
6 years ago
class-wc-tracker.php
6 years ago
class-wc-validation.php
6 years ago
class-wc-webhook.php
6 years ago
class-woocommerce.php
6 years ago
wc-account-functions.php
6 years ago
wc-attribute-functions.php
6 years ago
wc-cart-functions.php
6 years ago
wc-conditional-functions.php
6 years ago
wc-core-functions.php
6 years ago
wc-coupon-functions.php
7 years ago
wc-deprecated-functions.php
6 years ago
wc-formatting-functions.php
6 years ago
wc-notice-functions.php
6 years ago
wc-order-functions.php
6 years ago
wc-order-item-functions.php
6 years ago
wc-page-functions.php
6 years ago
wc-product-functions.php
6 years ago
wc-rest-functions.php
6 years ago
wc-stock-functions.php
6 years ago
wc-template-functions.php
6 years ago
wc-template-hooks.php
6 years ago
wc-term-functions.php
6 years ago
wc-update-functions.php
6 years ago
wc-user-functions.php
6 years ago
wc-webhook-functions.php
7 years ago
wc-widget-functions.php
8 years ago
class-wc-rate-limiter.php
80 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 | * Constructs Option name from action identifier. |
| 36 | * |
| 37 | * @param string $action_id Identifier of the action. |
| 38 | * @return string |
| 39 | */ |
| 40 | public static function storage_id( $action_id ) { |
| 41 | return 'woocommerce_rate_limit_' . $action_id; |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Returns true if the action is not allowed to be run by the rate limiter yet, false otherwise. |
| 46 | * |
| 47 | * @param string $action_id Identifier of the action. |
| 48 | * @return bool |
| 49 | */ |
| 50 | public static function retried_too_soon( $action_id ) { |
| 51 | $next_try_allowed_at = get_option( self::storage_id( $action_id ) ); |
| 52 | |
| 53 | // No record of action running, so action is allowed to run. |
| 54 | if ( false === $next_try_allowed_at ) { |
| 55 | return false; |
| 56 | } |
| 57 | |
| 58 | // Before the next run is allowed, retry forbidden. |
| 59 | if ( time() <= $next_try_allowed_at ) { |
| 60 | return true; |
| 61 | } |
| 62 | |
| 63 | // After the next run is allowed, retry allowed. |
| 64 | return false; |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Sets the rate limit delay in seconds for action with identifier $id. |
| 69 | * |
| 70 | * @param string $action_id Identifier of the action. |
| 71 | * @param int $delay Delay in seconds. |
| 72 | * @return bool True if the option setting was successful, false otherwise. |
| 73 | */ |
| 74 | public static function set_rate_limit( $action_id, $delay ) { |
| 75 | $option_name = self::storage_id( $action_id ); |
| 76 | $next_try_allowed_at = time() + $delay; |
| 77 | return update_option( $option_name, $next_try_allowed_at ); |
| 78 | } |
| 79 | } |
| 80 |