2007-05-27 20:04:33 -04:00
< ? php
2008-10-01 21:03:26 -04:00
/**
* File contains all the administration image manipulation functions .
*
* @ package WordPress
* @ subpackage Administration
*/
2007-05-27 20:04:33 -04:00
2008-10-01 21:03:26 -04:00
/** The descriptions for theme files. */
2008-08-23 05:49:52 -04:00
$wp_file_descriptions = array (
'index.php' => __ ( 'Main Index Template' ),
'style.css' => __ ( 'Stylesheet' ),
2008-10-01 21:03:26 -04:00
'rtl.css' => __ ( 'RTL Stylesheet' ),
'comments.php' => __ ( 'Comments' ),
'comments-popup.php' => __ ( 'Popup Comments' ),
'footer.php' => __ ( 'Footer' ),
'header.php' => __ ( 'Header' ),
2008-08-23 05:49:52 -04:00
'sidebar.php' => __ ( 'Sidebar' ),
'archive.php' => __ ( 'Archives' ),
'category.php' => __ ( 'Category Template' ),
'page.php' => __ ( 'Page Template' ),
'search.php' => __ ( 'Search Results' ),
'searchform.php' => __ ( 'Search Form' ),
'single.php' => __ ( 'Single Post' ),
'404.php' => __ ( '404 Template' ),
'link.php' => __ ( 'Links Template' ),
'functions.php' => __ ( 'Theme Functions' ),
'attachment.php' => __ ( 'Attachment Template' ),
'image.php' => __ ( 'Image Attachment Template' ),
'video.php' => __ ( 'Video Attachment Template' ),
'audio.php' => __ ( 'Audio Attachment Template' ),
'application.php' => __ ( 'Application Attachment Template' ),
'my-hacks.php' => __ ( 'my-hacks.php (legacy hacks support)' ),
'.htaccess' => __ ( '.htaccess (for rewrite rules )' ),
2007-05-27 20:04:33 -04:00
// Deprecated files
'wp-layout.css' => __ ( 'Stylesheet' ), 'wp-comments.php' => __ ( 'Comments Template' ), 'wp-comments-popup.php' => __ ( 'Popup Comments Template' ));
2008-10-01 21:03:26 -04:00
/**
* { @ internal Missing Short Description }}
*
* @ since unknown
*
* @ param unknown_type $file
* @ return unknown
*/
2007-05-27 20:04:33 -04:00
function get_file_description ( $file ) {
global $wp_file_descriptions ;
if ( isset ( $wp_file_descriptions [ basename ( $file )] ) ) {
return $wp_file_descriptions [ basename ( $file )];
}
2008-08-23 05:49:52 -04:00
elseif ( file_exists ( WP_CONTENT_DIR . $file ) && is_file ( WP_CONTENT_DIR . $file ) ) {
$template_data = implode ( '' , file ( WP_CONTENT_DIR . $file ) );
if ( preg_match ( '|Template Name:(.*)$|mi' , $template_data , $name ))
2009-05-04 05:12:12 -04:00
return _cleanup_header_comment ( $name [ 1 ]) . ' Page Template' ;
2007-05-27 20:04:33 -04:00
}
return basename ( $file );
}
2008-10-01 21:03:26 -04:00
/**
* { @ internal Missing Short Description }}
*
* @ since unknown
*
* @ return unknown
*/
2007-05-27 20:04:33 -04:00
function get_home_path () {
$home = get_option ( 'home' );
2009-05-04 22:45:40 -04:00
$siteurl = get_option ( 'siteurl' );
if ( $home != '' && $home != $siteurl ) {
$wp_path_rel_to_home = str_replace ( $home , '' , $siteurl ); /* $siteurl - $home */
$pos = strpos ( $_SERVER [ " SCRIPT_FILENAME " ], $wp_path_rel_to_home );
2009-05-24 19:47:49 -04:00
$home_path = substr ( $_SERVER [ " SCRIPT_FILENAME " ], 0 , $pos );
2009-05-04 22:45:40 -04:00
$home_path = trailingslashit ( $home_path );
2007-05-27 20:04:33 -04:00
} else {
$home_path = ABSPATH ;
}
return $home_path ;
}
2008-10-01 21:03:26 -04:00
/**
* { @ internal Missing Short Description }}
*
* @ since unknown
*
* @ param unknown_type $file
* @ return unknown
*/
2007-05-27 20:04:33 -04:00
function get_real_file_to_edit ( $file ) {
if ( 'index.php' == $file || '.htaccess' == $file ) {
2008-05-29 13:29:32 -04:00
$real_file = get_home_path () . $file ;
2007-05-27 20:04:33 -04:00
} else {
2008-06-05 12:39:20 -04:00
$real_file = WP_CONTENT_DIR . $file ;
2007-05-27 20:04:33 -04:00
}
return $real_file ;
}
2008-10-01 21:03:26 -04:00
/**
2009-11-05 18:03:48 -05:00
* Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep .
* The depth of the recursiveness can be controlled by the $levels param .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* @ since 2.6 . 0
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* @ param string $folder Full path to folder
* @ param int $levels ( optional ) Levels of folders to follow , Default : 100 ( PHP Loop limit ) .
* @ return bool | array False on failure , Else array of files
2008-10-01 21:03:26 -04:00
*/
2008-06-16 14:35:48 -04:00
function list_files ( $folder = '' , $levels = 100 ) {
2010-01-18 15:34:48 -05:00
if ( empty ( $folder ) )
2008-06-16 14:35:48 -04:00
return false ;
2010-01-18 15:34:48 -05:00
if ( ! $levels )
2008-06-16 14:35:48 -04:00
return false ;
$files = array ();
if ( $dir = @ opendir ( $folder ) ) {
while (( $file = readdir ( $dir ) ) !== false ) {
if ( in_array ( $file , array ( '.' , '..' ) ) )
continue ;
if ( is_dir ( $folder . '/' . $file ) ) {
$files2 = list_files ( $folder . '/' . $file , $levels - 1 );
2010-01-18 15:34:48 -05:00
if ( $files2 )
2008-06-16 14:35:48 -04:00
$files = array_merge ( $files , $files2 );
else
$files [] = $folder . '/' . $file . '/' ;
} else {
$files [] = $folder . '/' . $file ;
}
}
}
@ closedir ( $dir );
return $files ;
}
2007-05-27 20:04:33 -04:00
2008-10-01 21:03:26 -04:00
/**
2009-11-05 18:03:48 -05:00
* Determines a writable directory for temporary files .
* Function ' s preference is to WP_CONTENT_DIR followed by the return value of < code > sys_get_temp_dir () </ code > , before finally defaulting to / tmp /
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* In the event that this function does not find a writable location , It may be overridden by the < code > WP_TEMP_DIR </ code > constant in your < code > wp - config . php </ code > file .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* @ since 2.5 . 0
*
* @ return string Writable temporary directory
2008-10-01 21:03:26 -04:00
*/
2008-02-26 19:47:15 -05:00
function get_temp_dir () {
if ( defined ( 'WP_TEMP_DIR' ) )
return trailingslashit ( WP_TEMP_DIR );
2008-05-27 13:55:24 -04:00
$temp = WP_CONTENT_DIR . '/' ;
2008-02-26 19:47:15 -05:00
if ( is_dir ( $temp ) && is_writable ( $temp ) )
return $temp ;
if ( function_exists ( 'sys_get_temp_dir' ) )
return trailingslashit ( sys_get_temp_dir ());
2010-01-15 17:11:12 -05:00
2009-12-23 11:22:26 -05:00
$temp = ini_get ( 'upload_tmp_dir' );
if ( is_dir ( $temp ) ) // always writable
return trailingslashit ( $temp );
2008-02-26 19:47:15 -05:00
return '/tmp/' ;
}
2008-10-01 21:03:26 -04:00
/**
2009-11-05 18:03:48 -05:00
* Returns a filename of a Temporary unique file .
* Please note that the calling function must unlink () this itself .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* The filename is based off the passed parameter or defaults to the current unix timestamp ,
* while the directory can either be passed as well , or by leaving it blank , default to a writable temporary directory .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* @ since 2.6 . 0
*
* @ param string $filename ( optional ) Filename to base the Unique file off
* @ param string $dir ( optional ) Directory to store the file in
* @ return string a writable filename
2008-10-01 21:03:26 -04:00
*/
2008-04-25 17:34:54 -04:00
function wp_tempnam ( $filename = '' , $dir = '' ){
if ( empty ( $dir ) )
$dir = get_temp_dir ();
$filename = basename ( $filename );
if ( empty ( $filename ) )
$filename = time ();
2009-07-14 04:12:18 -04:00
$filename = preg_replace ( '|\..*$|' , '.tmp' , $filename );
2008-04-25 17:34:54 -04:00
$filename = $dir . wp_unique_filename ( $dir , $filename );
touch ( $filename );
return $filename ;
}
2008-10-01 21:03:26 -04:00
/**
* { @ internal Missing Short Description }}
*
* @ since unknown
*
* @ param unknown_type $file
* @ param unknown_type $allowed_files
* @ return unknown
*/
2007-05-27 20:04:33 -04:00
function validate_file_to_edit ( $file , $allowed_files = '' ) {
$code = validate_file ( $file , $allowed_files );
if ( ! $code )
return $file ;
switch ( $code ) {
case 1 :
2009-05-05 00:28:05 -04:00
wp_die ( __ ( 'Sorry, can’t edit files with “..” in the name. If you are trying to edit a file in your WordPress home directory, you can just type the name of the file in.' ));
2007-05-27 20:04:33 -04:00
2009-12-01 17:03:13 -05:00
//case 2 :
// wp_die( __('Sorry, can’t call files with their real path.' ));
2007-05-27 20:04:33 -04:00
case 3 :
wp_die ( __ ( 'Sorry, that file cannot be edited.' ));
}
}
2008-10-01 21:03:26 -04:00
/**
* { @ internal Missing Short Description }}
*
* @ since unknown
*
* @ param array $file Reference to a single element of $_FILES . Call the function once for each uploaded file .
* @ param array $overrides Optional . An associative array of names => values to override default variables with extract ( $overrides , EXTR_OVERWRITE ) .
* @ return array On success , returns an associative array of file attributes . On failure , returns $overrides [ 'upload_error_handler' ]( & $file , $message ) or array ( 'error' => $message ) .
*/
2008-11-13 13:22:00 -05:00
function wp_handle_upload ( & $file , $overrides = false , $time = null ) {
2007-05-27 20:04:33 -04:00
// The default error handler.
2010-02-22 11:54:51 -05:00
if ( ! function_exists ( 'wp_handle_upload_error' ) ) {
2007-05-27 20:04:33 -04:00
function wp_handle_upload_error ( & $file , $message ) {
return array ( 'error' => $message );
}
}
2009-11-05 09:24:20 -05:00
$file = apply_filters ( 'wp_handle_upload_prefilter' , $file );
2007-05-27 20:04:33 -04:00
// You may define your own function and pass the name in $overrides['upload_error_handler']
$upload_error_handler = 'wp_handle_upload_error' ;
2009-11-05 09:24:20 -05:00
// You may have had one or more 'wp_handle_upload_prefilter' functions error out the file. Handle that gracefully.
2009-12-26 03:47:47 -05:00
if ( isset ( $file [ 'error' ] ) && ! is_numeric ( $file [ 'error' ] ) && $file [ 'error' ] )
2009-11-05 09:24:20 -05:00
return $upload_error_handler ( $file , $file [ 'error' ] );
2008-11-14 18:01:16 -05:00
// You may define your own function and pass the name in $overrides['unique_filename_callback']
$unique_filename_callback = null ;
2007-05-27 20:04:33 -04:00
// $_POST['action'] must be set and its value must equal $overrides['action'] or this:
$action = 'wp_handle_upload' ;
// Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error'].
$upload_error_strings = array ( false ,
__ ( " The uploaded file exceeds the <code>upload_max_filesize</code> directive in <code>php.ini</code>. " ),
__ ( " The uploaded file exceeds the <em>MAX_FILE_SIZE</em> directive that was specified in the HTML form. " ),
__ ( " The uploaded file was only partially uploaded. " ),
__ ( " No file was uploaded. " ),
2008-11-27 16:19:12 -05:00
'' ,
2007-05-27 20:04:33 -04:00
__ ( " Missing a temporary folder. " ),
2009-05-12 13:02:34 -04:00
__ ( " Failed to write file to disk. " ),
__ ( " File upload stopped by extension. " ));
2007-05-27 20:04:33 -04:00
// All tests are on by default. Most can be turned off by $override[{test_name}] = false;
$test_form = true ;
$test_size = true ;
2010-02-22 11:54:51 -05:00
$test_upload = true ;
2007-05-27 20:04:33 -04:00
// If you override this, you must provide $ext and $type!!!!
$test_type = true ;
2008-01-04 14:36:34 -05:00
$mimes = false ;
2007-05-27 20:04:33 -04:00
// Install user overrides. Did we mention that this voids your warranty?
if ( is_array ( $overrides ) )
extract ( $overrides , EXTR_OVERWRITE );
// A correct form post will pass this test.
if ( $test_form && ( ! isset ( $_POST [ 'action' ] ) || ( $_POST [ 'action' ] != $action ) ) )
2010-02-22 11:54:51 -05:00
return call_user_func ( $upload_error_handler , $file , __ ( 'Invalid form submission.' ));
2007-05-27 20:04:33 -04:00
// A successful upload will pass this test. It makes no sense to override this one.
if ( $file [ 'error' ] > 0 )
2010-02-22 11:54:51 -05:00
return call_user_func ( $upload_error_handler , $file , $upload_error_strings [ $file [ 'error' ]] );
2007-05-27 20:04:33 -04:00
// A non-empty file will pass this test.
2010-02-22 11:54:51 -05:00
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 );
}
2007-05-27 20:04:33 -04:00
// A properly uploaded file will pass this test. There should be no reason to override this one.
2010-02-22 11:54:51 -05:00
if ( $test_upload && ! @ is_uploaded_file ( $file [ 'tmp_name' ] ) )
return call_user_func ( $upload_error_handler , $file , __ ( 'Specified file failed upload test.' ));
2007-05-27 20:04:33 -04:00
// 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 );
extract ( $wp_filetype );
if ( ( ! $type || ! $ext ) && ! current_user_can ( 'unfiltered_upload' ) )
2010-02-22 11:54:51 -05:00
return call_user_func ( $upload_error_handler , $file , __ ( 'File type does not meet security guidelines. Try another.' ));
2007-06-13 22:25:30 -04:00
2007-05-27 20:04:33 -04:00
if ( ! $ext )
2007-09-14 17:13:23 -04:00
$ext = ltrim ( strrchr ( $file [ 'name' ], '.' ), '.' );
2008-03-06 14:48:54 -05:00
if ( ! $type )
$type = $file [ 'type' ];
2009-05-07 02:50:54 -04:00
} else {
$type = '' ;
2007-05-27 20:04:33 -04:00
}
// A writable uploads dir will pass this test. Again, there's no point overriding this one.
2008-11-13 13:22:00 -05:00
if ( ! ( ( $uploads = wp_upload_dir ( $time ) ) && false === $uploads [ 'error' ] ) )
2010-02-22 11:54:51 -05:00
return call_user_func ( $upload_error_handler , $file , $uploads [ 'error' ] );
2007-05-27 20:04:33 -04:00
2007-12-17 22:32:43 -05:00
$filename = wp_unique_filename ( $uploads [ 'path' ], $file [ 'name' ], $unique_filename_callback );
2007-05-27 20:04:33 -04:00
// Move the file to the uploads dir
$new_file = $uploads [ 'path' ] . " / $filename " ;
2010-02-22 11:54:51 -05:00
if ( false === @ move_uploaded_file ( $file [ 'tmp_name' ], $new_file ) )
2008-04-14 12:01:59 -04:00
return $upload_error_handler ( $file , sprintf ( __ ( 'The uploaded file could not be moved to %s.' ), $uploads [ 'path' ] ) );
2007-05-27 20:04:33 -04:00
// Set correct file permissions
$stat = stat ( dirname ( $new_file ));
$perms = $stat [ 'mode' ] & 0000666 ;
@ chmod ( $new_file , $perms );
// Compute the URL
$url = $uploads [ 'url' ] . " / $filename " ;
2010-02-04 13:57:32 -05:00
if ( is_multisite () )
delete_transient ( 'dirsize_cache' );
2009-05-07 02:50:54 -04:00
return apply_filters ( 'wp_handle_upload' , array ( 'file' => $new_file , 'url' => $url , 'type' => $type ) );
2007-05-27 20:04:33 -04:00
}
2008-10-01 21:03:26 -04:00
/**
* { @ internal Missing Short Description }}
*
* Pass this function an array similar to that of a $_FILES POST array .
*
* @ since unknown
*
* @ param unknown_type $file
* @ param unknown_type $overrides
* @ return unknown
*/
2008-06-04 12:13:55 -04:00
function wp_handle_sideload ( & $file , $overrides = false ) {
// The default error handler.
if ( ! function_exists ( 'wp_handle_upload_error' ) ) {
function wp_handle_upload_error ( & $file , $message ) {
return array ( 'error' => $message );
}
}
// You may define your own function and pass the name in $overrides['upload_error_handler']
$upload_error_handler = 'wp_handle_upload_error' ;
2008-11-15 13:10:35 -05:00
// You may define your own function and pass the name in $overrides['unique_filename_callback']
$unique_filename_callback = null ;
2008-06-04 12:13:55 -04:00
// $_POST['action'] must be set and its value must equal $overrides['action'] or this:
$action = 'wp_handle_sideload' ;
// Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error'].
$upload_error_strings = array ( false ,
2009-05-12 13:02:34 -04:00
__ ( " The uploaded file exceeds the <code>upload_max_filesize</code> directive in <code>php.ini</code>. " ),
__ ( " The uploaded file exceeds the <em>MAX_FILE_SIZE</em> directive that was specified in the HTML form. " ),
__ ( " The uploaded file was only partially uploaded. " ),
__ ( " No file was uploaded. " ),
'' ,
2008-06-04 12:13:55 -04:00
__ ( " Missing a temporary folder. " ),
2009-05-12 13:02:34 -04:00
__ ( " Failed to write file to disk. " ),
__ ( " File upload stopped by extension. " ));
2008-06-04 12:13:55 -04:00
// All tests are on by default. Most can be turned off by $override[{test_name}] = false;
$test_form = true ;
$test_size = true ;
// If you override this, you must provide $ext and $type!!!!
$test_type = true ;
$mimes = false ;
// Install user overrides. Did we mention that this voids your warranty?
if ( is_array ( $overrides ) )
extract ( $overrides , EXTR_OVERWRITE );
// 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.' ));
// 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' ]] );
// A non-empty file will pass this test.
if ( $test_size && ! ( filesize ( $file [ 'tmp_name' ]) > 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.' ));
// A properly uploaded file will pass this test. There should be no reason to override this one.
if ( ! @ is_file ( $file [ 'tmp_name' ] ) )
return $upload_error_handler ( $file , __ ( 'Specified file does not exist.' ));
// 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 );
extract ( $wp_filetype );
if ( ( ! $type || ! $ext ) && ! current_user_can ( 'unfiltered_upload' ) )
return $upload_error_handler ( $file , __ ( 'File type does not meet security guidelines. Try another.' ));
if ( ! $ext )
$ext = ltrim ( strrchr ( $file [ 'name' ], '.' ), '.' );
if ( ! $type )
$type = $file [ 'type' ];
}
// A writable uploads dir will pass this test. Again, there's no point overriding this one.
if ( ! ( ( $uploads = wp_upload_dir () ) && false === $uploads [ 'error' ] ) )
return $upload_error_handler ( $file , $uploads [ 'error' ] );
$filename = wp_unique_filename ( $uploads [ 'path' ], $file [ 'name' ], $unique_filename_callback );
2008-08-09 01:36:14 -04:00
2008-06-25 12:45:04 -04:00
// Strip the query strings.
$filename = str_replace ( '?' , '-' , $filename );
$filename = str_replace ( '&' , '-' , $filename );
2008-08-09 01:36:14 -04:00
2008-06-04 12:13:55 -04:00
// 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' ] ) );
}
// Set correct file permissions
$stat = stat ( dirname ( $new_file ));
$perms = $stat [ 'mode' ] & 0000666 ;
@ chmod ( $new_file , $perms );
// Compute the URL
$url = $uploads [ 'url' ] . " / $filename " ;
$return = apply_filters ( 'wp_handle_upload' , array ( 'file' => $new_file , 'url' => $url , 'type' => $type ) );
return $return ;
}
2007-05-27 20:04:33 -04:00
2008-02-11 00:45:54 -05:00
/**
2009-11-05 18:03:48 -05:00
* Downloads a url to a local temporary file using the WordPress HTTP Class .
* Please note , That the calling function must unlink () the file .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* @ since 2.5 . 0
2008-10-01 21:03:26 -04:00
*
* @ param string $url the URL of the file to download
* @ return mixed WP_Error on failure , string Filename on success .
*/
2008-02-11 00:45:54 -05:00
function download_url ( $url ) {
//WARNING: The file is not automatically deleted, The script must unlink() the file.
2008-10-15 12:35:35 -04:00
if ( ! $url )
2010-01-21 16:37:43 -05:00
return new WP_Error ( 'http_no_url' , __ ( 'Invalid URL Provided.' ));
2008-02-11 00:45:54 -05:00
2008-04-25 17:34:54 -04:00
$tmpfname = wp_tempnam ( $url );
2008-10-15 12:35:35 -04:00
if ( ! $tmpfname )
2010-01-21 16:37:43 -05:00
return new WP_Error ( 'http_no_file' , __ ( 'Could not create Temporary file.' ));
2008-02-11 00:45:54 -05:00
2008-12-04 16:47:45 -05:00
$handle = @ fopen ( $tmpfname , 'wb' );
2008-10-15 12:35:35 -04:00
if ( ! $handle )
2010-01-21 16:37:43 -05:00
return new WP_Error ( 'http_no_file' , __ ( 'Could not create Temporary file.' ));
2008-02-11 00:45:54 -05:00
2009-12-22 11:42:30 -05:00
$response = wp_remote_get ( $url , array ( 'timeout' => 300 ));
2008-03-02 15:17:30 -05:00
2008-10-15 12:35:35 -04:00
if ( is_wp_error ( $response ) ) {
fclose ( $handle );
unlink ( $tmpfname );
return $response ;
}
if ( $response [ 'response' ][ 'code' ] != '200' ){
2008-03-27 03:36:30 -04:00
fclose ( $handle );
unlink ( $tmpfname );
2008-10-13 19:41:03 -04:00
return new WP_Error ( 'http_404' , trim ( $response [ 'response' ][ 'message' ]));
2008-03-27 03:36:30 -04:00
}
2008-10-14 12:37:08 -04:00
2008-10-13 19:41:03 -04:00
fwrite ( $handle , $response [ 'body' ]);
2008-02-11 00:45:54 -05:00
fclose ( $handle );
return $tmpfname ;
}
2008-10-01 21:03:26 -04:00
/**
2009-11-05 18:03:48 -05:00
* Unzip ' s 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 .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* Attempts to increase the PHP Memory limit to 256 M before uncompressing ,
* However , The most memory required shouldn ' t be much larger than the Archive itself .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* @ 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
2008-10-01 21:03:26 -04:00
*/
2008-02-11 00:45:54 -05:00
function unzip_file ( $file , $to ) {
global $wp_filesystem ;
if ( ! $wp_filesystem || ! is_object ( $wp_filesystem ) )
return new WP_Error ( 'fs_unavailable' , __ ( 'Could not access filesystem.' ));
2008-03-02 15:17:30 -05:00
2010-02-06 23:52:35 -05:00
// Unzip can use a lot of memory, but not this much hopefully
2008-11-11 14:11:48 -05:00
@ ini_set ( 'memory_limit' , '256M' );
2010-01-22 06:02:09 -05:00
$needed_dirs = array ();
2008-09-08 23:24:05 -04:00
$to = trailingslashit ( $to );
2010-01-22 06:02:09 -05:00
// 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 -- ) {
2008-09-13 14:06:20 -04:00
if ( empty ( $path [ $i ]) )
continue ;
2008-02-11 00:45:54 -05:00
2010-01-22 06:02:09 -05:00
$dir = implode ( '/' , array_slice ( $path , 0 , $i + 1 ) );
2010-02-06 23:52:35 -05:00
if ( preg_match ( '!^[a-z]:$!i' , $dir ) ) // Skip it if it looks like a Windows Drive letter.
2010-01-22 06:02:09 -05:00
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
2008-08-07 15:15:04 -04:00
}
2008-02-11 00:45:54 -05:00
}
2010-01-22 06:02:09 -05:00
2010-02-19 05:59:32 -05:00
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 );
2010-02-06 23:52:35 -05:00
}
2010-02-07 00:07:36 -05:00
/**
* 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
* @ 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
*/
2010-02-07 16:28:05 -05:00
function _unzip_file_ziparchive ( $file , $to , $needed_dirs = array () ) {
2010-02-06 23:52:35 -05:00
global $wp_filesystem ;
$z = new ZipArchive ();
2010-02-07 16:28:05 -05:00
// PHP4-compat - php4 classes can't contain constants
if ( true !== $z -> open ( $file , /* ZIPARCHIVE::CHECKCONS */ 4 ) )
2010-02-06 23:52:35 -05:00
return new WP_Error ( 'incompatible_archive' , __ ( 'Incompatible Archive.' ));
for ( $i = 0 ; $i < $z -> numFiles ; $i ++ ) {
if ( ! $info = $z -> statIndex ( $i ) )
2010-02-07 00:02:24 -05:00
return new WP_Error ( 'stat_failed' , __ ( 'Could not retrieve file from archive.' ));
2010-02-06 23:52:35 -05:00
if ( '/' == substr ( $info [ 'name' ], - 1 ) ) // directory
$needed_dirs [] = $to . untrailingslashit ( $info [ 'name' ]);
else
$needed_dirs [] = $to . untrailingslashit ( dirname ( $info [ 'name' ]));
}
2010-02-08 13:02:23 -05:00
2010-02-06 23:52:35 -05:00
$needed_dirs = array_unique ( $needed_dirs );
asort ( $needed_dirs );
2010-02-08 13:02:23 -05:00
2010-02-06 23:52:35 -05:00
// 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' , __ ( 'Could not create directory.' ), $_dir );
}
unset ( $needed_dirs );
2010-02-08 13:02:23 -05:00
2010-02-06 23:52:35 -05:00
for ( $i = 0 ; $i < $z -> numFiles ; $i ++ ) {
if ( ! $info = $z -> statIndex ( $i ) )
2010-02-07 00:02:24 -05:00
return new WP_Error ( 'stat_failed' , __ ( 'Could not retrieve file from archive.' ));
2010-02-06 23:52:35 -05:00
if ( '/' == substr ( $info [ 'name' ], - 1 ) ) // directory
continue ;
2010-02-07 00:02:24 -05:00
$contents = $z -> getFromIndex ( $i );
if ( false === $contents )
return new WP_Error ( 'extract_failed' , __ ( 'Could not extract file from archive.' ), $info [ 'name' ]);
if ( ! $wp_filesystem -> put_contents ( $to . $info [ 'name' ], $contents , FS_CHMOD_FILE ) )
2010-02-06 23:52:35 -05:00
return new WP_Error ( 'copy_failed' , __ ( 'Could not copy file.' ), $to . $file [ 'filename' ]);
}
2010-02-19 05:59:32 -05:00
$z -> close ();
2010-02-06 23:52:35 -05:00
return true ;
}
2010-02-07 00:07:36 -05:00
/**
* 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
* @ 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
*/
2010-02-06 23:52:35 -05:00
function _unzip_file_pclzip ( $file , $to , $needed_dirs = array ()) {
global $wp_filesystem ;
require_once ( ABSPATH . 'wp-admin/includes/class-pclzip.php' );
$archive = new PclZip ( $file );
// 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 ( 0 == count ( $archive_files ) )
return new WP_Error ( 'empty_archive' , __ ( 'Empty archive.' ));
2010-01-22 06:02:09 -05:00
// Determine any children directories needed (From within the archive)
foreach ( $archive_files as $file )
$needed_dirs [] = $to . untrailingslashit ( $file [ 'folder' ] ? $file [ 'filename' ] : dirname ( $file [ 'filename' ]) );
$needed_dirs = array_unique ( $needed_dirs );
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' , __ ( 'Could not create directory.' ), $_dir );
}
2010-02-06 23:52:35 -05:00
unset ( $needed_dirs );
2010-01-22 06:02:09 -05:00
// Extract the files from the zip
foreach ( $archive_files as $file ) {
if ( $file [ 'folder' ] )
continue ;
if ( ! $wp_filesystem -> put_contents ( $to . $file [ 'filename' ], $file [ 'content' ], FS_CHMOD_FILE ) )
return new WP_Error ( 'copy_failed' , __ ( 'Could not copy file.' ), $to . $file [ 'filename' ]);
}
2008-03-01 16:20:23 -05:00
return true ;
2008-02-11 00:45:54 -05:00
}
2008-10-01 21:03:26 -04:00
/**
2009-11-05 18:03:48 -05:00
* Copies a directory from one location to another via the WordPress Filesystem Abstraction .
* Assumes that WP_Filesystem () has already been called and setup .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* @ since 2.5 . 0
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* @ param string $from source directory
* @ param string $to destination directory
* @ return mixed WP_Error on failure , True on success .
2008-10-01 21:03:26 -04:00
*/
2008-02-11 00:45:54 -05:00
function copy_dir ( $from , $to ) {
global $wp_filesystem ;
$dirlist = $wp_filesystem -> dirlist ( $from );
$from = trailingslashit ( $from );
$to = trailingslashit ( $to );
foreach ( ( array ) $dirlist as $filename => $fileinfo ) {
2008-03-01 16:20:23 -05:00
if ( 'f' == $fileinfo [ 'type' ] ) {
2008-11-03 12:16:41 -05:00
if ( ! $wp_filesystem -> copy ( $from . $filename , $to . $filename , true ) ) {
// 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 ) )
2010-01-21 16:37:43 -05:00
return new WP_Error ( 'copy_failed' , __ ( 'Could not copy file.' ), $to . $filename );
2008-11-03 12:16:41 -05:00
}
2008-12-04 16:58:46 -05:00
$wp_filesystem -> chmod ( $to . $filename , FS_CHMOD_FILE );
2008-03-01 16:20:23 -05:00
} elseif ( 'd' == $fileinfo [ 'type' ] ) {
2008-08-08 18:49:35 -04:00
if ( ! $wp_filesystem -> is_dir ( $to . $filename ) ) {
2008-12-04 16:58:46 -05:00
if ( ! $wp_filesystem -> mkdir ( $to . $filename , FS_CHMOD_DIR ) )
2010-01-21 16:37:43 -05:00
return new WP_Error ( 'mkdir_failed' , __ ( 'Could not create directory.' ), $to . $filename );
2008-08-08 18:49:35 -04:00
}
2008-05-29 13:29:32 -04:00
$result = copy_dir ( $from . $filename , $to . $filename );
if ( is_wp_error ( $result ) )
return $result ;
2008-02-11 00:45:54 -05:00
}
}
2009-11-05 18:03:48 -05:00
return true ;
2008-02-11 00:45:54 -05:00
}
2008-10-01 21:03:26 -04:00
/**
2009-11-05 18:03:48 -05:00
* Initialises and connects the WordPress Filesystem Abstraction classes .
* This function will include the chosen transport and attempt connecting .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* Plugins may add extra transports , And force WordPress to use them by returning the filename via the 'filesystem_method_file' filter .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* @ since 2.5 . 0
*
* @ 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
2008-10-01 21:03:26 -04:00
*/
2009-05-31 17:08:03 -04:00
function WP_Filesystem ( $args = false , $context = false ) {
2008-02-11 00:45:54 -05:00
global $wp_filesystem ;
2008-05-29 13:29:32 -04:00
require_once ( ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php' );
2009-05-31 17:08:03 -04:00
$method = get_filesystem_method ( $args , $context );
2008-05-05 13:06:29 -04:00
2008-02-11 00:45:54 -05:00
if ( ! $method )
return false ;
2009-05-30 13:14:07 -04:00
if ( ! class_exists ( " WP_Filesystem_ $method " ) ) {
$abstraction_file = apply_filters ( 'filesystem_method_file' , ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php' , $method );
2010-01-18 15:34:48 -05:00
if ( ! file_exists ( $abstraction_file ) )
2009-05-30 13:14:07 -04:00
return ;
2009-09-14 10:03:32 -04:00
2009-05-30 13:14:07 -04:00
require_once ( $abstraction_file );
}
2008-02-11 00:45:54 -05:00
$method = " WP_Filesystem_ $method " ;
$wp_filesystem = new $method ( $args );
2009-08-15 08:01:04 -04:00
//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 );
2009-04-19 15:36:28 -04:00
if ( is_wp_error ( $wp_filesystem -> errors ) && $wp_filesystem -> errors -> get_error_code () )
2008-02-11 00:45:54 -05:00
return false ;
if ( ! $wp_filesystem -> connect () )
return false ; //There was an erorr connecting to the server.
2008-12-04 16:58:46 -05:00
// Set the permission constants if not already set.
if ( ! defined ( 'FS_CHMOD_DIR' ) )
define ( 'FS_CHMOD_DIR' , 0755 );
if ( ! defined ( 'FS_CHMOD_FILE' ) )
define ( 'FS_CHMOD_FILE' , 0644 );
2008-02-11 00:45:54 -05:00
return true ;
}
2008-10-01 21:03:26 -04:00
/**
2009-11-05 18:03:48 -05:00
* Determines which Filesystem Method to use .
* The priority of the Transports are : Direct , SSH2 , FTP PHP Extension , FTP Sockets ( Via Sockets class , or fsoxkopen ())
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* Note that the return value of this function can be overridden in 2 ways
* - By defining FS_METHOD in your < code > wp - config . php </ code > 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 .
*
* @ since 2.5 . 0
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* @ param array $args Connection details .
2009-05-31 17:08:03 -04:00
* @ param string $context Full path to the directory that is tested for being writable .
2009-11-05 18:03:48 -05:00
* @ return string The transport to use , see description for valid return values .
2008-10-01 21:03:26 -04:00
*/
2009-05-31 17:08:03 -04:00
function get_filesystem_method ( $args = array (), $context = false ) {
2009-05-25 06:39:21 -04:00
$method = defined ( 'FS_METHOD' ) ? FS_METHOD : false ; //Please ensure that this is either 'direct', 'ssh', 'ftpext' or 'ftpsockets'
2010-01-18 15:34:48 -05:00
if ( ! $method && function_exists ( 'getmyuid' ) && function_exists ( 'fileowner' ) ){
2009-05-31 17:08:03 -04:00
if ( ! $context )
$context = WP_CONTENT_DIR ;
$context = trailingslashit ( $context );
2009-08-15 04:03:48 -04:00
$temp_file_name = $context . 'temp-write-test-' . time ();
2009-05-25 06:39:21 -04:00
$temp_handle = @ fopen ( $temp_file_name , 'w' );
2009-05-26 20:56:32 -04:00
if ( $temp_handle ) {
2009-08-15 04:03:48 -04:00
if ( getmyuid () == @ fileowner ( $temp_file_name ) )
2009-05-26 20:56:32 -04:00
$method = 'direct' ;
@ fclose ( $temp_handle );
2009-08-15 04:03:48 -04:00
@ unlink ( $temp_file_name );
2009-05-26 20:56:32 -04:00
}
2009-05-25 06:39:21 -04:00
}
2008-02-11 00:45:54 -05:00
2009-06-23 17:54:53 -04:00
if ( ! $method && isset ( $args [ 'connection_type' ]) && 'ssh' == $args [ 'connection_type' ] && extension_loaded ( 'ssh2' ) && function_exists ( 'stream_get_contents' ) ) $method = 'ssh2' ;
2008-04-25 17:34:54 -04:00
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
2009-05-25 06:39:21 -04:00
return apply_filters ( 'filesystem_method' , $method , $args );
2008-02-11 00:45:54 -05:00
}
2008-10-01 21:03:26 -04:00
/**
2009-11-05 18:03:48 -05:00
* 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 .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* Hostnames may be in the form of hostname : portnumber ( eg : wordpress . org : 2467 ) to specify an alternate FTP / SSH port .
2008-10-01 21:03:26 -04:00
*
2009-11-05 18:03:48 -05:00
* Plugins may override this form by returning true | false via the < code > request_filesystem_credentials </ code > filter .
*
* @ since 2.5 . 0
*
* @ 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 ()
* @ return boolean False on failure . True on success .
2008-10-01 21:03:26 -04:00
*/
2009-05-31 17:08:03 -04:00
function request_filesystem_credentials ( $form_post , $type = '' , $error = false , $context = false ) {
$req_cred = apply_filters ( 'request_filesystem_credentials' , '' , $form_post , $type , $error , $context );
2008-08-04 17:01:09 -04:00
if ( '' !== $req_cred )
return $req_cred ;
if ( empty ( $type ) )
2009-05-31 17:08:03 -04:00
$type = get_filesystem_method ( array (), $context );
2008-08-04 17:01:09 -04:00
if ( 'direct' == $type )
return true ;
2008-08-09 01:36:14 -04:00
2009-04-22 19:38:01 -04:00
$credentials = get_option ( 'ftp_credentials' , array ( 'hostname' => '' , 'username' => '' ));
2008-08-04 17:01:09 -04:00
// 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)
2009-08-13 02:03:26 -04:00
$credentials [ 'hostname' ] = defined ( 'FTP_HOST' ) ? FTP_HOST : ( ! empty ( $_POST [ 'hostname' ]) ? stripslashes ( $_POST [ 'hostname' ]) : $credentials [ 'hostname' ]);
$credentials [ 'username' ] = defined ( 'FTP_USER' ) ? FTP_USER : ( ! empty ( $_POST [ 'username' ]) ? stripslashes ( $_POST [ 'username' ]) : $credentials [ 'username' ]);
$credentials [ 'password' ] = defined ( 'FTP_PASS' ) ? FTP_PASS : ( ! empty ( $_POST [ 'password' ]) ? stripslashes ( $_POST [ 'password' ]) : '' );
2008-12-09 13:03:31 -05:00
2008-09-11 13:44:43 -04:00
// Check to see if we are setting the public/private keys for ssh
2009-08-13 02:03:26 -04:00
$credentials [ 'public_key' ] = defined ( 'FTP_PUBKEY' ) ? FTP_PUBKEY : ( ! empty ( $_POST [ 'public_key' ]) ? stripslashes ( $_POST [ 'public_key' ]) : '' );
$credentials [ 'private_key' ] = defined ( 'FTP_PRIKEY' ) ? FTP_PRIKEY : ( ! empty ( $_POST [ 'private_key' ]) ? stripslashes ( $_POST [ 'private_key' ]) : '' );
2008-12-09 13:03:31 -05:00
2008-12-12 15:12:16 -05:00
//sanitize the hostname, Some people might pass in odd-data:
$credentials [ 'hostname' ] = preg_replace ( '|\w+://|' , '' , $credentials [ 'hostname' ]); //Strip any schemes off
2009-11-05 18:03:48 -05:00
if ( strpos ( $credentials [ 'hostname' ], ':' ) ) {
2008-09-08 23:24:05 -04:00
list ( $credentials [ 'hostname' ], $credentials [ 'port' ] ) = explode ( ':' , $credentials [ 'hostname' ], 2 );
2009-11-05 18:03:48 -05:00
if ( ! is_numeric ( $credentials [ 'port' ]) )
unset ( $credentials [ 'port' ]);
} else {
2008-12-12 15:12:16 -05:00
unset ( $credentials [ 'port' ]);
2009-11-05 18:03:48 -05:00
}
2008-09-08 23:24:05 -04:00
2009-11-23 16:52:13 -05:00
if ( ( defined ( 'FTP_SSH' ) && FTP_SSH ) || ( defined ( 'FS_METHOD' ) && 'ssh' == FS_METHOD ) )
2008-09-05 01:35:58 -04:00
$credentials [ 'connection_type' ] = 'ssh' ;
2009-11-23 16:52:13 -05:00
else if ( ( defined ( 'FTP_SSL' ) && FTP_SSL ) && 'ftpext' == $type ) //Only the FTP Extension understands SSL
2008-09-05 01:35:58 -04:00
$credentials [ 'connection_type' ] = 'ftps' ;
2009-05-30 13:14:07 -04:00
else if ( ! empty ( $_POST [ 'connection_type' ]) )
2009-08-13 02:03:26 -04:00
$credentials [ 'connection_type' ] = stripslashes ( $_POST [ 'connection_type' ]);
2009-05-30 13:14:07 -04:00
else if ( ! isset ( $credentials [ 'connection_type' ]) ) //All else fails (And its not defaulted to something else saved), Default to FTP
2008-09-05 01:35:58 -04:00
$credentials [ 'connection_type' ] = 'ftp' ;
2008-08-04 17:01:09 -04:00
2009-05-24 19:47:49 -04:00
if ( ! $error &&
2009-04-22 19:38:01 -04:00
(
( ! empty ( $credentials [ 'password' ]) && ! empty ( $credentials [ 'username' ]) && ! empty ( $credentials [ 'hostname' ]) ) ||
( 'ssh' == $credentials [ 'connection_type' ] && ! empty ( $credentials [ 'public_key' ]) && ! empty ( $credentials [ 'private_key' ]) )
) ) {
2008-08-04 17:01:09 -04:00
$stored_credentials = $credentials ;
2008-12-12 15:12:16 -05:00
if ( ! empty ( $stored_credentials [ 'port' ]) ) //save port as part of hostname to simplify above code.
$stored_credentials [ 'hostname' ] .= ':' . $stored_credentials [ 'port' ];
unset ( $stored_credentials [ 'password' ], $stored_credentials [ 'port' ], $stored_credentials [ 'private_key' ], $stored_credentials [ 'public_key' ]);
2008-08-04 17:01:09 -04:00
update_option ( 'ftp_credentials' , $stored_credentials );
return $credentials ;
}
$hostname = '' ;
$username = '' ;
$password = '' ;
2008-09-08 23:24:05 -04:00
$connection_type = '' ;
2008-08-04 17:01:09 -04:00
if ( ! empty ( $credentials ) )
extract ( $credentials , EXTR_OVERWRITE );
2008-09-05 01:35:58 -04:00
if ( $error ) {
$error_string = __ ( '<strong>Error:</strong> 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 ();
echo '<div id="message" class="error"><p>' . $error_string . '</p></div>' ;
}
2009-11-05 18:03:48 -05:00
$types = array ();
if ( extension_loaded ( 'ftp' ) || extension_loaded ( 'sockets' ) || function_exists ( 'fsockopen' ) )
$types [ 'ftp' ] = __ ( 'FTP' );
if ( extension_loaded ( 'ftp' ) ) //Only this supports FTPS
$types [ 'ftps' ] = __ ( 'FTPS (SSL)' );
if ( extension_loaded ( 'ssh2' ) && function_exists ( 'stream_get_contents' ) )
$types [ 'ssh' ] = __ ( 'SSH2' );
$types = apply_filters ( 'fs_ftp_connection_types' , $types , $credentials , $type , $error , $context );
2008-08-04 17:01:09 -04:00
?>
2008-09-11 13:44:43 -04:00
< script type = " text/javascript " >
<!--
jQuery ( function ( $ ){
jQuery ( " #ssh " ) . click ( function () {
2008-09-13 14:06:20 -04:00
jQuery ( " #ssh_keys " ) . show ();
2008-09-11 13:44:43 -04:00
});
2008-09-13 14:06:20 -04:00
jQuery ( " #ftp, #ftps " ) . click ( function () {
jQuery ( " #ssh_keys " ) . hide ();
2008-12-09 13:03:31 -05:00
});
2009-03-17 22:43:45 -04:00
jQuery ( 'form input[value=""]:first' ) . focus ();
2008-09-11 13:44:43 -04:00
});
-->
</ script >
2008-08-04 17:01:09 -04:00
< form action = " <?php echo $form_post ?> " method = " post " >
< div class = " wrap " >
2009-03-30 12:26:48 -04:00
< ? php screen_icon (); ?>
2008-09-13 14:06:20 -04:00
< h2 >< ? php _e ( 'Connection Information' ) ?> </h2>
< p >< ? php _e ( 'To perform the requested action, connection information is required.' ) ?> </p>
2008-12-02 20:43:11 -05:00
2008-08-04 17:01:09 -04:00
< table class = " form-table " >
< tr valign = " top " >
2008-09-05 01:35:58 -04:00
< th scope = " row " >< label for = " hostname " >< ? php _e ( 'Hostname' ) ?> </label></th>
2010-01-18 15:34:48 -05:00
< td >< input name = " hostname " type = " text " id = " hostname " value = " <?php echo esc_attr( $hostname ); if ( !empty( $port ) ) echo " : $port " ; ?> " < ? php if ( defined ( 'FTP_HOST' ) ) echo ' disabled="disabled"' ?> size="40" /></td>
2008-08-04 17:01:09 -04:00
</ tr >
2008-12-02 20:43:11 -05:00
2008-08-04 17:01:09 -04:00
< tr valign = " top " >
2008-09-05 01:35:58 -04:00
< th scope = " row " >< label for = " username " >< ? php _e ( 'Username' ) ?> </label></th>
2010-01-18 15:34:48 -05:00
< td >< input name = " username " type = " text " id = " username " value = " <?php echo esc_attr( $username ) ?> " < ? php if ( defined ( 'FTP_USER' ) ) echo ' disabled="disabled"' ?> size="40" /></td>
2008-08-04 17:01:09 -04:00
</ tr >
2008-12-02 20:43:11 -05:00
2008-08-04 17:01:09 -04:00
< tr valign = " top " >
2008-09-05 01:35:58 -04:00
< th scope = " row " >< label for = " password " >< ? php _e ( 'Password' ) ?> </label></th>
2009-05-30 13:14:07 -04:00
< td >< input name = " password " type = " password " id = " password " value = " <?php if ( defined('FTP_PASS') ) echo '*****'; ?> " < ? php if ( defined ( 'FTP_PASS' ) ) echo ' disabled="disabled"' ?> size="40" /></td>
2008-08-04 17:01:09 -04:00
</ tr >
2008-12-02 20:43:11 -05:00
2009-11-05 18:03:48 -05:00
< ? php if ( isset ( $types [ 'ssh' ]) ) : ?>
2008-09-13 14:06:20 -04:00
< tr id = " ssh_keys " valign = " top " style = " <?php if ( 'ssh' != $connection_type ) echo 'display:none' ?> " >
2008-12-02 20:43:11 -05:00
< th scope = " row " >< ? php _e ( 'Authentication Keys' ) ?>
< div class = " key-labels textright " >
< label for = " public_key " >< ? php _e ( 'Public Key:' ) ?> </label ><br />
< label for = " private_key " >< ? php _e ( 'Private Key:' ) ?> </label>
</ div ></ th >
2010-01-18 15:34:48 -05:00
< td >< br />< input name = " public_key " type = " text " id = " public_key " value = " <?php echo esc_attr( $public_key ) ?> " < ? php if ( defined ( 'FTP_PUBKEY' ) ) echo ' disabled="disabled"' ?> size="40" /><br /><input name="private_key" type="text" id="private_key" value="<?php echo esc_attr($private_key) ?>"<?php if ( defined('FTP_PRIKEY') ) echo ' disabled="disabled"' ?> size="40" />
2008-12-02 20:43:11 -05:00
< div >< ? php _e ( 'Enter the location on the server where the keys are located. If a passphrase is needed, enter that in the password field above.' ) ?> </div></td>
2008-09-11 13:44:43 -04:00
</ tr >
2009-05-30 13:14:07 -04:00
< ? php endif ; ?>
2008-12-02 20:43:11 -05:00
2008-08-04 17:01:09 -04:00
< tr valign = " top " >
2008-09-05 01:35:58 -04:00
< th scope = " row " >< ? php _e ( 'Connection Type' ) ?> </th>
2008-08-04 17:01:09 -04:00
< td >
2009-05-12 18:40:56 -04:00
< fieldset >< legend class = " screen-reader-text " >< span >< ? php _e ( 'Connection Type' ) ?> </span></legend>
2009-11-05 18:03:48 -05:00
< ? php
2009-11-23 16:52:13 -05:00
$disabled = ( defined ( 'FTP_SSL' ) && FTP_SSL ) || ( defined ( 'FTP_SSH' ) && FTP_SSH ) ? ' disabled="disabled"' : '' ;
2009-11-05 18:03:48 -05:00
foreach ( $types as $name => $text ) : ?>
2009-11-06 05:53:41 -05:00
< label for = " <?php echo esc_attr( $name ) ?> " >
< input type = " radio " name = " connection_type " id = " <?php echo esc_attr( $name ) ?> " value = " <?php echo esc_attr( $name ) ?> " < ? php checked ( $name , $connection_type ); echo $disabled ; ?> />
2009-11-05 18:03:48 -05:00
< ? php echo $text ?>
</ label >
< ? php endforeach ; ?>
2008-09-05 01:35:58 -04:00
</ fieldset >
2008-08-04 17:01:09 -04:00
</ td >
</ tr >
</ table >
2008-12-02 20:43:11 -05:00
2008-11-01 02:56:38 -04:00
< ? php if ( isset ( $_POST [ 'version' ] ) ) : ?>
2009-08-13 02:03:26 -04:00
< input type = " hidden " name = " version " value = " <?php echo esc_attr(stripslashes( $_POST['version'] )) ?> " />
2008-11-01 02:56:38 -04:00
< ? php endif ; ?>
< ? php if ( isset ( $_POST [ 'locale' ] ) ) : ?>
2009-08-13 02:03:26 -04:00
< input type = " hidden " name = " locale " value = " <?php echo esc_attr(stripslashes( $_POST['locale'] )) ?> " />
2008-11-01 02:56:38 -04:00
< ? php endif ; ?>
2008-08-04 17:01:09 -04:00
< p class = " submit " >
2009-05-05 15:43:53 -04:00
< input id = " upgrade " name = " upgrade " type = " submit " class = " button " value = " <?php esc_attr_e('Proceed'); ?> " />
2008-08-04 17:01:09 -04:00
</ p >
</ div >
</ form >
< ? php
return false ;
}
?>