class.jetpack-autoupdate.php — Jetpack – WP Security, Backup, Speed, & Growth 14.9.2

jetpack / class.jetpack-autoupdate.php

jetpack Last commit date

class.jetpack-autoupdate.php

376 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Handles items that have been selected for automatic updates.
4	* Hooks into WP_Automatic_Updater
5	*
6	* @package automattic/jetpack
7	*/
8
9	/**
10	* Handles items that have been selected for automatic updates.
11	* Hooks into WP_Automatic_Updater
12	*/
13	class Jetpack_Autoupdate {
14
15	/**
16	* Results.
17	*
18	* @var array
19	*/
20	private $results = array();
21
22	/**
23	* Expected updates.
24	*
25	* @var array
26	*/
27	private $expected = array();
28
29	/**
30	* Successful updates.
31	*
32	* @var array
33	*/
34	private $success = array(
35	'plugin' => array(),
36	'theme' => array(),
37	);
38
39	/**
40	* Failed updates.
41	*
42	* @var array
43	*/
44	private $failed = array(
45	'plugin' => array(),
46	'theme' => array(),
47	);
48
49	/**
50	* Static instance.
51	*
52	* @var self
53	*/
54	private static $instance = null;
55
56	/**
57	* Initialize and fetch the static instance.
58	*
59	* @return self
60	*/
61	public static function init() {
62	if ( self::$instance === null ) {
63	self::$instance = new Jetpack_Autoupdate();
64	}
65
66	return self::$instance;
67	}
68
69	/** Constructor. */
70	private function __construct() {
71	if (
72	/** This filter is documented in class.jetpack-json-api-endpoint.php */
73	apply_filters( 'jetpack_json_manage_api_enabled', true )
74	) {
75	add_filter( 'auto_update_theme', array( $this, 'autoupdate_theme' ), 10, 2 );
76	add_filter( 'auto_update_core', array( $this, 'autoupdate_core' ), 10, 2 );
77	add_filter( 'auto_update_translation', array( $this, 'autoupdate_translation' ), 10, 2 );
78	add_action( 'automatic_updates_complete', array( $this, 'automatic_updates_complete' ), 999, 1 );
79	}
80	}
81
82	/**
83	* Filter function for `auto_update_translation`.
84	*
85	* @param bool\|null $update Whether to update.
86	* @param object $item The update offer.
87	* @return bool\|null Whether to update.
88	*/
89	public function autoupdate_translation( $update, $item ) {
90	// Autoupdate all translations.
91	if ( Jetpack_Options::get_option( 'autoupdate_translations', false ) ) {
92	return true;
93	}
94
95	if ( ! isset( $item->slug ) \|\| ! isset( $item->type ) ) {
96	return $update;
97	}
98
99	// Themes.
100	$autoupdate_themes_translations = Jetpack_Options::get_option( 'autoupdate_themes_translations', array() );
101	$autoupdate_theme_list = Jetpack_Options::get_option( 'autoupdate_themes', array() );
102
103	if ( ( in_array( $item->slug, $autoupdate_themes_translations, true ) \|\| in_array( $item->slug, $autoupdate_theme_list, true ) )
104	&& 'theme' === $item->type
105	) {
106	$this->expect( $item->type . ':' . $item->slug, 'translation' );
107
108	return true;
109	}
110
111	// Plugins.
112	$autoupdate_plugin_translations = Jetpack_Options::get_option( 'autoupdate_plugins_translations', array() );
113	$autoupdate_plugin_list = (array) get_site_option( 'auto_update_plugins', array() );
114	$plugin_files = array_unique( array_merge( $autoupdate_plugin_list, $autoupdate_plugin_translations ) );
115	$plugin_slugs = array_map( array( __CLASS__, 'get_plugin_slug' ), $plugin_files );
116
117	if ( in_array( $item->slug, $plugin_slugs, true )
118	&& 'plugin' === $item->type
119	) {
120	$this->expect( $item->type . ':' . $item->slug, 'translation' );
121	return true;
122	}
123
124	return $update;
125	}
126
127	/**
128	* Filter function for `auto_update_theme`.
129	*
130	* @param bool\|null $update Whether to update.
131	* @param object $item The update offer.
132	* @return bool\|null Whether to update.
133	*/
134	public function autoupdate_theme( $update, $item ) {
135	if ( ! isset( $item->theme ) ) {
136	return $update;
137	}
138	$autoupdate_theme_list = Jetpack_Options::get_option( 'autoupdate_themes', array() );
139	if ( in_array( $item->theme, $autoupdate_theme_list, true ) ) {
140	$this->expect( $item->theme, 'theme' );
141	return true;
142	}
143
144	return $update;
145	}
146
147	/**
148	* Filter function for `auto_update_core`.
149	*
150	* @param bool\|null $update Whether to update.
151	* @return bool\|null Whether to update.
152	*/
153	public function autoupdate_core( $update ) {
154	$autoupdate_core = Jetpack_Options::get_option( 'autoupdate_core', false );
155	if ( $autoupdate_core ) {
156	return $autoupdate_core;
157	}
158
159	return $update;
160	}
161
162	/**
163	* Stores the an item identifier to the expected array.
164	*
165	* @param string $item Example: 'jetpack/jetpack.php' for type 'plugin' or 'twentyfifteen' for type 'theme'.
166	* @param string $type 'plugin' or 'theme'.
167	*/
168	private function expect( $item, $type ) {
169	if ( ! isset( $this->expected[ $type ] ) ) {
170	$this->expected[ $type ] = array();
171	}
172	$this->expected[ $type ][] = $item;
173	}
174
175	/**
176	* On completion of an automatic update, let's store the results.
177	*
178	* @param mixed $results - Sent by WP_Automatic_Updater after it completes an autoupdate action. Results may be empty.
179	*/
180	public function automatic_updates_complete( $results ) {
181	if ( empty( $this->expected ) ) {
182	return;
183	}
184	$this->results = empty( $results ) ? self::get_possible_failures() : $results;
185
186	add_action( 'shutdown', array( $this, 'bump_stats' ) );
187
188	Jetpack::init();
189
190	$items_to_log = array( 'plugin', 'theme', 'translation' );
191	foreach ( $items_to_log as $items ) {
192	$this->log_items( $items );
193	}
194
195	Jetpack::log( 'autoupdates', $this->get_log() );
196	}
197
198	/**
199	* Get log data.
200	*
201	* @return array Data.
202	*/
203	public function get_log() {
204	return array(
205	'results' => $this->results,
206	'failed' => $this->failed,
207	'success' => $this->success,
208	);
209	}
210
211	/**
212	* Iterates through expected items ( plugins or themes ) and compares them to actual results.
213	*
214	* @param string $items 'plugin' or 'theme'.
215	*/
216	private function log_items( $items ) {
217	if ( ! isset( $this->expected[ $items ] ) ) {
218	return;
219	}
220
221	$item_results = $this->get_successful_updates( $items );
222
223	if ( is_array( $this->expected[ $items ] ) ) {
224	foreach ( $this->expected[ $items ] as $item ) {
225	if ( in_array( $item, $item_results, true ) ) {
226	$this->success[ $items ][] = $item;
227	} else {
228	$this->failed[ $items ][] = $item;
229	}
230	}
231	}
232	}
233
234	/**
235	* Bump stats.
236	*/
237	public function bump_stats() {
238	$instance = Jetpack::init();
239	$log = array();
240	// Bump numbers.
241
242	if ( ! empty( $this->success['theme'] ) ) {
243	$instance->stat( 'autoupdates/theme-success', is_countable( $this->success['theme'] ) ? count( $this->success['theme'] ) : 0 );
244	$log['themes_success'] = $this->success['theme'];
245	}
246
247	if ( ! empty( $this->failed['theme'] ) ) {
248	$instance->stat( 'autoupdates/theme-fail', is_countable( $this->failed['theme'] ) ? count( $this->failed['theme'] ) : 0 );
249	$log['themes_failed'] = $this->failed['theme'];
250	}
251
252	$instance->do_stats( 'server_side' );
253
254	// Send a more detailed log to logstash.
255	if ( ! empty( $log ) ) {
256	$xml = new Jetpack_IXR_Client(
257	array(
258	'user_id' => get_current_user_id(),
259	)
260	);
261	$log['blog_id'] = Jetpack_Options::get_option( 'id' );
262	$xml->query( 'jetpack.debug_autoupdate', $log );
263	}
264	}
265
266	/**
267	* Parses the autoupdate results generated by WP_Automatic_Updater and returns a simple array of successful items.
268	*
269	* @param string $type 'plugin' or 'theme'.
270	* @return array
271	*/
272	private function get_successful_updates( $type ) {
273	$successful_updates = array();
274
275	if ( ! isset( $this->results[ $type ] ) ) {
276	return $successful_updates;
277	}
278
279	foreach ( $this->results[ $type ] as $result ) {
280	if ( $result->result ) {
281	switch ( $type ) {
282	case 'theme':
283	$successful_updates[] = $result->item->theme;
284	break;
285	case 'translation':
286	$successful_updates[] = $result->item->type . ':' . $result->item->slug;
287	break;
288	}
289	}
290	}
291
292	return $successful_updates;
293	}
294
295	/**
296	* Get possible failure codes.
297	*
298	* @return string[] Failure codes.
299	*/
300	public static function get_possible_failures() {
301	$result = array();
302	// Lets check some reasons why it might not be working as expected.
303	include_once ABSPATH . '/wp-admin/includes/admin.php';
304	include_once ABSPATH . '/wp-admin/includes/class-wp-upgrader.php';
305	$upgrader = new WP_Automatic_Updater();
306
307	if ( $upgrader->is_disabled() ) {
308	$result[] = 'autoupdates-disabled';
309	}
310	if ( ! is_main_site() ) {
311	$result[] = 'is-not-main-site';
312	}
313	if ( ! is_main_network() ) {
314	$result[] = 'is-not-main-network';
315	}
316	if ( $upgrader->is_vcs_checkout( ABSPATH ) ) {
317	$result[] = 'site-on-vcs';
318	}
319	if ( $upgrader->is_vcs_checkout( WP_PLUGIN_DIR ) ) {
320	$result[] = 'plugin-directory-on-vcs';
321	}
322	if ( $upgrader->is_vcs_checkout( WP_CONTENT_DIR ) ) {
323	$result[] = 'content-directory-on-vcs';
324	}
325	$lock = get_option( 'auto_updater.lock' );
326	if ( $lock > ( time() - HOUR_IN_SECONDS ) ) {
327	$result[] = 'lock-is-set';
328	}
329	$skin = new Automatic_Upgrader_Skin();
330	include_once ABSPATH . 'wp-admin/includes/file.php';
331	include_once ABSPATH . 'wp-admin/includes/template.php';
332	if ( ! $skin->request_filesystem_credentials( false, ABSPATH, false ) ) {
333	$result[] = 'no-system-write-access';
334	}
335	if ( ! $skin->request_filesystem_credentials( false, WP_PLUGIN_DIR, false ) ) {
336	$result[] = 'no-plugin-directory-write-access';
337	}
338	if ( ! $skin->request_filesystem_credentials( false, WP_CONTENT_DIR, false ) ) {
339	$result[] = 'no-wp-content-directory-write-access';
340	}
341
342	return $result;
343	}
344
345	/**
346	* Get the plugin slug.
347	*
348	* @param string $plugin_file Plugin file.
349	* @return string Slug.
350	*/
351	public static function get_plugin_slug( $plugin_file ) {
352	$update_plugins = get_site_transient( 'update_plugins' );
353	if ( isset( $update_plugins->no_update ) ) {
354	if ( isset( $update_plugins->no_update[ $plugin_file ]->slug ) ) {
355	$slug = $update_plugins->no_update[ $plugin_file ]->slug;
356	}
357	}
358	if ( empty( $slug ) && isset( $update_plugins->response ) ) {
359	if ( isset( $update_plugins->response[ $plugin_file ]->slug ) ) {
360	$slug = $update_plugins->response[ $plugin_file ]->slug;
361	}
362	}
363
364	// Try to infer from the plugin file if not cached.
365	if ( empty( $slug ) ) {
366	$slug = dirname( $plugin_file );
367	if ( '.' === $slug ) {
368	$slug = preg_replace( '/(.+)\.php$/', '$1', $plugin_file );
369	}
370	}
371	return $slug;
372	}
373	}
374
375	Jetpack_Autoupdate::init();
376