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

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

woocommerce / includes Last commit date

class-wc-background-updater.php

135 lines

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