3 * A File upgrader class for WordPress.
5 * This set of classes are designed to be used to upgrade/install a local set of files on the filesystem via the Filesystem Abstraction classes.
7 * @link https://core.trac.wordpress.org/ticket/7875 consolidate plugin/theme/core upgrade/install functions
10 * @subpackage Upgrader
14 require ABSPATH . 'wp-admin/includes/class-wp-upgrader-skins.php';
17 * WordPress Upgrader class for Upgrading/Installing a local set of files via the Filesystem Abstraction classes from a Zip file.
20 * @subpackage Upgrader
26 * The error/notification strings used to update the user on the progress.
29 * @var string $strings
31 public $strings = array();
34 * The upgrader skin being used.
37 * @var WP_Upgrader_Skin $skin
42 * The result of the installation.
44 * This is set by {@see WP_Upgrader::install_package()}, only when the package is installed
45 * successfully. It will then be an array, unless a {@see WP_Error} is returned by the
46 * {@see 'upgrader_post_install'} filter. In that case, the `WP_Error` will be assigned to
50 * @var WP_Error|array $result {
51 * @type string $source The full path to the source the files were installed from.
52 * @type string $source_files List of all the files in the source directory.
53 * @type string $destination The full path to the install destination folder.
54 * @type string $destination_name The name of the destination folder, or empty if `$destination`
55 * and `$local_destination` are the same.
56 * @type string $local_destination The full local path to the destination folder. This is usually
57 * the same as `$destination`.
58 * @type string $remote_destination The full remote path to the destination folder
59 * (i.e., from `$wp_filesystem`).
60 * @type bool $clear_destination Whether the destination folder was cleared.
63 public $result = array();
66 * The total number of updates being performed.
68 * Set by the bulk update methods.
71 * @var int $update_count
73 public $update_count = 0;
76 * The current update if multiple updates are being performed.
78 * Used by the bulk update methods, and incremented for each update.
83 public $update_current = 0;
86 * Construct the upgrader with a skin.
90 * @param WP_Upgrader_Skin $skin The upgrader skin to use. Default is a {@see WP_Upgrader_Skin}
93 public function __construct( $skin = null ) {
95 $this->skin = new WP_Upgrader_Skin();
101 * Initialize the upgrader.
103 * This will set the relationship between the skin being used and this upgrader,
104 * and also add the generic strings to `WP_Upgrader::$strings`.
108 public function init() {
109 $this->skin->set_upgrader($this);
110 $this->generic_strings();
114 * Add the generic strings to WP_Upgrader::$strings.
118 public function generic_strings() {
119 $this->strings['bad_request'] = __('Invalid Data provided.');
120 $this->strings['fs_unavailable'] = __('Could not access filesystem.');
121 $this->strings['fs_error'] = __('Filesystem error.');
122 $this->strings['fs_no_root_dir'] = __('Unable to locate WordPress Root directory.');
123 $this->strings['fs_no_content_dir'] = __('Unable to locate WordPress Content directory (wp-content).');
124 $this->strings['fs_no_plugins_dir'] = __('Unable to locate WordPress Plugin directory.');
125 $this->strings['fs_no_themes_dir'] = __('Unable to locate WordPress Theme directory.');
126 /* translators: %s: directory name */
127 $this->strings['fs_no_folder'] = __('Unable to locate needed folder (%s).');
129 $this->strings['download_failed'] = __('Download failed.');
130 $this->strings['installing_package'] = __('Installing the latest version…');
131 $this->strings['no_files'] = __('The package contains no files.');
132 $this->strings['folder_exists'] = __('Destination folder already exists.');
133 $this->strings['mkdir_failed'] = __('Could not create directory.');
134 $this->strings['incompatible_archive'] = __('The package could not be installed.');
136 $this->strings['maintenance_start'] = __('Enabling Maintenance mode…');
137 $this->strings['maintenance_end'] = __('Disabling Maintenance mode…');
141 * Connect to the filesystem.
145 * @param array $directories Optional. A list of directories. If any of these do
146 * not exist, a {@see WP_Error} object will be returned.
147 * Default empty array.
148 * @param bool $allow_relaxed_file_ownership Whether to allow relaxed file ownership.
150 * @return bool|WP_Error True if able to connect, false or a {@see WP_Error} otherwise.
152 public function fs_connect( $directories = array(), $allow_relaxed_file_ownership = false ) {
153 global $wp_filesystem;
155 if ( false === ( $credentials = $this->skin->request_filesystem_credentials( false, $directories[0], $allow_relaxed_file_ownership ) ) ) {
159 if ( ! WP_Filesystem( $credentials, $directories[0], $allow_relaxed_file_ownership ) ) {
161 if ( is_object($wp_filesystem) && $wp_filesystem->errors->get_error_code() )
162 $error = $wp_filesystem->errors;
163 // Failed to connect, Error and request again
164 $this->skin->request_filesystem_credentials( $error, $directories[0], $allow_relaxed_file_ownership );
168 if ( ! is_object($wp_filesystem) )
169 return new WP_Error('fs_unavailable', $this->strings['fs_unavailable'] );
171 if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() )
172 return new WP_Error('fs_error', $this->strings['fs_error'], $wp_filesystem->errors);
174 foreach ( (array)$directories as $dir ) {
177 if ( ! $wp_filesystem->abspath() )
178 return new WP_Error('fs_no_root_dir', $this->strings['fs_no_root_dir']);
181 if ( ! $wp_filesystem->wp_content_dir() )
182 return new WP_Error('fs_no_content_dir', $this->strings['fs_no_content_dir']);
185 if ( ! $wp_filesystem->wp_plugins_dir() )
186 return new WP_Error('fs_no_plugins_dir', $this->strings['fs_no_plugins_dir']);
188 case get_theme_root():
189 if ( ! $wp_filesystem->wp_themes_dir() )
190 return new WP_Error('fs_no_themes_dir', $this->strings['fs_no_themes_dir']);
193 if ( ! $wp_filesystem->find_folder($dir) )
194 return new WP_Error( 'fs_no_folder', sprintf( $this->strings['fs_no_folder'], esc_html( basename( $dir ) ) ) );
199 } //end fs_connect();
202 * Download a package.
206 * @param string $package The URI of the package. If this is the full path to an
207 * existing local file, it will be returned untouched.
208 * @return string|WP_Error The full path to the downloaded package file, or a {@see WP_Error} object.
210 public function download_package( $package ) {
213 * Filter whether to return the package.
217 * @param bool $reply Whether to bail without returning the package.
219 * @param string $package The package file name.
220 * @param WP_Upgrader $this The WP_Upgrader instance.
222 $reply = apply_filters( 'upgrader_pre_download', false, $package, $this );
223 if ( false !== $reply )
226 if ( ! preg_match('!^(http|https|ftp)://!i', $package) && file_exists($package) ) //Local file or remote?
227 return $package; //must be a local file..
229 if ( empty($package) )
230 return new WP_Error('no_package', $this->strings['no_package']);
232 $this->skin->feedback('downloading_package', $package);
234 $download_file = download_url($package);
236 if ( is_wp_error($download_file) )
237 return new WP_Error('download_failed', $this->strings['download_failed'], $download_file->get_error_message());
239 return $download_file;
243 * Unpack a compressed package file.
247 * @param string $package Full path to the package file.
248 * @param bool $delete_package Optional. Whether to delete the package file after attempting
249 * to unpack it. Default true.
250 * @return string|WP_Error The path to the unpacked contents, or a {@see WP_Error} on failure.
252 public function unpack_package( $package, $delete_package = true ) {
253 global $wp_filesystem;
255 $this->skin->feedback('unpack_package');
257 $upgrade_folder = $wp_filesystem->wp_content_dir() . 'upgrade/';
259 //Clean up contents of upgrade directory beforehand.
260 $upgrade_files = $wp_filesystem->dirlist($upgrade_folder);
261 if ( !empty($upgrade_files) ) {
262 foreach ( $upgrade_files as $file )
263 $wp_filesystem->delete($upgrade_folder . $file['name'], true);
266 // We need a working directory - Strip off any .tmp or .zip suffixes
267 $working_dir = $upgrade_folder . basename( basename( $package, '.tmp' ), '.zip' );
269 // Clean up working directory
270 if ( $wp_filesystem->is_dir($working_dir) )
271 $wp_filesystem->delete($working_dir, true);
273 // Unzip package to working directory
274 $result = unzip_file( $package, $working_dir );
276 // Once extracted, delete the package if required.
277 if ( $delete_package )
280 if ( is_wp_error($result) ) {
281 $wp_filesystem->delete($working_dir, true);
282 if ( 'incompatible_archive' == $result->get_error_code() ) {
283 return new WP_Error( 'incompatible_archive', $this->strings['incompatible_archive'], $result->get_error_data() );
294 * Copies the contents of a package form a source directory, and installs them in
295 * a destination directory. Optionally removes the source. It can also optionally
296 * clear out the destination folder if it already exists.
300 * @param array|string $args {
301 * Optional. Array or string of arguments for installing a package. Default empty array.
303 * @type string $source Required path to the package source. Default empty.
304 * @type string $destination Required path to a folder to install the package in.
306 * @type bool $clear_destination Whether to delete any files already in the destination
307 * folder. Default false.
308 * @type bool $clear_working Whether to delete the files form the working directory
309 * after copying to the destination. Default false.
310 * @type bool $abort_if_destination_exists Whether to abort the installation if
311 * the destination folder already exists. Default true.
312 * @type array $hook_extra Extra arguments to pass to the filter hooks called by
313 * {@see WP_Upgrader::install_package()}. Default empty array.
316 * @return array|WP_Error The result (also stored in `WP_Upgrader:$result`), or a {@see WP_Error} on failure.
318 public function install_package( $args = array() ) {
319 global $wp_filesystem, $wp_theme_directories;
322 'source' => '', // Please always pass this
323 'destination' => '', // and this
324 'clear_destination' => false,
325 'clear_working' => false,
326 'abort_if_destination_exists' => true,
327 'hook_extra' => array()
330 $args = wp_parse_args($args, $defaults);
332 // These were previously extract()'d.
333 $source = $args['source'];
334 $destination = $args['destination'];
335 $clear_destination = $args['clear_destination'];
337 @set_time_limit( 300 );
339 if ( empty( $source ) || empty( $destination ) ) {
340 return new WP_Error( 'bad_request', $this->strings['bad_request'] );
342 $this->skin->feedback( 'installing_package' );
345 * Filter the install response before the installation has started.
347 * Returning a truthy value, or one that could be evaluated as a WP_Error
348 * will effectively short-circuit the installation, returning that value
353 * @param bool|WP_Error $response Response.
354 * @param array $hook_extra Extra arguments passed to hooked filters.
356 $res = apply_filters( 'upgrader_pre_install', true, $args['hook_extra'] );
357 if ( is_wp_error( $res ) ) {
361 //Retain the Original source and destinations
362 $remote_source = $args['source'];
363 $local_destination = $destination;
365 $source_files = array_keys( $wp_filesystem->dirlist( $remote_source ) );
366 $remote_destination = $wp_filesystem->find_folder( $local_destination );
368 //Locate which directory to copy to the new folder, This is based on the actual folder holding the files.
369 if ( 1 == count( $source_files ) && $wp_filesystem->is_dir( trailingslashit( $args['source'] ) . $source_files[0] . '/' ) ) { //Only one folder? Then we want its contents.
370 $source = trailingslashit( $args['source'] ) . trailingslashit( $source_files[0] );
371 } elseif ( count( $source_files ) == 0 ) {
372 return new WP_Error( 'incompatible_archive_empty', $this->strings['incompatible_archive'], $this->strings['no_files'] ); // There are no files?
373 } else { //It's only a single file, the upgrader will use the foldername of this file as the destination folder. foldername is based on zip filename.
374 $source = trailingslashit( $args['source'] );
378 * Filter the source file location for the upgrade package.
382 * @param string $source File source location.
383 * @param string $remote_source Remove file source location.
384 * @param WP_Upgrader $this WP_Upgrader instance.
386 $source = apply_filters( 'upgrader_source_selection', $source, $remote_source, $this );
387 if ( is_wp_error( $source ) ) {
391 // Has the source location changed? If so, we need a new source_files list.
392 if ( $source !== $remote_source ) {
393 $source_files = array_keys( $wp_filesystem->dirlist( $source ) );
396 * Protection against deleting files in any important base directories.
397 * Theme_Upgrader & Plugin_Upgrader also trigger this, as they pass the
398 * destination directory (WP_PLUGIN_DIR / wp-content/themes) intending
399 * to copy the directory into the directory, whilst they pass the source
400 * as the actual files to copy.
402 $protected_directories = array( ABSPATH, WP_CONTENT_DIR, WP_PLUGIN_DIR, WP_CONTENT_DIR . '/themes' );
404 if ( is_array( $wp_theme_directories ) ) {
405 $protected_directories = array_merge( $protected_directories, $wp_theme_directories );
407 if ( in_array( $destination, $protected_directories ) ) {
408 $remote_destination = trailingslashit( $remote_destination ) . trailingslashit( basename( $source ) );
409 $destination = trailingslashit( $destination ) . trailingslashit( basename( $source ) );
412 if ( $clear_destination ) {
413 //We're going to clear the destination if there's something there
414 $this->skin->feedback('remove_old');
416 if ( $wp_filesystem->exists( $remote_destination ) ) {
417 $removed = $wp_filesystem->delete( $remote_destination, true );
421 * Filter whether the upgrader cleared the destination.
425 * @param bool $removed Whether the destination was cleared.
426 * @param string $local_destination The local package destination.
427 * @param string $remote_destination The remote package destination.
428 * @param array $hook_extra Extra arguments passed to hooked filters.
430 $removed = apply_filters( 'upgrader_clear_destination', $removed, $local_destination, $remote_destination, $args['hook_extra'] );
432 if ( is_wp_error($removed) ) {
434 } elseif ( ! $removed ) {
435 return new WP_Error('remove_old_failed', $this->strings['remove_old_failed']);
437 } elseif ( $args['abort_if_destination_exists'] && $wp_filesystem->exists($remote_destination) ) {
438 //If we're not clearing the destination folder and something exists there already, Bail.
439 //But first check to see if there are actually any files in the folder.
440 $_files = $wp_filesystem->dirlist($remote_destination);
441 if ( ! empty($_files) ) {
442 $wp_filesystem->delete($remote_source, true); //Clear out the source files.
443 return new WP_Error('folder_exists', $this->strings['folder_exists'], $remote_destination );
447 //Create destination if needed
448 if ( ! $wp_filesystem->exists( $remote_destination ) ) {
449 if ( ! $wp_filesystem->mkdir( $remote_destination, FS_CHMOD_DIR ) ) {
450 return new WP_Error( 'mkdir_failed_destination', $this->strings['mkdir_failed'], $remote_destination );
453 // Copy new version of item into place.
454 $result = copy_dir($source, $remote_destination);
455 if ( is_wp_error($result) ) {
456 if ( $args['clear_working'] ) {
457 $wp_filesystem->delete( $remote_source, true );
462 //Clear the Working folder?
463 if ( $args['clear_working'] ) {
464 $wp_filesystem->delete( $remote_source, true );
467 $destination_name = basename( str_replace($local_destination, '', $destination) );
468 if ( '.' == $destination_name ) {
469 $destination_name = '';
472 $this->result = compact( 'source', 'source_files', 'destination', 'destination_name', 'local_destination', 'remote_destination', 'clear_destination' );
475 * Filter the install response after the installation has finished.
479 * @param bool $response Install response.
480 * @param array $hook_extra Extra arguments passed to hooked filters.
481 * @param array $result Installation result data.
483 $res = apply_filters( 'upgrader_post_install', true, $args['hook_extra'], $this->result );
485 if ( is_wp_error($res) ) {
486 $this->result = $res;
490 //Bombard the calling function will all the info which we've just used.
491 return $this->result;
495 * Run an upgrade/install.
497 * Attempts to download the package (if it is not a local file), unpack it, and
498 * install it in the destination folder.
502 * @param array $options {
503 * Array or string of arguments for upgrading/installing a package.
505 * @type string $package The full path or URI of the package to install.
507 * @type string $destination The full path to the destination folder.
509 * @type bool $clear_destination Whether to delete any files already in the
510 * destination folder. Default false.
511 * @type bool $clear_working Whether to delete the files form the working
512 * directory after copying to the destination.
514 * @type bool $abort_if_destination_exists Whether to abort the installation if the destination
515 * folder already exists. When true, `$clear_destination`
516 * should be false. Default true.
517 * @type bool $is_multi Whether this run is one of multiple upgrade/install
518 * actions being performed in bulk. When true, the skin
519 * {@see WP_Upgrader::header()} and {@see WP_Upgrader::footer()}
520 * aren't called. Default false.
521 * @type array $hook_extra Extra arguments to pass to the filter hooks called by
522 * {@see WP_Upgrader::run()}.
525 * @return array|false|WP_error The result from self::install_package() on success, otherwise a WP_Error,
526 * or false if unable to connect to the filesystem.
528 public function run( $options ) {
531 'package' => '', // Please always pass this.
532 'destination' => '', // And this
533 'clear_destination' => false,
534 'abort_if_destination_exists' => true, // Abort if the Destination directory exists, Pass clear_destination as false please
535 'clear_working' => true,
537 'hook_extra' => array() // Pass any extra $hook_extra args here, this will be passed to any hooked filters.
540 $options = wp_parse_args( $options, $defaults );
542 if ( ! $options['is_multi'] ) { // call $this->header separately if running multiple times
543 $this->skin->header();
546 // Connect to the Filesystem first.
547 $res = $this->fs_connect( array( WP_CONTENT_DIR, $options['destination'] ) );
548 // Mainly for non-connected filesystem.
550 if ( ! $options['is_multi'] ) {
551 $this->skin->footer();
556 $this->skin->before();
558 if ( is_wp_error($res) ) {
559 $this->skin->error($res);
560 $this->skin->after();
561 if ( ! $options['is_multi'] ) {
562 $this->skin->footer();
567 //Download the package (Note, This just returns the filename of the file if the package is a local file)
568 $download = $this->download_package( $options['package'] );
569 if ( is_wp_error($download) ) {
570 $this->skin->error($download);
571 $this->skin->after();
572 if ( ! $options['is_multi'] ) {
573 $this->skin->footer();
578 $delete_package = ( $download != $options['package'] ); // Do not delete a "local" file
580 //Unzips the file into a temporary directory
581 $working_dir = $this->unpack_package( $download, $delete_package );
582 if ( is_wp_error($working_dir) ) {
583 $this->skin->error($working_dir);
584 $this->skin->after();
585 if ( ! $options['is_multi'] ) {
586 $this->skin->footer();
591 //With the given options, this installs it to the destination directory.
592 $result = $this->install_package( array(
593 'source' => $working_dir,
594 'destination' => $options['destination'],
595 'clear_destination' => $options['clear_destination'],
596 'abort_if_destination_exists' => $options['abort_if_destination_exists'],
597 'clear_working' => $options['clear_working'],
598 'hook_extra' => $options['hook_extra']
601 $this->skin->set_result($result);
602 if ( is_wp_error($result) ) {
603 $this->skin->error($result);
604 $this->skin->feedback('process_failed');
607 $this->skin->feedback('process_success');
610 $this->skin->after();
612 if ( ! $options['is_multi'] ) {
614 /** This action is documented in wp-admin/includes/class-wp-upgrader.php */
615 do_action( 'upgrader_process_complete', $this, $options['hook_extra'] );
616 $this->skin->footer();
623 * Toggle maintenance mode for the site.
625 * Creates/deletes the maintenance file to enable/disable maintenance mode.
629 * @param bool $enable True to enable maintenance mode, false to disable.
631 public function maintenance_mode( $enable = false ) {
632 global $wp_filesystem;
633 $file = $wp_filesystem->abspath() . '.maintenance';
635 $this->skin->feedback('maintenance_start');
636 // Create maintenance file to signal that we are upgrading
637 $maintenance_string = '<?php $upgrading = ' . time() . '; ?>';
638 $wp_filesystem->delete($file);
639 $wp_filesystem->put_contents($file, $maintenance_string, FS_CHMOD_FILE);
640 } elseif ( ! $enable && $wp_filesystem->exists( $file ) ) {
641 $this->skin->feedback('maintenance_end');
642 $wp_filesystem->delete($file);
649 * Plugin Upgrader class for WordPress Plugins, It is designed to upgrade/install plugins from a local zip, remote zip URL, or uploaded zip file.
652 * @subpackage Upgrader
655 class Plugin_Upgrader extends WP_Upgrader {
658 * Plugin upgrade result.
661 * @var array|WP_Error $result
662 * @see WP_Upgrader::$result
667 * Whether a bulk upgrade/install is being performed.
672 public $bulk = false;
675 * Initialize the upgrade strings.
679 public function upgrade_strings() {
680 $this->strings['up_to_date'] = __('The plugin is at the latest version.');
681 $this->strings['no_package'] = __('Update package not available.');
682 $this->strings['downloading_package'] = __('Downloading update from <span class="code">%s</span>…');
683 $this->strings['unpack_package'] = __('Unpacking the update…');
684 $this->strings['remove_old'] = __('Removing the old version of the plugin…');
685 $this->strings['remove_old_failed'] = __('Could not remove the old plugin.');
686 $this->strings['process_failed'] = __('Plugin update failed.');
687 $this->strings['process_success'] = __('Plugin updated successfully.');
688 $this->strings['process_bulk_success'] = __('Plugins updated successfully.');
692 * Initialize the install strings.
696 public function install_strings() {
697 $this->strings['no_package'] = __('Install package not available.');
698 $this->strings['downloading_package'] = __('Downloading install package from <span class="code">%s</span>…');
699 $this->strings['unpack_package'] = __('Unpacking the package…');
700 $this->strings['installing_package'] = __('Installing the plugin…');
701 $this->strings['no_files'] = __('The plugin contains no files.');
702 $this->strings['process_failed'] = __('Plugin install failed.');
703 $this->strings['process_success'] = __('Plugin installed successfully.');
707 * Install a plugin package.
710 * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
712 * @param string $package The full local path or URI of the package.
713 * @param array $args {
714 * Optional. Other arguments for installing a plugin package. Default empty array.
716 * @type bool $clear_update_cache Whether to clear the plugin updates cache if successful.
720 * @return bool|WP_Error True if the install was successful, false or a WP_Error otherwise.
722 public function install( $package, $args = array() ) {
725 'clear_update_cache' => true,
727 $parsed_args = wp_parse_args( $args, $defaults );
730 $this->install_strings();
732 add_filter('upgrader_source_selection', array($this, 'check_package') );
735 'package' => $package,
736 'destination' => WP_PLUGIN_DIR,
737 'clear_destination' => false, // Do not overwrite files.
738 'clear_working' => true,
739 'hook_extra' => array(
741 'action' => 'install',
745 remove_filter('upgrader_source_selection', array($this, 'check_package') );
747 if ( ! $this->result || is_wp_error($this->result) )
748 return $this->result;
750 // Force refresh of plugin update information
751 wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
760 * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
762 * @param string $plugin The basename path to the main plugin file.
763 * @param array $args {
764 * Optional. Other arguments for upgrading a plugin package. Defualt empty array.
766 * @type bool $clear_update_cache Whether to clear the plugin updates cache if successful.
769 * @return bool|WP_Error True if the upgrade was successful, false or a {@see WP_Error} object otherwise.
771 public function upgrade( $plugin, $args = array() ) {
774 'clear_update_cache' => true,
776 $parsed_args = wp_parse_args( $args, $defaults );
779 $this->upgrade_strings();
781 $current = get_site_transient( 'update_plugins' );
782 if ( !isset( $current->response[ $plugin ] ) ) {
783 $this->skin->before();
784 $this->skin->set_result(false);
785 $this->skin->error('up_to_date');
786 $this->skin->after();
790 // Get the URL to the zip file
791 $r = $current->response[ $plugin ];
793 add_filter('upgrader_pre_install', array($this, 'deactivate_plugin_before_upgrade'), 10, 2);
794 add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4);
795 //'source_selection' => array($this, 'source_selection'), //there's a trac ticket to move up the directory for zip's which are made a bit differently, useful for non-.org plugins.
798 'package' => $r->package,
799 'destination' => WP_PLUGIN_DIR,
800 'clear_destination' => true,
801 'clear_working' => true,
802 'hook_extra' => array(
805 'action' => 'update',
809 // Cleanup our hooks, in case something else does a upgrade on this connection.
810 remove_filter('upgrader_pre_install', array($this, 'deactivate_plugin_before_upgrade'));
811 remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'));
813 if ( ! $this->result || is_wp_error($this->result) )
814 return $this->result;
816 // Force refresh of plugin update information
817 wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
823 * Bulk upgrade several plugins at once.
826 * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
828 * @param array $plugins Array of the basename paths of the plugins' main files.
829 * @param array $args {
830 * Optional. Other arguments for upgrading several plugins at once. Default empty array.
832 * @type bool $clear_update_cache Whether to clear the plugin updates cache if successful.
836 * @return array|false An array of results indexed by plugin file, or false if unable to connect to the filesystem.
838 public function bulk_upgrade( $plugins, $args = array() ) {
841 'clear_update_cache' => true,
843 $parsed_args = wp_parse_args( $args, $defaults );
847 $this->upgrade_strings();
849 $current = get_site_transient( 'update_plugins' );
851 add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4);
853 $this->skin->header();
855 // Connect to the Filesystem first.
856 $res = $this->fs_connect( array(WP_CONTENT_DIR, WP_PLUGIN_DIR) );
858 $this->skin->footer();
862 $this->skin->bulk_header();
864 // Only start maintenance mode if:
865 // - running Multisite and there are one or more plugins specified, OR
866 // - a plugin with an update available is currently active.
867 // @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
868 $maintenance = ( is_multisite() && ! empty( $plugins ) );
869 foreach ( $plugins as $plugin )
870 $maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
872 $this->maintenance_mode(true);
876 $this->update_count = count($plugins);
877 $this->update_current = 0;
878 foreach ( $plugins as $plugin ) {
879 $this->update_current++;
880 $this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true);
882 if ( !isset( $current->response[ $plugin ] ) ) {
883 $this->skin->set_result('up_to_date');
884 $this->skin->before();
885 $this->skin->feedback('up_to_date');
886 $this->skin->after();
887 $results[$plugin] = true;
891 // Get the URL to the zip file
892 $r = $current->response[ $plugin ];
894 $this->skin->plugin_active = is_plugin_active($plugin);
896 $result = $this->run( array(
897 'package' => $r->package,
898 'destination' => WP_PLUGIN_DIR,
899 'clear_destination' => true,
900 'clear_working' => true,
902 'hook_extra' => array(
907 $results[$plugin] = $this->result;
909 // Prevent credentials auth screen from displaying multiple times
910 if ( false === $result )
912 } //end foreach $plugins
914 $this->maintenance_mode(false);
917 * Fires when the bulk upgrader process is complete.
921 * @param Plugin_Upgrader $this Plugin_Upgrader instance. In other contexts, $this, might
922 * be a Theme_Upgrader or Core_Upgrade instance.
923 * @param array $data {
924 * Array of bulk item update data.
926 * @type string $action Type of action. Default 'update'.
927 * @type string $type Type of update process. Accepts 'plugin', 'theme', or 'core'.
928 * @type bool $bulk Whether the update process is a bulk update. Default true.
929 * @type array $packages Array of plugin, theme, or core packages to update.
932 do_action( 'upgrader_process_complete', $this, array(
933 'action' => 'update',
936 'plugins' => $plugins,
939 $this->skin->bulk_footer();
941 $this->skin->footer();
943 // Cleanup our hooks, in case something else does a upgrade on this connection.
944 remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'));
946 // Force refresh of plugin update information
947 wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
953 * Check a source package to be sure it contains a plugin.
955 * This function is added to the {@see 'upgrader_source_selection'} filter by
956 * {@see Plugin_Upgrader::install()}.
960 * @param string $source The path to the downloaded package source.
961 * @return string|WP_Error The source as passed, or a {@see WP_Error} object if no plugins were found.
963 public function check_package($source) {
964 global $wp_filesystem;
966 if ( is_wp_error($source) )
969 $working_directory = str_replace( $wp_filesystem->wp_content_dir(), trailingslashit(WP_CONTENT_DIR), $source);
970 if ( ! is_dir($working_directory) ) // Sanity check, if the above fails, let's not prevent installation.
973 // Check the folder contains at least 1 valid plugin.
974 $plugins_found = false;
975 foreach ( glob( $working_directory . '*.php' ) as $file ) {
976 $info = get_plugin_data($file, false, false);
977 if ( !empty( $info['Name'] ) ) {
978 $plugins_found = true;
983 if ( ! $plugins_found )
984 return new WP_Error( 'incompatible_archive_no_plugins', $this->strings['incompatible_archive'], __( 'No valid plugins were found.' ) );
990 * Retrieve the path to the file that contains the plugin info.
992 * This isn't used internally in the class, but is called by the skins.
996 * @return string|false The full path to the main plugin file, or false.
998 public function plugin_info() {
999 if ( ! is_array($this->result) )
1001 if ( empty($this->result['destination_name']) )
1004 $plugin = get_plugins('/' . $this->result['destination_name']); //Ensure to pass with leading slash
1005 if ( empty($plugin) )
1008 $pluginfiles = array_keys($plugin); //Assume the requested plugin is the first in the list
1010 return $this->result['destination_name'] . '/' . $pluginfiles[0];
1014 * Deactivates a plugin before it is upgraded.
1016 * Hooked to the {@see 'upgrader_pre_install'} filter by {@see Plugin_Upgrader::upgrade()}.
1019 * @since 4.1.0 Added a return value.
1021 * @param bool|WP_Error $return Upgrade offer return.
1022 * @param array $plugin Plugin package arguments.
1023 * @return bool|WP_Error The passed in $return param or {@see WP_Error}.
1025 public function deactivate_plugin_before_upgrade($return, $plugin) {
1027 if ( is_wp_error($return) ) //Bypass.
1030 // When in cron (background updates) don't deactivate the plugin, as we require a browser to reactivate it
1031 if ( defined( 'DOING_CRON' ) && DOING_CRON )
1034 $plugin = isset($plugin['plugin']) ? $plugin['plugin'] : '';
1035 if ( empty($plugin) )
1036 return new WP_Error('bad_request', $this->strings['bad_request']);
1038 if ( is_plugin_active($plugin) ) {
1039 //Deactivate the plugin silently, Prevent deactivation hooks from running.
1040 deactivate_plugins($plugin, true);
1047 * Delete the old plugin during an upgrade.
1049 * Hooked to the {@see 'upgrader_clear_destination'} filter by
1050 * {@see Plugin_Upgrader::upgrade()} and {@see Plugin_Upgrader::bulk_upgrade()}.
1054 public function delete_old_plugin($removed, $local_destination, $remote_destination, $plugin) {
1055 global $wp_filesystem;
1057 if ( is_wp_error($removed) )
1058 return $removed; //Pass errors through.
1060 $plugin = isset($plugin['plugin']) ? $plugin['plugin'] : '';
1061 if ( empty($plugin) )
1062 return new WP_Error('bad_request', $this->strings['bad_request']);
1064 $plugins_dir = $wp_filesystem->wp_plugins_dir();
1065 $this_plugin_dir = trailingslashit( dirname($plugins_dir . $plugin) );
1067 if ( ! $wp_filesystem->exists($this_plugin_dir) ) //If it's already vanished.
1070 // If plugin is in its own directory, recursively delete the directory.
1071 if ( strpos($plugin, '/') && $this_plugin_dir != $plugins_dir ) //base check on if plugin includes directory separator AND that it's not the root plugin folder
1072 $deleted = $wp_filesystem->delete($this_plugin_dir, true);
1074 $deleted = $wp_filesystem->delete($plugins_dir . $plugin);
1077 return new WP_Error('remove_old_failed', $this->strings['remove_old_failed']);
1084 * Theme Upgrader class for WordPress Themes, It is designed to upgrade/install themes from a local zip, remote zip URL, or uploaded zip file.
1086 * @package WordPress
1087 * @subpackage Upgrader
1090 class Theme_Upgrader extends WP_Upgrader {
1093 * Result of the theme upgrade offer.
1096 * @var array|WP_Erorr $result
1097 * @see WP_Upgrader::$result
1102 * Whether multiple plugins are being upgraded/installed in bulk.
1107 public $bulk = false;
1110 * Initialize the upgrade strings.
1114 public function upgrade_strings() {
1115 $this->strings['up_to_date'] = __('The theme is at the latest version.');
1116 $this->strings['no_package'] = __('Update package not available.');
1117 $this->strings['downloading_package'] = __('Downloading update from <span class="code">%s</span>…');
1118 $this->strings['unpack_package'] = __('Unpacking the update…');
1119 $this->strings['remove_old'] = __('Removing the old version of the theme…');
1120 $this->strings['remove_old_failed'] = __('Could not remove the old theme.');
1121 $this->strings['process_failed'] = __('Theme update failed.');
1122 $this->strings['process_success'] = __('Theme updated successfully.');
1126 * Initialize the install strings.
1130 public function install_strings() {
1131 $this->strings['no_package'] = __('Install package not available.');
1132 $this->strings['downloading_package'] = __('Downloading install package from <span class="code">%s</span>…');
1133 $this->strings['unpack_package'] = __('Unpacking the package…');
1134 $this->strings['installing_package'] = __('Installing the theme…');
1135 $this->strings['no_files'] = __('The theme contains no files.');
1136 $this->strings['process_failed'] = __('Theme install failed.');
1137 $this->strings['process_success'] = __('Theme installed successfully.');
1138 /* translators: 1: theme name, 2: version */
1139 $this->strings['process_success_specific'] = __('Successfully installed the theme <strong>%1$s %2$s</strong>.');
1140 $this->strings['parent_theme_search'] = __('This theme requires a parent theme. Checking if it is installed…');
1141 /* translators: 1: theme name, 2: version */
1142 $this->strings['parent_theme_prepare_install'] = __('Preparing to install <strong>%1$s %2$s</strong>…');
1143 /* translators: 1: theme name, 2: version */
1144 $this->strings['parent_theme_currently_installed'] = __('The parent theme, <strong>%1$s %2$s</strong>, is currently installed.');
1145 /* translators: 1: theme name, 2: version */
1146 $this->strings['parent_theme_install_success'] = __('Successfully installed the parent theme, <strong>%1$s %2$s</strong>.');
1147 $this->strings['parent_theme_not_found'] = __('<strong>The parent theme could not be found.</strong> You will need to install the parent theme, <strong>%s</strong>, before you can use this child theme.');
1151 * Check if a child theme is being installed and we need to install its parent.
1153 * Hooked to the {@see 'upgrader_post_install'} filter by {@see Theme_Upgrader::install()}.
1157 public function check_parent_theme_filter( $install_result, $hook_extra, $child_result ) {
1158 // Check to see if we need to install a parent theme
1159 $theme_info = $this->theme_info();
1161 if ( ! $theme_info->parent() )
1162 return $install_result;
1164 $this->skin->feedback( 'parent_theme_search' );
1166 if ( ! $theme_info->parent()->errors() ) {
1167 $this->skin->feedback( 'parent_theme_currently_installed', $theme_info->parent()->display('Name'), $theme_info->parent()->display('Version') );
1168 // We already have the theme, fall through.
1169 return $install_result;
1172 // We don't have the parent theme, let's install it.
1173 $api = themes_api('theme_information', array('slug' => $theme_info->get('Template'), 'fields' => array('sections' => false, 'tags' => false) ) ); //Save on a bit of bandwidth.
1175 if ( ! $api || is_wp_error($api) ) {
1176 $this->skin->feedback( 'parent_theme_not_found', $theme_info->get('Template') );
1177 // Don't show activate or preview actions after install
1178 add_filter('install_theme_complete_actions', array($this, 'hide_activate_preview_actions') );
1179 return $install_result;
1182 // Backup required data we're going to override:
1183 $child_api = $this->skin->api;
1184 $child_success_message = $this->strings['process_success'];
1187 $this->skin->api = $api;
1188 $this->strings['process_success_specific'] = $this->strings['parent_theme_install_success'];//, $api->name, $api->version);
1190 $this->skin->feedback('parent_theme_prepare_install', $api->name, $api->version);
1192 add_filter('install_theme_complete_actions', '__return_false', 999); // Don't show any actions after installing the theme.
1194 // Install the parent theme
1195 $parent_result = $this->run( array(
1196 'package' => $api->download_link,
1197 'destination' => get_theme_root(),
1198 'clear_destination' => false, //Do not overwrite files.
1199 'clear_working' => true
1202 if ( is_wp_error($parent_result) )
1203 add_filter('install_theme_complete_actions', array($this, 'hide_activate_preview_actions') );
1205 // Start cleaning up after the parents installation
1206 remove_filter('install_theme_complete_actions', '__return_false', 999);
1208 // Reset child's result and data
1209 $this->result = $child_result;
1210 $this->skin->api = $child_api;
1211 $this->strings['process_success'] = $child_success_message;
1213 return $install_result;
1217 * Don't display the activate and preview actions to the user.
1219 * Hooked to the {@see 'install_theme_complete_actions'} filter by
1220 * {@see Theme_Upgrader::check_parent_theme_filter()} when installing
1221 * a child theme and installing the parent theme fails.
1225 * @param array $actions Preview actions.
1227 public function hide_activate_preview_actions( $actions ) {
1228 unset($actions['activate'], $actions['preview']);
1233 * Install a theme package.
1236 * @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
1238 * @param string $package The full local path or URI of the package.
1239 * @param array $args {
1240 * Optional. Other arguments for installing a theme package. Default empty array.
1242 * @type bool $clear_update_cache Whether to clear the updates cache if successful.
1246 * @return bool|WP_Error True if the install was successful, false or a {@see WP_Error} object otherwise.
1248 public function install( $package, $args = array() ) {
1251 'clear_update_cache' => true,
1253 $parsed_args = wp_parse_args( $args, $defaults );
1256 $this->install_strings();
1258 add_filter('upgrader_source_selection', array($this, 'check_package') );
1259 add_filter('upgrader_post_install', array($this, 'check_parent_theme_filter'), 10, 3);
1262 'package' => $package,
1263 'destination' => get_theme_root(),
1264 'clear_destination' => false, //Do not overwrite files.
1265 'clear_working' => true,
1266 'hook_extra' => array(
1268 'action' => 'install',
1272 remove_filter('upgrader_source_selection', array($this, 'check_package') );
1273 remove_filter('upgrader_post_install', array($this, 'check_parent_theme_filter'));
1275 if ( ! $this->result || is_wp_error($this->result) )
1276 return $this->result;
1278 // Refresh the Theme Update information
1279 wp_clean_themes_cache( $parsed_args['clear_update_cache'] );
1288 * @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
1290 * @param string $theme The theme slug.
1291 * @param array $args {
1292 * Optional. Other arguments for upgrading a theme. Default empty array.
1294 * @type bool $clear_update_cache Whether to clear the update cache if successful.
1297 * @return bool|WP_Error True if the upgrade was successful, false or a {@see WP_Error} object otherwise.
1299 public function upgrade( $theme, $args = array() ) {
1302 'clear_update_cache' => true,
1304 $parsed_args = wp_parse_args( $args, $defaults );
1307 $this->upgrade_strings();
1309 // Is an update available?
1310 $current = get_site_transient( 'update_themes' );
1311 if ( !isset( $current->response[ $theme ] ) ) {
1312 $this->skin->before();
1313 $this->skin->set_result(false);
1314 $this->skin->error( 'up_to_date' );
1315 $this->skin->after();
1319 $r = $current->response[ $theme ];
1321 add_filter('upgrader_pre_install', array($this, 'current_before'), 10, 2);
1322 add_filter('upgrader_post_install', array($this, 'current_after'), 10, 2);
1323 add_filter('upgrader_clear_destination', array($this, 'delete_old_theme'), 10, 4);
1326 'package' => $r['package'],
1327 'destination' => get_theme_root( $theme ),
1328 'clear_destination' => true,
1329 'clear_working' => true,
1330 'hook_extra' => array(
1333 'action' => 'update',
1337 remove_filter('upgrader_pre_install', array($this, 'current_before'));
1338 remove_filter('upgrader_post_install', array($this, 'current_after'));
1339 remove_filter('upgrader_clear_destination', array($this, 'delete_old_theme'));
1341 if ( ! $this->result || is_wp_error($this->result) )
1342 return $this->result;
1344 wp_clean_themes_cache( $parsed_args['clear_update_cache'] );
1350 * Upgrade several themes at once.
1353 * @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
1355 * @param array $themes The theme slugs.
1356 * @param array $args {
1357 * Optional. Other arguments for upgrading several themes at once. Default empty array.
1359 * @type bool $clear_update_cache Whether to clear the update cache if successful.
1362 * @return array[]|false An array of results, or false if unable to connect to the filesystem.
1364 public function bulk_upgrade( $themes, $args = array() ) {
1367 'clear_update_cache' => true,
1369 $parsed_args = wp_parse_args( $args, $defaults );
1373 $this->upgrade_strings();
1375 $current = get_site_transient( 'update_themes' );
1377 add_filter('upgrader_pre_install', array($this, 'current_before'), 10, 2);
1378 add_filter('upgrader_post_install', array($this, 'current_after'), 10, 2);
1379 add_filter('upgrader_clear_destination', array($this, 'delete_old_theme'), 10, 4);
1381 $this->skin->header();
1383 // Connect to the Filesystem first.
1384 $res = $this->fs_connect( array(WP_CONTENT_DIR) );
1386 $this->skin->footer();
1390 $this->skin->bulk_header();
1392 // Only start maintenance mode if:
1393 // - running Multisite and there are one or more themes specified, OR
1394 // - a theme with an update available is currently in use.
1395 // @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
1396 $maintenance = ( is_multisite() && ! empty( $themes ) );
1397 foreach ( $themes as $theme )
1398 $maintenance = $maintenance || $theme == get_stylesheet() || $theme == get_template();
1400 $this->maintenance_mode(true);
1404 $this->update_count = count($themes);
1405 $this->update_current = 0;
1406 foreach ( $themes as $theme ) {
1407 $this->update_current++;
1409 $this->skin->theme_info = $this->theme_info($theme);
1411 if ( !isset( $current->response[ $theme ] ) ) {
1412 $this->skin->set_result(true);
1413 $this->skin->before();
1414 $this->skin->feedback( 'up_to_date' );
1415 $this->skin->after();
1416 $results[$theme] = true;
1420 // Get the URL to the zip file
1421 $r = $current->response[ $theme ];
1423 $result = $this->run( array(
1424 'package' => $r['package'],
1425 'destination' => get_theme_root( $theme ),
1426 'clear_destination' => true,
1427 'clear_working' => true,
1429 'hook_extra' => array(
1434 $results[$theme] = $this->result;
1436 // Prevent credentials auth screen from displaying multiple times
1437 if ( false === $result )
1439 } //end foreach $plugins
1441 $this->maintenance_mode(false);
1443 /** This action is documented in wp-admin/includes/class-wp-upgrader.php */
1444 do_action( 'upgrader_process_complete', $this, array(
1445 'action' => 'update',
1448 'themes' => $themes,
1451 $this->skin->bulk_footer();
1453 $this->skin->footer();
1455 // Cleanup our hooks, in case something else does a upgrade on this connection.
1456 remove_filter('upgrader_pre_install', array($this, 'current_before'));
1457 remove_filter('upgrader_post_install', array($this, 'current_after'));
1458 remove_filter('upgrader_clear_destination', array($this, 'delete_old_theme'));
1460 // Refresh the Theme Update information
1461 wp_clean_themes_cache( $parsed_args['clear_update_cache'] );
1467 * Check that the package source contains a valid theme.
1469 * Hooked to the {@see 'upgrader_source_selection'} filter by {@see Theme_Upgrader::install()}.
1470 * It will return an error if the theme doesn't have style.css or index.php
1475 * @param string $source The full path to the package source.
1476 * @return string|WP_Error The source or a WP_Error.
1478 public function check_package( $source ) {
1479 global $wp_filesystem;
1481 if ( is_wp_error($source) )
1484 // Check the folder contains a valid theme
1485 $working_directory = str_replace( $wp_filesystem->wp_content_dir(), trailingslashit(WP_CONTENT_DIR), $source);
1486 if ( ! is_dir($working_directory) ) // Sanity check, if the above fails, let's not prevent installation.
1489 // A proper archive should have a style.css file in the single subdirectory
1490 if ( ! file_exists( $working_directory . 'style.css' ) )
1491 return new WP_Error( 'incompatible_archive_theme_no_style', $this->strings['incompatible_archive'], __( 'The theme is missing the <code>style.css</code> stylesheet.' ) );
1493 $info = get_file_data( $working_directory . 'style.css', array( 'Name' => 'Theme Name', 'Template' => 'Template' ) );
1495 if ( empty( $info['Name'] ) )
1496 return new WP_Error( 'incompatible_archive_theme_no_name', $this->strings['incompatible_archive'], __( "The <code>style.css</code> stylesheet doesn't contain a valid theme header." ) );
1498 // If it's not a child theme, it must have at least an index.php to be legit.
1499 if ( empty( $info['Template'] ) && ! file_exists( $working_directory . 'index.php' ) )
1500 return new WP_Error( 'incompatible_archive_theme_no_index', $this->strings['incompatible_archive'], __( 'The theme is missing the <code>index.php</code> file.' ) );
1506 * Turn on maintenance mode before attempting to upgrade the current theme.
1508 * Hooked to the {@see 'upgrader_pre_install'} filter by {@see Theme_Upgrader::upgrade()} and
1509 * {@see Theme_Upgrader::bulk_upgrade()}.
1513 public function current_before($return, $theme) {
1515 if ( is_wp_error($return) )
1518 $theme = isset($theme['theme']) ? $theme['theme'] : '';
1520 if ( $theme != get_stylesheet() ) //If not current
1522 //Change to maintenance mode now.
1523 if ( ! $this->bulk )
1524 $this->maintenance_mode(true);
1530 * Turn off maintenance mode after upgrading the current theme.
1532 * Hooked to the {@see 'upgrader_post_install'} filter by {@see Theme_Upgrader::upgrade()}
1533 * and {@see Theme_Upgrader::bulk_upgrade()}.
1537 public function current_after($return, $theme) {
1538 if ( is_wp_error($return) )
1541 $theme = isset($theme['theme']) ? $theme['theme'] : '';
1543 if ( $theme != get_stylesheet() ) // If not current
1546 // Ensure stylesheet name hasn't changed after the upgrade:
1547 if ( $theme == get_stylesheet() && $theme != $this->result['destination_name'] ) {
1548 wp_clean_themes_cache();
1549 $stylesheet = $this->result['destination_name'];
1550 switch_theme( $stylesheet );
1553 //Time to remove maintenance mode
1554 if ( ! $this->bulk )
1555 $this->maintenance_mode(false);
1560 * Delete the old theme during an upgrade.
1562 * Hooked to the {@see 'upgrader_clear_destination'} filter by {@see Theme_Upgrader::upgrade()}
1563 * and {@see Theme_Upgrader::bulk_upgrade()}.
1567 public function delete_old_theme( $removed, $local_destination, $remote_destination, $theme ) {
1568 global $wp_filesystem;
1570 if ( is_wp_error( $removed ) )
1571 return $removed; // Pass errors through.
1573 if ( ! isset( $theme['theme'] ) )
1576 $theme = $theme['theme'];
1577 $themes_dir = trailingslashit( $wp_filesystem->wp_themes_dir( $theme ) );
1578 if ( $wp_filesystem->exists( $themes_dir . $theme ) ) {
1579 if ( ! $wp_filesystem->delete( $themes_dir . $theme, true ) )
1587 * Get the WP_Theme object for a theme.
1590 * @since 3.0.0 The `$theme` argument was added.
1592 * @param string $theme The directory name of the theme. This is optional, and if not supplied,
1593 * the directory name from the last result will be used.
1594 * @return WP_Theme|false The theme's info object, or false `$theme` is not supplied
1595 * and the last result isn't set.
1597 public function theme_info($theme = null) {
1599 if ( empty($theme) ) {
1600 if ( !empty($this->result['destination_name']) )
1601 $theme = $this->result['destination_name'];
1605 return wp_get_theme( $theme );
1610 add_action( 'upgrader_process_complete', array( 'Language_Pack_Upgrader', 'async_upgrade' ), 20 );
1613 * Language pack upgrader, for updating translations of plugins, themes, and core.
1615 * @package WordPress
1616 * @subpackage Upgrader
1619 class Language_Pack_Upgrader extends WP_Upgrader {
1622 * Result of the language pack upgrade.
1625 * @var array|WP_Error $result
1626 * @see WP_Upgrader::$result
1631 * Whether a bulk upgrade/install is being performed.
1636 public $bulk = true;
1639 * Asynchronously upgrade language packs after other upgrades have been made.
1641 * Hooked to the {@see 'upgrader_process_complete'} action by default.
1645 public static function async_upgrade( $upgrader = false ) {
1647 if ( $upgrader && $upgrader instanceof Language_Pack_Upgrader ) {
1652 $language_updates = wp_get_translation_updates();
1653 if ( ! $language_updates ) {
1657 // Avoid messing with VCS installs, at least for now.
1658 // Noted: this is not the ideal way to accomplish this.
1659 $check_vcs = new WP_Automatic_Updater;
1660 if ( $check_vcs->is_vcs_checkout( WP_CONTENT_DIR ) ) {
1664 foreach ( $language_updates as $key => $language_update ) {
1665 $update = ! empty( $language_update->autoupdate );
1668 * Filter whether to asynchronously update translation for core, a plugin, or a theme.
1672 * @param bool $update Whether to update.
1673 * @param object $language_update The update offer.
1675 $update = apply_filters( 'async_update_translation', $update, $language_update );
1678 unset( $language_updates[ $key ] );
1682 if ( empty( $language_updates ) ) {
1686 $skin = new Language_Pack_Upgrader_Skin( array(
1687 'skip_header_footer' => true,
1690 $lp_upgrader = new Language_Pack_Upgrader( $skin );
1691 $lp_upgrader->bulk_upgrade( $language_updates );
1695 * Initialize the upgrade strings.
1699 public function upgrade_strings() {
1700 $this->strings['starting_upgrade'] = __( 'Some of your translations need updating. Sit tight for a few more seconds while we update them as well.' );
1701 $this->strings['up_to_date'] = __( 'The translation is up to date.' ); // We need to silently skip this case
1702 $this->strings['no_package'] = __( 'Update package not available.' );
1703 $this->strings['downloading_package'] = __( 'Downloading translation from <span class="code">%s</span>…' );
1704 $this->strings['unpack_package'] = __( 'Unpacking the update…' );
1705 $this->strings['process_failed'] = __( 'Translation update failed.' );
1706 $this->strings['process_success'] = __( 'Translation updated successfully.' );
1710 * Upgrade a language pack.
1714 * @param string|false $update Optional. Whether an update offer is available. Default false.
1715 * @param array $args Optional. Other optional arguments, see
1716 * {@see Language_Pack_Upgrader::bulk_upgrade()}. Default empty array.
1717 * @return array|WP_Error The result of the upgrade, or a {@see wP_Error} object instead.
1719 public function upgrade( $update = false, $args = array() ) {
1721 $update = array( $update );
1724 $results = $this->bulk_upgrade( $update, $args );
1726 if ( ! is_array( $results ) ) {
1734 * Bulk upgrade language packs.
1738 * @param array $language_updates Optional. Language pack updates. Default empty array.
1739 * @param array $args {
1740 * Optional. Other arguments for upgrading multiple language packs. Default empty array
1742 * @type bool $clear_update_cache Whether to clear the update cache when done.
1745 * @return array|true|false|WP_Error Will return an array of results, or true if there are no updates,
1746 * false or WP_Error for initial errors.
1748 public function bulk_upgrade( $language_updates = array(), $args = array() ) {
1749 global $wp_filesystem;
1752 'clear_update_cache' => true,
1754 $parsed_args = wp_parse_args( $args, $defaults );
1757 $this->upgrade_strings();
1759 if ( ! $language_updates )
1760 $language_updates = wp_get_translation_updates();
1762 if ( empty( $language_updates ) ) {
1763 $this->skin->header();
1764 $this->skin->before();
1765 $this->skin->set_result( true );
1766 $this->skin->feedback( 'up_to_date' );
1767 $this->skin->after();
1768 $this->skin->bulk_footer();
1769 $this->skin->footer();
1773 if ( 'upgrader_process_complete' == current_filter() )
1774 $this->skin->feedback( 'starting_upgrade' );
1776 // Remove any existing upgrade filters from the plugin/theme upgraders #WP29425 & #WP29230
1777 remove_all_filters( 'upgrader_pre_install' );
1778 remove_all_filters( 'upgrader_clear_destination' );
1779 remove_all_filterS( 'upgrader_post_install' );
1780 remove_all_filters( 'upgrader_source_selection' );
1782 add_filter( 'upgrader_source_selection', array( $this, 'check_package' ), 10, 2 );
1784 $this->skin->header();
1786 // Connect to the Filesystem first.
1787 $res = $this->fs_connect( array( WP_CONTENT_DIR, WP_LANG_DIR ) );
1789 $this->skin->footer();
1795 $this->update_count = count( $language_updates );
1796 $this->update_current = 0;
1799 * The filesystem's mkdir() is not recursive. Make sure WP_LANG_DIR exists,
1800 * as we then may need to create a /plugins or /themes directory inside of it.
1802 $remote_destination = $wp_filesystem->find_folder( WP_LANG_DIR );
1803 if ( ! $wp_filesystem->exists( $remote_destination ) )
1804 if ( ! $wp_filesystem->mkdir( $remote_destination, FS_CHMOD_DIR ) )
1805 return new WP_Error( 'mkdir_failed_lang_dir', $this->strings['mkdir_failed'], $remote_destination );
1807 foreach ( $language_updates as $language_update ) {
1809 $this->skin->language_update = $language_update;
1811 $destination = WP_LANG_DIR;
1812 if ( 'plugin' == $language_update->type )
1813 $destination .= '/plugins';
1814 elseif ( 'theme' == $language_update->type )
1815 $destination .= '/themes';
1817 $this->update_current++;
1820 'package' => $language_update->package,
1821 'destination' => $destination,
1822 'clear_destination' => false,
1823 'abort_if_destination_exists' => false, // We expect the destination to exist.
1824 'clear_working' => true,
1826 'hook_extra' => array(
1827 'language_update_type' => $language_update->type,
1828 'language_update' => $language_update,
1832 $result = $this->run( $options );
1834 $results[] = $this->result;
1836 // Prevent credentials auth screen from displaying multiple times.
1837 if ( false === $result )
1841 $this->skin->bulk_footer();
1843 $this->skin->footer();
1845 // Clean up our hooks, in case something else does an upgrade on this connection.
1846 remove_filter( 'upgrader_source_selection', array( $this, 'check_package' ) );
1848 if ( $parsed_args['clear_update_cache'] ) {
1849 wp_clean_update_cache();
1856 * Check the package source to make sure there are .mo and .po files.
1858 * Hooked to the {@see 'upgrader_source_selection'} filter by
1859 * {@see Language_Pack_Upgrader::bulk_upgrade()}.
1863 public function check_package( $source, $remote_source ) {
1864 global $wp_filesystem;
1866 if ( is_wp_error( $source ) )
1869 // Check that the folder contains a valid language.
1870 $files = $wp_filesystem->dirlist( $remote_source );
1872 // Check to see if a .po and .mo exist in the folder.
1874 foreach ( (array) $files as $file => $filedata ) {
1875 if ( '.po' == substr( $file, -3 ) )
1877 elseif ( '.mo' == substr( $file, -3 ) )
1881 if ( ! $mo || ! $po )
1882 return new WP_Error( 'incompatible_archive_pomo', $this->strings['incompatible_archive'],
1883 __( 'The language pack is missing either the <code>.po</code> or <code>.mo</code> files.' ) );
1889 * Get the name of an item being updated.
1893 * @param object The data for an update.
1894 * @return string The name of the item being updated.
1896 public function get_name_for_update( $update ) {
1897 switch ( $update->type ) {
1899 return 'WordPress'; // Not translated
1902 $theme = wp_get_theme( $update->slug );
1903 if ( $theme->exists() )
1904 return $theme->Get( 'Name' );
1907 $plugin_data = get_plugins( '/' . $update->slug );
1908 $plugin_data = reset( $plugin_data );
1910 return $plugin_data['Name'];
1919 * Core Upgrader class for WordPress. It allows for WordPress to upgrade itself in combination with the wp-admin/includes/update-core.php file
1921 * @package WordPress
1922 * @subpackage Upgrader
1925 class Core_Upgrader extends WP_Upgrader {
1928 * Initialize the upgrade strings.
1932 public function upgrade_strings() {
1933 $this->strings['up_to_date'] = __('WordPress is at the latest version.');
1934 $this->strings['no_package'] = __('Update package not available.');
1935 $this->strings['downloading_package'] = __('Downloading update from <span class="code">%s</span>…');
1936 $this->strings['unpack_package'] = __('Unpacking the update…');
1937 $this->strings['copy_failed'] = __('Could not copy files.');
1938 $this->strings['copy_failed_space'] = __('Could not copy files. You may have run out of disk space.' );
1939 $this->strings['start_rollback'] = __( 'Attempting to roll back to previous version.' );
1940 $this->strings['rollback_was_required'] = __( 'Due to an error during updating, WordPress has rolled back to your previous version.' );
1944 * Upgrade WordPress core.
1948 * @param object $current Response object for whether WordPress is current.
1949 * @param array $args {
1950 * Optional. Arguments for upgrading WordPress core. Default empty array.
1952 * @type bool $pre_check_md5 Whether to check the file checksums before
1953 * attempting the upgrade. Default true.
1954 * @type bool $attempt_rollback Whether to attempt to rollback the chances if
1955 * there is a problem. Default false.
1956 * @type bool $do_rollback Whether to perform this "upgrade" as a rollback.
1959 * @return null|false|WP_Error False or WP_Error on failure, null on success.
1961 public function upgrade( $current, $args = array() ) {
1962 global $wp_filesystem;
1964 include( ABSPATH . WPINC . '/version.php' ); // $wp_version;
1966 $start_time = time();
1969 'pre_check_md5' => true,
1970 'attempt_rollback' => false,
1971 'do_rollback' => false,
1972 'allow_relaxed_file_ownership' => false,
1974 $parsed_args = wp_parse_args( $args, $defaults );
1977 $this->upgrade_strings();
1979 // Is an update available?
1980 if ( !isset( $current->response ) || $current->response == 'latest' )
1981 return new WP_Error('up_to_date', $this->strings['up_to_date']);
1983 $res = $this->fs_connect( array( ABSPATH, WP_CONTENT_DIR ), $parsed_args['allow_relaxed_file_ownership'] );
1984 if ( ! $res || is_wp_error( $res ) ) {
1988 $wp_dir = trailingslashit($wp_filesystem->abspath());
1991 if ( $parsed_args['do_rollback'] )
1993 elseif ( $parsed_args['pre_check_md5'] && ! $this->check_files() )
1997 * If partial update is returned from the API, use that, unless we're doing
1998 * a reinstall. If we cross the new_bundled version number, then use
1999 * the new_bundled zip. Don't though if the constant is set to skip bundled items.
2000 * If the API returns a no_content zip, go with it. Finally, default to the full zip.
2002 if ( $parsed_args['do_rollback'] && $current->packages->rollback )
2003 $to_download = 'rollback';
2004 elseif ( $current->packages->partial && 'reinstall' != $current->response && $wp_version == $current->partial_version && $partial )
2005 $to_download = 'partial';
2006 elseif ( $current->packages->new_bundled && version_compare( $wp_version, $current->new_bundled, '<' )
2007 && ( ! defined( 'CORE_UPGRADE_SKIP_NEW_BUNDLED' ) || ! CORE_UPGRADE_SKIP_NEW_BUNDLED ) )
2008 $to_download = 'new_bundled';
2009 elseif ( $current->packages->no_content )
2010 $to_download = 'no_content';
2012 $to_download = 'full';
2014 $download = $this->download_package( $current->packages->$to_download );
2015 if ( is_wp_error($download) )
2018 $working_dir = $this->unpack_package( $download );
2019 if ( is_wp_error($working_dir) )
2020 return $working_dir;
2022 // Copy update-core.php from the new version into place.
2023 if ( !$wp_filesystem->copy($working_dir . '/wordpress/wp-admin/includes/update-core.php', $wp_dir . 'wp-admin/includes/update-core.php', true) ) {
2024 $wp_filesystem->delete($working_dir, true);
2025 return new WP_Error( 'copy_failed_for_update_core_file', __( 'The update cannot be installed because we will be unable to copy some files. This is usually due to inconsistent file permissions.' ), 'wp-admin/includes/update-core.php' );
2027 $wp_filesystem->chmod($wp_dir . 'wp-admin/includes/update-core.php', FS_CHMOD_FILE);
2029 require_once( ABSPATH . 'wp-admin/includes/update-core.php' );
2031 if ( ! function_exists( 'update_core' ) )
2032 return new WP_Error( 'copy_failed_space', $this->strings['copy_failed_space'] );
2034 $result = update_core( $working_dir, $wp_dir );
2036 // In the event of an issue, we may be able to roll back.
2037 if ( $parsed_args['attempt_rollback'] && $current->packages->rollback && ! $parsed_args['do_rollback'] ) {
2038 $try_rollback = false;
2039 if ( is_wp_error( $result ) ) {
2040 $error_code = $result->get_error_code();
2042 * Not all errors are equal. These codes are critical: copy_failed__copy_dir,
2043 * mkdir_failed__copy_dir, copy_failed__copy_dir_retry, and disk_full.
2044 * do_rollback allows for update_core() to trigger a rollback if needed.
2046 if ( false !== strpos( $error_code, 'do_rollback' ) )
2047 $try_rollback = true;
2048 elseif ( false !== strpos( $error_code, '__copy_dir' ) )
2049 $try_rollback = true;
2050 elseif ( 'disk_full' === $error_code )
2051 $try_rollback = true;
2054 if ( $try_rollback ) {
2055 /** This filter is documented in wp-admin/includes/update-core.php */
2056 apply_filters( 'update_feedback', $result );
2058 /** This filter is documented in wp-admin/includes/update-core.php */
2059 apply_filters( 'update_feedback', $this->strings['start_rollback'] );
2061 $rollback_result = $this->upgrade( $current, array_merge( $parsed_args, array( 'do_rollback' => true ) ) );
2063 $original_result = $result;
2064 $result = new WP_Error( 'rollback_was_required', $this->strings['rollback_was_required'], (object) array( 'update' => $original_result, 'rollback' => $rollback_result ) );
2068 /** This action is documented in wp-admin/includes/class-wp-upgrader.php */
2069 do_action( 'upgrader_process_complete', $this, array( 'action' => 'update', 'type' => 'core' ) );
2071 // Clear the current updates
2072 delete_site_transient( 'update_core' );
2074 if ( ! $parsed_args['do_rollback'] ) {
2076 'update_type' => $current->response,
2078 'fs_method' => $wp_filesystem->method,
2079 'fs_method_forced' => defined( 'FS_METHOD' ) || has_filter( 'filesystem_method' ),
2080 'fs_method_direct' => !empty( $GLOBALS['_wp_filesystem_direct_method'] ) ? $GLOBALS['_wp_filesystem_direct_method'] : '',
2081 'time_taken' => time() - $start_time,
2082 'reported' => $wp_version,
2083 'attempted' => $current->version,
2086 if ( is_wp_error( $result ) ) {
2087 $stats['success'] = false;
2088 // Did a rollback occur?
2089 if ( ! empty( $try_rollback ) ) {
2090 $stats['error_code'] = $original_result->get_error_code();
2091 $stats['error_data'] = $original_result->get_error_data();
2092 // Was the rollback successful? If not, collect its error too.
2093 $stats['rollback'] = ! is_wp_error( $rollback_result );
2094 if ( is_wp_error( $rollback_result ) ) {
2095 $stats['rollback_code'] = $rollback_result->get_error_code();
2096 $stats['rollback_data'] = $rollback_result->get_error_data();
2099 $stats['error_code'] = $result->get_error_code();
2100 $stats['error_data'] = $result->get_error_data();
2104 wp_version_check( $stats );
2111 * Determines if this WordPress Core version should update to an offered version or not.
2115 * @param string $offered_ver The offered version, of the format x.y.z.
2116 * @return bool True if we should update to the offered version, otherwise false.
2118 public static function should_update_to_version( $offered_ver ) {
2119 include( ABSPATH . WPINC . '/version.php' ); // $wp_version; // x.y.z
2121 $current_branch = implode( '.', array_slice( preg_split( '/[.-]/', $wp_version ), 0, 2 ) ); // x.y
2122 $new_branch = implode( '.', array_slice( preg_split( '/[.-]/', $offered_ver ), 0, 2 ) ); // x.y
2123 $current_is_development_version = (bool) strpos( $wp_version, '-' );
2126 $upgrade_dev = true;
2127 $upgrade_minor = true;
2128 $upgrade_major = false;
2130 // WP_AUTO_UPDATE_CORE = true (all), 'minor', false.
2131 if ( defined( 'WP_AUTO_UPDATE_CORE' ) ) {
2132 if ( false === WP_AUTO_UPDATE_CORE ) {
2133 // Defaults to turned off, unless a filter allows it
2134 $upgrade_dev = $upgrade_minor = $upgrade_major = false;
2135 } elseif ( true === WP_AUTO_UPDATE_CORE ) {
2136 // ALL updates for core
2137 $upgrade_dev = $upgrade_minor = $upgrade_major = true;
2138 } elseif ( 'minor' === WP_AUTO_UPDATE_CORE ) {
2139 // Only minor updates for core
2140 $upgrade_dev = $upgrade_major = false;
2141 $upgrade_minor = true;
2145 // 1: If we're already on that version, not much point in updating?
2146 if ( $offered_ver == $wp_version )
2149 // 2: If we're running a newer version, that's a nope
2150 if ( version_compare( $wp_version, $offered_ver, '>' ) )
2153 $failure_data = get_site_option( 'auto_core_update_failed' );
2154 if ( $failure_data ) {
2155 // If this was a critical update failure, cannot update.
2156 if ( ! empty( $failure_data['critical'] ) )
2159 // Don't claim we can update on update-core.php if we have a non-critical failure logged.
2160 if ( $wp_version == $failure_data['current'] && false !== strpos( $offered_ver, '.1.next.minor' ) )
2163 // Cannot update if we're retrying the same A to B update that caused a non-critical failure.
2164 // Some non-critical failures do allow retries, like download_failed.
2165 // 3.7.1 => 3.7.2 resulted in files_not_writable, if we are still on 3.7.1 and still trying to update to 3.7.2.
2166 if ( empty( $failure_data['retry'] ) && $wp_version == $failure_data['current'] && $offered_ver == $failure_data['attempted'] )
2170 // 3: 3.7-alpha-25000 -> 3.7-alpha-25678 -> 3.7-beta1 -> 3.7-beta2
2171 if ( $current_is_development_version ) {
2174 * Filter whether to enable automatic core updates for development versions.
2178 * @param bool $upgrade_dev Whether to enable automatic updates for
2179 * development versions.
2181 if ( ! apply_filters( 'allow_dev_auto_core_updates', $upgrade_dev ) )
2183 // Else fall through to minor + major branches below.
2186 // 4: Minor In-branch updates (3.7.0 -> 3.7.1 -> 3.7.2 -> 3.7.4)
2187 if ( $current_branch == $new_branch ) {
2190 * Filter whether to enable minor automatic core updates.
2194 * @param bool $upgrade_minor Whether to enable minor automatic core updates.
2196 return apply_filters( 'allow_minor_auto_core_updates', $upgrade_minor );
2199 // 5: Major version updates (3.7.0 -> 3.8.0 -> 3.9.1)
2200 if ( version_compare( $new_branch, $current_branch, '>' ) ) {
2203 * Filter whether to enable major automatic core updates.
2207 * @param bool $upgrade_major Whether to enable major automatic core updates.
2209 return apply_filters( 'allow_major_auto_core_updates', $upgrade_major );
2212 // If we're not sure, we don't want it
2217 * Compare the disk file checksums agains the expected checksums.
2221 * @return bool True if the checksums match, otherwise false.
2223 public function check_files() {
2224 global $wp_version, $wp_local_package;
2226 $checksums = get_core_checksums( $wp_version, isset( $wp_local_package ) ? $wp_local_package : 'en_US' );
2228 if ( ! is_array( $checksums ) )
2231 foreach ( $checksums as $file => $checksum ) {
2232 // Skip files which get updated
2233 if ( 'wp-content' == substr( $file, 0, 10 ) )
2235 if ( ! file_exists( ABSPATH . $file ) || md5_file( ABSPATH . $file ) !== $checksum )
2244 * Upgrade Skin helper for File uploads. This class handles the upload process and passes it as if it's a local file to the Upgrade/Installer functions.
2246 * @package WordPress
2247 * @subpackage Upgrader
2250 class File_Upload_Upgrader {
2253 * The full path to the file package.
2256 * @var string $package
2261 * The name of the file.
2264 * @var string $filename
2269 * The ID of the attachment post for this file.
2277 * Construct the upgrader for a form.
2281 * @param string $form The name of the form the file was uploaded from.
2282 * @param string $urlholder The name of the `GET` parameter that holds the filename.
2284 public function __construct( $form, $urlholder ) {
2286 if ( empty($_FILES[$form]['name']) && empty($_GET[$urlholder]) )
2287 wp_die(__('Please select a file'));
2289 //Handle a newly uploaded file, Else assume it's already been uploaded
2290 if ( ! empty($_FILES) ) {
2291 $overrides = array( 'test_form' => false, 'test_type' => false );
2292 $file = wp_handle_upload( $_FILES[$form], $overrides );
2294 if ( isset( $file['error'] ) )
2295 wp_die( $file['error'] );
2297 $this->filename = $_FILES[$form]['name'];
2298 $this->package = $file['file'];
2300 // Construct the object array
2302 'post_title' => $this->filename,
2303 'post_content' => $file['url'],
2304 'post_mime_type' => $file['type'],
2305 'guid' => $file['url'],
2306 'context' => 'upgrader',
2307 'post_status' => 'private'
2311 $this->id = wp_insert_attachment( $object, $file['file'] );
2313 // Schedule a cleanup for 2 hours from now in case of failed install.
2314 wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $this->id ) );
2316 } elseif ( is_numeric( $_GET[$urlholder] ) ) {
2317 // Numeric Package = previously uploaded file, see above.
2318 $this->id = (int) $_GET[$urlholder];
2319 $attachment = get_post( $this->id );
2320 if ( empty($attachment) )
2321 wp_die(__('Please select a file'));
2323 $this->filename = $attachment->post_title;
2324 $this->package = get_attached_file( $attachment->ID );
2326 // Else, It's set to something, Back compat for plugins using the old (pre-3.3) File_Uploader handler.
2327 if ( ! ( ( $uploads = wp_upload_dir() ) && false === $uploads['error'] ) )
2328 wp_die( $uploads['error'] );
2330 $this->filename = $_GET[$urlholder];
2331 $this->package = $uploads['basedir'] . '/' . $this->filename;
2336 * Delete the attachment/uploaded file.
2340 * @return bool Whether the cleanup was successful.
2342 public function cleanup() {
2344 wp_delete_attachment( $this->id );
2346 elseif ( file_exists( $this->package ) )
2347 return @unlink( $this->package );
2354 * The WordPress automatic background updater.
2356 * @package WordPress
2357 * @subpackage Upgrader
2360 class WP_Automatic_Updater {
2363 * Tracks update results during processing.
2367 protected $update_results = array();
2370 * Whether the entire automatic updater is disabled.
2374 public function is_disabled() {
2375 // Background updates are disabled if you don't want file changes.
2376 if ( defined( 'DISALLOW_FILE_MODS' ) && DISALLOW_FILE_MODS )
2379 if ( defined( 'WP_INSTALLING' ) )
2382 // More fine grained control can be done through the WP_AUTO_UPDATE_CORE constant and filters.
2383 $disabled = defined( 'AUTOMATIC_UPDATER_DISABLED' ) && AUTOMATIC_UPDATER_DISABLED;
2386 * Filter whether to entirely disable background updates.
2388 * There are more fine-grained filters and controls for selective disabling.
2389 * This filter parallels the AUTOMATIC_UPDATER_DISABLED constant in name.
2391 * This also disables update notification emails. That may change in the future.
2395 * @param bool $disabled Whether the updater should be disabled.
2397 return apply_filters( 'automatic_updater_disabled', $disabled );
2401 * Check for version control checkouts.
2403 * Checks for Subversion, Git, Mercurial, and Bazaar. It recursively looks up the
2404 * filesystem to the top of the drive, erring on the side of detecting a VCS
2405 * checkout somewhere.
2407 * ABSPATH is always checked in addition to whatever $context is (which may be the
2408 * wp-content directory, for example). The underlying assumption is that if you are
2409 * using version control *anywhere*, then you should be making decisions for
2410 * how things get updated.
2414 * @param string $context The filesystem path to check, in addition to ABSPATH.
2416 public function is_vcs_checkout( $context ) {
2417 $context_dirs = array( untrailingslashit( $context ) );
2418 if ( $context !== ABSPATH )
2419 $context_dirs[] = untrailingslashit( ABSPATH );
2421 $vcs_dirs = array( '.svn', '.git', '.hg', '.bzr' );
2422 $check_dirs = array();
2424 foreach ( $context_dirs as $context_dir ) {
2425 // Walk up from $context_dir to the root.
2427 $check_dirs[] = $context_dir;
2429 // Once we've hit '/' or 'C:\', we need to stop. dirname will keep returning the input here.
2430 if ( $context_dir == dirname( $context_dir ) )
2433 // Continue one level at a time.
2434 } while ( $context_dir = dirname( $context_dir ) );
2437 $check_dirs = array_unique( $check_dirs );
2439 // Search all directories we've found for evidence of version control.
2440 foreach ( $vcs_dirs as $vcs_dir ) {
2441 foreach ( $check_dirs as $check_dir ) {
2442 if ( $checkout = @is_dir( rtrim( $check_dir, '\\/' ) . "/$vcs_dir" ) )
2448 * Filter whether the automatic updater should consider a filesystem
2449 * location to be potentially managed by a version control system.
2453 * @param bool $checkout Whether a VCS checkout was discovered at $context
2454 * or ABSPATH, or anywhere higher.
2455 * @param string $context The filesystem context (a path) against which
2456 * filesystem status should be checked.
2458 return apply_filters( 'automatic_updates_is_vcs_checkout', $checkout, $context );
2462 * Tests to see if we can and should update a specific item.
2466 * @param string $type The type of update being checked: 'core', 'theme',
2467 * 'plugin', 'translation'.
2468 * @param object $item The update offer.
2469 * @param string $context The filesystem context (a path) against which filesystem
2470 * access and status should be checked.
2472 public function should_update( $type, $item, $context ) {
2473 // Used to see if WP_Filesystem is set up to allow unattended updates.
2474 $skin = new Automatic_Upgrader_Skin;
2476 if ( $this->is_disabled() )
2479 // Only relax the filesystem checks when the update doesn't include new files
2480 $allow_relaxed_file_ownership = false;
2481 if ( 'core' == $type && isset( $item->new_files ) && ! $item->new_files ) {
2482 $allow_relaxed_file_ownership = true;
2485 // If we can't do an auto core update, we may still be able to email the user.
2486 if ( ! $skin->request_filesystem_credentials( false, $context, $allow_relaxed_file_ownership ) || $this->is_vcs_checkout( $context ) ) {
2487 if ( 'core' == $type )
2488 $this->send_core_update_notification_email( $item );
2492 // Next up, is this an item we can update?
2493 if ( 'core' == $type )
2494 $update = Core_Upgrader::should_update_to_version( $item->current );
2496 $update = ! empty( $item->autoupdate );
2499 * Filter whether to automatically update core, a plugin, a theme, or a language.
2501 * The dynamic portion of the hook name, `$type`, refers to the type of update
2502 * being checked. Can be 'core', 'theme', 'plugin', or 'translation'.
2504 * Generally speaking, plugins, themes, and major core versions are not updated
2505 * by default, while translations and minor and development versions for core
2506 * are updated by default.
2508 * See the {@see 'allow_dev_auto_core_updates', {@see 'allow_minor_auto_core_updates'},
2509 * and {@see 'allow_major_auto_core_updates'} filters for a more straightforward way to
2510 * adjust core updates.
2514 * @param bool $update Whether to update.
2515 * @param object $item The update offer.
2517 $update = apply_filters( 'auto_update_' . $type, $update, $item );
2520 if ( 'core' == $type )
2521 $this->send_core_update_notification_email( $item );
2525 // If it's a core update, are we actually compatible with its requirements?
2526 if ( 'core' == $type ) {
2529 $php_compat = version_compare( phpversion(), $item->php_version, '>=' );
2530 if ( file_exists( WP_CONTENT_DIR . '/db.php' ) && empty( $wpdb->is_mysql ) )
2531 $mysql_compat = true;
2533 $mysql_compat = version_compare( $wpdb->db_version(), $item->mysql_version, '>=' );
2535 if ( ! $php_compat || ! $mysql_compat )
2543 * Notifies an administrator of a core update.
2547 * @param object $item The update offer.
2549 protected function send_core_update_notification_email( $item ) {
2550 $notified = get_site_option( 'auto_core_update_notified' );
2552 // Don't notify if we've already notified the same email address of the same version.
2553 if ( $notified && $notified['email'] == get_site_option( 'admin_email' ) && $notified['version'] == $item->current )
2556 // See if we need to notify users of a core update.
2557 $notify = ! empty( $item->notify_email );
2560 * Filter whether to notify the site administrator of a new core update.
2562 * By default, administrators are notified when the update offer received
2563 * from WordPress.org sets a particular flag. This allows some discretion
2564 * in if and when to notify.
2566 * This filter is only evaluated once per release. If the same email address
2567 * was already notified of the same new version, WordPress won't repeatedly
2568 * email the administrator.
2570 * This filter is also used on about.php to check if a plugin has disabled
2571 * these notifications.
2575 * @param bool $notify Whether the site administrator is notified.
2576 * @param object $item The update offer.
2578 if ( ! apply_filters( 'send_core_update_notification_email', $notify, $item ) )
2581 $this->send_email( 'manual', $item );
2586 * Update an item, if appropriate.
2590 * @param string $type The type of update being checked: 'core', 'theme', 'plugin', 'translation'.
2591 * @param object $item The update offer.
2593 public function update( $type, $item ) {
2594 $skin = new Automatic_Upgrader_Skin;
2598 // The Core upgrader doesn't use the Upgrader's skin during the actual main part of the upgrade, instead, firing a filter.
2599 add_filter( 'update_feedback', array( $skin, 'feedback' ) );
2600 $upgrader = new Core_Upgrader( $skin );
2604 $upgrader = new Plugin_Upgrader( $skin );
2605 $context = WP_PLUGIN_DIR; // We don't support custom Plugin directories, or updates for WPMU_PLUGIN_DIR
2608 $upgrader = new Theme_Upgrader( $skin );
2609 $context = get_theme_root( $item->theme );
2612 $upgrader = new Language_Pack_Upgrader( $skin );
2613 $context = WP_CONTENT_DIR; // WP_LANG_DIR;
2617 // Determine whether we can and should perform this update.
2618 if ( ! $this->should_update( $type, $item, $context ) )
2621 $upgrader_item = $item;
2624 $skin->feedback( __( 'Updating to WordPress %s' ), $item->version );
2625 $item_name = sprintf( __( 'WordPress %s' ), $item->version );
2628 $upgrader_item = $item->theme;
2629 $theme = wp_get_theme( $upgrader_item );
2630 $item_name = $theme->Get( 'Name' );
2631 $skin->feedback( __( 'Updating theme: %s' ), $item_name );
2634 $upgrader_item = $item->plugin;
2635 $plugin_data = get_plugin_data( $context . '/' . $upgrader_item );
2636 $item_name = $plugin_data['Name'];
2637 $skin->feedback( __( 'Updating plugin: %s' ), $item_name );
2640 $language_item_name = $upgrader->get_name_for_update( $item );
2641 $item_name = sprintf( __( 'Translations for %s' ), $language_item_name );
2642 $skin->feedback( sprintf( __( 'Updating translations for %1$s (%2$s)…' ), $language_item_name, $item->language ) );
2646 $allow_relaxed_file_ownership = false;
2647 if ( 'core' == $type && isset( $item->new_files ) && ! $item->new_files ) {
2648 $allow_relaxed_file_ownership = true;
2651 // Boom, This sites about to get a whole new splash of paint!
2652 $upgrade_result = $upgrader->upgrade( $upgrader_item, array(
2653 'clear_update_cache' => false,
2654 // Always use partial builds if possible for core updates.
2655 'pre_check_md5' => false,
2656 // Only available for core updates.
2657 'attempt_rollback' => true,
2658 // Allow relaxed file ownership in some scenarios
2659 'allow_relaxed_file_ownership' => $allow_relaxed_file_ownership,
2662 // If the filesystem is unavailable, false is returned.
2663 if ( false === $upgrade_result ) {
2664 $upgrade_result = new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
2667 // Core doesn't output this, so let's append it so we don't get confused.
2668 if ( 'core' == $type ) {
2669 if ( is_wp_error( $upgrade_result ) ) {
2670 $skin->error( __( 'Installation Failed' ), $upgrade_result );
2672 $skin->feedback( __( 'WordPress updated successfully' ) );
2676 $this->update_results[ $type ][] = (object) array(
2678 'result' => $upgrade_result,
2679 'name' => $item_name,
2680 'messages' => $skin->get_upgrade_messages()
2683 return $upgrade_result;
2687 * Kicks off the background update process, looping through all pending updates.
2691 public function run() {
2692 global $wpdb, $wp_version;
2694 if ( $this->is_disabled() )
2697 if ( ! is_main_network() || ! is_main_site() )
2700 $lock_name = 'auto_updater.lock';
2703 $lock_result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` ( `option_name`, `option_value`, `autoload` ) VALUES (%s, %s, 'no') /* LOCK */", $lock_name, time() ) );
2705 if ( ! $lock_result ) {
2706 $lock_result = get_option( $lock_name );
2708 // If we couldn't create a lock, and there isn't a lock, bail
2709 if ( ! $lock_result )
2712 // Check to see if the lock is still valid
2713 if ( $lock_result > ( time() - HOUR_IN_SECONDS ) )
2717 // Update the lock, as by this point we've definitely got a lock, just need to fire the actions
2718 update_option( $lock_name, time() );
2720 // Don't automatically run these thins, as we'll handle it ourselves
2721 remove_action( 'upgrader_process_complete', array( 'Language_Pack_Upgrader', 'async_upgrade' ), 20 );
2722 remove_action( 'upgrader_process_complete', 'wp_version_check' );
2723 remove_action( 'upgrader_process_complete', 'wp_update_plugins' );
2724 remove_action( 'upgrader_process_complete', 'wp_update_themes' );
2727 wp_update_plugins(); // Check for Plugin updates
2728 $plugin_updates = get_site_transient( 'update_plugins' );
2729 if ( $plugin_updates && !empty( $plugin_updates->response ) ) {
2730 foreach ( $plugin_updates->response as $plugin ) {
2731 $this->update( 'plugin', $plugin );
2733 // Force refresh of plugin update information
2734 wp_clean_plugins_cache();
2737 // Next, those themes we all love
2738 wp_update_themes(); // Check for Theme updates
2739 $theme_updates = get_site_transient( 'update_themes' );
2740 if ( $theme_updates && !empty( $theme_updates->response ) ) {
2741 foreach ( $theme_updates->response as $theme ) {
2742 $this->update( 'theme', (object) $theme );
2744 // Force refresh of theme update information
2745 wp_clean_themes_cache();
2748 // Next, Process any core update
2749 wp_version_check(); // Check for Core updates
2750 $core_update = find_core_auto_update();
2753 $this->update( 'core', $core_update );
2755 // Clean up, and check for any pending translations
2756 // (Core_Upgrader checks for core updates)
2757 $theme_stats = array();
2758 if ( isset( $this->update_results['theme'] ) ) {
2759 foreach ( $this->update_results['theme'] as $upgrade ) {
2760 $theme_stats[ $upgrade->item->theme ] = ( true === $upgrade->result );
2763 wp_update_themes( $theme_stats ); // Check for Theme updates
2765 $plugin_stats = array();
2766 if ( isset( $this->update_results['plugin'] ) ) {
2767 foreach ( $this->update_results['plugin'] as $upgrade ) {
2768 $plugin_stats[ $upgrade->item->plugin ] = ( true === $upgrade->result );
2771 wp_update_plugins( $plugin_stats ); // Check for Plugin updates
2773 // Finally, Process any new translations
2774 $language_updates = wp_get_translation_updates();
2775 if ( $language_updates ) {
2776 foreach ( $language_updates as $update ) {
2777 $this->update( 'translation', $update );
2780 // Clear existing caches
2781 wp_clean_update_cache();
2783 wp_version_check(); // check for Core updates
2784 wp_update_themes(); // Check for Theme updates
2785 wp_update_plugins(); // Check for Plugin updates
2788 // Send debugging email to all development installs.
2789 if ( ! empty( $this->update_results ) ) {
2790 $development_version = false !== strpos( $wp_version, '-' );
2793 * Filter whether to send a debugging email for each automatic background update.
2797 * @param bool $development_version By default, emails are sent if the
2798 * install is a development version.
2799 * Return false to avoid the email.
2801 if ( apply_filters( 'automatic_updates_send_debug_email', $development_version ) )
2802 $this->send_debug_email();
2804 if ( ! empty( $this->update_results['core'] ) )
2805 $this->after_core_update( $this->update_results['core'][0] );
2808 * Fires after all automatic updates have run.
2812 * @param array $update_results The results of all attempted updates.
2814 do_action( 'automatic_updates_complete', $this->update_results );
2818 delete_option( $lock_name );
2822 * If we tried to perform a core update, check if we should send an email,
2823 * and if we need to avoid processing future updates.
2825 * @param object $update_result The result of the core update. Includes the update offer and result.
2827 protected function after_core_update( $update_result ) {
2830 $core_update = $update_result->item;
2831 $result = $update_result->result;
2833 if ( ! is_wp_error( $result ) ) {
2834 $this->send_email( 'success', $core_update );
2838 $error_code = $result->get_error_code();
2840 // Any of these WP_Error codes are critical failures, as in they occurred after we started to copy core files.
2841 // We should not try to perform a background update again until there is a successful one-click update performed by the user.
2843 if ( $error_code === 'disk_full' || false !== strpos( $error_code, '__copy_dir' ) ) {
2845 } elseif ( $error_code === 'rollback_was_required' && is_wp_error( $result->get_error_data()->rollback ) ) {
2846 // A rollback is only critical if it failed too.
2848 $rollback_result = $result->get_error_data()->rollback;
2849 } elseif ( false !== strpos( $error_code, 'do_rollback' ) ) {
2854 $critical_data = array(
2855 'attempted' => $core_update->current,
2856 'current' => $wp_version,
2857 'error_code' => $error_code,
2858 'error_data' => $result->get_error_data(),
2859 'timestamp' => time(),
2862 if ( isset( $rollback_result ) ) {
2863 $critical_data['rollback_code'] = $rollback_result->get_error_code();
2864 $critical_data['rollback_data'] = $rollback_result->get_error_data();
2866 update_site_option( 'auto_core_update_failed', $critical_data );
2867 $this->send_email( 'critical', $core_update, $result );
2872 * Any other WP_Error code (like download_failed or files_not_writable) occurs before
2873 * we tried to copy over core files. Thus, the failures are early and graceful.
2875 * We should avoid trying to perform a background update again for the same version.
2876 * But we can try again if another version is released.
2878 * For certain 'transient' failures, like download_failed, we should allow retries.
2879 * In fact, let's schedule a special update for an hour from now. (It's possible
2880 * the issue could actually be on WordPress.org's side.) If that one fails, then email.
2883 $transient_failures = array( 'incompatible_archive', 'download_failed', 'insane_distro' );
2884 if ( in_array( $error_code, $transient_failures ) && ! get_site_option( 'auto_core_update_failed' ) ) {
2885 wp_schedule_single_event( time() + HOUR_IN_SECONDS, 'wp_maybe_auto_update' );
2889 $n = get_site_option( 'auto_core_update_notified' );
2890 // Don't notify if we've already notified the same email address of the same version of the same notification type.
2891 if ( $n && 'fail' == $n['type'] && $n['email'] == get_site_option( 'admin_email' ) && $n['version'] == $core_update->current )
2894 update_site_option( 'auto_core_update_failed', array(
2895 'attempted' => $core_update->current,
2896 'current' => $wp_version,
2897 'error_code' => $error_code,
2898 'error_data' => $result->get_error_data(),
2899 'timestamp' => time(),
2900 'retry' => in_array( $error_code, $transient_failures ),
2904 $this->send_email( 'fail', $core_update, $result );
2908 * Sends an email upon the completion or failure of a background core update.
2912 * @param string $type The type of email to send. Can be one of 'success', 'fail', 'manual', 'critical'.
2913 * @param object $core_update The update offer that was attempted.
2914 * @param mixed $result Optional. The result for the core update. Can be WP_Error.
2916 protected function send_email( $type, $core_update, $result = null ) {
2917 update_site_option( 'auto_core_update_notified', array(
2919 'email' => get_site_option( 'admin_email' ),
2920 'version' => $core_update->current,
2921 'timestamp' => time(),
2924 $next_user_core_update = get_preferred_from_update_core();
2925 // If the update transient is empty, use the update we just performed
2926 if ( ! $next_user_core_update )
2927 $next_user_core_update = $core_update;
2928 $newer_version_available = ( 'upgrade' == $next_user_core_update->response && version_compare( $next_user_core_update->version, $core_update->version, '>' ) );
2931 * Filter whether to send an email following an automatic background core update.
2935 * @param bool $send Whether to send the email. Default true.
2936 * @param string $type The type of email to send. Can be one of
2937 * 'success', 'fail', 'critical'.
2938 * @param object $core_update The update offer that was attempted.
2939 * @param mixed $result The result for the core update. Can be WP_Error.
2941 if ( 'manual' !== $type && ! apply_filters( 'auto_core_update_send_email', true, $type, $core_update, $result ) )
2945 case 'success' : // We updated.
2946 /* translators: 1: Site name, 2: WordPress version number. */
2947 $subject = __( '[%1$s] Your site has updated to WordPress %2$s' );
2950 case 'fail' : // We tried to update but couldn't.
2951 case 'manual' : // We can't update (and made no attempt).
2952 /* translators: 1: Site name, 2: WordPress version number. */
2953 $subject = __( '[%1$s] WordPress %2$s is available. Please update!' );
2956 case 'critical' : // We tried to update, started to copy files, then things went wrong.
2957 /* translators: 1: Site name. */
2958 $subject = __( '[%1$s] URGENT: Your site may be down due to a failed update' );
2965 // If the auto update is not to the latest version, say that the current version of WP is available instead.
2966 $version = 'success' === $type ? $core_update->current : $next_user_core_update->current;
2967 $subject = sprintf( $subject, wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ), $version );
2973 $body .= sprintf( __( 'Howdy! Your site at %1$s has been updated automatically to WordPress %2$s.' ), home_url(), $core_update->current );
2975 if ( ! $newer_version_available )
2976 $body .= __( 'No further action is needed on your part.' ) . ' ';
2978 // Can only reference the About screen if their update was successful.
2979 list( $about_version ) = explode( '-', $core_update->current, 2 );
2980 $body .= sprintf( __( "For more on version %s, see the About WordPress screen:" ), $about_version );
2981 $body .= "\n" . admin_url( 'about.php' );
2983 if ( $newer_version_available ) {
2984 $body .= "\n\n" . sprintf( __( 'WordPress %s is also now available.' ), $next_user_core_update->current ) . ' ';
2985 $body .= __( 'Updating is easy and only takes a few moments:' );
2986 $body .= "\n" . network_admin_url( 'update-core.php' );
2993 $body .= sprintf( __( 'Please update your site at %1$s to WordPress %2$s.' ), home_url(), $next_user_core_update->current );
2997 // Don't show this message if there is a newer version available.
2998 // Potential for confusion, and also not useful for them to know at this point.
2999 if ( 'fail' == $type && ! $newer_version_available )
3000 $body .= __( 'We tried but were unable to update your site automatically.' ) . ' ';
3002 $body .= __( 'Updating is easy and only takes a few moments:' );
3003 $body .= "\n" . network_admin_url( 'update-core.php' );
3007 if ( $newer_version_available )
3008 $body .= sprintf( __( 'Your site at %1$s experienced a critical failure while trying to update WordPress to version %2$s.' ), home_url(), $core_update->current );
3010 $body .= sprintf( __( 'Your site at %1$s experienced a critical failure while trying to update to the latest version of WordPress, %2$s.' ), home_url(), $core_update->current );
3012 $body .= "\n\n" . __( "This means your site may be offline or broken. Don't panic; this can be fixed." );
3014 $body .= "\n\n" . __( "Please check out your site now. It's possible that everything is working. If it says you need to update, you should do so:" );
3015 $body .= "\n" . network_admin_url( 'update-core.php' );
3019 $critical_support = 'critical' === $type && ! empty( $core_update->support_email );
3020 if ( $critical_support ) {
3021 // Support offer if available.
3022 $body .= "\n\n" . sprintf( __( "The WordPress team is willing to help you. Forward this email to %s and the team will work with you to make sure your site is working." ), $core_update->support_email );
3024 // Add a note about the support forums.
3025 $body .= "\n\n" . __( 'If you experience any issues or need support, the volunteers in the WordPress.org support forums may be able to help.' );
3026 $body .= "\n" . __( 'https://wordpress.org/support/' );
3029 // Updates are important!
3030 if ( $type != 'success' || $newer_version_available ) {
3031 $body .= "\n\n" . __( 'Keeping your site updated is important for security. It also makes the internet a safer place for you and your readers.' );
3034 if ( $critical_support ) {
3035 $body .= " " . __( "If you reach out to us, we'll also ensure you'll never have this problem again." );
3038 // If things are successful and we're now on the latest, mention plugins and themes if any are out of date.
3039 if ( $type == 'success' && ! $newer_version_available && ( get_plugin_updates() || get_theme_updates() ) ) {
3040 $body .= "\n\n" . __( 'You also have some plugins or themes with updates available. Update them now:' );
3041 $body .= "\n" . network_admin_url();
3044 $body .= "\n\n" . __( 'The WordPress Team' ) . "\n";
3046 if ( 'critical' == $type && is_wp_error( $result ) ) {
3047 $body .= "\n***\n\n";
3048 $body .= sprintf( __( 'Your site was running version %s.' ), $GLOBALS['wp_version'] );
3049 $body .= ' ' . __( 'We have some data that describes the error your site encountered.' );
3050 $body .= ' ' . __( 'Your hosting company, support forum volunteers, or a friendly developer may be able to use this information to help you:' );
3052 // If we had a rollback and we're still critical, then the rollback failed too.
3053 // Loop through all errors (the main WP_Error, the update result, the rollback result) for code, data, etc.
3054 if ( 'rollback_was_required' == $result->get_error_code() )
3055 $errors = array( $result, $result->get_error_data()->update, $result->get_error_data()->rollback );
3057 $errors = array( $result );
3059 foreach ( $errors as $error ) {
3060 if ( ! is_wp_error( $error ) )
3062 $error_code = $error->get_error_code();
3063 $body .= "\n\n" . sprintf( __( "Error code: %s" ), $error_code );
3064 if ( 'rollback_was_required' == $error_code )
3066 if ( $error->get_error_message() )
3067 $body .= "\n" . $error->get_error_message();
3068 $error_data = $error->get_error_data();
3070 $body .= "\n" . implode( ', ', (array) $error_data );
3075 $to = get_site_option( 'admin_email' );
3078 $email = compact( 'to', 'subject', 'body', 'headers' );
3081 * Filter the email sent following an automatic background core update.