class-wc-background-updater.php — WooCommerce 4.4.3

woocommerce / includes / class-wc-background-updater.php

woocommerce / includes Last commit date

class-wc-background-updater.php

146 lines

1	<?php
2	/**
3	* Background Updater
4	*
5	* @version 2.6.0
6	* @deprecated 3.6.0 Replaced with queue.
7	* @package WooCommerce/Classes
8	*/
9
10	defined( 'ABSPATH' ) \|\| exit;
11
12	if ( ! class_exists( 'WC_Background_Process', false ) ) {
13	include_once dirname( __FILE__ ) . '/abstracts/class-wc-background-process.php';
14	}
15
16	/**
17	* WC_Background_Updater Class.
18	*/
19	class WC_Background_Updater extends WC_Background_Process {
20
21	/**
22	* Initiate new background process.
23	*/
24	public function __construct() {
25	// Uses unique prefix per blog so each blog has separate queue.
26	$this->prefix = 'wp_' . get_current_blog_id();
27	$this->action = 'wc_updater';
28
29	parent::__construct();
30	}
31
32	/**
33	* Dispatch updater.
34	*
35	* Updater will still run via cron job if this fails for any reason.
36	*/
37	public function dispatch() {
38	$dispatched = parent::dispatch();
39	$logger = wc_get_logger();
40
41	if ( is_wp_error( $dispatched ) ) {
42	$logger->error(
43	sprintf( 'Unable to dispatch WooCommerce updater: %s', $dispatched->get_error_message() ),
44	array( 'source' => 'wc_db_updates' )
45	);
46	}
47	}
48
49	/**
50	* Handle cron healthcheck
51	*
52	* Restart the background process if not already running
53	* and data exists in the queue.
54	*/
55	public function handle_cron_healthcheck() {
56	if ( $this->is_process_running() ) {
57	// Background process already running.
58	return;
59	}
60
61	if ( $this->is_queue_empty() ) {
62	// No data to process.
63	$this->clear_scheduled_event();
64	return;
65	}
66
67	$this->handle();
68	}
69
70	/**
71	* Schedule fallback event.
72	*/
73	protected function schedule_event() {
74	if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
75	wp_schedule_event( time() + 10, $this->cron_interval_identifier, $this->cron_hook_identifier );
76	}
77	}
78
79	/**
80	* Is the updater running?
81	*
82	* @return boolean
83	*/
84	public function is_updating() {
85	return false === $this->is_queue_empty();
86	}
87
88	/**
89	* Task
90	*
91	* Override this method to perform any actions required on each
92	* queue item. Return the modified item for further processing
93	* in the next pass through. Or, return false to remove the
94	* item from the queue.
95	*
96	* @param string $callback Update callback function.
97	* @return string\|bool
98	*/
99	protected function task( $callback ) {
100	wc_maybe_define_constant( 'WC_UPDATING', true );
101
102	$logger = wc_get_logger();
103
104	include_once dirname( __FILE__ ) . '/wc-update-functions.php';
105
106	$result = false;
107
108	if ( is_callable( $callback ) ) {
109	$logger->info( sprintf( 'Running %s callback', $callback ), array( 'source' => 'wc_db_updates' ) );
110	$result = (bool) call_user_func( $callback, $this );
111
112	if ( $result ) {
113	$logger->info( sprintf( '%s callback needs to run again', $callback ), array( 'source' => 'wc_db_updates' ) );
114	} else {
115	$logger->info( sprintf( 'Finished running %s callback', $callback ), array( 'source' => 'wc_db_updates' ) );
116	}
117	} else {
118	$logger->notice( sprintf( 'Could not find %s callback', $callback ), array( 'source' => 'wc_db_updates' ) );
119	}
120
121	return $result ? $callback : false;
122	}
123
124	/**
125	* Complete
126	*
127	* Override if applicable, but ensure that the below actions are
128	* performed, or, call parent::complete().
129	*/
130	protected function complete() {
131	$logger = wc_get_logger();
132	$logger->info( 'Data update complete', array( 'source' => 'wc_db_updates' ) );
133	WC_Install::update_db_version();
134	parent::complete();
135	}
136
137	/**
138	* See if the batch limit has been exceeded.
139	*
140	* @return bool
141	*/
142	public function is_memory_exceeded() {
143	return $this->memory_exceeded();
144	}
145	}
146