upload_max_filesize directive in php.ini." ),
- __( "The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form." ),
+ __( "The uploaded file exceeds the upload_max_filesize directive in php.ini." ),
+ __( "The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form." ),
__( "The uploaded file was only partially uploaded." ),
__( "No file was uploaded." ),
'',
__( "Missing a temporary folder." ),
- __( "Failed to write file to disk." ));
+ __( "Failed to write file to disk." ),
+ __( "File upload stopped by extension." ));
- // All tests are on by default. Most can be turned off by $override[{test_name}] = false;
+ // All tests are on by default. Most can be turned off by $overrides[{test_name}] = false;
$test_form = true;
$test_size = true;
+ $test_upload = true;
// If you override this, you must provide $ext and $type!!!!
$test_type = true;
@@ -254,46 +255,62 @@ function wp_handle_upload( &$file, $overrides = false, $time = null ) {
// A correct form post will pass this test.
if ( $test_form && (!isset( $_POST['action'] ) || ($_POST['action'] != $action ) ) )
- return $upload_error_handler( $file, __( 'Invalid form submission.' ));
+ return call_user_func($upload_error_handler, $file, __( 'Invalid form submission.' ));
// A successful upload will pass this test. It makes no sense to override this one.
if ( $file['error'] > 0 )
- return $upload_error_handler( $file, $upload_error_strings[$file['error']] );
+ return call_user_func($upload_error_handler, $file, $upload_error_strings[$file['error']] );
// A non-empty file will pass this test.
- if ( $test_size && !($file['size'] > 0 ) )
- return $upload_error_handler( $file, __( 'File is empty. Please upload something more substantial. This error could also be caused by uploads being disabled in your php.ini.' ));
+ if ( $test_size && !($file['size'] > 0 ) ) {
+ if ( is_multisite() )
+ $error_msg = __( 'File is empty. Please upload something more substantial.' );
+ else
+ $error_msg = __( 'File is empty. Please upload something more substantial. This error could also be caused by uploads being disabled in your php.ini or by post_max_size being defined as smaller than upload_max_filesize in php.ini.' );
+ return call_user_func($upload_error_handler, $file, $error_msg);
+ }
// A properly uploaded file will pass this test. There should be no reason to override this one.
- if (! @ is_uploaded_file( $file['tmp_name'] ) )
- return $upload_error_handler( $file, __( 'Specified file failed upload test.' ));
+ if ( $test_upload && ! @ is_uploaded_file( $file['tmp_name'] ) )
+ return call_user_func($upload_error_handler, $file, __( 'Specified file failed upload test.' ));
// A correct MIME type will pass this test. Override $mimes or use the upload_mimes filter.
if ( $test_type ) {
- $wp_filetype = wp_check_filetype( $file['name'], $mimes );
+ $wp_filetype = wp_check_filetype_and_ext( $file['tmp_name'], $file['name'], $mimes );
extract( $wp_filetype );
+ // Check to see if wp_check_filetype_and_ext() determined the filename was incorrect
+ if ( $proper_filename )
+ $file['name'] = $proper_filename;
+
if ( ( !$type || !$ext ) && !current_user_can( 'unfiltered_upload' ) )
- return $upload_error_handler( $file, __( 'File type does not meet security guidelines. Try another.' ));
+ return call_user_func($upload_error_handler, $file, __( 'Sorry, this file type is not permitted for security reasons.' ));
if ( !$ext )
$ext = ltrim(strrchr($file['name'], '.'), '.');
if ( !$type )
$type = $file['type'];
+ } else {
+ $type = '';
}
// A writable uploads dir will pass this test. Again, there's no point overriding this one.
if ( ! ( ( $uploads = wp_upload_dir($time) ) && false === $uploads['error'] ) )
- return $upload_error_handler( $file, $uploads['error'] );
+ return call_user_func($upload_error_handler, $file, $uploads['error'] );
$filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );
// Move the file to the uploads dir
$new_file = $uploads['path'] . "/$filename";
if ( false === @ move_uploaded_file( $file['tmp_name'], $new_file ) ) {
- return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $uploads['path'] ) );
+ if ( 0 === strpos( $uploads['basedir'], ABSPATH ) )
+ $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
+ else
+ $error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
+
+ return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $error_path ) );
}
// Set correct file permissions
@@ -304,23 +321,31 @@ function wp_handle_upload( &$file, $overrides = false, $time = null ) {
// Compute the URL
$url = $uploads['url'] . "/$filename";
- $return = apply_filters( 'wp_handle_upload', array( 'file' => $new_file, 'url' => $url, 'type' => $type ) );
+ if ( is_multisite() )
+ delete_transient( 'dirsize_cache' );
- return $return;
+ return apply_filters( 'wp_handle_upload', array( 'file' => $new_file, 'url' => $url, 'type' => $type ), 'upload' );
}
/**
- * {@internal Missing Short Description}}
- *
- * Pass this function an array similar to that of a $_FILES POST array.
+ * Handle sideloads, which is the process of retrieving a media item from another server instead of
+ * a traditional media upload. This process involves sanitizing the filename, checking extensions
+ * for mime type, and moving the file to the appropriate directory within the uploads directory.
*
- * @since unknown
+ * @since 2.6.0
*
- * @param unknown_type $file
- * @param unknown_type $overrides
- * @return unknown
+ * @uses wp_handle_upload_error
+ * @uses apply_filters
+ * @uses wp_check_filetype_and_ext
+ * @uses current_user_can
+ * @uses wp_upload_dir
+ * @uses wp_unique_filename
+ * @param array $file an array similar to that of a PHP $_FILES POST array
+ * @param array $overrides Optional. An associative array of names=>values to override default variables with extract( $overrides, EXTR_OVERWRITE ).
+ * @param string $time Optional. Time formatted in 'yyyy/mm'.
+ * @return array On success, returns an associative array of file attributes. On failure, returns $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).
*/
-function wp_handle_sideload( &$file, $overrides = false ) {
+function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
// The default error handler.
if (! function_exists( 'wp_handle_upload_error' ) ) {
function wp_handle_upload_error( &$file, $message ) {
@@ -339,14 +364,16 @@ function wp_handle_sideload( &$file, $overrides = false ) {
// Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error'].
$upload_error_strings = array( false,
- __( "The file exceeds the upload_max_filesize directive in php.ini." ),
- __( "The file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form." ),
- __( "The file was only partially uploaded." ),
- __( "No file was sent." ),
+ __( "The uploaded file exceeds the upload_max_filesize directive in php.ini." ),
+ __( "The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form." ),
+ __( "The uploaded file was only partially uploaded." ),
+ __( "No file was uploaded." ),
+ '',
__( "Missing a temporary folder." ),
- __( "Failed to write file to disk." ));
+ __( "Failed to write file to disk." ),
+ __( "File upload stopped by extension." ));
- // All tests are on by default. Most can be turned off by $override[{test_name}] = false;
+ // All tests are on by default. Most can be turned off by $overrides[{test_name}] = false;
$test_form = true;
$test_size = true;
@@ -363,7 +390,7 @@ function wp_handle_sideload( &$file, $overrides = false ) {
return $upload_error_handler( $file, __( 'Invalid form submission.' ));
// A successful upload will pass this test. It makes no sense to override this one.
- if ( $file['error'] > 0 )
+ if ( ! empty( $file['error'] ) )
return $upload_error_handler( $file, $upload_error_strings[$file['error']] );
// A non-empty file will pass this test.
@@ -376,12 +403,16 @@ function wp_handle_sideload( &$file, $overrides = false ) {
// A correct MIME type will pass this test. Override $mimes or use the upload_mimes filter.
if ( $test_type ) {
- $wp_filetype = wp_check_filetype( $file['name'], $mimes );
+ $wp_filetype = wp_check_filetype_and_ext( $file['tmp_name'], $file['name'], $mimes );
extract( $wp_filetype );
+ // Check to see if wp_check_filetype_and_ext() determined the filename was incorrect
+ if ( $proper_filename )
+ $file['name'] = $proper_filename;
+
if ( ( !$type || !$ext ) && !current_user_can( 'unfiltered_upload' ) )
- return $upload_error_handler( $file, __( 'File type does not meet security guidelines. Try another.' ));
+ return $upload_error_handler( $file, __( 'Sorry, this file type is not permitted for security reasons.' ));
if ( !$ext )
$ext = ltrim(strrchr($file['name'], '.'), '.');
@@ -391,7 +422,7 @@ function wp_handle_sideload( &$file, $overrides = false ) {
}
// A writable uploads dir will pass this test. Again, there's no point overriding this one.
- if ( ! ( ( $uploads = wp_upload_dir() ) && false === $uploads['error'] ) )
+ if ( ! ( ( $uploads = wp_upload_dir( $time ) ) && false === $uploads['error'] ) )
return $upload_error_handler( $file, $uploads['error'] );
$filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );
@@ -403,7 +434,11 @@ function wp_handle_sideload( &$file, $overrides = false ) {
// Move the file to the uploads dir
$new_file = $uploads['path'] . "/$filename";
if ( false === @ rename( $file['tmp_name'], $new_file ) ) {
- return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $uploads['path'] ) );
+ if ( 0 === strpos( $uploads['basedir'], ABSPATH ) )
+ $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
+ else
+ $error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
+ return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $error_path ) );
}
// Set correct file permissions
@@ -414,61 +449,91 @@ function wp_handle_sideload( &$file, $overrides = false ) {
// Compute the URL
$url = $uploads['url'] . "/$filename";
- $return = apply_filters( 'wp_handle_upload', array( 'file' => $new_file, 'url' => $url, 'type' => $type ) );
+ $return = apply_filters( 'wp_handle_upload', array( 'file' => $new_file, 'url' => $url, 'type' => $type ), 'sideload' );
return $return;
}
/**
- * Downloads a url to a local file using the Snoopy HTTP Class.
+ * Downloads a url to a local temporary file using the WordPress HTTP Class.
+ * Please note, That the calling function must unlink() the file.
*
- * @since unknown
- * @todo Transition over to using the new HTTP Request API (jacob).
+ * @since 2.5.0
*
* @param string $url the URL of the file to download
+ * @param int $timeout The timeout for the request to download the file default 300 seconds
* @return mixed WP_Error on failure, string Filename on success.
*/
-function download_url( $url ) {
+function download_url( $url, $timeout = 300 ) {
//WARNING: The file is not automatically deleted, The script must unlink() the file.
if ( ! $url )
- return new WP_Error('http_no_url', __('Invalid URL Provided'));
+ return new WP_Error('http_no_url', __('Invalid URL Provided.'));
$tmpfname = wp_tempnam($url);
if ( ! $tmpfname )
- return new WP_Error('http_no_file', __('Could not create Temporary file'));
-
- $handle = @fopen($tmpfname, 'wb');
- if ( ! $handle )
- return new WP_Error('http_no_file', __('Could not create Temporary file'));
+ return new WP_Error('http_no_file', __('Could not create Temporary file.'));
- $response = wp_remote_get($url, array('timeout' => 30));
+ $response = wp_safe_remote_get( $url, array( 'timeout' => $timeout, 'stream' => true, 'filename' => $tmpfname ) );
- if ( is_wp_error($response) ) {
- fclose($handle);
- unlink($tmpfname);
+ if ( is_wp_error( $response ) ) {
+ unlink( $tmpfname );
return $response;
}
- if ( $response['response']['code'] != '200' ){
- fclose($handle);
- unlink($tmpfname);
- return new WP_Error('http_404', trim($response['response']['message']));
+ if ( 200 != wp_remote_retrieve_response_code( $response ) ){
+ unlink( $tmpfname );
+ return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ) );
}
- fwrite($handle, $response['body']);
- fclose($handle);
+ $content_md5 = wp_remote_retrieve_header( $response, 'content-md5' );
+ if ( $content_md5 ) {
+ $md5_check = verify_file_md5( $tmpfname, $content_md5 );
+ if ( is_wp_error( $md5_check ) ) {
+ unlink( $tmpfname );
+ return $md5_check;
+ }
+ }
return $tmpfname;
}
/**
- * {@internal Missing Short Description}}
+ * Calculates and compares the MD5 of a file to it's expected value.
*
- * @since unknown
+ * @since 3.7.0
*
- * @param unknown_type $file
- * @param unknown_type $to
- * @return unknown
+ * @param string $filename The filename to check the MD5 of.
+ * @param string $expected_md5 The expected MD5 of the file, either a base64 encoded raw md5, or a hex-encoded md5
+ * @return bool|object WP_Error on failure, true on success, false when the MD5 format is unknown/unexpected
+ */
+function verify_file_md5( $filename, $expected_md5 ) {
+ if ( 32 == strlen( $expected_md5 ) )
+ $expected_raw_md5 = pack( 'H*', $expected_md5 );
+ elseif ( 24 == strlen( $expected_md5 ) )
+ $expected_raw_md5 = base64_decode( $expected_md5 );
+ else
+ return false; // unknown format
+
+ $file_md5 = md5_file( $filename, true );
+
+ if ( $file_md5 === $expected_raw_md5 )
+ return true;
+
+ return new WP_Error( 'md5_mismatch', sprintf( __( 'The checksum of the file (%1$s) does not match the expected checksum value (%2$s).' ), bin2hex( $file_md5 ), bin2hex( $expected_raw_md5 ) ) );
+}
+
+/**
+ * Unzips a specified ZIP file to a location on the Filesystem via the WordPress Filesystem Abstraction.
+ * Assumes that WP_Filesystem() has already been called and set up. Does not extract a root-level __MACOSX directory, if present.
+ *
+ * Attempts to increase the PHP Memory limit to 256M before uncompressing,
+ * However, The most memory required shouldn't be much larger than the Archive itself.
+ *
+ * @since 2.5.0
+ *
+ * @param string $file Full path and filename of zip archive
+ * @param string $to Full path on the filesystem to extract archive to
+ * @return mixed WP_Error on failure, True on success
*/
function unzip_file($file, $to) {
global $wp_filesystem;
@@ -476,73 +541,245 @@ function unzip_file($file, $to) {
if ( ! $wp_filesystem || !is_object($wp_filesystem) )
return new WP_Error('fs_unavailable', __('Could not access filesystem.'));
- // Unzip uses a lot of memory
- @ini_set('memory_limit', '256M');
+ // Unzip can use a lot of memory, but not this much hopefully
+ @ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', WP_MAX_MEMORY_LIMIT ) );
+
+ $needed_dirs = array();
+ $to = trailingslashit($to);
+
+ // Determine any parent dir's needed (of the upgrade directory)
+ if ( ! $wp_filesystem->is_dir($to) ) { //Only do parents if no children exist
+ $path = preg_split('![/\\\]!', untrailingslashit($to));
+ for ( $i = count($path); $i >= 0; $i-- ) {
+ if ( empty($path[$i]) )
+ continue;
+
+ $dir = implode('/', array_slice($path, 0, $i+1) );
+ if ( preg_match('!^[a-z]:$!i', $dir) ) // Skip it if it looks like a Windows Drive letter.
+ continue;
+
+ if ( ! $wp_filesystem->is_dir($dir) )
+ $needed_dirs[] = $dir;
+ else
+ break; // A folder exists, therefor, we dont need the check the levels below this
+ }
+ }
+
+ if ( class_exists('ZipArchive') && apply_filters('unzip_file_use_ziparchive', true ) ) {
+ $result = _unzip_file_ziparchive($file, $to, $needed_dirs);
+ if ( true === $result ) {
+ return $result;
+ } elseif ( is_wp_error($result) ) {
+ if ( 'incompatible_archive' != $result->get_error_code() )
+ return $result;
+ }
+ }
+ // Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file.
+ return _unzip_file_pclzip($file, $to, $needed_dirs);
+}
+
+/**
+ * This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the ZipArchive class.
+ * Assumes that WP_Filesystem() has already been called and set up.
+ *
+ * @since 3.0.0
+ * @see unzip_file
+ * @access private
+ *
+ * @param string $file Full path and filename of zip archive
+ * @param string $to Full path on the filesystem to extract archive to
+ * @param array $needed_dirs A partial list of required folders needed to be created.
+ * @return mixed WP_Error on failure, True on success
+ */
+function _unzip_file_ziparchive($file, $to, $needed_dirs = array() ) {
+ global $wp_filesystem;
+
+ $z = new ZipArchive();
+
+ $zopen = $z->open( $file, ZIPARCHIVE::CHECKCONS );
+ if ( true !== $zopen )
+ return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), array( 'ziparchive_error' => $zopen ) );
+
+ $uncompressed_size = 0;
- $fs =& $wp_filesystem;
+ for ( $i = 0; $i < $z->numFiles; $i++ ) {
+ if ( ! $info = $z->statIndex($i) )
+ return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
+
+ if ( '__MACOSX/' === substr($info['name'], 0, 9) ) // Skip the OS X-created __MACOSX directory
+ continue;
+
+ $uncompressed_size += $info['size'];
+
+ if ( '/' == substr($info['name'], -1) ) // directory
+ $needed_dirs[] = $to . untrailingslashit($info['name']);
+ else
+ $needed_dirs[] = $to . untrailingslashit(dirname($info['name']));
+ }
+
+ /*
+ * disk_free_space() could return false. Assume that any falsey value is an error.
+ * A disk that has zero free bytes has bigger problems.
+ * Require we have enough space to unzip the file and copy its contents, with a 10% buffer.
+ */
+ if ( defined( 'DOING_CRON' ) && DOING_CRON ) {
+ $available_space = @disk_free_space( WP_CONTENT_DIR );
+ if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space )
+ return new WP_Error( 'disk_full_unzip_file', __( 'Could not copy files. You may have run out of disk space.' ), compact( 'uncompressed_size', 'available_space' ) );
+ }
+
+ $needed_dirs = array_unique($needed_dirs);
+ foreach ( $needed_dirs as $dir ) {
+ // Check the parent folders of the folders all exist within the creation array.
+ if ( untrailingslashit($to) == $dir ) // Skip over the working directory, We know this exists (or will exist)
+ continue;
+ if ( strpos($dir, $to) === false ) // If the directory is not within the working directory, Skip it
+ continue;
+
+ $parent_folder = dirname($dir);
+ while ( !empty($parent_folder) && untrailingslashit($to) != $parent_folder && !in_array($parent_folder, $needed_dirs) ) {
+ $needed_dirs[] = $parent_folder;
+ $parent_folder = dirname($parent_folder);
+ }
+ }
+ asort($needed_dirs);
+
+ // Create those directories if need be:
+ foreach ( $needed_dirs as $_dir ) {
+ if ( ! $wp_filesystem->mkdir($_dir, FS_CHMOD_DIR) && ! $wp_filesystem->is_dir($_dir) ) // Only check to see if the Dir exists upon creation failure. Less I/O this way.
+ return new WP_Error( 'mkdir_failed_ziparchive', __( 'Could not create directory.' ), substr( $_dir, strlen( $to ) ) );
+ }
+ unset($needed_dirs);
+
+ for ( $i = 0; $i < $z->numFiles; $i++ ) {
+ if ( ! $info = $z->statIndex($i) )
+ return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
+
+ if ( '/' == substr($info['name'], -1) ) // directory
+ continue;
+
+ if ( '__MACOSX/' === substr($info['name'], 0, 9) ) // Don't extract the OS X-created __MACOSX directory files
+ continue;
+
+ $contents = $z->getFromIndex($i);
+ if ( false === $contents )
+ return new WP_Error( 'extract_failed_ziparchive', __( 'Could not extract file from archive.' ), $info['name'] );
+
+ if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE) )
+ return new WP_Error( 'copy_failed_ziparchive', __( 'Could not copy file.' ), $info['name'] );
+ }
+
+ $z->close();
+
+ return true;
+}
+
+/**
+ * This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the PclZip library.
+ * Assumes that WP_Filesystem() has already been called and set up.
+ *
+ * @since 3.0.0
+ * @see unzip_file
+ * @access private
+ *
+ * @param string $file Full path and filename of zip archive
+ * @param string $to Full path on the filesystem to extract archive to
+ * @param array $needed_dirs A partial list of required folders needed to be created.
+ * @return mixed WP_Error on failure, True on success
+ */
+function _unzip_file_pclzip($file, $to, $needed_dirs = array()) {
+ global $wp_filesystem;
+
+ mbstring_binary_safe_encoding();
require_once(ABSPATH . 'wp-admin/includes/class-pclzip.php');
$archive = new PclZip($file);
+ $archive_files = $archive->extract(PCLZIP_OPT_EXTRACT_AS_STRING);
+
+ reset_mbstring_encoding();
+
// Is the archive valid?
- if ( false == ($archive_files = $archive->extract(PCLZIP_OPT_EXTRACT_AS_STRING)) )
- return new WP_Error('incompatible_archive', __('Incompatible archive'), $archive->errorInfo(true));
+ if ( !is_array($archive_files) )
+ return new WP_Error('incompatible_archive', __('Incompatible Archive.'), $archive->errorInfo(true));
if ( 0 == count($archive_files) )
- return new WP_Error('empty_archive', __('Empty archive'));
-
- $path = explode('/', untrailingslashit($to));
- for ( $i = count($path); $i > 0; $i-- ) { //>0 = first element is empty allways for paths starting with '/'
- $tmppath = implode('/', array_slice($path, 0, $i) );
- if ( $fs->is_dir($tmppath) ) { //Found the highest folder that exists, Create from here(ie +1)
- for ( $i = $i + 1; $i <= count($path); $i++ ) {
- $tmppath = implode('/', array_slice($path, 0, $i) );
- if ( ! $fs->mkdir($tmppath, FS_CHMOD_DIR) )
- return new WP_Error('mkdir_failed', __('Could not create directory'), $tmppath);
- }
- break; //Exit main for loop
- }
+ return new WP_Error( 'empty_archive_pclzip', __( 'Empty archive.' ) );
+
+ $uncompressed_size = 0;
+
+ // Determine any children directories needed (From within the archive)
+ foreach ( $archive_files as $file ) {
+ if ( '__MACOSX/' === substr($file['filename'], 0, 9) ) // Skip the OS X-created __MACOSX directory
+ continue;
+
+ $uncompressed_size += $file['size'];
+
+ $needed_dirs[] = $to . untrailingslashit( $file['folder'] ? $file['filename'] : dirname($file['filename']) );
}
- $to = trailingslashit($to);
- foreach ($archive_files as $file) {
- $path = $file['folder'] ? $file['filename'] : dirname($file['filename']);
- $path = explode('/', $path);
- for ( $i = count($path); $i >= 0; $i-- ) { //>=0 as the first element contains data
- if ( empty($path[$i]) )
- continue;
- $tmppath = $to . implode('/', array_slice($path, 0, $i) );
- if ( $fs->is_dir($tmppath) ) {//Found the highest folder that exists, Create from here
- for ( $i = $i + 1; $i <= count($path); $i++ ) { //< count() no file component please.
- $tmppath = $to . implode('/', array_slice($path, 0, $i) );
- if ( ! $fs->is_dir($tmppath) && ! $fs->mkdir($tmppath, FS_CHMOD_DIR) )
- return new WP_Error('mkdir_failed', __('Could not create directory'), $tmppath);
- }
- break; //Exit main for loop
- }
- }
+ /*
+ * disk_free_space() could return false. Assume that any falsey value is an error.
+ * A disk that has zero free bytes has bigger problems.
+ * Require we have enough space to unzip the file and copy its contents, with a 10% buffer.
+ */
+ if ( defined( 'DOING_CRON' ) && DOING_CRON ) {
+ $available_space = @disk_free_space( WP_CONTENT_DIR );
+ if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space )
+ return new WP_Error( 'disk_full_unzip_file', __( 'Could not copy files. You may have run out of disk space.' ), compact( 'uncompressed_size', 'available_space' ) );
+ }
- // We've made sure the folders are there, so let's extract the file now:
- if ( ! $file['folder'] ) {
- if ( !$fs->put_contents( $to . $file['filename'], $file['content']) )
- return new WP_Error('copy_failed', __('Could not copy file'), $to . $file['filename']);
- $fs->chmod($to . $file['filename'], FS_CHMOD_FILE);
+ $needed_dirs = array_unique($needed_dirs);
+ foreach ( $needed_dirs as $dir ) {
+ // Check the parent folders of the folders all exist within the creation array.
+ if ( untrailingslashit($to) == $dir ) // Skip over the working directory, We know this exists (or will exist)
+ continue;
+ if ( strpos($dir, $to) === false ) // If the directory is not within the working directory, Skip it
+ continue;
+
+ $parent_folder = dirname($dir);
+ while ( !empty($parent_folder) && untrailingslashit($to) != $parent_folder && !in_array($parent_folder, $needed_dirs) ) {
+ $needed_dirs[] = $parent_folder;
+ $parent_folder = dirname($parent_folder);
}
}
+ asort($needed_dirs);
+
+ // Create those directories if need be:
+ foreach ( $needed_dirs as $_dir ) {
+ // Only check to see if the dir exists upon creation failure. Less I/O this way.
+ if ( ! $wp_filesystem->mkdir( $_dir, FS_CHMOD_DIR ) && ! $wp_filesystem->is_dir( $_dir ) )
+ return new WP_Error( 'mkdir_failed_pclzip', __( 'Could not create directory.' ), substr( $_dir, strlen( $to ) ) );
+ }
+ unset($needed_dirs);
+
+ // Extract the files from the zip
+ foreach ( $archive_files as $file ) {
+ if ( $file['folder'] )
+ continue;
+
+ if ( '__MACOSX/' === substr($file['filename'], 0, 9) ) // Don't extract the OS X-created __MACOSX directory files
+ continue;
+
+ if ( ! $wp_filesystem->put_contents( $to . $file['filename'], $file['content'], FS_CHMOD_FILE) )
+ return new WP_Error( 'copy_failed_pclzip', __( 'Could not copy file.' ), $file['filename'] );
+ }
return true;
}
/**
- * {@internal Missing Short Description}}
+ * Copies a directory from one location to another via the WordPress Filesystem Abstraction.
+ * Assumes that WP_Filesystem() has already been called and setup.
*
- * @since unknown
+ * @since 2.5.0
*
- * @param unknown_type $from
- * @param unknown_type $to
- * @return unknown
+ * @param string $from source directory
+ * @param string $to destination directory
+ * @param array $skip_list a list of files/folders to skip copying
+ * @return mixed WP_Error on failure, True on success.
*/
-function copy_dir($from, $to) {
+function copy_dir($from, $to, $skip_list = array() ) {
global $wp_filesystem;
$dirlist = $wp_filesystem->dirlist($from);
@@ -551,138 +788,202 @@ function copy_dir($from, $to) {
$to = trailingslashit($to);
foreach ( (array) $dirlist as $filename => $fileinfo ) {
+ if ( in_array( $filename, $skip_list ) )
+ continue;
+
if ( 'f' == $fileinfo['type'] ) {
- if ( ! $wp_filesystem->copy($from . $filename, $to . $filename, true) ) {
+ if ( ! $wp_filesystem->copy($from . $filename, $to . $filename, true, FS_CHMOD_FILE) ) {
// If copy failed, chmod file to 0644 and try again.
- $wp_filesystem->chmod($to . $filename, 0644);
- if ( ! $wp_filesystem->copy($from . $filename, $to . $filename, true) )
- return new WP_Error('copy_failed', __('Could not copy file'), $to . $filename);
+ $wp_filesystem->chmod( $to . $filename, FS_CHMOD_FILE );
+ if ( ! $wp_filesystem->copy($from . $filename, $to . $filename, true, FS_CHMOD_FILE) )
+ return new WP_Error( 'copy_failed_copy_dir', __( 'Could not copy file.' ), $to . $filename );
}
- $wp_filesystem->chmod($to . $filename, FS_CHMOD_FILE);
} elseif ( 'd' == $fileinfo['type'] ) {
if ( !$wp_filesystem->is_dir($to . $filename) ) {
if ( !$wp_filesystem->mkdir($to . $filename, FS_CHMOD_DIR) )
- return new WP_Error('mkdir_failed', __('Could not create directory'), $to . $filename);
+ return new WP_Error( 'mkdir_failed_copy_dir', __( 'Could not create directory.' ), $to . $filename );
+ }
+
+ // generate the $sub_skip_list for the subdirectory as a sub-set of the existing $skip_list
+ $sub_skip_list = array();
+ foreach ( $skip_list as $skip_item ) {
+ if ( 0 === strpos( $skip_item, $filename . '/' ) )
+ $sub_skip_list[] = preg_replace( '!^' . preg_quote( $filename, '!' ) . '/!i', '', $skip_item );
}
- $result = copy_dir($from . $filename, $to . $filename);
+
+ $result = copy_dir($from . $filename, $to . $filename, $sub_skip_list);
if ( is_wp_error($result) )
return $result;
}
}
+ return true;
}
/**
- * {@internal Missing Short Description}}
+ * Initialises and connects the WordPress Filesystem Abstraction classes.
+ * This function will include the chosen transport and attempt connecting.
+ *
+ * Plugins may add extra transports, And force WordPress to use them by returning the filename via the 'filesystem_method_file' filter.
*
- * @since unknown
+ * @since 2.5.0
*
- * @param unknown_type $args
- * @return unknown
+ * @param array $args (optional) Connection args, These are passed directly to the WP_Filesystem_*() classes.
+ * @param string $context (optional) Context for get_filesystem_method(), See function declaration for more information.
+ * @return boolean false on failure, true on success
*/
-function WP_Filesystem( $args = false ) {
+function WP_Filesystem( $args = false, $context = false ) {
global $wp_filesystem;
require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
- $method = get_filesystem_method($args);
+ $method = get_filesystem_method($args, $context);
if ( ! $method )
return false;
- $abstraction_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method);
- if( ! file_exists($abstraction_file) )
- return;
+ if ( ! class_exists("WP_Filesystem_$method") ) {
+ $abstraction_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method);
+ if ( ! file_exists($abstraction_file) )
+ return;
- require_once($abstraction_file);
+ require_once($abstraction_file);
+ }
$method = "WP_Filesystem_$method";
$wp_filesystem = new $method($args);
- if ( $wp_filesystem->errors->get_error_code() )
+ //Define the timeouts for the connections. Only available after the construct is called to allow for per-transport overriding of the default.
+ if ( ! defined('FS_CONNECT_TIMEOUT') )
+ define('FS_CONNECT_TIMEOUT', 30);
+ if ( ! defined('FS_TIMEOUT') )
+ define('FS_TIMEOUT', 30);
+
+ if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() )
return false;
if ( !$wp_filesystem->connect() )
- return false; //There was an erorr connecting to the server.
+ return false; //There was an error connecting to the server.
// Set the permission constants if not already set.
if ( ! defined('FS_CHMOD_DIR') )
- define('FS_CHMOD_DIR', 0755 );
+ define('FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
if ( ! defined('FS_CHMOD_FILE') )
- define('FS_CHMOD_FILE', 0644 );
+ define('FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
return true;
}
/**
- * {@internal Missing Short Description}}
+ * Determines which Filesystem Method to use.
+ * The priority of the Transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets (Via Sockets class, or fsockopen())
*
- * @since unknown
+ * Note that the return value of this function can be overridden in 2 ways
+ * - By defining FS_METHOD in your wp-config.php file
+ * - By using the filesystem_method filter
+ * Valid values for these are: 'direct', 'ssh', 'ftpext' or 'ftpsockets'
+ * Plugins may also define a custom transport handler, See the WP_Filesystem function for more information.
*
- * @param unknown_type $args
- * @return unknown
+ * @since 2.5.0
+ *
+ * @param array $args Connection details.
+ * @param string $context Full path to the directory that is tested for being writable.
+ * @return string The transport to use, see description for valid return values.
*/
-function get_filesystem_method($args = array()) {
- $method = false;
- if( function_exists('getmyuid') && function_exists('fileowner') ){
- $temp_file = wp_tempnam();
- if ( getmyuid() == fileowner($temp_file) )
- $method = 'direct';
- unlink($temp_file);
- }
+function get_filesystem_method($args = array(), $context = false) {
+ $method = defined('FS_METHOD') ? FS_METHOD : false; //Please ensure that this is either 'direct', 'ssh', 'ftpext' or 'ftpsockets'
+
+ if ( ! $method && function_exists('getmyuid') && function_exists('fileowner') ){
+ if ( !$context )
+ $context = WP_CONTENT_DIR;
+
+ // If the directory doesn't exist (wp-content/languages) then use the parent directory as we'll create it.
+ if ( WP_LANG_DIR == $context && ! is_dir( $context ) )
+ $context = dirname( $context );
+
+ $context = trailingslashit($context);
+ $temp_file_name = $context . 'temp-write-test-' . time();
+ $temp_handle = @fopen($temp_file_name, 'w');
+ if ( $temp_handle ) {
+ if ( getmyuid() == @fileowner($temp_file_name) )
+ $method = 'direct';
+ @fclose($temp_handle);
+ @unlink($temp_file_name);
+ }
+ }
- if ( ! $method && isset($args['connection_type']) && 'ssh' == $args['connection_type'] && extension_loaded('ssh2') ) $method = 'ssh2';
+ if ( ! $method && isset($args['connection_type']) && 'ssh' == $args['connection_type'] && extension_loaded('ssh2') && function_exists('stream_get_contents') ) $method = 'ssh2';
if ( ! $method && extension_loaded('ftp') ) $method = 'ftpext';
if ( ! $method && ( extension_loaded('sockets') || function_exists('fsockopen') ) ) $method = 'ftpsockets'; //Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread
- return apply_filters('filesystem_method', $method);
+ return apply_filters('filesystem_method', $method, $args);
}
/**
- * {@internal Missing Short Description}}
+ * Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem.
+ * All chosen/entered details are saved, Excluding the Password.
+ *
+ * Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467) to specify an alternate FTP/SSH port.
+ *
+ * Plugins may override this form by returning true|false via the request_filesystem_credentials filter.
*
- * @since unknown
+ * @since 2.5.0
*
- * @param unknown_type $form_post
- * @param unknown_type $type
- * @param unknown_type $error
- * @return unknown
+ * @param string $form_post the URL to post the form to
+ * @param string $type the chosen Filesystem method in use
+ * @param boolean $error if the current request has failed to connect
+ * @param string $context The directory which is needed access to, The write-test will be performed on this directory by get_filesystem_method()
+ * @param string $extra_fields Extra POST fields which should be checked for to be included in the post.
+ * @return boolean False on failure. True on success.
*/
-function request_filesystem_credentials($form_post, $type = '', $error = false) {
- $req_cred = apply_filters('request_filesystem_credentials', '', $form_post, $type, $error);
+function request_filesystem_credentials($form_post, $type = '', $error = false, $context = false, $extra_fields = null) {
+ $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields );
if ( '' !== $req_cred )
return $req_cred;
if ( empty($type) )
- $type = get_filesystem_method();
+ $type = get_filesystem_method(array(), $context);
if ( 'direct' == $type )
return true;
- $credentials = get_option('ftp_credentials', array());
+ if ( is_null( $extra_fields ) )
+ $extra_fields = array( 'version', 'locale' );
+
+ $credentials = get_option('ftp_credentials', array( 'hostname' => '', 'username' => ''));
+
// If defined, set it to that, Else, If POST'd, set it to that, If not, Set it to whatever it previously was(saved details in option)
- $credentials['hostname'] = defined('FTP_HOST') ? FTP_HOST : (!empty($_POST['hostname']) ? $_POST['hostname'] : $credentials['hostname']);
- $credentials['username'] = defined('FTP_USER') ? FTP_USER : (!empty($_POST['username']) ? $_POST['username'] : $credentials['username']);
- $credentials['password'] = defined('FTP_PASS') ? FTP_PASS : (!empty($_POST['password']) ? $_POST['password'] : $credentials['password']);
+ $credentials['hostname'] = defined('FTP_HOST') ? FTP_HOST : (!empty($_POST['hostname']) ? wp_unslash( $_POST['hostname'] ) : $credentials['hostname']);
+ $credentials['username'] = defined('FTP_USER') ? FTP_USER : (!empty($_POST['username']) ? wp_unslash( $_POST['username'] ) : $credentials['username']);
+ $credentials['password'] = defined('FTP_PASS') ? FTP_PASS : (!empty($_POST['password']) ? wp_unslash( $_POST['password'] ) : '');
// Check to see if we are setting the public/private keys for ssh
- $credentials['public_key'] = defined('FTP_PUBKEY') ? FTP_PUBKEY : (!empty($_POST['public_key']) ? $_POST['public_key'] : $credentials['public_key']);
- $credentials['private_key'] = defined('FTP_PRIKEY') ? FTP_PRIKEY : (!empty($_POST['private_key']) ? $_POST['private_key'] : $credentials['private_key']);
+ $credentials['public_key'] = defined('FTP_PUBKEY') ? FTP_PUBKEY : (!empty($_POST['public_key']) ? wp_unslash( $_POST['public_key'] ) : '');
+ $credentials['private_key'] = defined('FTP_PRIKEY') ? FTP_PRIKEY : (!empty($_POST['private_key']) ? wp_unslash( $_POST['private_key'] ) : '');
//sanitize the hostname, Some people might pass in odd-data:
$credentials['hostname'] = preg_replace('|\w+://|', '', $credentials['hostname']); //Strip any schemes off
- if ( strpos($credentials['hostname'], ':') )
+ if ( strpos($credentials['hostname'], ':') ) {
list( $credentials['hostname'], $credentials['port'] ) = explode(':', $credentials['hostname'], 2);
- else
+ if ( ! is_numeric($credentials['port']) )
+ unset($credentials['port']);
+ } else {
unset($credentials['port']);
+ }
- if ( defined('FTP_SSH') || (isset($_POST['connection_type']) && 'ssh' == $_POST['connection_type']) )
+ if ( (defined('FTP_SSH') && FTP_SSH) || (defined('FS_METHOD') && 'ssh' == FS_METHOD) )
$credentials['connection_type'] = 'ssh';
- else if ( defined('FTP_SSL') || (isset($_POST['connection_type']) && 'ftps' == $_POST['connection_type']) )
+ else if ( (defined('FTP_SSL') && FTP_SSL) && 'ftpext' == $type ) //Only the FTP Extension understands SSL
$credentials['connection_type'] = 'ftps';
- else if ( !isset($credentials['connection_type']) || (isset($_POST['connection_type']) && 'ftp' == $_POST['connection_type']) )
+ else if ( !empty($_POST['connection_type']) )
+ $credentials['connection_type'] = wp_unslash( $_POST['connection_type'] );
+ else if ( !isset($credentials['connection_type']) ) //All else fails (And it's not defaulted to something else saved), Default to FTP
$credentials['connection_type'] = 'ftp';
- if ( ! $error && !empty($credentials['password']) && !empty($credentials['username']) && !empty($credentials['hostname']) ) {
+ if ( ! $error &&
+ (
+ ( !empty($credentials['password']) && !empty($credentials['username']) && !empty($credentials['hostname']) ) ||
+ ( 'ssh' == $credentials['connection_type'] && !empty($credentials['public_key']) && !empty($credentials['private_key']) )
+ ) ) {
$stored_credentials = $credentials;
if ( !empty($stored_credentials['port']) ) //save port as part of hostname to simplify above code.
$stored_credentials['hostname'] .= ':' . $stored_credentials['port'];
@@ -698,11 +999,22 @@ function request_filesystem_credentials($form_post, $type = '', $error = false)
if ( !empty($credentials) )
extract($credentials, EXTR_OVERWRITE);
if ( $error ) {
- $error_string = __('Error: There was an error connecting to the server, Please verify the settings are correct.');
+ $error_string = __('ERROR: There was an error connecting to the server, Please verify the settings are correct.');
if ( is_wp_error($error) )
- $error_string = $error->get_error_message();
+ $error_string = esc_html( $error->get_error_message() );
echo '' . $error_string . '