Core_Upgrader

Core class used for updating core.

Defined (1)

The class is defined in the following location(s).

/wp-admin/includes/class-core-upgrader.php  
  1. class Core_Upgrader extends WP_Upgrader { 
  2.  
  3.     /** 
  4.      * Initialize the upgrade strings. 
  5.      * 
  6.      * @since 2.8.0 
  7.      * @access public 
  8.      */ 
  9.     public function upgrade_strings() { 
  10.         $this->strings['up_to_date'] = __('WordPress is at the latest version.'); 
  11.         $this->strings['locked'] = __('Another update is currently in progress.'); 
  12.         $this->strings['no_package'] = __('Update package not available.'); 
  13.         $this->strings['downloading_package'] = __('Downloading update from <span class="code">%s</span>…'); 
  14.         $this->strings['unpack_package'] = __('Unpacking the update…'); 
  15.         $this->strings['copy_failed'] = __('Could not copy files.'); 
  16.         $this->strings['copy_failed_space'] = __('Could not copy files. You may have run out of disk space.' ); 
  17.         $this->strings['start_rollback'] = __( 'Attempting to roll back to previous version.' ); 
  18.         $this->strings['rollback_was_required'] = __( 'Due to an error during updating, WordPress has rolled back to your previous version.' ); 
  19.     } 
  20.  
  21.     /** 
  22.      * Upgrade WordPress core. 
  23.      * 
  24.      * @since 2.8.0 
  25.      * @access public 
  26.      * 
  27.      * @global WP_Filesystem_Base $wp_filesystem Subclass 
  28.      * @global callable           $_wp_filesystem_direct_method 
  29.      * 
  30.      * @param object $current Response object for whether WordPress is current. 
  31.      * @param array  $args { 
  32.      *        Optional. Arguments for upgrading WordPress core. Default empty array. 
  33.      * 
  34.      *        @type bool $pre_check_md5    Whether to check the file checksums before 
  35.      *                                     attempting the upgrade. Default true. 
  36.      *        @type bool $attempt_rollback Whether to attempt to rollback the chances if 
  37.      *                                     there is a problem. Default false. 
  38.      *        @type bool $do_rollback      Whether to perform this "upgrade" as a rollback. 
  39.      *                                     Default false. 
  40.      * } 
  41.      * @return null|false|WP_Error False or WP_Error on failure, null on success. 
  42.      */ 
  43.     public function upgrade( $current, $args = array() ) { 
  44.         global $wp_filesystem; 
  45.  
  46.         include( ABSPATH . WPINC . '/version.php' ); // $wp_version; 
  47.  
  48.         $start_time = time(); 
  49.  
  50.         $defaults = array( 
  51.             'pre_check_md5' => true,  
  52.             'attempt_rollback' => false,  
  53.             'do_rollback' => false,  
  54.             'allow_relaxed_file_ownership' => false,  
  55.  ); 
  56.         $parsed_args = wp_parse_args( $args, $defaults ); 
  57.  
  58.         $this->init(); 
  59.         $this->upgrade_strings(); 
  60.  
  61.         // Is an update available? 
  62.         if ( !isset( $current->response ) || $current->response == 'latest' ) 
  63.             return new WP_Error('up_to_date', $this->strings['up_to_date']); 
  64.  
  65.         $res = $this->fs_connect( array( ABSPATH, WP_CONTENT_DIR ), $parsed_args['allow_relaxed_file_ownership'] ); 
  66.         if ( ! $res || is_wp_error( $res ) ) { 
  67.             return $res; 
  68.         } 
  69.  
  70.         $wp_dir = trailingslashit($wp_filesystem->abspath()); 
  71.  
  72.         $partial = true; 
  73.         if ( $parsed_args['do_rollback'] ) 
  74.             $partial = false; 
  75.         elseif ( $parsed_args['pre_check_md5'] && ! $this->check_files() ) 
  76.             $partial = false; 
  77.  
  78.         /** 
  79.          * If partial update is returned from the API, use that, unless we're doing 
  80.          * a reinstall. If we cross the new_bundled version number, then use 
  81.          * the new_bundled zip. Don't though if the constant is set to skip bundled items. 
  82.          * If the API returns a no_content zip, go with it. Finally, default to the full zip. 
  83.          */ 
  84.         if ( $parsed_args['do_rollback'] && $current->packages->rollback ) 
  85.             $to_download = 'rollback'; 
  86.         elseif ( $current->packages->partial && 'reinstall' != $current->response && $wp_version == $current->partial_version && $partial ) 
  87.             $to_download = 'partial'; 
  88.         elseif ( $current->packages->new_bundled && version_compare( $wp_version, $current->new_bundled, '<' ) 
  89.             && ( ! defined( 'CORE_UPGRADE_SKIP_NEW_BUNDLED' ) || ! CORE_UPGRADE_SKIP_NEW_BUNDLED ) ) 
  90.             $to_download = 'new_bundled'; 
  91.         elseif ( $current->packages->no_content ) 
  92.             $to_download = 'no_content'; 
  93.         else 
  94.             $to_download = 'full'; 
  95.  
  96.         // Lock to prevent multiple Core Updates occurring 
  97.         $lock = WP_Upgrader::create_lock( 'core_updater', 15 * MINUTE_IN_SECONDS ); 
  98.         if ( ! $lock ) { 
  99.             return new WP_Error( 'locked', $this->strings['locked'] ); 
  100.         } 
  101.  
  102.         $download = $this->download_package( $current->packages->$to_download ); 
  103.         if ( is_wp_error( $download ) ) { 
  104.             WP_Upgrader::release_lock( 'core_updater' ); 
  105.             return $download; 
  106.         } 
  107.  
  108.         $working_dir = $this->unpack_package( $download ); 
  109.         if ( is_wp_error( $working_dir ) ) { 
  110.             WP_Upgrader::release_lock( 'core_updater' ); 
  111.             return $working_dir; 
  112.         } 
  113.  
  114.         // Copy update-core.php from the new version into place. 
  115.         if ( !$wp_filesystem->copy($working_dir . '/wordpress/wp-admin/includes/update-core.php', $wp_dir . 'wp-admin/includes/update-core.php', true) ) { 
  116.             $wp_filesystem->delete($working_dir, true); 
  117.             WP_Upgrader::release_lock( 'core_updater' ); 
  118.             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' ); 
  119.         } 
  120.         $wp_filesystem->chmod($wp_dir . 'wp-admin/includes/update-core.php', FS_CHMOD_FILE); 
  121.  
  122.         require_once( ABSPATH . 'wp-admin/includes/update-core.php' ); 
  123.  
  124.         if ( ! function_exists( 'update_core' ) ) { 
  125.             WP_Upgrader::release_lock( 'core_updater' ); 
  126.             return new WP_Error( 'copy_failed_space', $this->strings['copy_failed_space'] ); 
  127.         } 
  128.  
  129.         $result = update_core( $working_dir, $wp_dir ); 
  130.  
  131.         // In the event of an issue, we may be able to roll back. 
  132.         if ( $parsed_args['attempt_rollback'] && $current->packages->rollback && ! $parsed_args['do_rollback'] ) { 
  133.             $try_rollback = false; 
  134.             if ( is_wp_error( $result ) ) { 
  135.                 $error_code = $result->get_error_code(); 
  136.                 /** 
  137.                  * Not all errors are equal. These codes are critical: copy_failed__copy_dir,  
  138.                  * mkdir_failed__copy_dir, copy_failed__copy_dir_retry, and disk_full. 
  139.                  * do_rollback allows for update_core() to trigger a rollback if needed. 
  140.                  */ 
  141.                 if ( false !== strpos( $error_code, 'do_rollback' ) ) 
  142.                     $try_rollback = true; 
  143.                 elseif ( false !== strpos( $error_code, '__copy_dir' ) ) 
  144.                     $try_rollback = true; 
  145.                 elseif ( 'disk_full' === $error_code ) 
  146.                     $try_rollback = true; 
  147.             } 
  148.  
  149.             if ( $try_rollback ) { 
  150.                 /** This filter is documented in wp-admin/includes/update-core.php */ 
  151.                 apply_filters( 'update_feedback', $result ); 
  152.  
  153.                 /** This filter is documented in wp-admin/includes/update-core.php */ 
  154.                 apply_filters( 'update_feedback', $this->strings['start_rollback'] ); 
  155.  
  156.                 $rollback_result = $this->upgrade( $current, array_merge( $parsed_args, array( 'do_rollback' => true ) ) ); 
  157.  
  158.                 $original_result = $result; 
  159.                 $result = new WP_Error( 'rollback_was_required', $this->strings['rollback_was_required'], (object) array( 'update' => $original_result, 'rollback' => $rollback_result ) ); 
  160.             } 
  161.         } 
  162.  
  163.         /** This action is documented in wp-admin/includes/class-wp-upgrader.php */ 
  164.         do_action( 'upgrader_process_complete', $this, array( 'action' => 'update', 'type' => 'core' ) ); 
  165.  
  166.         // Clear the current updates 
  167.         delete_site_transient( 'update_core' ); 
  168.  
  169.         if ( ! $parsed_args['do_rollback'] ) { 
  170.             $stats = array( 
  171.                 'update_type' => $current->response,  
  172.                 'success' => true,  
  173.                 'fs_method' => $wp_filesystem->method,  
  174.                 'fs_method_forced' => defined( 'FS_METHOD' ) || has_filter( 'filesystem_method' ),  
  175.                 'fs_method_direct' => !empty( $GLOBALS['_wp_filesystem_direct_method'] ) ? $GLOBALS['_wp_filesystem_direct_method'] : '',  
  176.                 'time_taken' => time() - $start_time,  
  177.                 'reported' => $wp_version,  
  178.                 'attempted' => $current->version,  
  179.  ); 
  180.  
  181.             if ( is_wp_error( $result ) ) { 
  182.                 $stats['success'] = false; 
  183.                 // Did a rollback occur? 
  184.                 if ( ! empty( $try_rollback ) ) { 
  185.                     $stats['error_code'] = $original_result->get_error_code(); 
  186.                     $stats['error_data'] = $original_result->get_error_data(); 
  187.                     // Was the rollback successful? If not, collect its error too. 
  188.                     $stats['rollback'] = ! is_wp_error( $rollback_result ); 
  189.                     if ( is_wp_error( $rollback_result ) ) { 
  190.                         $stats['rollback_code'] = $rollback_result->get_error_code(); 
  191.                         $stats['rollback_data'] = $rollback_result->get_error_data(); 
  192.                     } 
  193.                 } else { 
  194.                     $stats['error_code'] = $result->get_error_code(); 
  195.                     $stats['error_data'] = $result->get_error_data(); 
  196.                 } 
  197.             } 
  198.  
  199.             wp_version_check( $stats ); 
  200.         } 
  201.  
  202.         WP_Upgrader::release_lock( 'core_updater' ); 
  203.  
  204.         return $result; 
  205.     } 
  206.  
  207.     /** 
  208.      * Determines if this WordPress Core version should update to an offered version or not. 
  209.      * 
  210.      * @since 3.7.0 
  211.      * @access public 
  212.      * 
  213.      * @static 
  214.      * 
  215.      * @param string $offered_ver The offered version, of the format x.y.z. 
  216.      * @return bool True if we should update to the offered version, otherwise false. 
  217.      */ 
  218.     public static function should_update_to_version( $offered_ver ) { 
  219.         include( ABSPATH . WPINC . '/version.php' ); // $wp_version; // x.y.z 
  220.  
  221.         $current_branch = implode( '.', array_slice( preg_split( '/[.-]/', $wp_version ), 0, 2 ) ); // x.y 
  222.         $new_branch = implode( '.', array_slice( preg_split( '/[.-]/', $offered_ver ), 0, 2 ) ); // x.y 
  223.         $current_is_development_version = (bool) strpos( $wp_version, '-' ); 
  224.  
  225.         // Defaults: 
  226.         $upgrade_dev = true; 
  227.         $upgrade_minor = true; 
  228.         $upgrade_major = false; 
  229.  
  230.         // WP_AUTO_UPDATE_CORE = true (all), 'minor', false. 
  231.         if ( defined( 'WP_AUTO_UPDATE_CORE' ) ) { 
  232.             if ( false === WP_AUTO_UPDATE_CORE ) { 
  233.                 // Defaults to turned off, unless a filter allows it 
  234.                 $upgrade_dev = $upgrade_minor = $upgrade_major = false; 
  235.             } elseif ( true === WP_AUTO_UPDATE_CORE ) { 
  236.                 // ALL updates for core 
  237.                 $upgrade_dev = $upgrade_minor = $upgrade_major = true; 
  238.             } elseif ( 'minor' === WP_AUTO_UPDATE_CORE ) { 
  239.                 // Only minor updates for core 
  240.                 $upgrade_dev = $upgrade_major = false; 
  241.                 $upgrade_minor = true; 
  242.             } 
  243.         } 
  244.  
  245.         // 1: If we're already on that version, not much point in updating? 
  246.         if ( $offered_ver == $wp_version ) 
  247.             return false; 
  248.  
  249.         // 2: If we're running a newer version, that's a nope 
  250.         if ( version_compare( $wp_version, $offered_ver, '>' ) ) 
  251.             return false; 
  252.  
  253.         $failure_data = get_site_option( 'auto_core_update_failed' ); 
  254.         if ( $failure_data ) { 
  255.             // If this was a critical update failure, cannot update. 
  256.             if ( ! empty( $failure_data['critical'] ) ) 
  257.                 return false; 
  258.  
  259.             // Don't claim we can update on update-core.php if we have a non-critical failure logged. 
  260.             if ( $wp_version == $failure_data['current'] && false !== strpos( $offered_ver, '.1.next.minor' ) ) 
  261.                 return false; 
  262.  
  263.             // Cannot update if we're retrying the same A to B update that caused a non-critical failure. 
  264.             // Some non-critical failures do allow retries, like download_failed. 
  265.             // 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. 
  266.             if ( empty( $failure_data['retry'] ) && $wp_version == $failure_data['current'] && $offered_ver == $failure_data['attempted'] ) 
  267.                 return false; 
  268.         } 
  269.  
  270.         // 3: 3.7-alpha-25000 -> 3.7-alpha-25678 -> 3.7-beta1 -> 3.7-beta2 
  271.         if ( $current_is_development_version ) { 
  272.  
  273.             /** 
  274.              * Filters whether to enable automatic core updates for development versions. 
  275.              * 
  276.              * @since 3.7.0 
  277.              * 
  278.              * @param bool $upgrade_dev Whether to enable automatic updates for 
  279.              *                          development versions. 
  280.              */ 
  281.             if ( ! apply_filters( 'allow_dev_auto_core_updates', $upgrade_dev ) ) 
  282.                 return false; 
  283.             // Else fall through to minor + major branches below. 
  284.         } 
  285.  
  286.         // 4: Minor In-branch updates (3.7.0 -> 3.7.1 -> 3.7.2 -> 3.7.4) 
  287.         if ( $current_branch == $new_branch ) { 
  288.  
  289.             /** 
  290.              * Filters whether to enable minor automatic core updates. 
  291.              * 
  292.              * @since 3.7.0 
  293.              * 
  294.              * @param bool $upgrade_minor Whether to enable minor automatic core updates. 
  295.              */ 
  296.             return apply_filters( 'allow_minor_auto_core_updates', $upgrade_minor ); 
  297.         } 
  298.  
  299.         // 5: Major version updates (3.7.0 -> 3.8.0 -> 3.9.1) 
  300.         if ( version_compare( $new_branch, $current_branch, '>' ) ) { 
  301.  
  302.             /** 
  303.              * Filters whether to enable major automatic core updates. 
  304.              * 
  305.              * @since 3.7.0 
  306.              * 
  307.              * @param bool $upgrade_major Whether to enable major automatic core updates. 
  308.              */ 
  309.             return apply_filters( 'allow_major_auto_core_updates', $upgrade_major ); 
  310.         } 
  311.  
  312.         // If we're not sure, we don't want it 
  313.         return false; 
  314.     } 
  315.  
  316.     /** 
  317.      * Compare the disk file checksums against the expected checksums. 
  318.      * 
  319.      * @since 3.7.0 
  320.      * @access public 
  321.      * 
  322.      * @global string $wp_version 
  323.      * @global string $wp_local_package 
  324.      * 
  325.      * @return bool True if the checksums match, otherwise false. 
  326.      */ 
  327.     public function check_files() { 
  328.         global $wp_version, $wp_local_package; 
  329.  
  330.         $checksums = get_core_checksums( $wp_version, isset( $wp_local_package ) ? $wp_local_package : 'en_US' ); 
  331.  
  332.         if ( ! is_array( $checksums ) ) 
  333.             return false; 
  334.  
  335.         foreach ( $checksums as $file => $checksum ) { 
  336.             // Skip files which get updated 
  337.             if ( 'wp-content' == substr( $file, 0, 10 ) ) 
  338.                 continue; 
  339.             if ( ! file_exists( ABSPATH . $file ) || md5_file( ABSPATH . $file ) !== $checksum ) 
  340.                 return false; 
  341.         } 
  342.  
  343.         return true; 
  344.     } 
  345. }