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

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

woocommerce / includes Last commit date

class-wc-background-emailer.php

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