WPAsyncRequest.php
166 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\WordPressLibraries; |
| 4 | |
| 5 | /** |
| 6 | * This is a fork of WP_Async_Request that adds GiveWP namespaces to prevent conflicts with other plugins. |
| 7 | * |
| 8 | * @since 2.32.0 |
| 9 | */ |
| 10 | abstract class WPAsyncRequest |
| 11 | { |
| 12 | |
| 13 | /** |
| 14 | * Prefix |
| 15 | * |
| 16 | * (default value: 'wp') |
| 17 | * |
| 18 | * @var string |
| 19 | * @access protected |
| 20 | */ |
| 21 | protected $prefix = 'wp'; |
| 22 | |
| 23 | /** |
| 24 | * Action |
| 25 | * |
| 26 | * (default value: 'async_request') |
| 27 | * |
| 28 | * @var string |
| 29 | * @access protected |
| 30 | */ |
| 31 | protected $action = 'async_request'; |
| 32 | |
| 33 | /** |
| 34 | * Identifier |
| 35 | * |
| 36 | * @var mixed |
| 37 | * @access protected |
| 38 | */ |
| 39 | protected $identifier; |
| 40 | |
| 41 | /** |
| 42 | * Data |
| 43 | * |
| 44 | * (default value: array()) |
| 45 | * |
| 46 | * @var array |
| 47 | * @access protected |
| 48 | */ |
| 49 | protected $data = []; |
| 50 | |
| 51 | /** |
| 52 | * Initiate new async request |
| 53 | */ |
| 54 | public function __construct() |
| 55 | { |
| 56 | $this->identifier = $this->prefix . '_' . $this->action; |
| 57 | |
| 58 | add_action('wp_ajax_' . $this->identifier, [$this, 'maybe_handle']); |
| 59 | add_action('wp_ajax_nopriv_' . $this->identifier, [$this, 'maybe_handle']); |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * Set data used during the request |
| 64 | * |
| 65 | * @param array $data Data. |
| 66 | * |
| 67 | * @return $this |
| 68 | */ |
| 69 | public function data($data) |
| 70 | { |
| 71 | $this->data = $data; |
| 72 | |
| 73 | return $this; |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Dispatch the async request |
| 78 | * |
| 79 | * @return array|WP_Error |
| 80 | */ |
| 81 | public function dispatch() |
| 82 | { |
| 83 | $url = add_query_arg($this->get_query_args(), $this->get_query_url()); |
| 84 | $args = $this->get_post_args(); |
| 85 | |
| 86 | return wp_remote_post(esc_url_raw($url), $args); |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * Get query args |
| 91 | * |
| 92 | * @return array |
| 93 | */ |
| 94 | protected function get_query_args() |
| 95 | { |
| 96 | if (property_exists($this, 'query_args')) { |
| 97 | return $this->query_args; |
| 98 | } |
| 99 | |
| 100 | return [ |
| 101 | 'action' => $this->identifier, |
| 102 | 'nonce' => wp_create_nonce($this->identifier), |
| 103 | ]; |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Get query URL |
| 108 | * |
| 109 | * @return string |
| 110 | */ |
| 111 | protected function get_query_url() |
| 112 | { |
| 113 | if (property_exists($this, 'query_url')) { |
| 114 | return $this->query_url; |
| 115 | } |
| 116 | |
| 117 | return admin_url('admin-ajax.php'); |
| 118 | } |
| 119 | |
| 120 | /** |
| 121 | * Get post args |
| 122 | * |
| 123 | * @return array |
| 124 | */ |
| 125 | protected function get_post_args() |
| 126 | { |
| 127 | if (property_exists($this, 'post_args')) { |
| 128 | return $this->post_args; |
| 129 | } |
| 130 | |
| 131 | return [ |
| 132 | 'timeout' => 0.01, |
| 133 | 'blocking' => false, |
| 134 | 'body' => $this->data, |
| 135 | 'cookies' => $_COOKIE, |
| 136 | 'sslverify' => apply_filters('https_local_ssl_verify', false), |
| 137 | ]; |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Maybe handle |
| 142 | * |
| 143 | * Check for correct nonce and pass to handler. |
| 144 | */ |
| 145 | public function maybe_handle() |
| 146 | { |
| 147 | // Don't lock up other requests while processing |
| 148 | session_write_close(); |
| 149 | |
| 150 | check_ajax_referer($this->identifier, 'nonce'); |
| 151 | |
| 152 | $this->handle(); |
| 153 | |
| 154 | wp_die(); |
| 155 | } |
| 156 | |
| 157 | /** |
| 158 | * Handle |
| 159 | * |
| 160 | * Override this method to perform any actions required |
| 161 | * during the async request. |
| 162 | */ |
| 163 | abstract protected function handle(); |
| 164 | |
| 165 | } |
| 166 |