| 1 |
<?php |
| 2 |
/** |
| 3 |
* Load required classes. |
| 4 |
* |
| 5 |
* @author Paul Kilmurray <paul@kilbot.com> |
| 6 |
* |
| 7 |
* @see http://wcpos.com |
| 8 |
* @package WCPOS\WooCommercePOS |
| 9 |
*/ |
| 10 |
|
| 11 |
namespace WCPOS\WooCommercePOS; |
| 12 |
|
| 13 |
use WCPOS\WooCommercePOS\Admin\Consent; |
| 14 |
use WCPOS\WooCommercePOS\Admin\Menu; |
| 15 |
use WCPOS\WooCommercePOS\Services\Auth as AuthService; |
| 16 |
use WCPOS\WooCommercePOS\Services\Extensions; |
| 17 |
use WCPOS\WooCommercePOS\Services\Receipt_Snapshot_Store; |
| 18 |
use WCPOS\WooCommercePOS\Services\Settings as SettingsService; |
| 19 |
|
| 20 |
/** |
| 21 |
* Init class. |
| 22 |
*/ |
| 23 |
class Init { |
| 24 |
/** |
| 25 |
* Constructor — the plugin's entire `plugins_loaded` hook wiring. |
| 26 |
* |
| 27 |
* Reached from {@see Activator::init()}, which runs on `plugins_loaded` at the |
| 28 |
* default priority 10. Everything that must exist before `init` fires — most |
| 29 |
* importantly the `determine_current_user` pair — has to be registered here. |
| 30 |
* |
| 31 |
* NOT PURE WIRING. Constructing this class also, in statement order: |
| 32 |
* `require_once`s `wcpos-functions.php` and `wcpos-store-functions.php`; |
| 33 |
* registers the `wc_pos_user_uuid_locks` global cache group; READS the sync |
| 34 |
* schema-latch option; WRITES options through |
| 35 |
* `Config_Fingerprint::maybe_cleanup_legacy_options()` (one-time, latched on |
| 36 |
* its own version option); and SCHEDULES a daily cron event through |
| 37 |
* `Sync_Journal_Purge::register_hooks()`. Anything that constructs `Init` — |
| 38 |
* a test included — inherits all of that. |
| 39 |
* |
| 40 |
* ## How to read the ordering table |
| 41 |
* |
| 42 |
* A priority number decides ordering on its own, wherever in this method it |
| 43 |
* happens to be written. Statement order is load-bearing ONLY when two |
| 44 |
* callbacks share a hook AND a priority: WordPress then runs them in |
| 45 |
* registration order. Exactly one such pair exists here, and it is marked |
| 46 |
* ORDER-CRITICAL (STATEMENT ORDER) below — do not move it. |
| 47 |
* |
| 48 |
* Priorities that live in the callee (`Meta_Normalizer` at 5, `Revision` at 9, |
| 49 |
* the proxy stampers at 10) are listed at the value they actually register, |
| 50 |
* not at the position of the call in this method. Reordering those statements |
| 51 |
* changes nothing; changing those numbers changes everything. |
| 52 |
* |
| 53 |
* "Why" is recovered from `git log -S` / `git blame` where a reason was |
| 54 |
* recorded. Where none was, the entry says **unknown** rather than guessing. |
| 55 |
* |
| 56 |
* ## Ordering table |
| 57 |
* |
| 58 |
* | # | Hook | Callback | Pri | Order | Why that priority | |
| 59 |
* |---|------|----------|-----|-------|-------------------| |
| 60 |
* | 1 | `activated_plugin`, `upgrader_process_complete`, `admin_enqueue_scripts`, `admin_notices`, `rest_api_init` | `Admin\Consent` (5 callbacks) | 10 | irrelevant | Default. What matters is that `Consent` is built during `plugins_loaded`, so its lifecycle hooks exist before an activation/update request fires them. | |
| 61 |
* | 2 | `woocommerce_pos_rest_api_controllers` | `Sync\Api::register_controllers` | 10 | irrelevant | Default; sole callback. | |
| 62 |
* | 3 | `wcpos_integrity_digest_rebuild` | `Sync\Integrity_Digest::run_scheduled_rebuild` | 10 | irrelevant | Default; sole callback. Registered OUTSIDE the schema latch, so an already-scheduled rebuild still has a callback while the latch is down. | |
| 63 |
* | 4 | `woocommerce_pos_sync_proxy_response`, `..._serialized_product`, `..._serialized_order` | `Sync\Meta_Normalizer::normalize` | **5** | **ORDER-CRITICAL** | Must precede `Revision` at 9 so the stamped revision bytes equal what the write path recomputes from a bare `wc/v3` re-read. See `Sync\Augmentation_Pipeline` class docblock and `Sync\Meta_Normalizer::register_hooks()`. Kept out of the pipeline because it also serves the ORDER lane. | |
| 64 |
* | 5 | `woocommerce_pos_sync_serialized_order` | `Sync\Pos_Uuid::stamp_serialized_record` | 10 | order-critical (by number) | After `Meta_Normalizer` at 5, in step with the product lane's stampers. | |
| 65 |
* | 6 | `woocommerce_pos_sync_order_pull_payloads` | `Sync\Integrity_Digest::stamp_proxy_order_digests` | 10 | irrelevant | Default; sole callback on that filter. | |
| 66 |
* | 7 | `woocommerce_pos_sync_proxy_response` | `Sync\Revision::stamp_proxy_revisions` (via `Augmentation_Pipeline::install()`) | **9** | **ORDER-CRITICAL** | Between `Meta_Normalizer` (5) and the uuid/digest stampers (10). Revision must hash the normalized-but-not-yet-augmented payload. | |
| 67 |
* | 8 | `woocommerce_pos_sync_proxy_response`, `..._serialized_product` | `Proxy_Uuid_Stamper`, `Integrity_Digest` digest stampers, pipeline projections | 10 | order-critical (by number) | Preserved verbatim from the hand-wiring the pipeline replaced, so third-party code hooking either public filter still runs where it always did. | |
| 68 |
* | 9 | `woocommerce_before_product_object_save`, `woocommerce_before_product_variation_object_save` | `Sync\Pos_Uuid::stamp_on_save` | 10 | irrelevant | Default. The HOOK is the design (before the data store writes, so the uuid lands in the same save); the number is not. Registered unconditionally — identity is core, not an observer. | |
| 69 |
* | 9a | `untrashed_post`, `woocommerce_untrash_order` | `Sync\Pos_Uuid::recheck_ownership_after_untrash`, `::recheck_order_ownership_after_untrash` | 10 | irrelevant | Default. Re-proves uuid ownership when a record leaves the trash — the one seam a native restore passes through (#1805, ADR 0038). Unconditional for the same reason as row 9; the journal and digest observers (rows 10, 12) share both hooks at the same priority once the latch is set, and nothing depends on the order. | |
| 70 |
* | 10 | 32 catalogue/customer/order hooks, plus `shutdown` | `Sync\Sync_Journal` (34 callbacks) | 10 (`shutdown` at `PHP_INT_MAX`) | `shutdown`: order-critical (by number) | Default throughout. `woocommerce_update_order` only MARKS the order dirty; the `hook:update` row lands on `flush_pending_order_updates()` — at `shutdown`, before any other-origin row for that order, or when a different order is saved — so one online checkout writes one update row, not eleven. The shutdown flush runs LAST because WooCommerce saves the customer at 10 and the session at 20; a save those trigger after the flush is written immediately. | |
| 71 |
* | 10b | `delete_option` plus `pre_update_option_*`, `update_option_*`, `add_option_*`, `delete_option_*` for the two `Pos_Visibility::source_options()` | `Sync\Visibility_Observer` (9 callbacks) | 10 | irrelevant | Default. Appends the journal row for a record entering or leaving the POS servable set — the transition the sequence-log stream relies on, since it drops a hidden record's update rows. `delete_option` is the generic PRE-delete action (the per-option form fires after) and is gated on the option name inside the callback. Registered after `Sync_Journal` only because it writes through it; the constructor also runs the observer's one-time tombstone seed. | |
| 72 |
* | 11 | `wcpos_sync_journal_purge` | `Sync\Sync_Journal_Purge::run_purge` | 10 | irrelevant | Cron callback; sole listener. This call also SCHEDULES the daily event. | |
| 73 |
* | 12 | 21 catalogue/customer/order hooks (a subset of row 10's), plus `shutdown` | `Sync\Integrity_Digest` | 10 (`shutdown` at `PHP_INT_MAX`) | unknown | Default. Shares every one of its hooks with `Sync_Journal` at the same priority, so the journal always runs first — no code found that depends on that, but nothing pins it either. Every save — product, variation, customer, order — only MARKS the digest dirty; the upsert lands on `flush_pending_digests()` at `shutdown`, before any `Digest_Index::read_digests()`, or when the queue holds 50 records. | |
| 74 |
* | 13 | `init` | `Init::init` | 10 | **ORDER-CRITICAL, CROSS-PLUGIN** | Default. **Pro registers its own `init` at 20** (`woocommerce-pos-pro/includes/Init.php:32`) so free's services exist first. Raising free's number silently breaks Pro; nothing on either side tests it. | |
| 75 |
* | 14 | `rest_api_init` | `Init::init_rest_api` | **20** | **ORDER-CRITICAL, CROSS-PLUGIN** | Free's own reason: unknown — the number dates to the initial commit (8f2b9eac, 2021-03-16). It is load-bearing anyway: **Pro registers `rest_api_init` at 9**, commented "Before the free version" (`woocommerce-pos-pro/includes/Init.php:33`). Untested on both sides. | |
| 76 |
* | 15 | `query_vars` | `Init::query_vars` | 10 | irrelevant | Default; appends one var. | |
| 77 |
* | 16 | `pre_update_option_woocommerce_pos_pro_settings_license` | `Init::remove_license_transient` | 10 | irrelevant | Default. The reentrancy guard, not the priority, is what makes it safe (f33b8d655). | |
| 78 |
* | 17 | ~~`rest_pre_serve_request`~~ | *(removed)* | — | — | Init no longer publishes any part of the REST wire contract. This registration and its handler moved to `Rest_Cors::register_hooks()`, which registers at **20** — after core's `rest_send_cors_headers` at 10 — so WCPOS is the last writer on the lanes it owns. The old `5` had no recorded reason; the new number does. | |
| 79 |
* | 18 | `send_headers` | `Init::send_headers` | 99 | unknown | Introduced by 62da70551 ("fix WPSEO integration"). The commit records no reason for the number beyond running late. | |
| 80 |
* | 19 | `send_headers` | `Init::remove_x_frame_options` | **9999** | **ORDER-CRITICAL** | Must run AFTER security plugins have set `X-Frame-Options`, because it works by `header_remove()` (80ee545a5). A smaller number lets the plugin set the header again afterwards. | |
| 81 |
* | 20 | `determine_current_user` | `Services\Core_Order_Audit_Guard::record_prior_authentication` | **20** | **ORDER-CRITICAL (STATEMENT ORDER)** | See below. | |
| 82 |
* | 21 | `rest_pre_dispatch` | `Services\Core_Order_Audit_Guard::rest_pre_dispatch` | 10 | irrelevant | Default; reads what row 20 recorded. | |
| 83 |
* | 22 | `woocommerce_update_coupon` | `Sync\Coupon_Modified_Date::touch` | 10 | irrelevant | Default. `Sync_Journal::record_coupon_updated` shares the hook and priority (row 10) and is registered first, but the journal timestamps rows with the wall clock, not the coupon's `post_modified`, so neither ordering changes an outcome. | |
| 84 |
* | 23 | `determine_current_user` | `Init::determine_current_user_early` | **20** | **ORDER-CRITICAL (STATEMENT ORDER)** | See below. | |
| 85 |
* | 24 | `admin_init` | `Services\Lifecycle_Events::flush_pending`, `::maybe_schedule_refresh` | 10 | irrelevant | Default. `admin_init` because both need a fully booted admin request: one sends install/upgrade events recorded before the plugin was loaded enough to send them, the other schedules row 25. Both check consent first and cost nothing on a site that opted out. | |
| 86 |
* | 25 | `wcpos_analytics_group_refresh` | `Services\Lifecycle_Events::refresh_group_properties` | 10 | irrelevant | Default; sole listener. Unlike row 11, this call does NOT schedule the event — scheduling lives in row 24 so that withdrawing consent unschedules it. | |
| 87 |
* | 26 | `rest_request_after_callbacks` | `Services\Error_Reporter::filter_rest_request_after_callbacks` | **999** | order-critical (by number) | Runs late so the response status it reports is the one the client receives. | |
| 88 |
* |
| 89 |
* ## The one pair where statement order is the whole mechanism |
| 90 |
* |
| 91 |
* Rows 20 and 23 share `determine_current_user` AND priority 20, so insertion |
| 92 |
* order — and nothing else — decides which runs first. 20 puts both after |
| 93 |
* WordPress core's own handlers, which `default-filters.php` registers before |
| 94 |
* any plugin loads: `wp_validate_auth_cookie` at 10, then |
| 95 |
* `wp_validate_logged_in_cookie` and `wp_validate_application_password`, both |
| 96 |
* at 20 and therefore both ahead of these two. |
| 97 |
* |
| 98 |
* The guard must run FIRST. It records into `pre_wcpos_user_id` whichever user |
| 99 |
* some EARLIER filter had already authenticated; a non-zero value means the |
| 100 |
* request proved itself with a cookie or application password, so |
| 101 |
* `Core_Order_Audit_Guard::is_wcpos_jwt_authenticated()` returns false and the |
| 102 |
* request keeps its normal power over order meta. |
| 103 |
* |
| 104 |
* Swap the two statements and the guard records the user WCPOS's own JWT filter |
| 105 |
* just authenticated. `pre_wcpos_user_id` is then non-zero on every |
| 106 |
* token-authenticated request, `is_wcpos_jwt_authenticated()` returns false for |
| 107 |
* all of them, and forged `_pos_*` audit meta on `/wc/v3/orders` is accepted. |
| 108 |
* It fails OPEN, silently, on a route no smoke test touches. |
| 109 |
* |
| 110 |
* Pinned by `tests/includes/Test_Init_Hook_Wiring.php`, which asserts the two |
| 111 |
* callbacks' ARRAY POSITIONS inside `callbacks[20]` — asserting priorities |
| 112 |
* would pass on the broken order. |
| 113 |
*/ |
| 114 |
public function __construct() { |
| 115 |
// global helper functions. |
| 116 |
require_once PLUGIN_PATH . 'includes/wcpos-functions.php'; |
| 117 |
require_once PLUGIN_PATH . 'includes/wcpos-store-functions.php'; |
| 118 |
wp_cache_add_global_groups( 'wc_pos_user_uuid_locks' ); |
| 119 |
|
| 120 |
// Tracking consent pop-up + callout. Registered here (during |
| 121 |
// plugins_loaded) so its lifecycle hooks (activated_plugin, |
| 122 |
// upgrader_process_complete) are in place before those actions |
| 123 |
// fire on a plugin activation or update request. |
| 124 |
new Consent(); |
| 125 |
add_filter( 'woocommerce_pos_rest_api_controllers', array( \WCPOS\WooCommercePOS\Sync\Api::class, 'register_controllers' ) ); |
| 126 |
add_action( \WCPOS\WooCommercePOS\Sync\Integrity_Digest::REBUILD_HOOK, array( \WCPOS\WooCommercePOS\Sync\Integrity_Digest::class, 'run_scheduled_rebuild' ) ); |
| 127 |
// Gate on the schema latch, not a live Health probe: the latch is only |
| 128 |
// set AFTER install verified every table (latch-after-verify), so a |
| 129 |
// per-request SHOW TABLES sweep buys nothing — and a table lost after |
| 130 |
// latching is already survivable (observer writes fail open and the |
| 131 |
// REST health gate 503s the sync endpoints). |
| 132 |
$sync_schema_latched = \WCPOS\WooCommercePOS\Sync\Api::SCHEMA_VERSION === get_option( \WCPOS\WooCommercePOS\Sync\Api::SCHEMA_OPTION, null ); |
| 133 |
if ( $sync_schema_latched ) { |
| 134 |
// Normalize structured meta at priority 5, before revision stamps at 9 |
| 135 |
// and UUID, digest, and variable-price stamps at priority 10. Kept out |
| 136 |
// of the augmentation pipeline because it also serves the order lane. |
| 137 |
\WCPOS\WooCommercePOS\Sync\Meta_Normalizer::register_hooks(); |
| 138 |
add_filter( 'woocommerce_pos_sync_serialized_order', array( \WCPOS\WooCommercePOS\Sync\Pos_Uuid::class, 'stamp_serialized_record' ), 10, 3 ); |
| 139 |
// ONE seam for both product read lanes: the batch catalog proxy and the |
| 140 |
// per-object serializer. Every stamper is declared once inside; both |
| 141 |
// public filter names stay live as projections of it. The order pull |
| 142 |
// lane's digest stamper is wired there too — it was hand-added here, |
| 143 |
// under this same latch, which made the pipeline's single-wiring-site |
| 144 |
// claim untrue. |
| 145 |
\WCPOS\WooCommercePOS\Sync\Augmentation_Pipeline::install(); |
| 146 |
} |
| 147 |
|
| 148 |
// Identity is core, not an observer benchmark variable: every product is |
| 149 |
// born with a UUID even before the schema latch is healthy. The before-save |
| 150 |
// hook writes it in the same save. |
| 151 |
\WCPOS\WooCommercePOS\Sync\Pos_Uuid::register_hooks(); |
| 152 |
|
| 153 |
if ( $sync_schema_latched ) { |
| 154 |
( new \WCPOS\WooCommercePOS\Sync\Sync_Journal() )->register_hooks(); |
| 155 |
$visibility_observer = new \WCPOS\WooCommercePOS\Sync\Visibility_Observer(); |
| 156 |
$visibility_observer->register_hooks(); |
| 157 |
$visibility_observer->maybe_seed_hidden_tombstones(); |
| 158 |
( new \WCPOS\WooCommercePOS\Sync\Sync_Journal_Purge() )->register_hooks(); |
| 159 |
( new \WCPOS\WooCommercePOS\Sync\Integrity_Digest() )->register_hooks(); |
| 160 |
} |
| 161 |
|
| 162 |
( new \WCPOS\WooCommercePOS\Sync\Config_Fingerprint() )->maybe_cleanup_legacy_options(); |
| 163 |
|
| 164 |
// Init hooks. |
| 165 |
add_action( 'init', array( $this, 'init' ) ); |
| 166 |
add_action( 'rest_api_init', array( $this, 'init_rest_api' ), 20 ); |
| 167 |
add_filter( 'query_vars', array( $this, 'query_vars' ) ); |
| 168 |
|
| 169 |
// Remove this once Pro settings have been moved to the new settings service. |
| 170 |
add_filter( 'pre_update_option_woocommerce_pos_pro_settings_license', array( self::class, 'remove_license_transient' ), 10, 2 ); |
| 171 |
|
| 172 |
// The REST wire contract — CORS and shared-cache defeat — has a single |
| 173 |
// owner. Registered unconditionally, from here rather than from the |
| 174 |
// X-WCPOS-gated API class, because preflights carry no marker and the |
| 175 |
// relay's consent route is served without constructing API. |
| 176 |
Rest_Cors::register_hooks(); |
| 177 |
|
| 178 |
// Non-REST API discoverability: the HEAD probe against the homepage. |
| 179 |
add_action( 'send_headers', array( $this, 'send_headers' ), 99, 1 ); |
| 180 |
add_action( 'send_headers', array( $this, 'remove_x_frame_options' ), 9999, 1 ); |
| 181 |
|
| 182 |
/* |
| 183 |
* Add the global JWT authentication filter and its core-route audit guard. |
| 184 |
* |
| 185 |
* Hook order: plugins_loaded -> init (determine_current_user) -> rest_api_init |
| 186 |
* |
| 187 |
* This filter runs at priority 20, after WordPress core's cookie auth handlers. |
| 188 |
* It must be registered here (during plugins_loaded) because determine_current_user |
| 189 |
* fires during 'init', which is BEFORE rest_api_init where our API class loads. |
| 190 |
* Because it authenticates WCPOS Bearer tokens on EVERY |
| 191 |
* REST request (marked or not), the audit-meta guard for core routes |
| 192 |
* must be registered just as unconditionally — never from the |
| 193 |
* X-WCPOS-gated API class, whose marker an attacker simply omits. |
| 194 |
* Registering it first lets its priority-20 provenance filter run after |
| 195 |
* core's cookie handlers but before WCPOS's JWT filter. |
| 196 |
*/ |
| 197 |
( new Services\Core_Order_Audit_Guard() )->register_hooks(); |
| 198 |
|
| 199 |
// Coupon post-date touch. Unconditional and lane-agnostic on purpose: a |
| 200 |
// meta-only coupon edit (amount, discount_type, usage limits) never moves |
| 201 |
// post_modified, and the client's catalogue replication is date-based |
| 202 |
// (?modified_after, filtered by WooCommerce on post_modified_gmt), so an |
| 203 |
// untouched coupon is invisible to every other till. That is true whether |
| 204 |
// the edit came from the POS, wp-admin, WP-CLI or another plugin — so this |
| 205 |
// sits outside the schema latch above because it does not use the v2 sync |
| 206 |
// tables. |
| 207 |
\WCPOS\WooCommercePOS\Sync\Coupon_Modified_Date::register_hooks(); |
| 208 |
|
| 209 |
add_filter( 'determine_current_user', array( $this, 'determine_current_user_early' ), 20 ); |
| 210 |
|
| 211 |
// Install lifecycle reporting. Registered last: it adds no filter that |
| 212 |
// anything else orders against, and appending keeps the ordering table |
| 213 |
// above in statement order. Deliberately NOT before the pair above — |
| 214 |
// rows 20 and 23 are decided by insertion order alone. |
| 215 |
( new Services\Lifecycle_Events() )->register_hooks(); |
| 216 |
|
| 217 |
// Consent-gated Sentry error reporting (issue #1811). Registered last for |
| 218 |
// the same reason as Lifecycle_Events: nothing orders against it. Its REST |
| 219 |
// filter runs at 999 so the status it reports is the one the client receives. |
| 220 |
Services\Error_Reporter::instance()->register_hooks(); |
| 221 |
} |
| 222 |
|
| 223 |
/** |
| 224 |
* Clear cached data that depends on the Pro license. |
| 225 |
* |
| 226 |
* @param mixed $value The new option value. |
| 227 |
* @param mixed $old_value The previous option value (false when unset). |
| 228 |
* |
| 229 |
* @return mixed |
| 230 |
*/ |
| 231 |
public static function remove_license_transient( $value, $old_value = false ) { |
| 232 |
// Pro's updater can react to the update_plugins deletion by reading — |
| 233 |
// and, when the stored instance id is blank, re-saving — the license |
| 234 |
// option, which re-enters this filter. Without the guard that cycle is |
| 235 |
// unbounded and OOMs the first license activation on a fresh install. |
| 236 |
static $clearing = false; |
| 237 |
if ( $clearing ) { |
| 238 |
return $value; |
| 239 |
} |
| 240 |
$clearing = true; |
| 241 |
delete_transient( 'woocommerce_pos_pro_license_status' ); |
| 242 |
|
| 243 |
// The update caches bind to the license key and activation state. A |
| 244 |
// write that changes neither — e.g. Pro's read-side instance mint — |
| 245 |
// must not wipe update_plugins: Pro reacts to that deletion by |
| 246 |
// clearing its own update-data cache, which empties the payload of an |
| 247 |
// update check that is in flight when the mint occurs. |
| 248 |
$old = \is_array( $old_value ) ? $old_value : array(); |
| 249 |
$new = \is_array( $value ) ? $value : array(); |
| 250 |
if ( |
| 251 |
(string) ( $old['key'] ?? '' ) !== (string) ( $new['key'] ?? '' ) |
| 252 |
|| ! empty( $old['activated'] ) !== ! empty( $new['activated'] ) |
| 253 |
) { |
| 254 |
delete_site_transient( 'update_plugins' ); |
| 255 |
} |
| 256 |
$clearing = false; |
| 257 |
|
| 258 |
return $value; |
| 259 |
} |
| 260 |
|
| 261 |
/** |
| 262 |
* Early authentication check for JWT tokens. |
| 263 |
* |
| 264 |
* This runs BEFORE rest_api_init, so we can authenticate users before WP REST API |
| 265 |
* permission callbacks run. This is especially important for authorization via |
| 266 |
* query parameter (?authorization=Bearer...) which some servers require. |
| 267 |
* |
| 268 |
* Note: We don't check for X-WCPOS header here because: |
| 269 |
* 1. The header check uses getallheaders() which may not work in all environments |
| 270 |
* 2. JWT authentication should work regardless - the token itself is proof of WCPOS usage |
| 271 |
* 3. Invalid tokens (non-WCPOS) will fail validation anyway |
| 272 |
* |
| 273 |
* @param false|int $user_id User ID if one has been determined, false otherwise. |
| 274 |
* |
| 275 |
* @return false|int User ID if authenticated, original value otherwise. |
| 276 |
*/ |
| 277 |
public function determine_current_user_early( $user_id ) { |
| 278 |
// Skip if user already authenticated. |
| 279 |
if ( ! empty( $user_id ) ) { |
| 280 |
return $user_id; |
| 281 |
} |
| 282 |
|
| 283 |
$authenticated_user_id = AuthService::instance()->authenticate_request(); |
| 284 |
if ( false === $authenticated_user_id || is_wp_error( $authenticated_user_id ) ) { |
| 285 |
return $user_id; |
| 286 |
} |
| 287 |
|
| 288 |
return $authenticated_user_id; |
| 289 |
} |
| 290 |
|
| 291 |
/** |
| 292 |
* Load the required resources. |
| 293 |
*/ |
| 294 |
public function init(): void { |
| 295 |
$this->init_common(); |
| 296 |
$this->init_frontend(); |
| 297 |
$this->init_admin(); |
| 298 |
$this->init_integrations(); |
| 299 |
} |
| 300 |
|
| 301 |
/** |
| 302 |
* Loads the POS API and duck punches the WC REST API. |
| 303 |
*/ |
| 304 |
public function init_rest_api(): void { |
| 305 |
$is_wcpos_request = woocommerce_pos_request(); |
| 306 |
|
| 307 |
if ( $is_wcpos_request ) { |
| 308 |
if ( ! wcpos_request( 'header' ) && ! wcpos_request( 'query_var' ) ) { |
| 309 |
// Namespace-detected only: routes still register, but surface |
| 310 |
// that a proxy/WAF is stripping the X-WCPOS marker. |
| 311 |
$this->log_unmarked_wcpos_rest_request(); |
| 312 |
} |
| 313 |
new API(); |
| 314 |
} else { |
| 315 |
// Queue the registration at a later priority of the SAME |
| 316 |
// rest_api_init pass this method runs on (priority 20), so |
| 317 |
// register_rest_route() executes during the action as WP requires. |
| 318 |
// When this method is called outside the action (tests), the |
| 319 |
// add_action is simply inert. |
| 320 |
add_action( 'rest_api_init', array( $this, 'register_public_relay_routes' ), 30 ); |
| 321 |
new WC_API(); |
| 322 |
} |
| 323 |
} |
| 324 |
|
| 325 |
/** |
| 326 |
* Register the relay's public consent-callback route for unmarked requests. |
| 327 |
* |
| 328 |
* The WCPOS Cloud Print relay proves site consent by fetching |
| 329 |
* print-jobs/relay-verification WITHOUT the WCPOS request marker, so this |
| 330 |
* single public route must exist even when the full WCPOS API is not |
| 331 |
* loaded. Everything else stays behind the marker. |
| 332 |
*/ |
| 333 |
public function register_public_relay_routes(): void { |
| 334 |
register_rest_route( |
| 335 |
SHORT_NAME . '/v1', |
| 336 |
'/print-jobs/relay-verification', |
| 337 |
array( |
| 338 |
'methods' => 'GET', |
| 339 |
'callback' => array( new API\V1\Print_Jobs_Controller(), 'relay_verification' ), |
| 340 |
'permission_callback' => '__return_true', |
| 341 |
) |
| 342 |
); |
| 343 |
} |
| 344 |
|
| 345 |
/** |
| 346 |
* Log requests for a WCPOS namespace that omitted the request marker. |
| 347 |
* |
| 348 |
* Namespace detection registers the routes anyway; this surfaces that a |
| 349 |
* proxy/WAF is stripping the X-WCPOS marker so misconfigured hosts stay |
| 350 |
* visible in the logs. Warnings are limited by API version to avoid |
| 351 |
* allowing repeated unauthenticated requests to flood WooCommerce logs. |
| 352 |
*/ |
| 353 |
private function log_unmarked_wcpos_rest_request(): void { |
| 354 |
global $wp; |
| 355 |
|
| 356 |
$route = isset( $wp->query_vars['rest_route'] ) |
| 357 |
? '/' . ltrim( sanitize_text_field( wp_unslash( (string) $wp->query_vars['rest_route'] ) ), '/' ) |
| 358 |
: ''; |
| 359 |
|
| 360 |
if ( 1 !== preg_match( '#^/wcpos/v([12])(?:/|$)#', $route, $matches ) ) { |
| 361 |
return; |
| 362 |
} |
| 363 |
|
| 364 |
// The relay's consent callback is expected unmarked traffic (see |
| 365 |
// register_public_relay_routes()), not a misconfigured client. |
| 366 |
if ( '/wcpos/v1/print-jobs/relay-verification' === $route ) { |
| 367 |
return; |
| 368 |
} |
| 369 |
|
| 370 |
$transient = 'wcpos_missing_request_marker_v' . $matches[1]; |
| 371 |
if ( false !== get_transient( $transient ) ) { |
| 372 |
return; |
| 373 |
} |
| 374 |
|
| 375 |
set_transient( $transient, 1, 5 * MINUTE_IN_SECONDS ); |
| 376 |
Logger::warning( $route . ': request marker missing (routes still registered via namespace detection).' ); |
| 377 |
} |
| 378 |
|
| 379 |
/** |
| 380 |
* Adds 'wcpos' to the query variables allowed before processing. |
| 381 |
* |
| 382 |
* Allows (publicly allowed) query vars to be added, removed, or changed prior |
| 383 |
* to executing the query. Needed to allow custom rewrite rules using your own arguments |
| 384 |
* to work, or any other custom query variables you want to be publicly available. |
| 385 |
* |
| 386 |
* @param string[] $query_vars The array of allowed query variable names. |
| 387 |
* |
| 388 |
* @return string[] The array of allowed query variable names. |
| 389 |
*/ |
| 390 |
public function query_vars( array $query_vars ): array { |
| 391 |
$query_vars[] = SHORT_NAME; |
| 392 |
|
| 393 |
return $query_vars; |
| 394 |
} |
| 395 |
|
| 396 |
/** |
| 397 |
* Allow HEAD checks for WP API Link URL and server uptime. |
| 398 |
* |
| 399 |
* This is the NON-REST lane and is not part of the REST wire contract |
| 400 |
* ({@see Rest_Cors}): `send_headers` fires from `WP::main()`, which a REST |
| 401 |
* request never reaches — core's `rest_api_loaded()` runs on |
| 402 |
* `parse_request` and dies. What it serves is the app's site-discovery |
| 403 |
* probe against an ordinary page: the app reads the `Link: |
| 404 |
* <.../wp-json/>; rel="https://api.w.org/"` header cross-origin to find |
| 405 |
* the REST root, which needs both headers below. Some servers turn HEAD |
| 406 |
* into GET, hence the `?_method=head` query param rather than the method. |
| 407 |
* |
| 408 |
* This is live, not legacy. The client calls it on every Connect: |
| 409 |
* `packages/core/src/screens/auth/hooks/use-url-discovery.ts` issues |
| 410 |
* `http.head()` against the site root, and |
| 411 |
* `packages/hooks/src/use-http-client/use-http-client.tsx` sets |
| 412 |
* `params._method = 'HEAD'` on every HEAD request (both in the client |
| 413 |
* monorepo). That same client code deliberately omits the `X-WCPOS` |
| 414 |
* marker for HEAD, so this handler cannot be marker-gated and must stay |
| 415 |
* unconditional. 521ccb9a added it; the `?wcpos=1` gate it originally |
| 416 |
* carried is long gone. |
| 417 |
* |
| 418 |
* @return void |
| 419 |
*/ |
| 420 |
public function send_headers(): void { |
| 421 |
// some server convert HEAD to GET method, so use this query param instead. |
| 422 |
if ( isset( $_GET['_method'] ) && 'head' === strtolower( sanitize_text_field( wp_unslash( $_GET['_method'] ) ) ) ) { |
| 423 |
header( 'Access-Control-Allow-Origin: *' ); |
| 424 |
header( 'Access-Control-Expose-Headers: Link' ); |
| 425 |
} |
| 426 |
} |
| 427 |
|
| 428 |
/** |
| 429 |
* Some security plugins will set X-Frame-Options: SAMEORIGIN/DENY, which will prevent the POS desktop |
| 430 |
* application from opening pages like the login in an iframe. |
| 431 |
* |
| 432 |
* For pages we need, we will remove the X-Frame-Options header. |
| 433 |
* |
| 434 |
* @param mixed $wp The WP object. |
| 435 |
* |
| 436 |
* @return void |
| 437 |
*/ |
| 438 |
public function remove_x_frame_options( $wp ): void { |
| 439 |
if ( woocommerce_pos_request() || isset( $wp->query_vars['wcpos-login'] ) ) { |
| 440 |
if ( ! headers_sent() && \function_exists( 'header_remove' ) ) { |
| 441 |
header_remove( 'X-Frame-Options' ); |
| 442 |
} |
| 443 |
} |
| 444 |
} |
| 445 |
|
| 446 |
/** |
| 447 |
* Groups constructed so far in this request (test seam; see constructed_groups()). |
| 448 |
* |
| 449 |
* @var array<string, bool> |
| 450 |
*/ |
| 451 |
private static array $constructed = array(); |
| 452 |
|
| 453 |
/** |
| 454 |
* Common initializations, by request lane. |
| 455 |
* |
| 456 |
* Every request gets the services whose hooks WooCommerce consults on a |
| 457 |
* plain shopper page BEFORE any order exists: translations, the product |
| 458 |
* visibility filters, the order statuses and the read-side order filters |
| 459 |
* (My Account renders POS orders), the gateway registration (WooCommerce |
| 460 |
* builds its gateway list on cart pages) and the reserved-stock filter |
| 461 |
* (POS drafts must reduce online availability at add-to-cart time). |
| 462 |
* |
| 463 |
* Everything else is constructed only on the lanes that use it, and the |
| 464 |
* order-event services additionally on the first order write of ANY request |
| 465 |
* ({@see ensure_order_services()}), so the lane classifier is an |
| 466 |
* optimisation rather than a correctness gate. Measured 2026-09-03: a |
| 467 |
* storefront page loaded ~80 plugin files and 22 objects for hooks that |
| 468 |
* never fire there (see .claude/research/2026-09-03-lazy-service-construction-spec.md). |
| 469 |
*/ |
| 470 |
private function init_common(): void { |
| 471 |
self::$constructed['always'] = true; |
| 472 |
|
| 473 |
// init the Services. |
| 474 |
SettingsService::instance(); |
| 475 |
AuthService::instance(); |
| 476 |
|
| 477 |
// Needed on every lane, including a plain storefront page. |
| 478 |
new i18n(); |
| 479 |
new Gateways(); |
| 480 |
new Products(); |
| 481 |
new Orders(); |
| 482 |
Services\Stock_Validator::instance(); |
| 483 |
|
| 484 |
if ( Services\Request_Lane::is_storefront() ) { |
| 485 |
// Order-event services arrive on the first order write, if any. |
| 486 |
self::arm_order_services(); |
| 487 |
return; |
| 488 |
} |
| 489 |
|
| 490 |
self::ensure_order_services(); |
| 491 |
self::construct_pos_services(); |
| 492 |
} |
| 493 |
|
| 494 |
/** |
| 495 |
* Services only POS, admin, REST, cron and CLI requests use. |
| 496 |
*/ |
| 497 |
private static function construct_pos_services(): void { |
| 498 |
if ( isset( self::$constructed['pos'] ) ) { |
| 499 |
return; |
| 500 |
} |
| 501 |
self::$constructed['pos'] = true; |
| 502 |
Extensions::instance(); |
| 503 |
new Services\Decimal_Quantities(); |
| 504 |
new Services\Customer_Meta_Parity(); |
| 505 |
} |
| 506 |
|
| 507 |
/** |
| 508 |
* Hook the order-event services to the first order write of the request. |
| 509 |
* |
| 510 |
* Every WooCommerce order write — create, update, status transition, |
| 511 |
* `payment_complete()`, refund — goes through `WC_Abstract_Order::save()`, |
| 512 |
* which fires `woocommerce_before_order_object_save` before the data store |
| 513 |
* writes and before `woocommerce_new_order` / `woocommerce_order_status_changed` |
| 514 |
* / `woocommerce_payment_complete` fire. Priority 0 there means every |
| 515 |
* observer exists before any order is written — on a webhook, a cron |
| 516 |
* spawned from a page view, a third-party plugin creating an order on |
| 517 |
* `template_redirect`, or a lane the classifier got wrong. Nothing in the |
| 518 |
* order group listens to trash or delete, so those need no arming. |
| 519 |
*/ |
| 520 |
private static function arm_order_services(): void { |
| 521 |
add_action( 'woocommerce_before_order_object_save', array( self::class, 'ensure_order_services' ), 0, 0 ); |
| 522 |
} |
| 523 |
|
| 524 |
/** |
| 525 |
* Construct the order-event services exactly once per request. |
| 526 |
* |
| 527 |
* Idempotent and safe to call after `init`; each service handles its own |
| 528 |
* late registration. Fires `woocommerce_pos_order_services_ready` once so |
| 529 |
* Pro and extensions can construct their own order-event services at the |
| 530 |
* same moment on every lane. |
| 531 |
*/ |
| 532 |
public static function ensure_order_services(): void { |
| 533 |
if ( isset( self::$constructed['order'] ) ) { |
| 534 |
return; |
| 535 |
} |
| 536 |
self::$constructed['order'] = true; |
| 537 |
|
| 538 |
Receipt_Snapshot_Store::instance(); |
| 539 |
new Emails(); |
| 540 |
new Templates(); |
| 541 |
new Services\Print_Job_Service(); |
| 542 |
new Services\Cloud_Print_Trigger_Service(); |
| 543 |
new Services\Cloud_Print_Submit_Service(); |
| 544 |
new Services\Cloud_Print_Relay_Service(); |
| 545 |
|
| 546 |
/** |
| 547 |
* Fires once per request when the POS order-event services exist: |
| 548 |
* eagerly on POS, admin, REST, cron and CLI requests (from this |
| 549 |
* plugin's `init` callback at priority 10), and on a storefront |
| 550 |
* request the moment the first order is about to be written. |
| 551 |
* |
| 552 |
* Because the eager firing happens at `init` priority 10, a listener |
| 553 |
* added later than that (for example from another plugin's `init` |
| 554 |
* callback at priority 20) must check `did_action()` first and |
| 555 |
* construct immediately when the action has already fired. |
| 556 |
* |
| 557 |
* @since 1.10.8 |
| 558 |
*/ |
| 559 |
do_action( 'woocommerce_pos_order_services_ready' ); |
| 560 |
} |
| 561 |
|
| 562 |
/** |
| 563 |
* Which service groups this request has constructed: 'always', 'order', 'pos'. |
| 564 |
* |
| 565 |
* @internal Test seam. |
| 566 |
* |
| 567 |
* @return string[] |
| 568 |
*/ |
| 569 |
public static function constructed_groups(): array { |
| 570 |
return array_keys( self::$constructed ); |
| 571 |
} |
| 572 |
|
| 573 |
/** |
| 574 |
* Forget which groups were constructed. Tests only. |
| 575 |
* |
| 576 |
* @internal |
| 577 |
*/ |
| 578 |
public static function reset_request_state(): void { |
| 579 |
self::$constructed = array(); |
| 580 |
Services\Request_Lane::reset(); |
| 581 |
} |
| 582 |
|
| 583 |
/** |
| 584 |
* Frontend specific initializations. |
| 585 |
*/ |
| 586 |
private function init_frontend(): void { |
| 587 |
if ( is_admin() ) { |
| 588 |
return; |
| 589 |
} |
| 590 |
// The public receipt shortcode and the My Account receipt action are |
| 591 |
// storefront features; they construct the template services when used. |
| 592 |
new Storefront_Receipts(); |
| 593 |
if ( ! Services\Request_Lane::is_storefront() ) { |
| 594 |
// The POS routes (rewrite rules, checkout context, order-pay and |
| 595 |
// coupon forms) only matter on requests the classifier saw as POS. |
| 596 |
new Template_Router(); |
| 597 |
new Form_Handler(); |
| 598 |
} |
| 599 |
} |
| 600 |
|
| 601 |
/** |
| 602 |
* Admin specific initializations. |
| 603 |
*/ |
| 604 |
private function init_admin(): void { |
| 605 |
if ( is_admin() ) { |
| 606 |
// Register AJAX handler before the branch so it's available during AJAX requests. |
| 607 |
add_action( 'wp_ajax_wcpos_track_upgrade_click_ajax', array( Menu::class, 'handle_upgrade_click_ajax' ) ); |
| 608 |
add_action( 'admin_post_wcpos_track_upgrade_click', array( Menu::class, 'handle_upgrade_click_redirect' ) ); |
| 609 |
|
| 610 |
if ( wp_doing_ajax() ) { |
| 611 |
new AJAX(); |
| 612 |
} else { |
| 613 |
new Admin(); |
| 614 |
} |
| 615 |
} |
| 616 |
} |
| 617 |
|
| 618 |
/** |
| 619 |
* Integrations. |
| 620 |
*/ |
| 621 |
private function init_integrations(): void { |
| 622 |
// WooCommerce Bookings - http://www.woothemes.com/products/woocommerce-bookings/ |
| 623 |
// if ( class_exists( 'WC-Bookings' ) ) { |
| 624 |
// new Integrations\Bookings(); |
| 625 |
// }. |
| 626 |
|
| 627 |
// Yoast SEO - https://wordpress.org/plugins/wordpress-seo/. |
| 628 |
if ( class_exists( 'WPSEO_Options' ) ) { |
| 629 |
new Integrations\WPSEO(); |
| 630 |
} |
| 631 |
|
| 632 |
// wePOS alters the WooCommerce REST API, breaking the expected schema |
| 633 |
// It's very bad form on their part, but we need to work around it. |
| 634 |
// Its only hook is admin_init (a conflict notice), so admin lane only. |
| 635 |
if ( is_admin() ) { |
| 636 |
new Integrations\WePOS(); |
| 637 |
} |
| 638 |
|
| 639 |
// WooCommerce Tax - https://wordpress.org/plugins/woocommerce-services/ |
| 640 |
// Its class exists whenever the plugin is active, but its callbacks are |
| 641 |
// only hooked when automated taxes are on and the store country is |
| 642 |
// supported, so the integration looks them up on the hooks at |
| 643 |
// recalculation time instead of gating on the class here. |
| 644 |
new Integrations\WooCommerce_Tax(); |
| 645 |
} |
| 646 |
} |
| 647 |
|
