[ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Filesystem API: Top-level functionality 4 * 5 * Functions for reading, writing, modifying, and deleting files on the file system. 6 * Includes functionality for theme-specific files as well as operations for uploading, 7 * archiving, and rendering output when necessary. 8 * 9 * @package WordPress 10 * @subpackage Filesystem 11 * @since 2.3.0 12 */ 13 14 /** The descriptions for theme files. */ 15 $wp_file_descriptions = array( 16 'functions.php' => __( 'Theme Functions' ), 17 'header.php' => __( 'Theme Header' ), 18 'footer.php' => __( 'Theme Footer' ), 19 'sidebar.php' => __( 'Sidebar' ), 20 'comments.php' => __( 'Comments' ), 21 'searchform.php' => __( 'Search Form' ), 22 '404.php' => __( '404 Template' ), 23 'link.php' => __( 'Links Template' ), 24 'theme.json' => __( 'Theme Styles & Block Settings' ), 25 // Archives. 26 'index.php' => __( 'Main Index Template' ), 27 'archive.php' => __( 'Archives' ), 28 'author.php' => __( 'Author Template' ), 29 'taxonomy.php' => __( 'Taxonomy Template' ), 30 'category.php' => __( 'Category Template' ), 31 'tag.php' => __( 'Tag Template' ), 32 'home.php' => __( 'Posts Page' ), 33 'search.php' => __( 'Search Results' ), 34 'date.php' => __( 'Date Template' ), 35 // Content. 36 'singular.php' => __( 'Singular Template' ), 37 'single.php' => __( 'Single Post' ), 38 'page.php' => __( 'Single Page' ), 39 'front-page.php' => __( 'Homepage' ), 40 'privacy-policy.php' => __( 'Privacy Policy Page' ), 41 // Attachments. 42 'attachment.php' => __( 'Attachment Template' ), 43 'image.php' => __( 'Image Attachment Template' ), 44 'video.php' => __( 'Video Attachment Template' ), 45 'audio.php' => __( 'Audio Attachment Template' ), 46 'application.php' => __( 'Application Attachment Template' ), 47 // Embeds. 48 'embed.php' => __( 'Embed Template' ), 49 'embed-404.php' => __( 'Embed 404 Template' ), 50 'embed-content.php' => __( 'Embed Content Template' ), 51 'header-embed.php' => __( 'Embed Header Template' ), 52 'footer-embed.php' => __( 'Embed Footer Template' ), 53 // Stylesheets. 54 'style.css' => __( 'Stylesheet' ), 55 'editor-style.css' => __( 'Visual Editor Stylesheet' ), 56 'editor-style-rtl.css' => __( 'Visual Editor RTL Stylesheet' ), 57 'rtl.css' => __( 'RTL Stylesheet' ), 58 // Other. 59 'my-hacks.php' => __( 'my-hacks.php (legacy hacks support)' ), 60 '.htaccess' => __( '.htaccess (for rewrite rules )' ), 61 // Deprecated files. 62 'wp-layout.css' => __( 'Stylesheet' ), 63 'wp-comments.php' => __( 'Comments Template' ), 64 'wp-comments-popup.php' => __( 'Popup Comments Template' ), 65 'comments-popup.php' => __( 'Popup Comments' ), 66 ); 67 68 /** 69 * Gets the description for standard WordPress theme files. 70 * 71 * @since 1.5.0 72 * 73 * @global array $wp_file_descriptions Theme file descriptions. 74 * @global array $allowed_files List of allowed files. 75 * 76 * @param string $file Filesystem path or filename. 77 * @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist. 78 * Appends 'Page Template' to basename of $file if the file is a page template. 79 */ 80 function get_file_description( $file ) { 81 global $wp_file_descriptions, $allowed_files; 82 83 $dirname = pathinfo( $file, PATHINFO_DIRNAME ); 84 $file_path = $allowed_files[ $file ]; 85 86 if ( isset( $wp_file_descriptions[ basename( $file ) ] ) && '.' === $dirname ) { 87 return $wp_file_descriptions[ basename( $file ) ]; 88 } elseif ( file_exists( $file_path ) && is_file( $file_path ) ) { 89 $template_data = implode( '', file( $file_path ) ); 90 91 if ( preg_match( '|Template Name:(.*)$|mi', $template_data, $name ) ) { 92 /* translators: %s: Template name. */ 93 return sprintf( __( '%s Page Template' ), _cleanup_header_comment( $name[1] ) ); 94 } 95 } 96 97 return trim( basename( $file ) ); 98 } 99 100 /** 101 * Gets the absolute filesystem path to the root of the WordPress installation. 102 * 103 * @since 1.5.0 104 * 105 * @return string Full filesystem path to the root of the WordPress installation. 106 */ 107 function get_home_path() { 108 $home = set_url_scheme( get_option( 'home' ), 'http' ); 109 $siteurl = set_url_scheme( get_option( 'siteurl' ), 'http' ); 110 111 if ( ! empty( $home ) && 0 !== strcasecmp( $home, $siteurl ) ) { 112 $wp_path_rel_to_home = str_ireplace( $home, '', $siteurl ); /* $siteurl - $home */ 113 $pos = strripos( str_replace( '\\', '/', $_SERVER['SCRIPT_FILENAME'] ), trailingslashit( $wp_path_rel_to_home ) ); 114 $home_path = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos ); 115 $home_path = trailingslashit( $home_path ); 116 } else { 117 $home_path = ABSPATH; 118 } 119 120 return str_replace( '\\', '/', $home_path ); 121 } 122 123 /** 124 * Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep. 125 * 126 * The depth of the recursiveness can be controlled by the $levels param. 127 * 128 * @since 2.6.0 129 * @since 4.9.0 Added the `$exclusions` parameter. 130 * @since 6.3.0 Added the `$include_hidden` parameter. 131 * 132 * @param string $folder Optional. Full path to folder. Default empty. 133 * @param int $levels Optional. Levels of folders to follow, Default 100 (PHP Loop limit). 134 * @param string[] $exclusions Optional. List of folders and files to skip. 135 * @param bool $include_hidden Optional. Whether to include details of hidden ("." prefixed) files. 136 * Default false. 137 * @return string[]|false Array of files on success, false on failure. 138 */ 139 function list_files( $folder = '', $levels = 100, $exclusions = array(), $include_hidden = false ) { 140 if ( empty( $folder ) ) { 141 return false; 142 } 143 144 $folder = trailingslashit( $folder ); 145 146 if ( ! $levels ) { 147 return false; 148 } 149 150 $files = array(); 151 152 $dir = @opendir( $folder ); 153 154 if ( $dir ) { 155 while ( ( $file = readdir( $dir ) ) !== false ) { 156 // Skip current and parent folder links. 157 if ( in_array( $file, array( '.', '..' ), true ) ) { 158 continue; 159 } 160 161 // Skip hidden and excluded files. 162 if ( ( ! $include_hidden && '.' === $file[0] ) || in_array( $file, $exclusions, true ) ) { 163 continue; 164 } 165 166 if ( is_dir( $folder . $file ) ) { 167 $files2 = list_files( $folder . $file, $levels - 1, array(), $include_hidden ); 168 if ( $files2 ) { 169 $files = array_merge( $files, $files2 ); 170 } else { 171 $files[] = $folder . $file . '/'; 172 } 173 } else { 174 $files[] = $folder . $file; 175 } 176 } 177 178 closedir( $dir ); 179 } 180 181 return $files; 182 } 183 184 /** 185 * Gets the list of file extensions that are editable in plugins. 186 * 187 * @since 4.9.0 188 * 189 * @param string $plugin Path to the plugin file relative to the plugins directory. 190 * @return string[] Array of editable file extensions. 191 */ 192 function wp_get_plugin_file_editable_extensions( $plugin ) { 193 194 $default_types = array( 195 'bash', 196 'conf', 197 'css', 198 'diff', 199 'htm', 200 'html', 201 'http', 202 'inc', 203 'include', 204 'js', 205 'json', 206 'jsx', 207 'less', 208 'md', 209 'patch', 210 'php', 211 'php3', 212 'php4', 213 'php5', 214 'php7', 215 'phps', 216 'phtml', 217 'sass', 218 'scss', 219 'sh', 220 'sql', 221 'svg', 222 'text', 223 'txt', 224 'xml', 225 'yaml', 226 'yml', 227 ); 228 229 /** 230 * Filters the list of file types allowed for editing in the plugin file editor. 231 * 232 * @since 2.8.0 233 * @since 4.9.0 Added the `$plugin` parameter. 234 * 235 * @param string[] $default_types An array of editable plugin file extensions. 236 * @param string $plugin Path to the plugin file relative to the plugins directory. 237 */ 238 $file_types = (array) apply_filters( 'editable_extensions', $default_types, $plugin ); 239 240 return $file_types; 241 } 242 243 /** 244 * Gets the list of file extensions that are editable for a given theme. 245 * 246 * @since 4.9.0 247 * 248 * @param WP_Theme $theme Theme object. 249 * @return string[] Array of editable file extensions. 250 */ 251 function wp_get_theme_file_editable_extensions( $theme ) { 252 253 $default_types = array( 254 'bash', 255 'conf', 256 'css', 257 'diff', 258 'htm', 259 'html', 260 'http', 261 'inc', 262 'include', 263 'js', 264 'json', 265 'jsx', 266 'less', 267 'md', 268 'patch', 269 'php', 270 'php3', 271 'php4', 272 'php5', 273 'php7', 274 'phps', 275 'phtml', 276 'sass', 277 'scss', 278 'sh', 279 'sql', 280 'svg', 281 'text', 282 'txt', 283 'xml', 284 'yaml', 285 'yml', 286 ); 287 288 /** 289 * Filters the list of file types allowed for editing in the theme file editor. 290 * 291 * @since 4.4.0 292 * 293 * @param string[] $default_types An array of editable theme file extensions. 294 * @param WP_Theme $theme The active theme object. 295 */ 296 $file_types = apply_filters( 'wp_theme_editor_filetypes', $default_types, $theme ); 297 298 // Ensure that default types are still there. 299 return array_unique( array_merge( $file_types, $default_types ) ); 300 } 301 302 /** 303 * Prints file editor templates (for plugins and themes). 304 * 305 * @since 4.9.0 306 */ 307 function wp_print_file_editor_templates() { 308 ?> 309 <script type="text/html" id="tmpl-wp-file-editor-notice"> 310 <div class="notice inline notice-{{ data.type || 'info' }} {{ data.alt ? 'notice-alt' : '' }} {{ data.dismissible ? 'is-dismissible' : '' }} {{ data.classes || '' }}"> 311 <# if ( 'php_error' === data.code ) { #> 312 <p> 313 <?php 314 printf( 315 /* translators: 1: Line number, 2: File path. */ 316 __( 'Your PHP code changes were not applied due to an error on line %1$s of file %2$s. Please fix and try saving again.' ), 317 '{{ data.line }}', 318 '{{ data.file }}' 319 ); 320 ?> 321 </p> 322 <pre>{{ data.message }}</pre> 323 <# } else if ( 'file_not_writable' === data.code ) { #> 324 <p> 325 <?php 326 printf( 327 /* translators: %s: Documentation URL. */ 328 __( 'You need to make this file writable before you can save your changes. See <a href="%s">Changing File Permissions</a> for more information.' ), 329 __( 'https://developer.wordpress.org/advanced-administration/server/file-permissions/' ) 330 ); 331 ?> 332 </p> 333 <# } else { #> 334 <p>{{ data.message || data.code }}</p> 335 336 <# if ( 'lint_errors' === data.code ) { #> 337 <p> 338 <# var elementId = 'el-' + String( Math.random() ); #> 339 <input id="{{ elementId }}" type="checkbox"> 340 <label for="{{ elementId }}"><?php _e( 'Update anyway, even though it might break your site?' ); ?></label> 341 </p> 342 <# } #> 343 <# } #> 344 <# if ( data.dismissible ) { #> 345 <button type="button" class="notice-dismiss"><span class="screen-reader-text"> 346 <?php 347 /* translators: Hidden accessibility text. */ 348 _e( 'Dismiss' ); 349 ?> 350 </span></button> 351 <# } #> 352 </div> 353 </script> 354 <?php 355 } 356 357 /** 358 * Attempts to edit a file for a theme or plugin. 359 * 360 * When editing a PHP file, loopback requests will be made to the admin and the homepage 361 * to attempt to see if there is a fatal error introduced. If so, the PHP change will be 362 * reverted. 363 * 364 * @since 4.9.0 365 * 366 * @param string[] $args { 367 * Args. Note that all of the arg values are already unslashed. They are, however, 368 * coming straight from `$_POST` and are not validated or sanitized in any way. 369 * 370 * @type string $file Relative path to file. 371 * @type string $plugin Path to the plugin file relative to the plugins directory. 372 * @type string $theme Theme being edited. 373 * @type string $newcontent New content for the file. 374 * @type string $nonce Nonce. 375 * } 376 * @return true|WP_Error True on success or `WP_Error` on failure. 377 */ 378 function wp_edit_theme_plugin_file( $args ) { 379 if ( empty( $args['file'] ) ) { 380 return new WP_Error( 'missing_file' ); 381 } 382 383 if ( 0 !== validate_file( $args['file'] ) ) { 384 return new WP_Error( 'bad_file' ); 385 } 386 387 if ( ! isset( $args['newcontent'] ) ) { 388 return new WP_Error( 'missing_content' ); 389 } 390 391 if ( ! isset( $args['nonce'] ) ) { 392 return new WP_Error( 'missing_nonce' ); 393 } 394 395 $file = $args['file']; 396 $content = $args['newcontent']; 397 398 $plugin = null; 399 $theme = null; 400 $real_file = null; 401 402 if ( ! empty( $args['plugin'] ) ) { 403 $plugin = $args['plugin']; 404 405 if ( ! current_user_can( 'edit_plugins' ) ) { 406 return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit plugins for this site.' ) ); 407 } 408 409 if ( ! wp_verify_nonce( $args['nonce'], 'edit-plugin_' . $file ) ) { 410 return new WP_Error( 'nonce_failure' ); 411 } 412 413 if ( ! array_key_exists( $plugin, get_plugins() ) ) { 414 return new WP_Error( 'invalid_plugin' ); 415 } 416 417 if ( 0 !== validate_file( $file, get_plugin_files( $plugin ) ) ) { 418 return new WP_Error( 'bad_plugin_file_path', __( 'Sorry, that file cannot be edited.' ) ); 419 } 420 421 $editable_extensions = wp_get_plugin_file_editable_extensions( $plugin ); 422 423 $real_file = WP_PLUGIN_DIR . '/' . $file; 424 425 $is_active = in_array( 426 $plugin, 427 (array) get_option( 'active_plugins', array() ), 428 true 429 ); 430 431 } elseif ( ! empty( $args['theme'] ) ) { 432 $stylesheet = $args['theme']; 433 434 if ( 0 !== validate_file( $stylesheet ) ) { 435 return new WP_Error( 'bad_theme_path' ); 436 } 437 438 if ( ! current_user_can( 'edit_themes' ) ) { 439 return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit templates for this site.' ) ); 440 } 441 442 $theme = wp_get_theme( $stylesheet ); 443 if ( ! $theme->exists() ) { 444 return new WP_Error( 'non_existent_theme', __( 'The requested theme does not exist.' ) ); 445 } 446 447 if ( ! wp_verify_nonce( $args['nonce'], 'edit-theme_' . $stylesheet . '_' . $file ) ) { 448 return new WP_Error( 'nonce_failure' ); 449 } 450 451 if ( $theme->errors() && 'theme_no_stylesheet' === $theme->errors()->get_error_code() ) { 452 return new WP_Error( 453 'theme_no_stylesheet', 454 __( 'The requested theme does not exist.' ) . ' ' . $theme->errors()->get_error_message() 455 ); 456 } 457 458 $editable_extensions = wp_get_theme_file_editable_extensions( $theme ); 459 460 $allowed_files = array(); 461 foreach ( $editable_extensions as $type ) { 462 switch ( $type ) { 463 case 'php': 464 $allowed_files = array_merge( $allowed_files, $theme->get_files( 'php', -1 ) ); 465 break; 466 case 'css': 467 $style_files = $theme->get_files( 'css', -1 ); 468 $allowed_files['style.css'] = $style_files['style.css']; 469 $allowed_files = array_merge( $allowed_files, $style_files ); 470 break; 471 default: 472 $allowed_files = array_merge( $allowed_files, $theme->get_files( $type, -1 ) ); 473 break; 474 } 475 } 476 477 // Compare based on relative paths. 478 if ( 0 !== validate_file( $file, array_keys( $allowed_files ) ) ) { 479 return new WP_Error( 'disallowed_theme_file', __( 'Sorry, that file cannot be edited.' ) ); 480 } 481 482 $real_file = $theme->get_stylesheet_directory() . '/' . $file; 483 484 $is_active = ( get_stylesheet() === $stylesheet || get_template() === $stylesheet ); 485 486 } else { 487 return new WP_Error( 'missing_theme_or_plugin' ); 488 } 489 490 // Ensure file is real. 491 if ( ! is_file( $real_file ) ) { 492 return new WP_Error( 'file_does_not_exist', __( 'File does not exist! Please double check the name and try again.' ) ); 493 } 494 495 // Ensure file extension is allowed. 496 $extension = null; 497 if ( preg_match( '/\.([^.]+)$/', $real_file, $matches ) ) { 498 $extension = strtolower( $matches[1] ); 499 if ( ! in_array( $extension, $editable_extensions, true ) ) { 500 return new WP_Error( 'illegal_file_type', __( 'Files of this type are not editable.' ) ); 501 } 502 } 503 504 $previous_content = file_get_contents( $real_file ); 505 506 if ( ! is_writable( $real_file ) ) { 507 return new WP_Error( 'file_not_writable' ); 508 } 509 510 $f = fopen( $real_file, 'w+' ); 511 512 if ( false === $f ) { 513 return new WP_Error( 'file_not_writable' ); 514 } 515 516 $written = fwrite( $f, $content ); 517 fclose( $f ); 518 519 if ( false === $written ) { 520 return new WP_Error( 'unable_to_write', __( 'Unable to write to file.' ) ); 521 } 522 523 wp_opcache_invalidate( $real_file, true ); 524 525 if ( $is_active && 'php' === $extension ) { 526 527 $scrape_key = md5( rand() ); 528 $transient = 'scrape_key_' . $scrape_key; 529 $scrape_nonce = (string) rand(); 530 // It shouldn't take more than 60 seconds to make the two loopback requests. 531 set_transient( $transient, $scrape_nonce, 60 ); 532 533 $cookies = wp_unslash( $_COOKIE ); 534 $scrape_params = array( 535 'wp_scrape_key' => $scrape_key, 536 'wp_scrape_nonce' => $scrape_nonce, 537 ); 538 $headers = array( 539 'Cache-Control' => 'no-cache', 540 ); 541 542 /** This filter is documented in wp-includes/class-wp-http-streams.php */ 543 $sslverify = apply_filters( 'https_local_ssl_verify', false ); 544 545 // Include Basic auth in loopback requests. 546 if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) { 547 $headers['Authorization'] = 'Basic ' . base64_encode( wp_unslash( $_SERVER['PHP_AUTH_USER'] ) . ':' . wp_unslash( $_SERVER['PHP_AUTH_PW'] ) ); 548 } 549 550 // Make sure PHP process doesn't die before loopback requests complete. 551 if ( function_exists( 'set_time_limit' ) ) { 552 set_time_limit( 5 * MINUTE_IN_SECONDS ); 553 } 554 555 // Time to wait for loopback requests to finish. 556 $timeout = 100; // 100 seconds. 557 558 $needle_start = "###### wp_scraping_result_start:$scrape_key ######"; 559 $needle_end = "###### wp_scraping_result_end:$scrape_key ######"; 560 561 // Attempt loopback request to editor to see if user just whitescreened themselves. 562 if ( $plugin ) { 563 $url = add_query_arg( compact( 'plugin', 'file' ), admin_url( 'plugin-editor.php' ) ); 564 } elseif ( isset( $stylesheet ) ) { 565 $url = add_query_arg( 566 array( 567 'theme' => $stylesheet, 568 'file' => $file, 569 ), 570 admin_url( 'theme-editor.php' ) 571 ); 572 } else { 573 $url = admin_url(); 574 } 575 576 if ( function_exists( 'session_status' ) && PHP_SESSION_ACTIVE === session_status() ) { 577 /* 578 * Close any active session to prevent HTTP requests from timing out 579 * when attempting to connect back to the site. 580 */ 581 session_write_close(); 582 } 583 584 $url = add_query_arg( $scrape_params, $url ); 585 $r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) ); 586 $body = wp_remote_retrieve_body( $r ); 587 $scrape_result_position = strpos( $body, $needle_start ); 588 589 $loopback_request_failure = array( 590 'code' => 'loopback_request_failed', 591 'message' => __( 'Unable to communicate back with site to check for fatal errors, so the PHP change was reverted. You will need to upload your PHP file change by some other means, such as by using SFTP.' ), 592 ); 593 $json_parse_failure = array( 594 'code' => 'json_parse_error', 595 ); 596 597 $result = null; 598 599 if ( false === $scrape_result_position ) { 600 $result = $loopback_request_failure; 601 } else { 602 $error_output = substr( $body, $scrape_result_position + strlen( $needle_start ) ); 603 $error_output = substr( $error_output, 0, strpos( $error_output, $needle_end ) ); 604 $result = json_decode( trim( $error_output ), true ); 605 if ( empty( $result ) ) { 606 $result = $json_parse_failure; 607 } 608 } 609 610 // Try making request to homepage as well to see if visitors have been whitescreened. 611 if ( true === $result ) { 612 $url = home_url( '/' ); 613 $url = add_query_arg( $scrape_params, $url ); 614 $r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) ); 615 $body = wp_remote_retrieve_body( $r ); 616 $scrape_result_position = strpos( $body, $needle_start ); 617 618 if ( false === $scrape_result_position ) { 619 $result = $loopback_request_failure; 620 } else { 621 $error_output = substr( $body, $scrape_result_position + strlen( $needle_start ) ); 622 $error_output = substr( $error_output, 0, strpos( $error_output, $needle_end ) ); 623 $result = json_decode( trim( $error_output ), true ); 624 if ( empty( $result ) ) { 625 $result = $json_parse_failure; 626 } 627 } 628 } 629 630 delete_transient( $transient ); 631 632 if ( true !== $result ) { 633 // Roll-back file change. 634 file_put_contents( $real_file, $previous_content ); 635 wp_opcache_invalidate( $real_file, true ); 636 637 if ( ! isset( $result['message'] ) ) { 638 $message = __( 'Something went wrong.' ); 639 } else { 640 $message = $result['message']; 641 unset( $result['message'] ); 642 } 643 644 return new WP_Error( 'php_error', $message, $result ); 645 } 646 } 647 648 if ( $theme instanceof WP_Theme ) { 649 $theme->cache_delete(); 650 } 651 652 return true; 653 } 654 655 656 /** 657 * Returns a filename of a temporary unique file. 658 * 659 * Please note that the calling function must delete or move the file. 660 * 661 * The filename is based off the passed parameter or defaults to the current unix timestamp, 662 * while the directory can either be passed as well, or by leaving it blank, default to a writable 663 * temporary directory. 664 * 665 * @since 2.6.0 666 * 667 * @param string $filename Optional. Filename to base the Unique file off. Default empty. 668 * @param string $dir Optional. Directory to store the file in. Default empty. 669 * @return string A writable filename. 670 */ 671 function wp_tempnam( $filename = '', $dir = '' ) { 672 if ( empty( $dir ) ) { 673 $dir = get_temp_dir(); 674 } 675 676 if ( empty( $filename ) || in_array( $filename, array( '.', '/', '\\' ), true ) ) { 677 $filename = uniqid(); 678 } 679 680 // Use the basename of the given file without the extension as the name for the temporary directory. 681 $temp_filename = basename( $filename ); 682 $temp_filename = preg_replace( '|\.[^.]*$|', '', $temp_filename ); 683 684 // If the folder is falsey, use its parent directory name instead. 685 if ( ! $temp_filename ) { 686 return wp_tempnam( dirname( $filename ), $dir ); 687 } 688 689 // Suffix some random data to avoid filename conflicts. 690 $temp_filename .= '-' . wp_generate_password( 6, false ); 691 $temp_filename .= '.tmp'; 692 $temp_filename = wp_unique_filename( $dir, $temp_filename ); 693 694 /* 695 * Filesystems typically have a limit of 255 characters for a filename. 696 * 697 * If the generated unique filename exceeds this, truncate the initial 698 * filename and try again. 699 * 700 * As it's possible that the truncated filename may exist, producing a 701 * suffix of "-1" or "-10" which could exceed the limit again, truncate 702 * it to 252 instead. 703 */ 704 $characters_over_limit = strlen( $temp_filename ) - 252; 705 if ( $characters_over_limit > 0 ) { 706 $filename = substr( $filename, 0, -$characters_over_limit ); 707 return wp_tempnam( $filename, $dir ); 708 } 709 710 $temp_filename = $dir . $temp_filename; 711 712 $fp = @fopen( $temp_filename, 'x' ); 713 714 if ( ! $fp && is_writable( $dir ) && file_exists( $temp_filename ) ) { 715 return wp_tempnam( $filename, $dir ); 716 } 717 718 if ( $fp ) { 719 fclose( $fp ); 720 } 721 722 return $temp_filename; 723 } 724 725 /** 726 * Makes sure that the file that was requested to be edited is allowed to be edited. 727 * 728 * Function will die if you are not allowed to edit the file. 729 * 730 * @since 1.5.0 731 * 732 * @param string $file File the user is attempting to edit. 733 * @param string[] $allowed_files Optional. Array of allowed files to edit. 734 * `$file` must match an entry exactly. 735 * @return string|void Returns the file name on success, dies on failure. 736 */ 737 function validate_file_to_edit( $file, $allowed_files = array() ) { 738 $code = validate_file( $file, $allowed_files ); 739 740 if ( ! $code ) { 741 return $file; 742 } 743 744 switch ( $code ) { 745 case 1: 746 wp_die( __( 'Sorry, that file cannot be edited.' ) ); 747 748 // case 2 : 749 // wp_die( __('Sorry, cannot call files with their real path.' )); 750 751 case 3: 752 wp_die( __( 'Sorry, that file cannot be edited.' ) ); 753 } 754 } 755 756 /** 757 * Handles PHP uploads in WordPress. 758 * 759 * Sanitizes file names, checks extensions for mime type, and moves the file 760 * to the appropriate directory within the uploads directory. 761 * 762 * @access private 763 * @since 4.0.0 764 * 765 * @see wp_handle_upload_error 766 * 767 * @param array $file { 768 * Reference to a single element from `$_FILES`. Call the function once for each uploaded file. 769 * 770 * @type string $name The original name of the file on the client machine. 771 * @type string $type The mime type of the file, if the browser provided this information. 772 * @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server. 773 * @type int $size The size, in bytes, of the uploaded file. 774 * @type int $error The error code associated with this file upload. 775 * } 776 * @param array|false $overrides { 777 * An array of override parameters for this file, or boolean false if none are provided. 778 * 779 * @type callable $upload_error_handler Function to call when there is an error during the upload process. 780 * See {@see wp_handle_upload_error()}. 781 * @type callable $unique_filename_callback Function to call when determining a unique file name for the file. 782 * See {@see wp_unique_filename()}. 783 * @type string[] $upload_error_strings The strings that describe the error indicated in 784 * `$_FILES[{form field}]['error']`. 785 * @type bool $test_form Whether to test that the `$_POST['action']` parameter is as expected. 786 * @type bool $test_size Whether to test that the file size is greater than zero bytes. 787 * @type bool $test_type Whether to test that the mime type of the file is as expected. 788 * @type string[] $mimes Array of allowed mime types keyed by their file extension regex. 789 * } 790 * @param string $time Time formatted in 'yyyy/mm'. 791 * @param string $action Expected value for `$_POST['action']`. 792 * @return array { 793 * On success, returns an associative array of file attributes. 794 * On failure, returns `$overrides['upload_error_handler']( &$file, $message )` 795 * or `array( 'error' => $message )`. 796 * 797 * @type string $file Filename of the newly-uploaded file. 798 * @type string $url URL of the newly-uploaded file. 799 * @type string $type Mime type of the newly-uploaded file. 800 * } 801 */ 802 function _wp_handle_upload( &$file, $overrides, $time, $action ) { 803 // The default error handler. 804 if ( ! function_exists( 'wp_handle_upload_error' ) ) { 805 function wp_handle_upload_error( &$file, $message ) { 806 return array( 'error' => $message ); 807 } 808 } 809 810 /** 811 * Filters the data for a file before it is uploaded to WordPress. 812 * 813 * The dynamic portion of the hook name, `$action`, refers to the post action. 814 * 815 * Possible hook names include: 816 * 817 * - `wp_handle_sideload_prefilter` 818 * - `wp_handle_upload_prefilter` 819 * 820 * @since 2.9.0 as 'wp_handle_upload_prefilter'. 821 * @since 4.0.0 Converted to a dynamic hook with `$action`. 822 * 823 * @param array $file { 824 * Reference to a single element from `$_FILES`. 825 * 826 * @type string $name The original name of the file on the client machine. 827 * @type string $type The mime type of the file, if the browser provided this information. 828 * @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server. 829 * @type int $size The size, in bytes, of the uploaded file. 830 * @type int $error The error code associated with this file upload. 831 * } 832 */ 833 $file = apply_filters( "{$action}_prefilter", $file ); 834 835 /** 836 * Filters the override parameters for a file before it is uploaded to WordPress. 837 * 838 * The dynamic portion of the hook name, `$action`, refers to the post action. 839 * 840 * Possible hook names include: 841 * 842 * - `wp_handle_sideload_overrides` 843 * - `wp_handle_upload_overrides` 844 * 845 * @since 5.7.0 846 * 847 * @param array|false $overrides An array of override parameters for this file. Boolean false if none are 848 * provided. See {@see _wp_handle_upload()}. 849 * @param array $file { 850 * Reference to a single element from `$_FILES`. 851 * 852 * @type string $name The original name of the file on the client machine. 853 * @type string $type The mime type of the file, if the browser provided this information. 854 * @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server. 855 * @type int $size The size, in bytes, of the uploaded file. 856 * @type int $error The error code associated with this file upload. 857 * } 858 */ 859 $overrides = apply_filters( "{$action}_overrides", $overrides, $file ); 860 861 // You may define your own function and pass the name in $overrides['upload_error_handler']. 862 $upload_error_handler = 'wp_handle_upload_error'; 863 if ( isset( $overrides['upload_error_handler'] ) ) { 864 $upload_error_handler = $overrides['upload_error_handler']; 865 } 866 867 // You may have had one or more 'wp_handle_upload_prefilter' functions error out the file. Handle that gracefully. 868 if ( isset( $file['error'] ) && ! is_numeric( $file['error'] ) && $file['error'] ) { 869 return call_user_func_array( $upload_error_handler, array( &$file, $file['error'] ) ); 870 } 871 872 // Install user overrides. Did we mention that this voids your warranty? 873 874 // You may define your own function and pass the name in $overrides['unique_filename_callback']. 875 $unique_filename_callback = null; 876 if ( isset( $overrides['unique_filename_callback'] ) ) { 877 $unique_filename_callback = $overrides['unique_filename_callback']; 878 } 879 880 /* 881 * This may not have originally been intended to be overridable, 882 * but historically has been. 883 */ 884 if ( isset( $overrides['upload_error_strings'] ) ) { 885 $upload_error_strings = $overrides['upload_error_strings']; 886 } else { 887 // Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error']. 888 $upload_error_strings = array( 889 false, 890 sprintf( 891 /* translators: 1: upload_max_filesize, 2: php.ini */ 892 __( 'The uploaded file exceeds the %1$s directive in %2$s.' ), 893 'upload_max_filesize', 894 'php.ini' 895 ), 896 sprintf( 897 /* translators: %s: MAX_FILE_SIZE */ 898 __( 'The uploaded file exceeds the %s directive that was specified in the HTML form.' ), 899 'MAX_FILE_SIZE' 900 ), 901 __( 'The uploaded file was only partially uploaded.' ), 902 __( 'No file was uploaded.' ), 903 '', 904 __( 'Missing a temporary folder.' ), 905 __( 'Failed to write file to disk.' ), 906 __( 'File upload stopped by extension.' ), 907 ); 908 } 909 910 // All tests are on by default. Most can be turned off by $overrides[{test_name}] = false; 911 $test_form = isset( $overrides['test_form'] ) ? $overrides['test_form'] : true; 912 $test_size = isset( $overrides['test_size'] ) ? $overrides['test_size'] : true; 913 914 // If you override this, you must provide $ext and $type!! 915 $test_type = isset( $overrides['test_type'] ) ? $overrides['test_type'] : true; 916 $mimes = isset( $overrides['mimes'] ) ? $overrides['mimes'] : null; 917 918 // A correct form post will pass this test. 919 if ( $test_form && ( ! isset( $_POST['action'] ) || $_POST['action'] !== $action ) ) { 920 return call_user_func_array( $upload_error_handler, array( &$file, __( 'Invalid form submission.' ) ) ); 921 } 922 923 // A successful upload will pass this test. It makes no sense to override this one. 924 if ( isset( $file['error'] ) && $file['error'] > 0 ) { 925 return call_user_func_array( $upload_error_handler, array( &$file, $upload_error_strings[ $file['error'] ] ) ); 926 } 927 928 // A properly uploaded file will pass this test. There should be no reason to override this one. 929 $test_uploaded_file = 'wp_handle_upload' === $action ? is_uploaded_file( $file['tmp_name'] ) : @is_readable( $file['tmp_name'] ); 930 if ( ! $test_uploaded_file ) { 931 return call_user_func_array( $upload_error_handler, array( &$file, __( 'Specified file failed upload test.' ) ) ); 932 } 933 934 $test_file_size = 'wp_handle_upload' === $action ? $file['size'] : filesize( $file['tmp_name'] ); 935 // A non-empty file will pass this test. 936 if ( $test_size && ! ( $test_file_size > 0 ) ) { 937 if ( is_multisite() ) { 938 $error_msg = __( 'File is empty. Please upload something more substantial.' ); 939 } else { 940 $error_msg = sprintf( 941 /* translators: 1: php.ini, 2: post_max_size, 3: upload_max_filesize */ 942 __( 'File is empty. Please upload something more substantial. This error could also be caused by uploads being disabled in your %1$s file or by %2$s being defined as smaller than %3$s in %1$s.' ), 943 'php.ini', 944 'post_max_size', 945 'upload_max_filesize' 946 ); 947 } 948 949 return call_user_func_array( $upload_error_handler, array( &$file, $error_msg ) ); 950 } 951 952 // A correct MIME type will pass this test. Override $mimes or use the upload_mimes filter. 953 if ( $test_type ) { 954 $wp_filetype = wp_check_filetype_and_ext( $file['tmp_name'], $file['name'], $mimes ); 955 $ext = empty( $wp_filetype['ext'] ) ? '' : $wp_filetype['ext']; 956 $type = empty( $wp_filetype['type'] ) ? '' : $wp_filetype['type']; 957 $proper_filename = empty( $wp_filetype['proper_filename'] ) ? '' : $wp_filetype['proper_filename']; 958 959 // Check to see if wp_check_filetype_and_ext() determined the filename was incorrect. 960 if ( $proper_filename ) { 961 $file['name'] = $proper_filename; 962 } 963 964 if ( ( ! $type || ! $ext ) && ! current_user_can( 'unfiltered_upload' ) ) { 965 return call_user_func_array( $upload_error_handler, array( &$file, __( 'Sorry, you are not allowed to upload this file type.' ) ) ); 966 } 967 968 if ( ! $type ) { 969 $type = $file['type']; 970 } 971 } else { 972 $type = ''; 973 } 974 975 /* 976 * A writable uploads dir will pass this test. Again, there's no point 977 * overriding this one. 978 */ 979 $uploads = wp_upload_dir( $time ); 980 if ( ! ( $uploads && false === $uploads['error'] ) ) { 981 return call_user_func_array( $upload_error_handler, array( &$file, $uploads['error'] ) ); 982 } 983 984 $filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback ); 985 986 // Move the file to the uploads dir. 987 $new_file = $uploads['path'] . "/$filename"; 988 989 /** 990 * Filters whether to short-circuit moving the uploaded file after passing all checks. 991 * 992 * If a non-null value is returned from the filter, moving the file and any related 993 * error reporting will be completely skipped. 994 * 995 * @since 4.9.0 996 * 997 * @param mixed $move_new_file If null (default) move the file after the upload. 998 * @param array $file { 999 * Reference to a single element from `$_FILES`. 1000 * 1001 * @type string $name The original name of the file on the client machine. 1002 * @type string $type The mime type of the file, if the browser provided this information. 1003 * @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server. 1004 * @type int $size The size, in bytes, of the uploaded file. 1005 * @type int $error The error code associated with this file upload. 1006 * } 1007 * @param string $new_file Filename of the newly-uploaded file. 1008 * @param string $type Mime type of the newly-uploaded file. 1009 */ 1010 $move_new_file = apply_filters( 'pre_move_uploaded_file', null, $file, $new_file, $type ); 1011 1012 if ( null === $move_new_file ) { 1013 if ( 'wp_handle_upload' === $action ) { 1014 $move_new_file = @move_uploaded_file( $file['tmp_name'], $new_file ); 1015 } else { 1016 // Use copy and unlink because rename breaks streams. 1017 // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged 1018 $move_new_file = @copy( $file['tmp_name'], $new_file ); 1019 unlink( $file['tmp_name'] ); 1020 } 1021 1022 if ( false === $move_new_file ) { 1023 if ( str_starts_with( $uploads['basedir'], ABSPATH ) ) { 1024 $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir']; 1025 } else { 1026 $error_path = basename( $uploads['basedir'] ) . $uploads['subdir']; 1027 } 1028 1029 return $upload_error_handler( 1030 $file, 1031 sprintf( 1032 /* translators: %s: Destination file path. */ 1033 __( 'The uploaded file could not be moved to %s.' ), 1034 $error_path 1035 ) 1036 ); 1037 } 1038 } 1039 1040 // Set correct file permissions. 1041 $stat = stat( dirname( $new_file ) ); 1042 $perms = $stat['mode'] & 0000666; 1043 chmod( $new_file, $perms ); 1044 1045 // Compute the URL. 1046 $url = $uploads['url'] . "/$filename"; 1047 1048 if ( is_multisite() ) { 1049 clean_dirsize_cache( $new_file ); 1050 } 1051 1052 /** 1053 * Filters the data array for the uploaded file. 1054 * 1055 * @since 2.1.0 1056 * 1057 * @param array $upload { 1058 * Array of upload data. 1059 * 1060 * @type string $file Filename of the newly-uploaded file. 1061 * @type string $url URL of the newly-uploaded file. 1062 * @type string $type Mime type of the newly-uploaded file. 1063 * } 1064 * @param string $context The type of upload action. Values include 'upload' or 'sideload'. 1065 */ 1066 return apply_filters( 1067 'wp_handle_upload', 1068 array( 1069 'file' => $new_file, 1070 'url' => $url, 1071 'type' => $type, 1072 ), 1073 'wp_handle_sideload' === $action ? 'sideload' : 'upload' 1074 ); 1075 } 1076 1077 /** 1078 * Wrapper for _wp_handle_upload(). 1079 * 1080 * Passes the {@see 'wp_handle_upload'} action. 1081 * 1082 * @since 2.0.0 1083 * 1084 * @see _wp_handle_upload() 1085 * 1086 * @param array $file Reference to a single element of `$_FILES`. 1087 * Call the function once for each uploaded file. 1088 * See _wp_handle_upload() for accepted values. 1089 * @param array|false $overrides Optional. An associative array of names => values 1090 * to override default variables. Default false. 1091 * See _wp_handle_upload() for accepted values. 1092 * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null. 1093 * @return array See _wp_handle_upload() for return value. 1094 */ 1095 function wp_handle_upload( &$file, $overrides = false, $time = null ) { 1096 /* 1097 * $_POST['action'] must be set and its value must equal $overrides['action'] 1098 * or this: 1099 */ 1100 $action = 'wp_handle_upload'; 1101 if ( isset( $overrides['action'] ) ) { 1102 $action = $overrides['action']; 1103 } 1104 1105 return _wp_handle_upload( $file, $overrides, $time, $action ); 1106 } 1107 1108 /** 1109 * Wrapper for _wp_handle_upload(). 1110 * 1111 * Passes the {@see 'wp_handle_sideload'} action. 1112 * 1113 * @since 2.6.0 1114 * 1115 * @see _wp_handle_upload() 1116 * 1117 * @param array $file Reference to a single element of `$_FILES`. 1118 * Call the function once for each uploaded file. 1119 * See _wp_handle_upload() for accepted values. 1120 * @param array|false $overrides Optional. An associative array of names => values 1121 * to override default variables. Default false. 1122 * See _wp_handle_upload() for accepted values. 1123 * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null. 1124 * @return array See _wp_handle_upload() for return value. 1125 */ 1126 function wp_handle_sideload( &$file, $overrides = false, $time = null ) { 1127 /* 1128 * $_POST['action'] must be set and its value must equal $overrides['action'] 1129 * or this: 1130 */ 1131 $action = 'wp_handle_sideload'; 1132 if ( isset( $overrides['action'] ) ) { 1133 $action = $overrides['action']; 1134 } 1135 1136 return _wp_handle_upload( $file, $overrides, $time, $action ); 1137 } 1138 1139 /** 1140 * Downloads a URL to a local temporary file using the WordPress HTTP API. 1141 * 1142 * Please note that the calling function must delete or move the file. 1143 * 1144 * @since 2.5.0 1145 * @since 5.2.0 Signature Verification with SoftFail was added. 1146 * @since 5.9.0 Support for Content-Disposition filename was added. 1147 * 1148 * @param string $url The URL of the file to download. 1149 * @param int $timeout The timeout for the request to download the file. 1150 * Default 300 seconds. 1151 * @param bool $signature_verification Whether to perform Signature Verification. 1152 * Default false. 1153 * @return string|WP_Error Filename on success, WP_Error on failure. 1154 */ 1155 function download_url( $url, $timeout = 300, $signature_verification = false ) { 1156 // WARNING: The file is not automatically deleted, the script must delete or move the file. 1157 if ( ! $url ) { 1158 return new WP_Error( 'http_no_url', __( 'Invalid URL Provided.' ) ); 1159 } 1160 1161 $url_path = parse_url( $url, PHP_URL_PATH ); 1162 $url_filename = ''; 1163 if ( is_string( $url_path ) && '' !== $url_path ) { 1164 $url_filename = basename( $url_path ); 1165 } 1166 1167 $tmpfname = wp_tempnam( $url_filename ); 1168 if ( ! $tmpfname ) { 1169 return new WP_Error( 'http_no_file', __( 'Could not create temporary file.' ) ); 1170 } 1171 1172 $response = wp_safe_remote_get( 1173 $url, 1174 array( 1175 'timeout' => $timeout, 1176 'stream' => true, 1177 'filename' => $tmpfname, 1178 ) 1179 ); 1180 1181 if ( is_wp_error( $response ) ) { 1182 unlink( $tmpfname ); 1183 return $response; 1184 } 1185 1186 $response_code = wp_remote_retrieve_response_code( $response ); 1187 1188 if ( 200 !== $response_code ) { 1189 $data = array( 1190 'code' => $response_code, 1191 ); 1192 1193 // Retrieve a sample of the response body for debugging purposes. 1194 $tmpf = fopen( $tmpfname, 'rb' ); 1195 1196 if ( $tmpf ) { 1197 /** 1198 * Filters the maximum error response body size in `download_url()`. 1199 * 1200 * @since 5.1.0 1201 * 1202 * @see download_url() 1203 * 1204 * @param int $size The maximum error response body size. Default 1 KB. 1205 */ 1206 $response_size = apply_filters( 'download_url_error_max_body_size', KB_IN_BYTES ); 1207 1208 $data['body'] = fread( $tmpf, $response_size ); 1209 fclose( $tmpf ); 1210 } 1211 1212 unlink( $tmpfname ); 1213 1214 return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ), $data ); 1215 } 1216 1217 $content_disposition = wp_remote_retrieve_header( $response, 'Content-Disposition' ); 1218 1219 if ( $content_disposition ) { 1220 $content_disposition = strtolower( $content_disposition ); 1221 1222 if ( str_starts_with( $content_disposition, 'attachment; filename=' ) ) { 1223 $tmpfname_disposition = sanitize_file_name( substr( $content_disposition, 21 ) ); 1224 } else { 1225 $tmpfname_disposition = ''; 1226 } 1227 1228 // Potential file name must be valid string. 1229 if ( $tmpfname_disposition && is_string( $tmpfname_disposition ) 1230 && ( 0 === validate_file( $tmpfname_disposition ) ) 1231 ) { 1232 $tmpfname_disposition = dirname( $tmpfname ) . '/' . $tmpfname_disposition; 1233 1234 if ( rename( $tmpfname, $tmpfname_disposition ) ) { 1235 $tmpfname = $tmpfname_disposition; 1236 } 1237 1238 if ( ( $tmpfname !== $tmpfname_disposition ) && file_exists( $tmpfname_disposition ) ) { 1239 unlink( $tmpfname_disposition ); 1240 } 1241 } 1242 } 1243 1244 $content_md5 = wp_remote_retrieve_header( $response, 'Content-MD5' ); 1245 1246 if ( $content_md5 ) { 1247 $md5_check = verify_file_md5( $tmpfname, $content_md5 ); 1248 1249 if ( is_wp_error( $md5_check ) ) { 1250 unlink( $tmpfname ); 1251 return $md5_check; 1252 } 1253 } 1254 1255 // If the caller expects signature verification to occur, check to see if this URL supports it. 1256 if ( $signature_verification ) { 1257 /** 1258 * Filters the list of hosts which should have Signature Verification attempted on. 1259 * 1260 * @since 5.2.0 1261 * 1262 * @param string[] $hostnames List of hostnames. 1263 */ 1264 $signed_hostnames = apply_filters( 'wp_signature_hosts', array( 'wordpress.org', 'downloads.wordpress.org', 's.w.org' ) ); 1265 1266 $signature_verification = in_array( parse_url( $url, PHP_URL_HOST ), $signed_hostnames, true ); 1267 } 1268 1269 // Perform signature validation if supported. 1270 if ( $signature_verification ) { 1271 $signature = wp_remote_retrieve_header( $response, 'X-Content-Signature' ); 1272 1273 if ( ! $signature ) { 1274 /* 1275 * Retrieve signatures from a file if the header wasn't included. 1276 * WordPress.org stores signatures at $package_url.sig. 1277 */ 1278 1279 $signature_url = false; 1280 1281 if ( is_string( $url_path ) && ( str_ends_with( $url_path, '.zip' ) || str_ends_with( $url_path, '.tar.gz' ) ) ) { 1282 $signature_url = str_replace( $url_path, $url_path . '.sig', $url ); 1283 } 1284 1285 /** 1286 * Filters the URL where the signature for a file is located. 1287 * 1288 * @since 5.2.0 1289 * 1290 * @param false|string $signature_url The URL where signatures can be found for a file, or false if none are known. 1291 * @param string $url The URL being verified. 1292 */ 1293 $signature_url = apply_filters( 'wp_signature_url', $signature_url, $url ); 1294 1295 if ( $signature_url ) { 1296 $signature_request = wp_safe_remote_get( 1297 $signature_url, 1298 array( 1299 'limit_response_size' => 10 * KB_IN_BYTES, // 10KB should be large enough for quite a few signatures. 1300 ) 1301 ); 1302 1303 if ( ! is_wp_error( $signature_request ) && 200 === wp_remote_retrieve_response_code( $signature_request ) ) { 1304 $signature = explode( "\n", wp_remote_retrieve_body( $signature_request ) ); 1305 } 1306 } 1307 } 1308 1309 // Perform the checks. 1310 $signature_verification = verify_file_signature( $tmpfname, $signature, $url_filename ); 1311 } 1312 1313 if ( is_wp_error( $signature_verification ) ) { 1314 if ( 1315 /** 1316 * Filters whether Signature Verification failures should be allowed to soft fail. 1317 * 1318 * WARNING: This may be removed from a future release. 1319 * 1320 * @since 5.2.0 1321 * 1322 * @param bool $signature_softfail If a softfail is allowed. 1323 * @param string $url The url being accessed. 1324 */ 1325 apply_filters( 'wp_signature_softfail', true, $url ) 1326 ) { 1327 $signature_verification->add_data( $tmpfname, 'softfail-filename' ); 1328 } else { 1329 // Hard-fail. 1330 unlink( $tmpfname ); 1331 } 1332 1333 return $signature_verification; 1334 } 1335 1336 return $tmpfname; 1337 } 1338 1339 /** 1340 * Calculates and compares the MD5 of a file to its expected value. 1341 * 1342 * @since 3.7.0 1343 * 1344 * @param string $filename The filename to check the MD5 of. 1345 * @param string $expected_md5 The expected MD5 of the file, either a base64-encoded raw md5, 1346 * or a hex-encoded md5. 1347 * @return bool|WP_Error True on success, false when the MD5 format is unknown/unexpected, 1348 * WP_Error on failure. 1349 */ 1350 function verify_file_md5( $filename, $expected_md5 ) { 1351 if ( 32 === strlen( $expected_md5 ) ) { 1352 $expected_raw_md5 = pack( 'H*', $expected_md5 ); 1353 } elseif ( 24 === strlen( $expected_md5 ) ) { 1354 $expected_raw_md5 = base64_decode( $expected_md5 ); 1355 } else { 1356 return false; // Unknown format. 1357 } 1358 1359 $file_md5 = md5_file( $filename, true ); 1360 1361 if ( $file_md5 === $expected_raw_md5 ) { 1362 return true; 1363 } 1364 1365 return new WP_Error( 1366 'md5_mismatch', 1367 sprintf( 1368 /* translators: 1: File checksum, 2: Expected checksum value. */ 1369 __( 'The checksum of the file (%1$s) does not match the expected checksum value (%2$s).' ), 1370 bin2hex( $file_md5 ), 1371 bin2hex( $expected_raw_md5 ) 1372 ) 1373 ); 1374 } 1375 1376 /** 1377 * Verifies the contents of a file against its ED25519 signature. 1378 * 1379 * @since 5.2.0 1380 * 1381 * @param string $filename The file to validate. 1382 * @param string|array $signatures A Signature provided for the file. 1383 * @param string|false $filename_for_errors Optional. A friendly filename for errors. 1384 * @return bool|WP_Error True on success, false if verification not attempted, 1385 * or WP_Error describing an error condition. 1386 */ 1387 function verify_file_signature( $filename, $signatures, $filename_for_errors = false ) { 1388 if ( ! $filename_for_errors ) { 1389 $filename_for_errors = wp_basename( $filename ); 1390 } 1391 1392 // Check we can process signatures. 1393 if ( ! function_exists( 'sodium_crypto_sign_verify_detached' ) || ! in_array( 'sha384', array_map( 'strtolower', hash_algos() ), true ) ) { 1394 return new WP_Error( 1395 'signature_verification_unsupported', 1396 sprintf( 1397 /* translators: %s: The filename of the package. */ 1398 __( 'The authenticity of %s could not be verified as signature verification is unavailable on this system.' ), 1399 '<span class="code">' . esc_html( $filename_for_errors ) . '</span>' 1400 ), 1401 ( ! function_exists( 'sodium_crypto_sign_verify_detached' ) ? 'sodium_crypto_sign_verify_detached' : 'sha384' ) 1402 ); 1403 } 1404 1405 // Check for an edge-case affecting PHP Maths abilities. 1406 if ( 1407 ! extension_loaded( 'sodium' ) && 1408 in_array( PHP_VERSION_ID, array( 70200, 70201, 70202 ), true ) && 1409 extension_loaded( 'opcache' ) 1410 ) { 1411 /* 1412 * Sodium_Compat isn't compatible with PHP 7.2.0~7.2.2 due to a bug in the PHP Opcache extension, bail early as it'll fail. 1413 * https://bugs.php.net/bug.php?id=75938 1414 */ 1415 return new WP_Error( 1416 'signature_verification_unsupported', 1417 sprintf( 1418 /* translators: %s: The filename of the package. */ 1419 __( 'The authenticity of %s could not be verified as signature verification is unavailable on this system.' ), 1420 '<span class="code">' . esc_html( $filename_for_errors ) . '</span>' 1421 ), 1422 array( 1423 'php' => PHP_VERSION, 1424 'sodium' => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ), 1425 ) 1426 ); 1427 } 1428 1429 // Verify runtime speed of Sodium_Compat is acceptable. 1430 if ( ! extension_loaded( 'sodium' ) && ! ParagonIE_Sodium_Compat::polyfill_is_fast() ) { 1431 $sodium_compat_is_fast = false; 1432 1433 // Allow for an old version of Sodium_Compat being loaded before the bundled WordPress one. 1434 if ( method_exists( 'ParagonIE_Sodium_Compat', 'runtime_speed_test' ) ) { 1435 /* 1436 * Run `ParagonIE_Sodium_Compat::runtime_speed_test()` in optimized integer mode, 1437 * as that's what WordPress utilizes during signing verifications. 1438 */ 1439 // phpcs:disable WordPress.NamingConventions.ValidVariableName 1440 $old_fastMult = ParagonIE_Sodium_Compat::$fastMult; 1441 ParagonIE_Sodium_Compat::$fastMult = true; 1442 $sodium_compat_is_fast = ParagonIE_Sodium_Compat::runtime_speed_test( 100, 10 ); 1443 ParagonIE_Sodium_Compat::$fastMult = $old_fastMult; 1444 // phpcs:enable 1445 } 1446 1447 /* 1448 * This cannot be performed in a reasonable amount of time. 1449 * https://github.com/paragonie/sodium_compat#help-sodium_compat-is-slow-how-can-i-make-it-fast 1450 */ 1451 if ( ! $sodium_compat_is_fast ) { 1452 return new WP_Error( 1453 'signature_verification_unsupported', 1454 sprintf( 1455 /* translators: %s: The filename of the package. */ 1456 __( 'The authenticity of %s could not be verified as signature verification is unavailable on this system.' ), 1457 '<span class="code">' . esc_html( $filename_for_errors ) . '</span>' 1458 ), 1459 array( 1460 'php' => PHP_VERSION, 1461 'sodium' => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ), 1462 'polyfill_is_fast' => false, 1463 'max_execution_time' => ini_get( 'max_execution_time' ), 1464 ) 1465 ); 1466 } 1467 } 1468 1469 if ( ! $signatures ) { 1470 return new WP_Error( 1471 'signature_verification_no_signature', 1472 sprintf( 1473 /* translators: %s: The filename of the package. */ 1474 __( 'The authenticity of %s could not be verified as no signature was found.' ), 1475 '<span class="code">' . esc_html( $filename_for_errors ) . '</span>' 1476 ), 1477 array( 1478 'filename' => $filename_for_errors, 1479 ) 1480 ); 1481 } 1482 1483 $trusted_keys = wp_trusted_keys(); 1484 $file_hash = hash_file( 'sha384', $filename, true ); 1485 1486 mbstring_binary_safe_encoding(); 1487 1488 $skipped_key = 0; 1489 $skipped_signature = 0; 1490 1491 foreach ( (array) $signatures as $signature ) { 1492 $signature_raw = base64_decode( $signature ); 1493 1494 // Ensure only valid-length signatures are considered. 1495 if ( SODIUM_CRYPTO_SIGN_BYTES !== strlen( $signature_raw ) ) { 1496 ++$skipped_signature; 1497 continue; 1498 } 1499 1500 foreach ( (array) $trusted_keys as $key ) { 1501 $key_raw = base64_decode( $key ); 1502 1503 // Only pass valid public keys through. 1504 if ( SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES !== strlen( $key_raw ) ) { 1505 ++$skipped_key; 1506 continue; 1507 } 1508 1509 if ( sodium_crypto_sign_verify_detached( $signature_raw, $file_hash, $key_raw ) ) { 1510 reset_mbstring_encoding(); 1511 return true; 1512 } 1513 } 1514 } 1515 1516 reset_mbstring_encoding(); 1517 1518 return new WP_Error( 1519 'signature_verification_failed', 1520 sprintf( 1521 /* translators: %s: The filename of the package. */ 1522 __( 'The authenticity of %s could not be verified.' ), 1523 '<span class="code">' . esc_html( $filename_for_errors ) . '</span>' 1524 ), 1525 // Error data helpful for debugging: 1526 array( 1527 'filename' => $filename_for_errors, 1528 'keys' => $trusted_keys, 1529 'signatures' => $signatures, 1530 'hash' => bin2hex( $file_hash ), 1531 'skipped_key' => $skipped_key, 1532 'skipped_sig' => $skipped_signature, 1533 'php' => PHP_VERSION, 1534 'sodium' => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ), 1535 ) 1536 ); 1537 } 1538 1539 /** 1540 * Retrieves the list of signing keys trusted by WordPress. 1541 * 1542 * @since 5.2.0 1543 * 1544 * @return string[] Array of base64-encoded signing keys. 1545 */ 1546 function wp_trusted_keys() { 1547 $trusted_keys = array(); 1548 1549 if ( time() < 1617235200 ) { 1550 // WordPress.org Key #1 - This key is only valid before April 1st, 2021. 1551 $trusted_keys[] = 'fRPyrxb/MvVLbdsYi+OOEv4xc+Eqpsj+kkAS6gNOkI0='; 1552 } 1553 1554 // TODO: Add key #2 with longer expiration. 1555 1556 /** 1557 * Filters the valid signing keys used to verify the contents of files. 1558 * 1559 * @since 5.2.0 1560 * 1561 * @param string[] $trusted_keys The trusted keys that may sign packages. 1562 */ 1563 return apply_filters( 'wp_trusted_keys', $trusted_keys ); 1564 } 1565 1566 /** 1567 * Determines whether the given file is a valid ZIP file. 1568 * 1569 * This function does not test to ensure that a file exists. Non-existent files 1570 * are not valid ZIPs, so those will also return false. 1571 * 1572 * @since 6.4.4 1573 * 1574 * @param string $file Full path to the ZIP file. 1575 * @return bool Whether the file is a valid ZIP file. 1576 */ 1577 function wp_zip_file_is_valid( $file ) { 1578 /** This filter is documented in wp-admin/includes/file.php */ 1579 if ( class_exists( 'ZipArchive', false ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) { 1580 $archive = new ZipArchive(); 1581 $archive_is_valid = $archive->open( $file, ZipArchive::CHECKCONS ); 1582 if ( true === $archive_is_valid ) { 1583 $archive->close(); 1584 return true; 1585 } 1586 } 1587 1588 // Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file. 1589 require_once ABSPATH . 'wp-admin/includes/class-pclzip.php'; 1590 1591 $archive = new PclZip( $file ); 1592 $archive_is_valid = is_array( $archive->properties() ); 1593 1594 return $archive_is_valid; 1595 } 1596 1597 /** 1598 * Unzips a specified ZIP file to a location on the filesystem via the WordPress 1599 * Filesystem Abstraction. 1600 * 1601 * Assumes that WP_Filesystem() has already been called and set up. Does not extract 1602 * a root-level __MACOSX directory, if present. 1603 * 1604 * Attempts to increase the PHP memory limit to 256M before uncompressing. However, 1605 * the most memory required shouldn't be much larger than the archive itself. 1606 * 1607 * @since 2.5.0 1608 * 1609 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. 1610 * 1611 * @param string $file Full path and filename of ZIP archive. 1612 * @param string $to Full path on the filesystem to extract archive to. 1613 * @return true|WP_Error True on success, WP_Error on failure. 1614 */ 1615 function unzip_file( $file, $to ) { 1616 global $wp_filesystem; 1617 1618 if ( ! $wp_filesystem || ! is_object( $wp_filesystem ) ) { 1619 return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) ); 1620 } 1621 1622 // Unzip can use a lot of memory, but not this much hopefully. 1623 wp_raise_memory_limit( 'admin' ); 1624 1625 $needed_dirs = array(); 1626 $to = trailingslashit( $to ); 1627 1628 // Determine any parent directories needed (of the upgrade directory). 1629 if ( ! $wp_filesystem->is_dir( $to ) ) { // Only do parents if no children exist. 1630 $path = preg_split( '![/\\\]!', untrailingslashit( $to ) ); 1631 for ( $i = count( $path ); $i >= 0; $i-- ) { 1632 if ( empty( $path[ $i ] ) ) { 1633 continue; 1634 } 1635 1636 $dir = implode( '/', array_slice( $path, 0, $i + 1 ) ); 1637 if ( preg_match( '!^[a-z]:$!i', $dir ) ) { // Skip it if it looks like a Windows Drive letter. 1638 continue; 1639 } 1640 1641 if ( ! $wp_filesystem->is_dir( $dir ) ) { 1642 $needed_dirs[] = $dir; 1643 } else { 1644 break; // A folder exists, therefore we don't need to check the levels below this. 1645 } 1646 } 1647 } 1648 1649 /** 1650 * Filters whether to use ZipArchive to unzip archives. 1651 * 1652 * @since 3.0.0 1653 * 1654 * @param bool $ziparchive Whether to use ZipArchive. Default true. 1655 */ 1656 if ( class_exists( 'ZipArchive', false ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) { 1657 $result = _unzip_file_ziparchive( $file, $to, $needed_dirs ); 1658 if ( true === $result ) { 1659 return $result; 1660 } elseif ( is_wp_error( $result ) ) { 1661 if ( 'incompatible_archive' !== $result->get_error_code() ) { 1662 return $result; 1663 } 1664 } 1665 } 1666 // Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file. 1667 return _unzip_file_pclzip( $file, $to, $needed_dirs ); 1668 } 1669 1670 /** 1671 * Attempts to unzip an archive using the ZipArchive class. 1672 * 1673 * This function should not be called directly, use `unzip_file()` instead. 1674 * 1675 * Assumes that WP_Filesystem() has already been called and set up. 1676 * 1677 * @since 3.0.0 1678 * @access private 1679 * 1680 * @see unzip_file() 1681 * 1682 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. 1683 * 1684 * @param string $file Full path and filename of ZIP archive. 1685 * @param string $to Full path on the filesystem to extract archive to. 1686 * @param string[] $needed_dirs A partial list of required folders needed to be created. 1687 * @return true|WP_Error True on success, WP_Error on failure. 1688 */ 1689 function _unzip_file_ziparchive( $file, $to, $needed_dirs = array() ) { 1690 global $wp_filesystem; 1691 1692 $z = new ZipArchive(); 1693 1694 $zopen = $z->open( $file, ZIPARCHIVE::CHECKCONS ); 1695 1696 if ( true !== $zopen ) { 1697 return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), array( 'ziparchive_error' => $zopen ) ); 1698 } 1699 1700 $uncompressed_size = 0; 1701 1702 for ( $i = 0; $i < $z->numFiles; $i++ ) { 1703 $info = $z->statIndex( $i ); 1704 1705 if ( ! $info ) { 1706 $z->close(); 1707 return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) ); 1708 } 1709 1710 if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory. 1711 continue; 1712 } 1713 1714 // Don't extract invalid files: 1715 if ( 0 !== validate_file( $info['name'] ) ) { 1716 continue; 1717 } 1718 1719 $uncompressed_size += $info['size']; 1720 1721 $dirname = dirname( $info['name'] ); 1722 1723 if ( str_ends_with( $info['name'], '/' ) ) { 1724 // Directory. 1725 $needed_dirs[] = $to . untrailingslashit( $info['name'] ); 1726 } elseif ( '.' !== $dirname ) { 1727 // Path to a file. 1728 $needed_dirs[] = $to . untrailingslashit( $dirname ); 1729 } 1730 } 1731 1732 // Enough space to unzip the file and copy its contents, with a 10% buffer. 1733 $required_space = $uncompressed_size * 2.1; 1734 1735 /* 1736 * disk_free_space() could return false. Assume that any falsey value is an error. 1737 * A disk that has zero free bytes has bigger problems. 1738 * Require we have enough space to unzip the file and copy its contents, with a 10% buffer. 1739 */ 1740 if ( wp_doing_cron() ) { 1741 $available_space = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false; 1742 1743 if ( $available_space && ( $required_space > $available_space ) ) { 1744 $z->close(); 1745 return new WP_Error( 1746 'disk_full_unzip_file', 1747 __( 'Could not copy files. You may have run out of disk space.' ), 1748 compact( 'uncompressed_size', 'available_space' ) 1749 ); 1750 } 1751 } 1752 1753 $needed_dirs = array_unique( $needed_dirs ); 1754 1755 foreach ( $needed_dirs as $dir ) { 1756 // Check the parent folders of the folders all exist within the creation array. 1757 if ( untrailingslashit( $to ) === $dir ) { // Skip over the working directory, we know this exists (or will exist). 1758 continue; 1759 } 1760 1761 if ( ! str_contains( $dir, $to ) ) { // If the directory is not within the working directory, skip it. 1762 continue; 1763 } 1764 1765 $parent_folder = dirname( $dir ); 1766 1767 while ( ! empty( $parent_folder ) 1768 && untrailingslashit( $to ) !== $parent_folder 1769 && ! in_array( $parent_folder, $needed_dirs, true ) 1770 ) { 1771 $needed_dirs[] = $parent_folder; 1772 $parent_folder = dirname( $parent_folder ); 1773 } 1774 } 1775 1776 asort( $needed_dirs ); 1777 1778 // Create those directories if need be: 1779 foreach ( $needed_dirs as $_dir ) { 1780 // Only check to see if the Dir exists upon creation failure. Less I/O this way. 1781 if ( ! $wp_filesystem->mkdir( $_dir, FS_CHMOD_DIR ) && ! $wp_filesystem->is_dir( $_dir ) ) { 1782 $z->close(); 1783 return new WP_Error( 'mkdir_failed_ziparchive', __( 'Could not create directory.' ), $_dir ); 1784 } 1785 } 1786 1787 /** 1788 * Filters archive unzipping to override with a custom process. 1789 * 1790 * @since 6.4.0 1791 * 1792 * @param null|true|WP_Error $result The result of the override. True on success, otherwise WP Error. Default null. 1793 * @param string $file Full path and filename of ZIP archive. 1794 * @param string $to Full path on the filesystem to extract archive to. 1795 * @param string[] $needed_dirs A full list of required folders that need to be created. 1796 * @param float $required_space The space required to unzip the file and copy its contents, with a 10% buffer. 1797 */ 1798 $pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space ); 1799 1800 if ( null !== $pre ) { 1801 // Ensure the ZIP file archive has been closed. 1802 $z->close(); 1803 1804 return $pre; 1805 } 1806 1807 for ( $i = 0; $i < $z->numFiles; $i++ ) { 1808 $info = $z->statIndex( $i ); 1809 1810 if ( ! $info ) { 1811 $z->close(); 1812 return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) ); 1813 } 1814 1815 if ( str_ends_with( $info['name'], '/' ) ) { // Directory. 1816 continue; 1817 } 1818 1819 if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files. 1820 continue; 1821 } 1822 1823 // Don't extract invalid files: 1824 if ( 0 !== validate_file( $info['name'] ) ) { 1825 continue; 1826 } 1827 1828 $contents = $z->getFromIndex( $i ); 1829 1830 if ( false === $contents ) { 1831 $z->close(); 1832 return new WP_Error( 'extract_failed_ziparchive', __( 'Could not extract file from archive.' ), $info['name'] ); 1833 } 1834 1835 if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE ) ) { 1836 $z->close(); 1837 return new WP_Error( 'copy_failed_ziparchive', __( 'Could not copy file.' ), $info['name'] ); 1838 } 1839 } 1840 1841 $z->close(); 1842 1843 /** 1844 * Filters the result of unzipping an archive. 1845 * 1846 * @since 6.4.0 1847 * 1848 * @param true|WP_Error $result The result of unzipping the archive. True on success, otherwise WP_Error. Default true. 1849 * @param string $file Full path and filename of ZIP archive. 1850 * @param string $to Full path on the filesystem the archive was extracted to. 1851 * @param string[] $needed_dirs A full list of required folders that were created. 1852 * @param float $required_space The space required to unzip the file and copy its contents, with a 10% buffer. 1853 */ 1854 $result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space ); 1855 1856 unset( $needed_dirs ); 1857 1858 return $result; 1859 } 1860 1861 /** 1862 * Attempts to unzip an archive using the PclZip library. 1863 * 1864 * This function should not be called directly, use `unzip_file()` instead. 1865 * 1866 * Assumes that WP_Filesystem() has already been called and set up. 1867 * 1868 * @since 3.0.0 1869 * @access private 1870 * 1871 * @see unzip_file() 1872 * 1873 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. 1874 * 1875 * @param string $file Full path and filename of ZIP archive. 1876 * @param string $to Full path on the filesystem to extract archive to. 1877 * @param string[] $needed_dirs A partial list of required folders needed to be created. 1878 * @return true|WP_Error True on success, WP_Error on failure. 1879 */ 1880 function _unzip_file_pclzip( $file, $to, $needed_dirs = array() ) { 1881 global $wp_filesystem; 1882 1883 mbstring_binary_safe_encoding(); 1884 1885 require_once ABSPATH . 'wp-admin/includes/class-pclzip.php'; 1886 1887 $archive = new PclZip( $file ); 1888 1889 $archive_files = $archive->extract( PCLZIP_OPT_EXTRACT_AS_STRING ); 1890 1891 reset_mbstring_encoding(); 1892 1893 // Is the archive valid? 1894 if ( ! is_array( $archive_files ) ) { 1895 return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), $archive->errorInfo( true ) ); 1896 } 1897 1898 if ( 0 === count( $archive_files ) ) { 1899 return new WP_Error( 'empty_archive_pclzip', __( 'Empty archive.' ) ); 1900 } 1901 1902 $uncompressed_size = 0; 1903 1904 // Determine any children directories needed (From within the archive). 1905 foreach ( $archive_files as $file ) { 1906 if ( str_starts_with( $file['filename'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory. 1907 continue; 1908 } 1909 1910 $uncompressed_size += $file['size']; 1911 1912 $needed_dirs[] = $to . untrailingslashit( $file['folder'] ? $file['filename'] : dirname( $file['filename'] ) ); 1913 } 1914 1915 // Enough space to unzip the file and copy its contents, with a 10% buffer. 1916 $required_space = $uncompressed_size * 2.1; 1917 1918 /* 1919 * disk_free_space() could return false. Assume that any falsey value is an error. 1920 * A disk that has zero free bytes has bigger problems. 1921 * Require we have enough space to unzip the file and copy its contents, with a 10% buffer. 1922 */ 1923 if ( wp_doing_cron() ) { 1924 $available_space = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false; 1925 1926 if ( $available_space && ( $required_space > $available_space ) ) { 1927 return new WP_Error( 1928 'disk_full_unzip_file', 1929 __( 'Could not copy files. You may have run out of disk space.' ), 1930 compact( 'uncompressed_size', 'available_space' ) 1931 ); 1932 } 1933 } 1934 1935 $needed_dirs = array_unique( $needed_dirs ); 1936 1937 foreach ( $needed_dirs as $dir ) { 1938 // Check the parent folders of the folders all exist within the creation array. 1939 if ( untrailingslashit( $to ) === $dir ) { // Skip over the working directory, we know this exists (or will exist). 1940 continue; 1941 } 1942 1943 if ( ! str_contains( $dir, $to ) ) { // If the directory is not within the working directory, skip it. 1944 continue; 1945 } 1946 1947 $parent_folder = dirname( $dir ); 1948 1949 while ( ! empty( $parent_folder ) 1950 && untrailingslashit( $to ) !== $parent_folder 1951 && ! in_array( $parent_folder, $needed_dirs, true ) 1952 ) { 1953 $needed_dirs[] = $parent_folder; 1954 $parent_folder = dirname( $parent_folder ); 1955 } 1956 } 1957 1958 asort( $needed_dirs ); 1959 1960 // Create those directories if need be: 1961 foreach ( $needed_dirs as $_dir ) { 1962 // Only check to see if the dir exists upon creation failure. Less I/O this way. 1963 if ( ! $wp_filesystem->mkdir( $_dir, FS_CHMOD_DIR ) && ! $wp_filesystem->is_dir( $_dir ) ) { 1964 return new WP_Error( 'mkdir_failed_pclzip', __( 'Could not create directory.' ), $_dir ); 1965 } 1966 } 1967 1968 /** This filter is documented in src/wp-admin/includes/file.php */ 1969 $pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space ); 1970 1971 if ( null !== $pre ) { 1972 return $pre; 1973 } 1974 1975 // Extract the files from the zip. 1976 foreach ( $archive_files as $file ) { 1977 if ( $file['folder'] ) { 1978 continue; 1979 } 1980 1981 if ( str_starts_with( $file['filename'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files. 1982 continue; 1983 } 1984 1985 // Don't extract invalid files: 1986 if ( 0 !== validate_file( $file['filename'] ) ) { 1987 continue; 1988 } 1989 1990 if ( ! $wp_filesystem->put_contents( $to . $file['filename'], $file['content'], FS_CHMOD_FILE ) ) { 1991 return new WP_Error( 'copy_failed_pclzip', __( 'Could not copy file.' ), $file['filename'] ); 1992 } 1993 } 1994 1995 /** This action is documented in src/wp-admin/includes/file.php */ 1996 $result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space ); 1997 1998 unset( $needed_dirs ); 1999 2000 return $result; 2001 } 2002 2003 /** 2004 * Copies a directory from one location to another via the WordPress Filesystem 2005 * Abstraction. 2006 * 2007 * Assumes that WP_Filesystem() has already been called and setup. 2008 * 2009 * @since 2.5.0 2010 * 2011 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. 2012 * 2013 * @param string $from Source directory. 2014 * @param string $to Destination directory. 2015 * @param string[] $skip_list An array of files/folders to skip copying. 2016 * @return true|WP_Error True on success, WP_Error on failure. 2017 */ 2018 function copy_dir( $from, $to, $skip_list = array() ) { 2019 global $wp_filesystem; 2020 2021 $dirlist = $wp_filesystem->dirlist( $from ); 2022 2023 if ( false === $dirlist ) { 2024 return new WP_Error( 'dirlist_failed_copy_dir', __( 'Directory listing failed.' ), basename( $from ) ); 2025 } 2026 2027 $from = trailingslashit( $from ); 2028 $to = trailingslashit( $to ); 2029 2030 if ( ! $wp_filesystem->exists( $to ) && ! $wp_filesystem->mkdir( $to ) ) { 2031 return new WP_Error( 2032 'mkdir_destination_failed_copy_dir', 2033 __( 'Could not create the destination directory.' ), 2034 basename( $to ) 2035 ); 2036 } 2037 2038 foreach ( (array) $dirlist as $filename => $fileinfo ) { 2039 if ( in_array( $filename, $skip_list, true ) ) { 2040 continue; 2041 } 2042 2043 if ( 'f' === $fileinfo['type'] ) { 2044 if ( ! $wp_filesystem->copy( $from . $filename, $to . $filename, true, FS_CHMOD_FILE ) ) { 2045 // If copy failed, chmod file to 0644 and try again. 2046 $wp_filesystem->chmod( $to . $filename, FS_CHMOD_FILE ); 2047 2048 if ( ! $wp_filesystem->copy( $from . $filename, $to . $filename, true, FS_CHMOD_FILE ) ) { 2049 return new WP_Error( 'copy_failed_copy_dir', __( 'Could not copy file.' ), $to . $filename ); 2050 } 2051 } 2052 2053 wp_opcache_invalidate( $to . $filename ); 2054 } elseif ( 'd' === $fileinfo['type'] ) { 2055 if ( ! $wp_filesystem->is_dir( $to . $filename ) ) { 2056 if ( ! $wp_filesystem->mkdir( $to . $filename, FS_CHMOD_DIR ) ) { 2057 return new WP_Error( 'mkdir_failed_copy_dir', __( 'Could not create directory.' ), $to . $filename ); 2058 } 2059 } 2060 2061 // Generate the $sub_skip_list for the subdirectory as a sub-set of the existing $skip_list. 2062 $sub_skip_list = array(); 2063 2064 foreach ( $skip_list as $skip_item ) { 2065 if ( str_starts_with( $skip_item, $filename . '/' ) ) { 2066 $sub_skip_list[] = preg_replace( '!^' . preg_quote( $filename, '!' ) . '/!i', '', $skip_item ); 2067 } 2068 } 2069 2070 $result = copy_dir( $from . $filename, $to . $filename, $sub_skip_list ); 2071 2072 if ( is_wp_error( $result ) ) { 2073 return $result; 2074 } 2075 } 2076 } 2077 2078 return true; 2079 } 2080 2081 /** 2082 * Moves a directory from one location to another. 2083 * 2084 * Recursively invalidates OPcache on success. 2085 * 2086 * If the renaming failed, falls back to copy_dir(). 2087 * 2088 * Assumes that WP_Filesystem() has already been called and setup. 2089 * 2090 * This function is not designed to merge directories, copy_dir() should be used instead. 2091 * 2092 * @since 6.2.0 2093 * 2094 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. 2095 * 2096 * @param string $from Source directory. 2097 * @param string $to Destination directory. 2098 * @param bool $overwrite Optional. Whether to overwrite the destination directory if it exists. 2099 * Default false. 2100 * @return true|WP_Error True on success, WP_Error on failure. 2101 */ 2102 function move_dir( $from, $to, $overwrite = false ) { 2103 global $wp_filesystem; 2104 2105 if ( trailingslashit( strtolower( $from ) ) === trailingslashit( strtolower( $to ) ) ) { 2106 return new WP_Error( 'source_destination_same_move_dir', __( 'The source and destination are the same.' ) ); 2107 } 2108 2109 if ( $wp_filesystem->exists( $to ) ) { 2110 if ( ! $overwrite ) { 2111 return new WP_Error( 'destination_already_exists_move_dir', __( 'The destination folder already exists.' ), $to ); 2112 } elseif ( ! $wp_filesystem->delete( $to, true ) ) { 2113 // Can't overwrite if the destination couldn't be deleted. 2114 return new WP_Error( 'destination_not_deleted_move_dir', __( 'The destination directory already exists and could not be removed.' ) ); 2115 } 2116 } 2117 2118 if ( $wp_filesystem->move( $from, $to ) ) { 2119 /* 2120 * When using an environment with shared folders, 2121 * there is a delay in updating the filesystem's cache. 2122 * 2123 * This is a known issue in environments with a VirtualBox provider. 2124 * 2125 * A 200ms delay gives time for the filesystem to update its cache, 2126 * prevents "Operation not permitted", and "No such file or directory" warnings. 2127 * 2128 * This delay is used in other projects, including Composer. 2129 * @link https://github.com/composer/composer/blob/2.5.1/src/Composer/Util/Platform.php#L228-L233 2130 */ 2131 usleep( 200000 ); 2132 wp_opcache_invalidate_directory( $to ); 2133 2134 return true; 2135 } 2136 2137 // Fall back to a recursive copy. 2138 if ( ! $wp_filesystem->is_dir( $to ) ) { 2139 if ( ! $wp_filesystem->mkdir( $to, FS_CHMOD_DIR ) ) { 2140 return new WP_Error( 'mkdir_failed_move_dir', __( 'Could not create directory.' ), $to ); 2141 } 2142 } 2143 2144 $result = copy_dir( $from, $to, array( basename( $to ) ) ); 2145 2146 // Clear the source directory. 2147 if ( true === $result ) { 2148 $wp_filesystem->delete( $from, true ); 2149 } 2150 2151 return $result; 2152 } 2153 2154 /** 2155 * Initializes and connects the WordPress Filesystem Abstraction classes. 2156 * 2157 * This function will include the chosen transport and attempt connecting. 2158 * 2159 * Plugins may add extra transports, And force WordPress to use them by returning 2160 * the filename via the {@see 'filesystem_method_file'} filter. 2161 * 2162 * @since 2.5.0 2163 * 2164 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. 2165 * 2166 * @param array|false $args Optional. Connection args, These are passed 2167 * directly to the `WP_Filesystem_*()` classes. 2168 * Default false. 2169 * @param string|false $context Optional. Context for get_filesystem_method(). 2170 * Default false. 2171 * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. 2172 * Default false. 2173 * @return bool|null True on success, false on failure, 2174 * null if the filesystem method class file does not exist. 2175 */ 2176 function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid 2177 global $wp_filesystem; 2178 2179 require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php'; 2180 2181 $method = get_filesystem_method( $args, $context, $allow_relaxed_file_ownership ); 2182 2183 if ( ! $method ) { 2184 return false; 2185 } 2186 2187 if ( ! class_exists( "WP_Filesystem_$method" ) ) { 2188 2189 /** 2190 * Filters the path for a specific filesystem method class file. 2191 * 2192 * @since 2.6.0 2193 * 2194 * @see get_filesystem_method() 2195 * 2196 * @param string $path Path to the specific filesystem method class file. 2197 * @param string $method The filesystem method to use. 2198 */ 2199 $abstraction_file = apply_filters( 'filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method ); 2200 2201 if ( ! file_exists( $abstraction_file ) ) { 2202 return; 2203 } 2204 2205 require_once $abstraction_file; 2206 } 2207 $method = "WP_Filesystem_$method"; 2208 2209 $wp_filesystem = new $method( $args ); 2210 2211 /* 2212 * Define the timeouts for the connections. Only available after the constructor is called 2213 * to allow for per-transport overriding of the default. 2214 */ 2215 if ( ! defined( 'FS_CONNECT_TIMEOUT' ) ) { 2216 define( 'FS_CONNECT_TIMEOUT', 30 ); // 30 seconds. 2217 } 2218 if ( ! defined( 'FS_TIMEOUT' ) ) { 2219 define( 'FS_TIMEOUT', 30 ); // 30 seconds. 2220 } 2221 2222 if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) { 2223 return false; 2224 } 2225 2226 if ( ! $wp_filesystem->connect() ) { 2227 return false; // There was an error connecting to the server. 2228 } 2229 2230 // Set the permission constants if not already set. 2231 if ( ! defined( 'FS_CHMOD_DIR' ) ) { 2232 define( 'FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) ); 2233 } 2234 if ( ! defined( 'FS_CHMOD_FILE' ) ) { 2235 define( 'FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) ); 2236 } 2237 2238 return true; 2239 } 2240 2241 /** 2242 * Determines which method to use for reading, writing, modifying, or deleting 2243 * files on the filesystem. 2244 * 2245 * The priority of the transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets 2246 * (Via Sockets class, or `fsockopen()`). Valid values for these are: 'direct', 'ssh2', 2247 * 'ftpext' or 'ftpsockets'. 2248 * 2249 * The return value can be overridden by defining the `FS_METHOD` constant in `wp-config.php`, 2250 * or filtering via {@see 'filesystem_method'}. 2251 * 2252 * @link https://developer.wordpress.org/advanced-administration/wordpress/wp-config/#wordpress-upgrade-constants 2253 * 2254 * Plugins may define a custom transport handler, See WP_Filesystem(). 2255 * 2256 * @since 2.5.0 2257 * 2258 * @global callable $_wp_filesystem_direct_method 2259 * 2260 * @param array $args Optional. Connection details. Default empty array. 2261 * @param string $context Optional. Full path to the directory that is tested 2262 * for being writable. Default empty. 2263 * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. 2264 * Default false. 2265 * @return string The transport to use, see description for valid return values. 2266 */ 2267 function get_filesystem_method( $args = array(), $context = '', $allow_relaxed_file_ownership = false ) { 2268 // Please ensure that this is either 'direct', 'ssh2', 'ftpext', or 'ftpsockets'. 2269 $method = defined( 'FS_METHOD' ) ? FS_METHOD : false; 2270 2271 if ( ! $context ) { 2272 $context = WP_CONTENT_DIR; 2273 } 2274 2275 // If the directory doesn't exist (wp-content/languages) then use the parent directory as we'll create it. 2276 if ( WP_LANG_DIR === $context && ! is_dir( $context ) ) { 2277 $context = dirname( $context ); 2278 } 2279 2280 $context = trailingslashit( $context ); 2281 2282 if ( ! $method ) { 2283 2284 $temp_file_name = $context . 'temp-write-test-' . str_replace( '.', '-', uniqid( '', true ) ); 2285 $temp_handle = @fopen( $temp_file_name, 'w' ); 2286 if ( $temp_handle ) { 2287 2288 // Attempt to determine the file owner of the WordPress files, and that of newly created files. 2289 $wp_file_owner = false; 2290 $temp_file_owner = false; 2291 if ( function_exists( 'fileowner' ) ) { 2292 $wp_file_owner = @fileowner( __FILE__ ); 2293 $temp_file_owner = @fileowner( $temp_file_name ); 2294 } 2295 2296 if ( false !== $wp_file_owner && $wp_file_owner === $temp_file_owner ) { 2297 /* 2298 * WordPress is creating files as the same owner as the WordPress files, 2299 * this means it's safe to modify & create new files via PHP. 2300 */ 2301 $method = 'direct'; 2302 $GLOBALS['_wp_filesystem_direct_method'] = 'file_owner'; 2303 } elseif ( $allow_relaxed_file_ownership ) { 2304 /* 2305 * The $context directory is writable, and $allow_relaxed_file_ownership is set, 2306 * this means we can modify files safely in this directory. 2307 * This mode doesn't create new files, only alter existing ones. 2308 */ 2309 $method = 'direct'; 2310 $GLOBALS['_wp_filesystem_direct_method'] = 'relaxed_ownership'; 2311 } 2312 2313 fclose( $temp_handle ); 2314 @unlink( $temp_file_name ); 2315 } 2316 } 2317 2318 if ( ! $method && isset( $args['connection_type'] ) && 'ssh' === $args['connection_type'] && extension_loaded( 'ssh2' ) ) { 2319 $method = 'ssh2'; 2320 } 2321 if ( ! $method && extension_loaded( 'ftp' ) ) { 2322 $method = 'ftpext'; 2323 } 2324 if ( ! $method && ( extension_loaded( 'sockets' ) || function_exists( 'fsockopen' ) ) ) { 2325 $method = 'ftpsockets'; // Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread. 2326 } 2327 2328 /** 2329 * Filters the filesystem method to use. 2330 * 2331 * @since 2.6.0 2332 * 2333 * @param string $method Filesystem method to return. 2334 * @param array $args An array of connection details for the method. 2335 * @param string $context Full path to the directory that is tested for being writable. 2336 * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable. 2337 */ 2338 return apply_filters( 'filesystem_method', $method, $args, $context, $allow_relaxed_file_ownership ); 2339 } 2340 2341 /** 2342 * Displays a form to the user to request for their FTP/SSH details in order 2343 * to connect to the filesystem. 2344 * 2345 * All chosen/entered details are saved, excluding the password. 2346 * 2347 * Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467) 2348 * to specify an alternate FTP/SSH port. 2349 * 2350 * Plugins may override this form by returning true|false via the {@see 'request_filesystem_credentials'} filter. 2351 * 2352 * @since 2.5.0 2353 * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string. 2354 * 2355 * @global string $pagenow The filename of the current screen. 2356 * 2357 * @param string $form_post The URL to post the form to. 2358 * @param string $type Optional. Chosen type of filesystem. Default empty. 2359 * @param bool|WP_Error $error Optional. Whether the current request has failed 2360 * to connect, or an error object. Default false. 2361 * @param string $context Optional. Full path to the directory that is tested 2362 * for being writable. Default empty. 2363 * @param array $extra_fields Optional. Extra `POST` fields to be checked 2364 * for inclusion in the post. Default null. 2365 * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. 2366 * Default false. 2367 * @return bool|array True if no filesystem credentials are required, 2368 * false if they are required but have not been provided, 2369 * array of credentials if they are required and have been provided. 2370 */ 2371 function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) { 2372 global $pagenow; 2373 2374 /** 2375 * Filters the filesystem credentials. 2376 * 2377 * Returning anything other than an empty string will effectively short-circuit 2378 * output of the filesystem credentials form, returning that value instead. 2379 * 2380 * A filter should return true if no filesystem credentials are required, false if they are required but have not been 2381 * provided, or an array of credentials if they are required and have been provided. 2382 * 2383 * @since 2.5.0 2384 * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string. 2385 * 2386 * @param mixed $credentials Credentials to return instead. Default empty string. 2387 * @param string $form_post The URL to post the form to. 2388 * @param string $type Chosen type of filesystem. 2389 * @param bool|WP_Error $error Whether the current request has failed to connect, 2390 * or an error object. 2391 * @param string $context Full path to the directory that is tested for 2392 * being writable. 2393 * @param array $extra_fields Extra POST fields. 2394 * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable. 2395 */ 2396 $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership ); 2397 2398 if ( '' !== $req_cred ) { 2399 return $req_cred; 2400 } 2401 2402 if ( empty( $type ) ) { 2403 $type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership ); 2404 } 2405 2406 if ( 'direct' === $type ) { 2407 return true; 2408 } 2409 2410 if ( is_null( $extra_fields ) ) { 2411 $extra_fields = array( 'version', 'locale' ); 2412 } 2413 2414 $credentials = get_option( 2415 'ftp_credentials', 2416 array( 2417 'hostname' => '', 2418 'username' => '', 2419 ) 2420 ); 2421 2422 $submitted_form = wp_unslash( $_POST ); 2423 2424 // Verify nonce, or unset submitted form field values on failure. 2425 if ( ! isset( $_POST['_fs_nonce'] ) || ! wp_verify_nonce( $_POST['_fs_nonce'], 'filesystem-credentials' ) ) { 2426 unset( 2427 $submitted_form['hostname'], 2428 $submitted_form['username'], 2429 $submitted_form['password'], 2430 $submitted_form['public_key'], 2431 $submitted_form['private_key'], 2432 $submitted_form['connection_type'] 2433 ); 2434 } 2435 2436 $ftp_constants = array( 2437 'hostname' => 'FTP_HOST', 2438 'username' => 'FTP_USER', 2439 'password' => 'FTP_PASS', 2440 'public_key' => 'FTP_PUBKEY', 2441 'private_key' => 'FTP_PRIKEY', 2442 ); 2443 2444 /* 2445 * If defined, set it to that. Else, if POST'd, set it to that. If not, set it to an empty string. 2446 * Otherwise, keep it as it previously was (saved details in option). 2447 */ 2448 foreach ( $ftp_constants as $key => $constant ) { 2449 if ( defined( $constant ) ) { 2450 $credentials[ $key ] = constant( $constant ); 2451 } elseif ( ! empty( $submitted_form[ $key ] ) ) { 2452 $credentials[ $key ] = $submitted_form[ $key ]; 2453 } elseif ( ! isset( $credentials[ $key ] ) ) { 2454 $credentials[ $key ] = ''; 2455 } 2456 } 2457 2458 // Sanitize the hostname, some people might pass in odd data. 2459 $credentials['hostname'] = preg_replace( '|\w+://|', '', $credentials['hostname'] ); // Strip any schemes off. 2460 2461 if ( strpos( $credentials['hostname'], ':' ) ) { 2462 list( $credentials['hostname'], $credentials['port'] ) = explode( ':', $credentials['hostname'], 2 ); 2463 if ( ! is_numeric( $credentials['port'] ) ) { 2464 unset( $credentials['port'] ); 2465 } 2466 } else { 2467 unset( $credentials['port'] ); 2468 } 2469 2470 if ( ( defined( 'FTP_SSH' ) && FTP_SSH ) || ( defined( 'FS_METHOD' ) && 'ssh2' === FS_METHOD ) ) { 2471 $credentials['connection_type'] = 'ssh'; 2472 } elseif ( ( defined( 'FTP_SSL' ) && FTP_SSL ) && 'ftpext' === $type ) { // Only the FTP Extension understands SSL. 2473 $credentials['connection_type'] = 'ftps'; 2474 } elseif ( ! empty( $submitted_form['connection_type'] ) ) { 2475 $credentials['connection_type'] = $submitted_form['connection_type']; 2476 } elseif ( ! isset( $credentials['connection_type'] ) ) { // All else fails (and it's not defaulted to something else saved), default to FTP. 2477 $credentials['connection_type'] = 'ftp'; 2478 } 2479 2480 if ( ! $error 2481 && ( ! empty( $credentials['hostname'] ) && ! empty( $credentials['username'] ) && ! empty( $credentials['password'] ) 2482 || 'ssh' === $credentials['connection_type'] && ! empty( $credentials['public_key'] ) && ! empty( $credentials['private_key'] ) 2483 ) 2484 ) { 2485 $stored_credentials = $credentials; 2486 2487 if ( ! empty( $stored_credentials['port'] ) ) { // Save port as part of hostname to simplify above code. 2488 $stored_credentials['hostname'] .= ':' . $stored_credentials['port']; 2489 } 2490 2491 unset( 2492 $stored_credentials['password'], 2493 $stored_credentials['port'], 2494 $stored_credentials['private_key'], 2495 $stored_credentials['public_key'] 2496 ); 2497 2498 if ( ! wp_installing() ) { 2499 update_option( 'ftp_credentials', $stored_credentials ); 2500 } 2501 2502 return $credentials; 2503 } 2504 2505 $hostname = isset( $credentials['hostname'] ) ? $credentials['hostname'] : ''; 2506 $username = isset( $credentials['username'] ) ? $credentials['username'] : ''; 2507 $public_key = isset( $credentials['public_key'] ) ? $credentials['public_key'] : ''; 2508 $private_key = isset( $credentials['private_key'] ) ? $credentials['private_key'] : ''; 2509 $port = isset( $credentials['port'] ) ? $credentials['port'] : ''; 2510 $connection_type = isset( $credentials['connection_type'] ) ? $credentials['connection_type'] : ''; 2511 2512 if ( $error ) { 2513 $error_string = __( '<strong>Error:</strong> Could not connect to the server. Please verify the settings are correct.' ); 2514 if ( is_wp_error( $error ) ) { 2515 $error_string = esc_html( $error->get_error_message() ); 2516 } 2517 wp_admin_notice( 2518 $error_string, 2519 array( 2520 'id' => 'message', 2521 'additional_classes' => array( 'error' ), 2522 ) 2523 ); 2524 } 2525 2526 $types = array(); 2527 if ( extension_loaded( 'ftp' ) || extension_loaded( 'sockets' ) || function_exists( 'fsockopen' ) ) { 2528 $types['ftp'] = __( 'FTP' ); 2529 } 2530 if ( extension_loaded( 'ftp' ) ) { // Only this supports FTPS. 2531 $types['ftps'] = __( 'FTPS (SSL)' ); 2532 } 2533 if ( extension_loaded( 'ssh2' ) ) { 2534 $types['ssh'] = __( 'SSH2' ); 2535 } 2536 2537 /** 2538 * Filters the connection types to output to the filesystem credentials form. 2539 * 2540 * @since 2.9.0 2541 * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string. 2542 * 2543 * @param string[] $types Types of connections. 2544 * @param array $credentials Credentials to connect with. 2545 * @param string $type Chosen filesystem method. 2546 * @param bool|WP_Error $error Whether the current request has failed to connect, 2547 * or an error object. 2548 * @param string $context Full path to the directory that is tested for being writable. 2549 */ 2550 $types = apply_filters( 'fs_ftp_connection_types', $types, $credentials, $type, $error, $context ); 2551 ?> 2552 <form action="<?php echo esc_url( $form_post ); ?>" method="post"> 2553 <div id="request-filesystem-credentials-form" class="request-filesystem-credentials-form"> 2554 <?php 2555 // Print a H1 heading in the FTP credentials modal dialog, default is a H2. 2556 $heading_tag = 'h2'; 2557 if ( 'plugins.php' === $pagenow || 'plugin-install.php' === $pagenow ) { 2558 $heading_tag = 'h1'; 2559 } 2560 echo "<$heading_tag id='request-filesystem-credentials-title'>" . __( 'Connection Information' ) . "</$heading_tag>"; 2561 ?> 2562 <p id="request-filesystem-credentials-desc"> 2563 <?php 2564 $label_user = __( 'Username' ); 2565 $label_pass = __( 'Password' ); 2566 _e( 'To perform the requested action, WordPress needs to access your web server.' ); 2567 echo ' '; 2568 if ( ( isset( $types['ftp'] ) || isset( $types['ftps'] ) ) ) { 2569 if ( isset( $types['ssh'] ) ) { 2570 _e( 'Please enter your FTP or SSH credentials to proceed.' ); 2571 $label_user = __( 'FTP/SSH Username' ); 2572 $label_pass = __( 'FTP/SSH Password' ); 2573 } else { 2574 _e( 'Please enter your FTP credentials to proceed.' ); 2575 $label_user = __( 'FTP Username' ); 2576 $label_pass = __( 'FTP Password' ); 2577 } 2578 echo ' '; 2579 } 2580 _e( 'If you do not remember your credentials, you should contact your web host.' ); 2581 2582 $hostname_value = esc_attr( $hostname ); 2583 if ( ! empty( $port ) ) { 2584 $hostname_value .= ":$port"; 2585 } 2586 2587 $password_value = ''; 2588 if ( defined( 'FTP_PASS' ) ) { 2589 $password_value = '*****'; 2590 } 2591 ?> 2592 </p> 2593 <label for="hostname"> 2594 <span class="field-title"><?php _e( 'Hostname' ); ?></span> 2595 <input name="hostname" type="text" id="hostname" aria-describedby="request-filesystem-credentials-desc" class="code" placeholder="<?php esc_attr_e( 'example: www.wordpress.org' ); ?>" value="<?php echo $hostname_value; ?>"<?php disabled( defined( 'FTP_HOST' ) ); ?> /> 2596 </label> 2597 <div class="ftp-username"> 2598 <label for="username"> 2599 <span class="field-title"><?php echo $label_user; ?></span> 2600 <input name="username" type="text" id="username" value="<?php echo esc_attr( $username ); ?>"<?php disabled( defined( 'FTP_USER' ) ); ?> /> 2601 </label> 2602 </div> 2603 <div class="ftp-password"> 2604 <label for="password"> 2605 <span class="field-title"><?php echo $label_pass; ?></span> 2606 <input name="password" type="password" id="password" value="<?php echo $password_value; ?>"<?php disabled( defined( 'FTP_PASS' ) ); ?> spellcheck="false" /> 2607 <?php 2608 if ( ! defined( 'FTP_PASS' ) ) { 2609 _e( 'This password will not be stored on the server.' ); 2610 } 2611 ?> 2612 </label> 2613 </div> 2614 <fieldset> 2615 <legend><?php _e( 'Connection Type' ); ?></legend> 2616 <?php 2617 $disabled = disabled( ( defined( 'FTP_SSL' ) && FTP_SSL ) || ( defined( 'FTP_SSH' ) && FTP_SSH ), true, false ); 2618 foreach ( $types as $name => $text ) : 2619 ?> 2620 <label for="<?php echo esc_attr( $name ); ?>"> 2621 <input type="radio" name="connection_type" id="<?php echo esc_attr( $name ); ?>" value="<?php echo esc_attr( $name ); ?>" <?php checked( $name, $connection_type ); ?> <?php echo $disabled; ?> /> 2622 <?php echo $text; ?> 2623 </label> 2624 <?php 2625 endforeach; 2626 ?> 2627 </fieldset> 2628 <?php 2629 if ( isset( $types['ssh'] ) ) { 2630 $hidden_class = ''; 2631 if ( 'ssh' !== $connection_type || empty( $connection_type ) ) { 2632 $hidden_class = ' class="hidden"'; 2633 } 2634 ?> 2635 <fieldset id="ssh-keys"<?php echo $hidden_class; ?>> 2636 <legend><?php _e( 'Authentication Keys' ); ?></legend> 2637 <label for="public_key"> 2638 <span class="field-title"><?php _e( 'Public Key:' ); ?></span> 2639 <input name="public_key" type="text" id="public_key" aria-describedby="auth-keys-desc" value="<?php echo esc_attr( $public_key ); ?>"<?php disabled( defined( 'FTP_PUBKEY' ) ); ?> /> 2640 </label> 2641 <label for="private_key"> 2642 <span class="field-title"><?php _e( 'Private Key:' ); ?></span> 2643 <input name="private_key" type="text" id="private_key" value="<?php echo esc_attr( $private_key ); ?>"<?php disabled( defined( 'FTP_PRIKEY' ) ); ?> /> 2644 </label> 2645 <p id="auth-keys-desc"><?php _e( 'Enter the location on the server where the public and private keys are located. If a passphrase is needed, enter that in the password field above.' ); ?></p> 2646 </fieldset> 2647 <?php 2648 } 2649 2650 foreach ( (array) $extra_fields as $field ) { 2651 if ( isset( $submitted_form[ $field ] ) ) { 2652 echo '<input type="hidden" name="' . esc_attr( $field ) . '" value="' . esc_attr( $submitted_form[ $field ] ) . '" />'; 2653 } 2654 } 2655 2656 /* 2657 * Make sure the `submit_button()` function is available during the REST API call 2658 * from WP_Site_Health_Auto_Updates::test_check_wp_filesystem_method(). 2659 */ 2660 if ( ! function_exists( 'submit_button' ) ) { 2661 require_once ABSPATH . 'wp-admin/includes/template.php'; 2662 } 2663 ?> 2664 <p class="request-filesystem-credentials-action-buttons"> 2665 <?php wp_nonce_field( 'filesystem-credentials', '_fs_nonce', false, true ); ?> 2666 <button class="button cancel-button" data-js-action="close" type="button"><?php _e( 'Cancel' ); ?></button> 2667 <?php submit_button( __( 'Proceed' ), '', 'upgrade', false ); ?> 2668 </p> 2669 </div> 2670 </form> 2671 <?php 2672 return false; 2673 } 2674 2675 /** 2676 * Prints the filesystem credentials modal when needed. 2677 * 2678 * @since 4.2.0 2679 */ 2680 function wp_print_request_filesystem_credentials_modal() { 2681 $filesystem_method = get_filesystem_method(); 2682 2683 ob_start(); 2684 $filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() ); 2685 ob_end_clean(); 2686 2687 $request_filesystem_credentials = ( 'direct' !== $filesystem_method && ! $filesystem_credentials_are_stored ); 2688 if ( ! $request_filesystem_credentials ) { 2689 return; 2690 } 2691 ?> 2692 <div id="request-filesystem-credentials-dialog" class="notification-dialog-wrap request-filesystem-credentials-dialog"> 2693 <div class="notification-dialog-background"></div> 2694 <div class="notification-dialog" role="dialog" aria-labelledby="request-filesystem-credentials-title" tabindex="0"> 2695 <div class="request-filesystem-credentials-dialog-content"> 2696 <?php request_filesystem_credentials( site_url() ); ?> 2697 </div> 2698 </div> 2699 </div> 2700 <?php 2701 } 2702 2703 /** 2704 * Attempts to clear the opcode cache for an individual PHP file. 2705 * 2706 * This function can be called safely without having to check the file extension 2707 * or availability of the OPcache extension. 2708 * 2709 * Whether or not invalidation is possible is cached to improve performance. 2710 * 2711 * @since 5.5.0 2712 * 2713 * @link https://www.php.net/manual/en/function.opcache-invalidate.php 2714 * 2715 * @param string $filepath Path to the file, including extension, for which the opcode cache is to be cleared. 2716 * @param bool $force Invalidate even if the modification time is not newer than the file in cache. 2717 * Default false. 2718 * @return bool True if opcache was invalidated for `$filepath`, or there was nothing to invalidate. 2719 * False if opcache invalidation is not available, or is disabled via filter. 2720 */ 2721 function wp_opcache_invalidate( $filepath, $force = false ) { 2722 static $can_invalidate = null; 2723 2724 /* 2725 * Check to see if WordPress is able to run `opcache_invalidate()` or not, and cache the value. 2726 * 2727 * First, check to see if the function is available to call, then if the host has restricted 2728 * the ability to run the function to avoid a PHP warning. 2729 * 2730 * `opcache.restrict_api` can specify the path for files allowed to call `opcache_invalidate()`. 2731 * 2732 * If the host has this set, check whether the path in `opcache.restrict_api` matches 2733 * the beginning of the path of the origin file. 2734 * 2735 * `$_SERVER['SCRIPT_FILENAME']` approximates the origin file's path, but `realpath()` 2736 * is necessary because `SCRIPT_FILENAME` can be a relative path when run from CLI. 2737 * 2738 * For more details, see: 2739 * - https://www.php.net/manual/en/opcache.configuration.php 2740 * - https://www.php.net/manual/en/reserved.variables.server.php 2741 * - https://core.trac.wordpress.org/ticket/36455 2742 */ 2743 if ( null === $can_invalidate 2744 && function_exists( 'opcache_invalidate' ) 2745 && ( ! ini_get( 'opcache.restrict_api' ) 2746 || stripos( realpath( $_SERVER['SCRIPT_FILENAME'] ), ini_get( 'opcache.restrict_api' ) ) === 0 ) 2747 ) { 2748 $can_invalidate = true; 2749 } 2750 2751 // If invalidation is not available, return early. 2752 if ( ! $can_invalidate ) { 2753 return false; 2754 } 2755 2756 // Verify that file to be invalidated has a PHP extension. 2757 if ( '.php' !== strtolower( substr( $filepath, -4 ) ) ) { 2758 return false; 2759 } 2760 2761 /** 2762 * Filters whether to invalidate a file from the opcode cache. 2763 * 2764 * @since 5.5.0 2765 * 2766 * @param bool $will_invalidate Whether WordPress will invalidate `$filepath`. Default true. 2767 * @param string $filepath The path to the PHP file to invalidate. 2768 */ 2769 if ( apply_filters( 'wp_opcache_invalidate_file', true, $filepath ) ) { 2770 return opcache_invalidate( $filepath, $force ); 2771 } 2772 2773 return false; 2774 } 2775 2776 /** 2777 * Attempts to clear the opcode cache for a directory of files. 2778 * 2779 * @since 6.2.0 2780 * 2781 * @see wp_opcache_invalidate() 2782 * @link https://www.php.net/manual/en/function.opcache-invalidate.php 2783 * 2784 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. 2785 * 2786 * @param string $dir The path to the directory for which the opcode cache is to be cleared. 2787 */ 2788 function wp_opcache_invalidate_directory( $dir ) { 2789 global $wp_filesystem; 2790 2791 if ( ! is_string( $dir ) || '' === trim( $dir ) ) { 2792 if ( WP_DEBUG ) { 2793 $error_message = sprintf( 2794 /* translators: %s: The function name. */ 2795 __( '%s expects a non-empty string.' ), 2796 '<code>wp_opcache_invalidate_directory()</code>' 2797 ); 2798 trigger_error( $error_message ); 2799 } 2800 return; 2801 } 2802 2803 $dirlist = $wp_filesystem->dirlist( $dir, false, true ); 2804 2805 if ( empty( $dirlist ) ) { 2806 return; 2807 } 2808 2809 /* 2810 * Recursively invalidate opcache of files in a directory. 2811 * 2812 * WP_Filesystem_*::dirlist() returns an array of file and directory information. 2813 * 2814 * This does not include a path to the file or directory. 2815 * To invalidate files within sub-directories, recursion is needed 2816 * to prepend an absolute path containing the sub-directory's name. 2817 * 2818 * @param array $dirlist Array of file/directory information from WP_Filesystem_Base::dirlist(), 2819 * with sub-directories represented as nested arrays. 2820 * @param string $path Absolute path to the directory. 2821 */ 2822 $invalidate_directory = static function ( $dirlist, $path ) use ( &$invalidate_directory ) { 2823 $path = trailingslashit( $path ); 2824 2825 foreach ( $dirlist as $name => $details ) { 2826 if ( 'f' === $details['type'] ) { 2827 wp_opcache_invalidate( $path . $name, true ); 2828 } elseif ( is_array( $details['files'] ) && ! empty( $details['files'] ) ) { 2829 $invalidate_directory( $details['files'], $path . $name ); 2830 } 2831 } 2832 }; 2833 2834 $invalidate_directory( $dirlist, $dir ); 2835 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
Generated : Mon Mar 18 08:20:01 2024 | Cross-referenced by PHPXref |