class-wc-background-emailer.php — WooCommerce 10.8.1

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

woocommerce / includes Last commit date

class-wc-background-emailer.php

189 lines

1	<?php
2	/**
3	* Background Emailer
4	*
5	* @version 3.0.1
6	* @package WooCommerce\Classes
7	*/
8
9	use Automattic\Jetpack\Constants;
10
11	defined( 'ABSPATH' ) \|\| exit;
12
13	if ( ! class_exists( 'WC_Background_Process', false ) ) {
14	include_once dirname( __FILE__ ) . '/abstracts/class-wc-background-process.php';
15	}
16
17	/**
18	* WC_Background_Emailer Class.
19	*
20	* @deprecated 10.8.0 Deferred emails now use Action Scheduler. No stable public replacement exists.
21	*/
22	class WC_Background_Emailer extends WC_Background_Process {
23
24	/**
25	* Initiate new background process.
26	*/
27	public function __construct() {
28	// Uses unique prefix per blog so each blog has separate queue.
29	$this->prefix = 'wp_' . get_current_blog_id();
30	$this->action = 'wc_emailer';
31
32	// Dispatch queue after shutdown.
33	add_action( 'shutdown', array( $this, 'dispatch_queue' ), 100 );
34
35	parent::__construct();
36	}
37
38	/**
39	* Schedule fallback event.
40	*/
41	protected function schedule_event() {
42	if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
43	wp_schedule_event( time() + 10, $this->cron_interval_identifier, $this->cron_hook_identifier );
44	}
45	}
46
47	/**
48	* Task
49	*
50	* Override this method to perform any actions required on each
51	* queue item. Return the modified item for further processing
52	* in the next pass through. Or, return false to remove the
53	* item from the queue.
54	*
55	* @param array $callback Update callback function.
56	* @return mixed
57	*/
58	protected function task( $callback ) {
59	if ( isset( $callback['filter'], $callback['args'] ) ) {
60	try {
61	WC_Emails::send_queued_transactional_email( $callback['filter'], $callback['args'] );
62	} catch ( Exception $e ) {
63	if ( Constants::is_true( 'WP_DEBUG' ) ) {
64	trigger_error( 'Transactional email triggered fatal error for callback ' . esc_html( $callback['filter'] ), E_USER_WARNING ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
65	}
66	}
67	}
68	return false;
69	}
70
71	/**
72	* Finishes replying to the client, but keeps the process running for further (async) code execution.
73	*
74	* @see https://core.trac.wordpress.org/ticket/41358 .
75	*/
76	protected function close_http_connection() {
77	// Only 1 PHP process can access a session object at a time, close this so the next request isn't kept waiting.
78	// @codingStandardsIgnoreStart
79	if ( session_id() ) {
80	session_write_close();
81	}
82	// @codingStandardsIgnoreEnd
83
84	wc_set_time_limit( 0 );
85
86	// fastcgi_finish_request is the cleanest way to send the response and keep the script running, but not every server has it.
87	if ( is_callable( 'fastcgi_finish_request' ) ) {
88	fastcgi_finish_request();
89	} else {
90	// Fallback: send headers and flush buffers.
91	if ( ! headers_sent() ) {
92	header( 'Connection: close' );
93	}
94	@ob_end_flush(); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
95	flush();
96	}
97	}
98
99	/**
100	* Save and run queue.
101	*/
102	public function dispatch_queue() {
103	if ( ! empty( $this->data ) ) {
104	$this->close_http_connection();
105	$this->save()->dispatch();
106	}
107	}
108
109	/**
110	* Get post args
111	*
112	* @return array
113	*/
114	protected function get_post_args() {
115	if ( property_exists( $this, 'post_args' ) ) {
116	return $this->post_args;
117	}
118
119	// Pass cookies through with the request so nonces function.
120	$cookies = array();
121
122	foreach ( $_COOKIE as $name => $value ) { // WPCS: input var ok.
123	if ( 'PHPSESSID' === $name ) {
124	continue;
125	}
126	$cookies[] = new WP_Http_Cookie( array(
127	'name' => $name,
128	'value' => $value,
129	) );
130	}
131
132	return array(
133	'timeout' => 0.01,
134	'blocking' => false,
135	'body' => $this->data,
136	'cookies' => $cookies,
137	'sslverify' => apply_filters( 'https_local_ssl_verify', false ),
138	);
139	}
140
141	/**
142	* Handle
143	*
144	* Pass each queue item to the task handler, while remaining
145	* within server memory and time limit constraints.
146	*/
147	protected function handle() {
148	$this->lock_process();
149
150	do {
151	$batch = $this->get_batch();
152
153	if ( empty( $batch->data ) ) {
154	break;
155	}
156
157	foreach ( $batch->data as $key => $value ) {
158	$task = $this->task( $value );
159
160	if ( false !== $task ) {
161	$batch->data[ $key ] = $task;
162	} else {
163	unset( $batch->data[ $key ] );
164	}
165
166	// Update batch before sending more to prevent duplicate email possibility.
167	$this->update( $batch->key, $batch->data );
168
169	if ( $this->time_exceeded() \|\| $this->memory_exceeded() ) {
170	// Batch limits reached.
171	break;
172	}
173	}
174	if ( empty( $batch->data ) ) {
175	$this->delete( $batch->key );
176	}
177	} while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() );
178
179	$this->unlock_process();
180
181	// Start next batch or complete process.
182	if ( ! $this->is_queue_empty() ) {
183	$this->dispatch();
184	} else {
185	$this->complete();
186	}
187	}
188	}
189