| 1 |
<?php |
| 2 |
/** |
| 3 |
* Activation checks and set up. |
| 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\Services\Lifecycle_Events; |
| 15 |
use WCPOS\WooCommercePOS\Sync\Api as Sync_Api; |
| 16 |
use WCPOS\WooCommercePOS\Sync\Health as Sync_Health; |
| 17 |
use WCPOS\WooCommercePOS\Sync\Integrity_Digest; |
| 18 |
use WCPOS\WooCommercePOS\Sync\Mutation_Store; |
| 19 |
use WCPOS\WooCommercePOS\Sync\Sync_Journal; |
| 20 |
use const DOING_AJAX; |
| 21 |
|
| 22 |
/** |
| 23 |
* Activator class. |
| 24 |
*/ |
| 25 |
class Activator { |
| 26 |
/** |
| 27 |
* Lock name used by WP_Upgrader::create_lock(). |
| 28 |
*/ |
| 29 |
private const DB_UPGRADE_LOCK_NAME = 'woocommerce_pos_db_upgrade_lock'; |
| 30 |
|
| 31 |
/** |
| 32 |
* Lock TTL in seconds. |
| 33 |
*/ |
| 34 |
private const DB_UPGRADE_LOCK_TTL = 600; |
| 35 |
|
| 36 |
/** |
| 37 |
* Constructor. |
| 38 |
*/ |
| 39 |
public function __construct() { |
| 40 |
register_activation_hook( PLUGIN_FILE, array( $this, 'activate' ) ); |
| 41 |
add_action( 'wpmu_new_blog', array( $this, 'activate_new_site' ) ); |
| 42 |
add_action( 'plugins_loaded', array( $this, 'init' ) ); |
| 43 |
} |
| 44 |
|
| 45 |
/** |
| 46 |
* Checks for valid install and begins execution of the plugin. |
| 47 |
*/ |
| 48 |
public function init(): void { |
| 49 |
// Check for min requirements to run. |
| 50 |
if ( $this->php_check() && $this->woocommerce_check() ) { |
| 51 |
// Defer permalink check to admin_init so __() calls happen after |
| 52 |
// after_setup_theme (WordPress 6.7+ triggers a notice otherwise). |
| 53 |
if ( is_admin() && ( ! \defined( '\DOING_AJAX' ) || ! DOING_AJAX ) ) { // @phpstan-ignore-line |
| 54 |
add_action( |
| 55 |
'admin_init', |
| 56 |
function () { |
| 57 |
$this->permalink_check(); |
| 58 |
} |
| 59 |
); |
| 60 |
} |
| 61 |
|
| 62 |
// Init update script if required. |
| 63 |
$this->version_check(); |
| 64 |
$this->pro_version_check(); |
| 65 |
|
| 66 |
// resolve plugin plugins. |
| 67 |
$this->plugin_check(); |
| 68 |
|
| 69 |
new Init(); |
| 70 |
} |
| 71 |
} |
| 72 |
|
| 73 |
/** |
| 74 |
* Fired when the plugin is activated. |
| 75 |
* |
| 76 |
* @param bool $network_wide Whether to activate network-wide. |
| 77 |
*/ |
| 78 |
public function activate( $network_wide ): void { |
| 79 |
if ( \function_exists( 'is_multisite' ) && is_multisite() ) { |
| 80 |
if ( $network_wide ) { |
| 81 |
// Get all blog ids. |
| 82 |
$blog_ids = $this->get_blog_ids(); |
| 83 |
|
| 84 |
foreach ( $blog_ids as $blog_id ) { |
| 85 |
switch_to_blog( $blog_id ); |
| 86 |
$this->single_activate(); |
| 87 |
|
| 88 |
restore_current_blog(); |
| 89 |
} |
| 90 |
} else { |
| 91 |
self::single_activate(); |
| 92 |
} |
| 93 |
} else { |
| 94 |
self::single_activate(); |
| 95 |
} |
| 96 |
} |
| 97 |
|
| 98 |
/** |
| 99 |
* Fired when the plugin is activated. |
| 100 |
* |
| 101 |
* @param bool $install_sync_schema Whether to install the sync schema. |
| 102 |
* @param bool $full_role_sync Whether to repair all default role capabilities. |
| 103 |
*/ |
| 104 |
public function single_activate( bool $install_sync_schema = true, bool $full_role_sync = true ): void { |
| 105 |
$role_capabilities = self::role_capability_definition(); |
| 106 |
$capability_names = $role_capabilities; |
| 107 |
$capability_names['cashier'] = array_merge( array( 'access_woocommerce_pos' ), array_keys( $role_capabilities['cashier'] ) ); |
| 108 |
$synced = get_option( 'woocommerce_pos_role_caps_synced', false ); |
| 109 |
if ( ! $full_role_sync && false === $synced && get_option( 'woocommerce_pos_role_caps_fingerprint' ) === $this->role_caps_fingerprint() ) { |
| 110 |
$synced = $capability_names; |
| 111 |
} |
| 112 |
// An upgrade grants only capabilities new to the definition since the |
| 113 |
// last sync, so a capability the merchant removed on the Access screen |
| 114 |
// stays removed. Explicit activation still repairs every default. |
| 115 |
$granted = $capability_names; |
| 116 |
if ( ! $full_role_sync && \is_array( $synced ) ) { |
| 117 |
foreach ( $granted as $slug => $capabilities ) { |
| 118 |
$already = isset( $synced[ $slug ] ) && \is_array( $synced[ $slug ] ) ? $synced[ $slug ] : array(); |
| 119 |
$granted[ $slug ] = array_values( array_diff( $capabilities, $already ) ); |
| 120 |
} |
| 121 |
} |
| 122 |
|
| 123 |
// Reseed the default template terms on the next request: (re)activation |
| 124 |
// is the repair a merchant reaches for after deleting a term by hand. |
| 125 |
// This also runs once per upgrade (version_check re-activates to sync |
| 126 |
// role caps), so one post-upgrade request pays the ~18 seeding queries. |
| 127 |
delete_option( Templates::DEFAULT_TERMS_OPTION ); |
| 128 |
|
| 129 |
// Second, merchant-reachable trigger for the autoload repair: db_upgrade() |
| 130 |
// only runs when version_check() trips on an admin load that reaches |
| 131 |
// woocommerce_init, and a miss there is permanent once bump_versions() ran. |
| 132 |
self::autoload_request_latches(); |
| 133 |
Admin\Permalink::ensure_default(); |
| 134 |
|
| 135 |
// create POS specific roles. |
| 136 |
$this->create_pos_roles( $granted['cashier'] ); |
| 137 |
|
| 138 |
// add pos capabilities to non POS roles. |
| 139 |
$this->add_pos_capability( |
| 140 |
array( |
| 141 |
'administrator' => $granted['administrator'], |
| 142 |
'shop_manager' => $granted['shop_manager'], |
| 143 |
) |
| 144 |
); |
| 145 |
|
| 146 |
$stored_roles = get_option( wp_roles()->role_key, array() ); |
| 147 |
$roles_are_persisted = is_array( $stored_roles ); |
| 148 |
if ( $roles_are_persisted ) { |
| 149 |
foreach ( $granted as $slug => $capabilities ) { |
| 150 |
if ( ! isset( $stored_roles[ $slug ] ) ) { |
| 151 |
$roles_are_persisted = false; |
| 152 |
break; |
| 153 |
} |
| 154 |
foreach ( $capabilities as $capability ) { |
| 155 |
if ( empty( $stored_roles[ $slug ]['capabilities'][ $capability ] ) ) { |
| 156 |
$roles_are_persisted = false; |
| 157 |
break 2; |
| 158 |
} |
| 159 |
} |
| 160 |
} |
| 161 |
} |
| 162 |
|
| 163 |
$obsolete_customer_create_cap = isset( $role_capabilities['cashier']['create_customers'] ) ? 'promote_users' : 'create_customers'; |
| 164 |
if ( $roles_are_persisted && empty( $stored_roles['cashier']['capabilities'][ $obsolete_customer_create_cap ] ) ) { |
| 165 |
// Snapshot first: a fingerprint that advanced past a failed snapshot |
| 166 |
// write would never retry it. |
| 167 |
update_option( 'woocommerce_pos_role_caps_synced', $capability_names, true ); |
| 168 |
update_option( 'woocommerce_pos_role_caps_fingerprint', $this->role_caps_fingerprint(), true ); |
| 169 |
} |
| 170 |
|
| 171 |
// Flag the consent pop-up for the next admin page load. Done here |
| 172 |
// because the `activated_plugin` action in Admin\Consent fires |
| 173 |
// inside the activation request, at which point our plugin's |
| 174 |
// `plugins_loaded` callback hasn't yet instantiated Init on a |
| 175 |
// fresh install. |
| 176 |
// |
| 177 |
// Read the option directly — woocommerce_pos_get_settings() lives in |
| 178 |
// wcpos-functions.php which Init loads on `plugins_loaded`, but |
| 179 |
// plugins_loaded has already fired by the time activation runs. |
| 180 |
$general_settings = get_option( 'woocommerce_pos_settings_general', array() ); |
| 181 |
$tracking_consent = is_array( $general_settings ) && isset( $general_settings['tracking_consent'] ) |
| 182 |
? $general_settings['tracking_consent'] |
| 183 |
: 'undecided'; |
| 184 |
if ( 'undecided' === $tracking_consent ) { |
| 185 |
set_transient( Consent::MODAL_TRANSIENT, 1, Consent::MODAL_TRANSIENT_TTL ); |
| 186 |
} |
| 187 |
|
| 188 |
if ( $install_sync_schema ) { |
| 189 |
$this->install_sync_schema(); |
| 190 |
} |
| 191 |
|
| 192 |
// Record the install for analytics. Consent is still `undecided` at this |
| 193 |
// point, so the event is held until the user answers the pop-up flagged |
| 194 |
// above; Lifecycle_Events owns that deferral and reports at most once. |
| 195 |
( new Lifecycle_Events() )->record_install(); |
| 196 |
} |
| 197 |
|
| 198 |
/** |
| 199 |
* Install the sync store and latch its aggregate schema version after verification. |
| 200 |
*/ |
| 201 |
public function install_sync_schema(): void { |
| 202 |
$previous_schema = get_option( Sync_Api::SCHEMA_OPTION, null ); |
| 203 |
|
| 204 |
$journal = new Sync_Journal(); |
| 205 |
$journal->install(); |
| 206 |
( new Integrity_Digest() )->install(); |
| 207 |
( new Mutation_Store() )->install(); |
| 208 |
|
| 209 |
if ( ! Sync_Health::is_healthy() ) { |
| 210 |
if ( Sync_Api::SCHEMA_VERSION === $previous_schema ) { |
| 211 |
delete_option( Sync_Api::SCHEMA_OPTION ); |
| 212 |
} |
| 213 |
return; |
| 214 |
} |
| 215 |
|
| 216 |
// Schema 3 (#1379): the customer space widened from role=customer to ALL users. |
| 217 |
// Upgrading installs carry role-departure tombstones in the persisted stream that |
| 218 |
// would replay against now-live users; compensating updates supersede them (see |
| 219 |
// Sync_Journal::append_customer_updates_for_all_users). The old latch stays until |
| 220 |
// migration succeeds, so retries may append duplicate but harmless superseding |
| 221 |
// updates. Fresh installs (no previous latch) have no stream to repair. |
| 222 |
if ( |
| 223 |
null !== $previous_schema |
| 224 |
&& version_compare( (string) $previous_schema, '3', '<' ) |
| 225 |
&& ! $journal->append_customer_updates_for_all_users() |
| 226 |
) { |
| 227 |
return; |
| 228 |
} |
| 229 |
|
| 230 |
// Autoloaded: the Init constructor reads this latch on every request. |
| 231 |
// This flips an existing row only on WP 6.4+; older rows are flipped by |
| 232 |
// autoload_request_latches() on upgrade. |
| 233 |
update_option( Sync_Api::SCHEMA_OPTION, Sync_Api::SCHEMA_VERSION, true ); |
| 234 |
|
| 235 |
if ( null !== $previous_schema && version_compare( (string) $previous_schema, Sync_Api::SCHEMA_VERSION, '<' ) ) { |
| 236 |
global $wpdb; |
| 237 |
$wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}wcpos_sync_change_log" ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Known legacy table name. |
| 238 |
$wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}wcpos_sync_order_index" ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Known legacy table name. |
| 239 |
// The legacy Change_Log_Purge class is gone; its recurring cron event |
| 240 |
// would otherwise survive the upgrade and fire a hook with no handler |
| 241 |
// forever. Literal hook name — the constant was removed with the class. |
| 242 |
wp_clear_scheduled_hook( 'wcpos_change_log_purge' ); |
| 243 |
} |
| 244 |
} |
| 245 |
|
| 246 |
/** |
| 247 |
* Fired when a new site is activated with a WPMU environment. |
| 248 |
* |
| 249 |
* @param int $blog_id Blog ID. |
| 250 |
*/ |
| 251 |
public function activate_new_site( $blog_id ): void { |
| 252 |
if ( 1 !== did_action( 'wpmu_new_blog' ) ) { |
| 253 |
return; |
| 254 |
} |
| 255 |
|
| 256 |
switch_to_blog( $blog_id ); |
| 257 |
$this->single_activate(); |
| 258 |
restore_current_blog(); |
| 259 |
} |
| 260 |
|
| 261 |
/** |
| 262 |
* Check min version of PHP. |
| 263 |
*/ |
| 264 |
private function php_check() { |
| 265 |
$php_version = PHP_VERSION; |
| 266 |
if ( version_compare( $php_version, PHP_MIN_VERSION, '>' ) ) { |
| 267 |
return true; |
| 268 |
} |
| 269 |
|
| 270 |
// Defer __() call to avoid "too early" warning in WordPress 6.7+. |
| 271 |
add_action( |
| 272 |
'admin_init', |
| 273 |
function () { |
| 274 |
$message = \sprintf( |
| 275 |
// translators: 1: Minimum PHP version, 2: Update URL. |
| 276 |
__( '<strong>WCPOS</strong> requires PHP %1$s or higher. Read more information about <a href="%2$s">how you can update</a>', 'woocommerce-pos' ), |
| 277 |
PHP_MIN_VERSION, |
| 278 |
'http://www.wpupdatephp.com/update/' |
| 279 |
) . ' »'; |
| 280 |
|
| 281 |
Admin\Notices::add( $message ); |
| 282 |
} |
| 283 |
); |
| 284 |
} |
| 285 |
|
| 286 |
/** |
| 287 |
* Check min version of WooCommerce installed. |
| 288 |
*/ |
| 289 |
private function woocommerce_check() { |
| 290 |
if ( class_exists( '\WooCommerce' ) && version_compare( WC()->version, WC_MIN_VERSION, '>=' ) ) { |
| 291 |
return true; |
| 292 |
} |
| 293 |
|
| 294 |
// Defer __() call to avoid "too early" warning in WordPress 6.7+. |
| 295 |
add_action( |
| 296 |
'admin_init', |
| 297 |
function () { |
| 298 |
$message = \sprintf( |
| 299 |
// translators: 1: WooCommerce URL, 2: Minimum WC version, 3: Plugins URL. |
| 300 |
__( '<strong>WCPOS</strong> requires <a href="%1$s">WooCommerce %2$s or higher</a>. Please <a href="%3$s">install and activate WooCommerce</a>', 'woocommerce-pos' ), |
| 301 |
'http://wordpress.org/plugins/woocommerce/', |
| 302 |
WC_MIN_VERSION, |
| 303 |
admin_url( 'plugins.php' ) |
| 304 |
) . ' »'; |
| 305 |
|
| 306 |
Admin\Notices::add( $message ); |
| 307 |
} |
| 308 |
); |
| 309 |
} |
| 310 |
|
| 311 |
/** |
| 312 |
* POS Frontend will give 404 if pretty permalinks not active. |
| 313 |
*/ |
| 314 |
private function permalink_check(): void { |
| 315 |
$permalinks = get_option( 'permalink_structure' ); |
| 316 |
|
| 317 |
// early return. |
| 318 |
if ( $permalinks ) { |
| 319 |
return; |
| 320 |
} |
| 321 |
|
| 322 |
$message = /* translators: Plugin activation notice label. */ __( '<strong>WooCommerce REST API</strong> requires <em>pretty</em> permalinks to work correctly', 'woocommerce-pos' ) . '. '; |
| 323 |
$message .= \sprintf( '<a href="%s">%s</a>', admin_url( 'options-permalink.php' ), /* translators: Plugin activation notice label. */ __( 'Enable permalinks', 'woocommerce-pos' ) ) . ' »'; |
| 324 |
|
| 325 |
Admin\Notices::add( $message ); |
| 326 |
} |
| 327 |
|
| 328 |
/** |
| 329 |
* Check version number, runs every admin page load. |
| 330 |
*/ |
| 331 |
private function version_check(): void { |
| 332 |
$old = (string) Services\Settings::get_db_version(); |
| 333 |
$plugin_needs_upgrade = version_compare( $old, VERSION, '<' ); |
| 334 |
$sync_needs_upgrade = Sync_Api::SCHEMA_VERSION !== get_option( Sync_Api::SCHEMA_OPTION, null ); |
| 335 |
|
| 336 |
$role_caps_fingerprint = $this->role_caps_fingerprint(); |
| 337 |
$role_caps_need_sync = get_option( 'woocommerce_pos_role_caps_fingerprint' ) !== $role_caps_fingerprint |
| 338 |
|| false === get_option( 'woocommerce_pos_role_caps_synced' ); |
| 339 |
if ( ! $plugin_needs_upgrade && ! $sync_needs_upgrade && ! $role_caps_need_sync ) { |
| 340 |
return; |
| 341 |
} |
| 342 |
|
| 343 |
if ( ! $this->acquire_db_upgrade_lock() ) { |
| 344 |
return; |
| 345 |
} |
| 346 |
|
| 347 |
$locked_old = (string) Services\Settings::get_db_version(); |
| 348 |
$locked_plugin_needs_upgrade = version_compare( $locked_old, VERSION, '<' ); |
| 349 |
$locked_sync_needs_upgrade = Sync_Api::SCHEMA_VERSION !== get_option( Sync_Api::SCHEMA_OPTION, null ); |
| 350 |
|
| 351 |
$locked_role_caps_fingerprint = $this->role_caps_fingerprint(); |
| 352 |
$locked_role_caps_need_sync = get_option( 'woocommerce_pos_role_caps_fingerprint' ) !== $locked_role_caps_fingerprint |
| 353 |
|| false === get_option( 'woocommerce_pos_role_caps_synced' ); |
| 354 |
if ( ! $locked_plugin_needs_upgrade && ! $locked_sync_needs_upgrade && ! $locked_role_caps_need_sync ) { |
| 355 |
$this->release_db_upgrade_lock(); |
| 356 |
return; |
| 357 |
} |
| 358 |
|
| 359 |
if ( $locked_plugin_needs_upgrade ) { |
| 360 |
Services\Settings::bump_versions(); |
| 361 |
} |
| 362 |
|
| 363 |
if ( $locked_plugin_needs_upgrade || $locked_role_caps_need_sync ) { |
| 364 |
// Re-run activation to sync role capabilities. add_role() and add_cap() |
| 365 |
// are both idempotent, so this is safe. Without this, capabilities added |
| 366 |
// in newer versions would never reach existing installs because add_role() |
| 367 |
// is a no-op when the role already exists. |
| 368 |
// Deferred to 'init' because create_pos_roles() calls __() which |
| 369 |
// requires translations to be loaded (WordPress 6.7+). |
| 370 |
add_action( |
| 371 |
'init', |
| 372 |
function () { |
| 373 |
$this->single_activate( false, false ); |
| 374 |
} |
| 375 |
); |
| 376 |
} |
| 377 |
|
| 378 |
$lock_released = false; |
| 379 |
$release_lock = function () use ( &$lock_released ): void { |
| 380 |
if ( $lock_released ) { |
| 381 |
return; |
| 382 |
} |
| 383 |
|
| 384 |
$lock_released = true; |
| 385 |
$this->release_db_upgrade_lock(); |
| 386 |
}; |
| 387 |
|
| 388 |
// Safety net in case woocommerce_init does not fire for this request. |
| 389 |
add_action( 'shutdown', $release_lock ); |
| 390 |
|
| 391 |
// Defer db_upgrade to woocommerce_init when WC is fully loaded. |
| 392 |
// This prevents conflicts with plugins like WC Subscriptions that hook |
| 393 |
// into before_delete_post and assume WC()->order_factory is available. |
| 394 |
add_action( |
| 395 |
'woocommerce_init', |
| 396 |
function () use ( $locked_old, $locked_plugin_needs_upgrade, $locked_sync_needs_upgrade, $release_lock ) { |
| 397 |
try { |
| 398 |
$this->db_upgrade( $locked_old, VERSION ); |
| 399 |
|
| 400 |
// Report the upgrade only once the migration has actually |
| 401 |
// completed — queueing it beside bump_versions() would claim a |
| 402 |
// finished upgrade even when db_upgrade() threw or never ran. |
| 403 |
// Still exactly-once: the version was bumped above, so the |
| 404 |
// upgrade is not re-detected on the next request. |
| 405 |
if ( $locked_plugin_needs_upgrade ) { |
| 406 |
( new Lifecycle_Events() )->record_upgrade( $locked_old, VERSION ); |
| 407 |
} |
| 408 |
if ( $locked_sync_needs_upgrade && Sync_Api::SCHEMA_VERSION === get_option( Sync_Api::SCHEMA_OPTION, null ) ) { |
| 409 |
( new Sync_Journal() )->register_hooks(); |
| 410 |
( new Integrity_Digest() )->register_hooks(); |
| 411 |
} |
| 412 |
} finally { |
| 413 |
$release_lock(); |
| 414 |
remove_action( 'shutdown', $release_lock ); |
| 415 |
} |
| 416 |
} |
| 417 |
); |
| 418 |
} |
| 419 |
|
| 420 |
/** |
| 421 |
* Acquire the DB upgrade lock. |
| 422 |
* |
| 423 |
* @return bool True when this request owns the lock. |
| 424 |
*/ |
| 425 |
private function acquire_db_upgrade_lock(): bool { |
| 426 |
require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
| 427 |
|
| 428 |
return \WP_Upgrader::create_lock( self::DB_UPGRADE_LOCK_NAME, self::DB_UPGRADE_LOCK_TTL ); |
| 429 |
} |
| 430 |
|
| 431 |
/** |
| 432 |
* Release the DB upgrade lock. |
| 433 |
*/ |
| 434 |
private function release_db_upgrade_lock(): void { |
| 435 |
if ( ! class_exists( '\WP_Upgrader', false ) ) { |
| 436 |
require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
| 437 |
} |
| 438 |
|
| 439 |
\WP_Upgrader::release_lock( self::DB_UPGRADE_LOCK_NAME ); |
| 440 |
} |
| 441 |
|
| 442 |
/** |
| 443 |
* Plugin conflicts. |
| 444 |
* |
| 445 |
* - NextGEN Gallery is a terrible plugin. It buffers all content on 'init' action, priority -1 and inserts junk code. |
| 446 |
*/ |
| 447 |
private function plugin_check(): void { |
| 448 |
// disable NextGEN Gallery resource manager |
| 449 |
// if ( ! \defined( 'NGG_DISABLE_RESOURCE_MANAGER' ) ) { |
| 450 |
// \define( 'NGG_DISABLE_RESOURCE_MANAGER', true ); |
| 451 |
// }. |
| 452 |
} |
| 453 |
|
| 454 |
/** |
| 455 |
* Get all blog ids of blogs in the current network that are: |
| 456 |
* - not archived |
| 457 |
* - not spam |
| 458 |
* - not deleted. |
| 459 |
*/ |
| 460 |
private function get_blog_ids() { |
| 461 |
global $wpdb; |
| 462 |
|
| 463 |
// get an array of blog ids. |
| 464 |
$sql = "SELECT blog_id FROM $wpdb->blogs |
| 465 |
WHERE archived = '0' AND spam = '0' |
| 466 |
AND deleted = '0'"; |
| 467 |
|
| 468 |
return $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Static query, no user input |
| 469 |
} |
| 470 |
|
| 471 |
/** |
| 472 |
* Get the role capability definition. |
| 473 |
* |
| 474 |
* @return array<string, array<string, bool>|array<int, string>> Role capabilities keyed by role. |
| 475 |
*/ |
| 476 |
private static function role_capability_definition(): array { |
| 477 |
// WC 9.9 replaced promote_users with create_customers for customer creation. |
| 478 |
$customer_create_cap = \defined( 'WC_VERSION' ) && version_compare( WC_VERSION, '9.9', '>=' ) // @phpstan-ignore-line |
| 479 |
? 'create_customers' |
| 480 |
: 'promote_users'; |
| 481 |
|
| 482 |
// Cashier role. |
| 483 |
$cashier_capabilities = array( |
| 484 |
'read' => true, |
| 485 |
'read_private_products' => true, |
| 486 |
'publish_products' => true, |
| 487 |
'edit_product' => true, |
| 488 |
'edit_products' => true, |
| 489 |
'edit_published_products' => true, |
| 490 |
'edit_private_products' => true, |
| 491 |
'edit_others_products' => true, |
| 492 |
'read_private_shop_orders' => true, |
| 493 |
'publish_shop_orders' => true, |
| 494 |
'edit_shop_orders' => true, |
| 495 |
'edit_others_shop_orders' => true, |
| 496 |
'list_users' => true, |
| 497 |
$customer_create_cap => true, |
| 498 |
'edit_users' => true, |
| 499 |
'read_private_shop_coupons' => true, |
| 500 |
'publish_shop_coupons' => true, |
| 501 |
'edit_shop_coupons' => true, |
| 502 |
'edit_published_shop_coupons' => true, |
| 503 |
'edit_private_shop_coupons' => true, |
| 504 |
'edit_others_shop_coupons' => true, |
| 505 |
'manage_product_terms' => true, |
| 506 |
); |
| 507 |
|
| 508 |
return array( |
| 509 |
'cashier' => $cashier_capabilities, |
| 510 |
'administrator' => array( |
| 511 |
'manage_woocommerce_pos', |
| 512 |
'access_woocommerce_pos', |
| 513 |
'edit_wcpos_store', |
| 514 |
'read_wcpos_store', |
| 515 |
'delete_wcpos_store', |
| 516 |
'edit_wcpos_stores', |
| 517 |
'edit_others_wcpos_stores', |
| 518 |
'publish_wcpos_stores', |
| 519 |
'read_private_wcpos_stores', |
| 520 |
'delete_wcpos_stores', |
| 521 |
'delete_private_wcpos_stores', |
| 522 |
'delete_published_wcpos_stores', |
| 523 |
'delete_others_wcpos_stores', |
| 524 |
'edit_private_wcpos_stores', |
| 525 |
'edit_published_wcpos_stores', |
| 526 |
), |
| 527 |
'shop_manager' => array( 'manage_woocommerce_pos', 'access_woocommerce_pos' ), |
| 528 |
); |
| 529 |
} |
| 530 |
|
| 531 |
/** |
| 532 |
* Get the role-capabilities definition fingerprint. |
| 533 |
*/ |
| 534 |
private function role_caps_fingerprint(): string { |
| 535 |
return md5( wp_json_encode( self::role_capability_definition() ) ); |
| 536 |
} |
| 537 |
|
| 538 |
/** |
| 539 |
* Add POS specific roles. |
| 540 |
* |
| 541 |
* @param string[]|null $capabilities Capability names to sync onto an existing role, or null for |
| 542 |
* every default. A missing role is always created with the full set. |
| 543 |
*/ |
| 544 |
private function create_pos_roles( ?array $capabilities = null ): void { |
| 545 |
$role_capabilities = self::role_capability_definition(); |
| 546 |
$cashier_capabilities = $role_capabilities['cashier']; |
| 547 |
|
| 548 |
add_role( |
| 549 |
'cashier', |
| 550 |
/* translators: Plugin activation notice label. */ |
| 551 |
__( 'Cashier', 'woocommerce-pos' ), |
| 552 |
// A missing role is created whole, access gate included, whatever |
| 553 |
// subset an incremental upgrade asked to sync. |
| 554 |
array_merge( array( 'access_woocommerce_pos' => true ), $cashier_capabilities ) |
| 555 |
); |
| 556 |
|
| 557 |
$obsolete_customer_create_cap = isset( $cashier_capabilities['create_customers'] ) ? 'promote_users' : 'create_customers'; |
| 558 |
$cashier = get_role( 'cashier' ); |
| 559 |
if ( $cashier ) { |
| 560 |
$cashier->remove_cap( $obsolete_customer_create_cap ); |
| 561 |
} |
| 562 |
|
| 563 |
// Sync the requested capabilities to the role. add_role() is a no-op when |
| 564 |
// the role already exists, so capabilities added in newer versions would |
| 565 |
// never reach existing installs without this. |
| 566 |
$this->add_pos_capability( |
| 567 |
array( |
| 568 |
'cashier' => $capabilities ?? array_merge( |
| 569 |
array( 'access_woocommerce_pos' ), |
| 570 |
array_keys( $cashier_capabilities ) |
| 571 |
), |
| 572 |
) |
| 573 |
); |
| 574 |
} |
| 575 |
|
| 576 |
/** |
| 577 |
* Add default pos capabilities to administrator and shop_manager roles. |
| 578 |
* |
| 579 |
* @param array $roles An array of arrays representing the roles and their POS capabilities. |
| 580 |
*/ |
| 581 |
private function add_pos_capability( $roles ): void { |
| 582 |
foreach ( $roles as $slug => $caps ) { |
| 583 |
$role = get_role( $slug ); |
| 584 |
if ( $role ) { |
| 585 |
foreach ( $caps as $cap ) { |
| 586 |
$role->add_cap( $cap ); |
| 587 |
} |
| 588 |
} |
| 589 |
} |
| 590 |
} |
| 591 |
|
| 592 |
/** |
| 593 |
* Upgrade database. |
| 594 |
* |
| 595 |
* @param string $old Old version. |
| 596 |
* @param string $current Current version. |
| 597 |
*/ |
| 598 |
private function db_upgrade( $old, $current ): void { |
| 599 |
$db_updates = array( |
| 600 |
'0.4' => 'updates/update-0.4.php', |
| 601 |
'0.4.6' => 'updates/update-0.4.6.php', |
| 602 |
'1.0.0-beta.1' => 'updates/update-1.0.0-beta.1.php', |
| 603 |
'1.6.1' => 'updates/update-1.6.1.php', |
| 604 |
'1.8.0' => 'updates/update-1.8.0.php', |
| 605 |
'1.8.7' => 'updates/update-1.8.7.php', |
| 606 |
'1.8.12' => 'updates/update-1.8.12.php', |
| 607 |
'1.8.13' => 'updates/update-1.8.13.php', |
| 608 |
'1.9.0' => 'updates/update-1.9.0.php', |
| 609 |
'1.10.0' => 'updates/update-1.10.0.php', |
| 610 |
); |
| 611 |
foreach ( $db_updates as $version => $updater ) { |
| 612 |
if ( version_compare( $version, $old, '>' ) && |
| 613 |
version_compare( $version, $current, '<=' ) ) { |
| 614 |
include $updater; |
| 615 |
} |
| 616 |
} |
| 617 |
|
| 618 |
if ( Sync_Api::SCHEMA_VERSION !== get_option( Sync_Api::SCHEMA_OPTION, null ) ) { |
| 619 |
$this->install_sync_schema(); |
| 620 |
} |
| 621 |
|
| 622 |
// Installs that predate 2026-09 wrote the per-request latches with |
| 623 |
// autoload off; every upgrade re-asserts autoload so the flip is |
| 624 |
// idempotent and needs no versioned update file. |
| 625 |
self::autoload_request_latches(); |
| 626 |
Admin\Permalink::ensure_default(); |
| 627 |
} |
| 628 |
|
| 629 |
/** |
| 630 |
* Every option row that is read on EVERY request and must therefore ride in |
| 631 |
* alloptions: the three sync latches the Init constructor reads, the permalink |
| 632 |
* slug Template_Router reads, and each registered settings section that |
| 633 |
* declares {@see Services\Settings\Abstract_Section::autoload()} — the |
| 634 |
* sections are the extension point, so Pro's and extensions' sections join |
| 635 |
* the repair by declaring it, without touching this file. |
| 636 |
* |
| 637 |
* Needed because core's update_option() returns early on an unchanged value |
| 638 |
* WITHOUT touching the autoload column, so a writer alone never repairs a row |
| 639 |
* an older release wrote with autoload off. Without a persistent object cache |
| 640 |
* each such row cost one `SELECT option_value` per page load (measured |
| 641 |
* 2026-09-03 on dev-next and dev-free). |
| 642 |
* |
| 643 |
* @return string[] |
| 644 |
*/ |
| 645 |
private static function request_option_names(): array { |
| 646 |
$names = array( |
| 647 |
Sync_Api::SCHEMA_OPTION, |
| 648 |
\WCPOS\WooCommercePOS\Sync\Visibility_Observer::SEED_VERSION_OPTION, |
| 649 |
\WCPOS\WooCommercePOS\Sync\Config_Fingerprint::CLEANUP_VERSION_OPTION, |
| 650 |
Admin\Permalink::DB_KEY, |
| 651 |
); |
| 652 |
foreach ( Services\Settings::instance()->sections()->all() as $section ) { |
| 653 |
if ( $section instanceof Services\Settings\Abstract_Section && $section->autoload() ) { |
| 654 |
$names[] = $section->autoload_option_name(); |
| 655 |
} |
| 656 |
} |
| 657 |
return $names; |
| 658 |
} |
| 659 |
|
| 660 |
/** |
| 661 |
* Flip the per-request rows to autoload in place, and seed the settings |
| 662 |
* sections that are absent. |
| 663 |
* |
| 664 |
* One UPDATE on the flag column: never delete-and-recreate, because |
| 665 |
* `Sync_Api::SCHEMA_OPTION` gates the sync observers on every request and a |
| 666 |
* request landing in that gap would run with journaling off. 'yes' is |
| 667 |
* accepted by every core version (6.6+ maps it alongside 'on'). Idempotent: |
| 668 |
* already-autoloaded rows match nothing. Latches that were never written |
| 669 |
* stay absent (their absence is the signal). An autoloaded settings section |
| 670 |
* that was never saved is seeded as an autoloaded row — an absent option is |
| 671 |
* queried on every request too. General also persists its migrated consent |
| 672 |
* so the legacy row does not remain on the read path; other defaults stay |
| 673 |
* dynamic. |
| 674 |
*/ |
| 675 |
public static function autoload_request_latches(): void { |
| 676 |
global $wpdb; |
| 677 |
// The key comes from the section itself (autoload_option_name()): Pro's |
| 678 |
// License section stores under a Pro-prefixed key, so deriving it from |
| 679 |
// id() flipped nothing for that row and seeded a stray free-prefixed one. |
| 680 |
foreach ( Services\Settings::instance()->sections()->all() as $section ) { |
| 681 |
if ( ! $section instanceof Services\Settings\Abstract_Section || ! $section->autoload() ) { |
| 682 |
continue; |
| 683 |
} |
| 684 |
$option_name = $section->autoload_option_name(); |
| 685 |
if ( false === get_option( $option_name ) ) { |
| 686 |
$value = $section instanceof Services\Settings\General_Section |
| 687 |
? array( 'tracking_consent' => $section->raw_tracking_consent() ) |
| 688 |
: array(); |
| 689 |
add_option( $option_name, $value, '', true ); |
| 690 |
} |
| 691 |
} |
| 692 |
$options = self::request_option_names(); |
| 693 |
$placeholders = implode( ', ', array_fill( 0, \count( $options ), '%s' ) ); |
| 694 |
$flipped = $wpdb->query( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- the flag column is the target; caches are cleared below. |
| 695 |
$wpdb->prepare( |
| 696 |
"UPDATE {$wpdb->options} SET autoload = 'yes' WHERE option_name IN ({$placeholders}) AND autoload NOT IN ('yes', 'on', 'auto-on')", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- placeholders are generated for the prepared values. |
| 697 |
$options |
| 698 |
) |
| 699 |
); |
| 700 |
if ( ! $flipped ) { |
| 701 |
return; |
| 702 |
} |
| 703 |
foreach ( $options as $option ) { |
| 704 |
wp_cache_delete( $option, 'options' ); |
| 705 |
} |
| 706 |
wp_cache_delete( 'alloptions', 'options' ); |
| 707 |
} |
| 708 |
|
| 709 |
/** |
| 710 |
* If \WCPOS\WooCommercePOSPro\ is installed, check the version is above MIN_PRO_VERSION. |
| 711 |
*/ |
| 712 |
private function pro_version_check(): void { |
| 713 |
if ( class_exists( '\WCPOS\WooCommercePOSPro\Activator' ) ) { |
| 714 |
if ( version_compare( \WCPOS\WooCommercePOSPro\VERSION, MIN_PRO_VERSION, '<' ) ) { // @phpstan-ignore-line |
| 715 |
|
| 716 |
/* |
| 717 |
* NOTE: the deactivate_plugins function is not available in the frontend or ajax |
| 718 |
* This is an extreme situation where the Pro plugin could crash the site, so we need to deactivate it |
| 719 |
*/ |
| 720 |
if ( ! \function_exists( 'deactivate_plugins' ) ) { |
| 721 |
require_once ABSPATH . '/wp-admin/includes/plugin.php'; |
| 722 |
} |
| 723 |
|
| 724 |
// WCPOS Pro is activated, but the version is too low - use the constant for dynamic folder name. |
| 725 |
deactivate_plugins( \WCPOS\WooCommercePOSPro\PLUGIN_FILE ); // @phpstan-ignore-line |
| 726 |
|
| 727 |
// Defer __() call to avoid "too early" warning in WordPress 6.7+. |
| 728 |
add_action( |
| 729 |
'admin_init', |
| 730 |
function () { |
| 731 |
$message = \sprintf( |
| 732 |
// translators: 1: WCPOS Pro URL, 2: Minimum Pro version, 3: Plugins URL. |
| 733 |
__( '<strong>WCPOS</strong> requires <a href="%1$s">WCPOS Pro %2$s or higher</a>. Please <a href="%3$s">install and activate WCPOS Pro</a>', 'woocommerce-pos' ), |
| 734 |
'https://wcpos.com/my-account', |
| 735 |
MIN_PRO_VERSION, |
| 736 |
admin_url( 'plugins.php' ) |
| 737 |
) . ' »'; |
| 738 |
|
| 739 |
Admin\Notices::add( $message ); |
| 740 |
} |
| 741 |
); |
| 742 |
} |
| 743 |
} |
| 744 |
} |
| 745 |
} |
| 746 |
|
