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