Merge pull request #3858 from wp-cli/3818-basename

Introduce `WP_CLI\Utils\basename()` for locale-independent basename()

Author: schlessera

php/WP_CLI/CommandWithUpgrade.php

@@ -3,6 +3,7 @@
 namespace WP_CLI;
 
 use WP_CLI;
+use WP_CLI\Utils;
 
 abstract class CommandWithUpgrade extends \WP_CLI_Command {
 
@@ -152,7 +153,7 @@ function install( $args, $assoc_args ) {
 						if ( $branch_length ) {
 							$new_path = substr( rtrim( $source, '/' ), 0, - ( $branch_length + 1 ) ) . '/';
 							if ( $GLOBALS['wp_filesystem']->move( $source, $new_path ) ) {
-								WP_CLI::log( "Renamed Github-based project from '" . basename( $source ) . "' to '" . basename( $new_path ) . "'." );
+								WP_CLI::log( "Renamed Github-based project from '" . Utils\basename( $source ) . "' to '" . Utils\basename( $new_path ) . "'." );
 								return $new_path;
 							} else {
 								return new \WP_Error( 'wpcli_install_gitub', "Couldn't move Github-based project to appropriate directory." );

php/WP_CLI/Extractor.php

@@ -46,7 +46,7 @@ private static function extract_zip( $zipfile, $dest ) {
 		if ( true === $res ) {
 			$tempdir = implode( DIRECTORY_SEPARATOR, Array (
 				dirname( $zipfile ),
-				basename( $zipfile, '.zip' ),
+				Utils\basename( $zipfile, '.zip' ),
 				$zip->getNameIndex( 0 )
 			) );
 
@@ -75,7 +75,7 @@ private static function extract_tarball( $tarball, $dest ) {
 		$phar = new PharData( $tarball );
 		$tempdir = implode( DIRECTORY_SEPARATOR, Array (
 			dirname( $tarball ),
-			basename( $tarball, '.tar.gz' ),
+			Utils\basename( $tarball, '.tar.gz' ),
 			$phar->getFileName()
 		) );
 

php/WP_CLI/Runner.php

@@ -833,10 +833,10 @@ public function start() {
 						if ( in_array( $path, $this->_required_files[ $scope ] ) ) {
 							switch ( $scope ) {
 								case 'global':
-									$context = ' (from global ' . basename( $this->global_config_path ) . ')';
+									$context = ' (from global ' . Utils\basename( $this->global_config_path ) . ')';
 									break;
 								case 'project':
-									$context = ' (from project\'s ' . basename( $this->project_config_path ) . ')';
+									$context = ' (from project\'s ' . Utils\basename( $this->project_config_path ) . ')';
 									break;
 								case 'runtime':
 									$context = ' (from runtime argument)';
@@ -845,7 +845,7 @@ public function start() {
 							break;
 						}
 					}
-					WP_CLI::error( sprintf( "Required file '%s' doesn't exist%s.", basename( $path ), $context ) );
+					WP_CLI::error( sprintf( "Required file '%s' doesn't exist%s.", Utils\basename( $path ), $context ) );
 				}
 				Utils\load_file( $path );
 				WP_CLI::debug( 'Required file from config: ' . $path, 'bootstrap' );

php/commands/media.php

@@ -216,7 +216,7 @@ function import( $args, $assoc_args = array() ) {
 
 			$file_array = array(
 				'tmp_name' => $tempfile,
-				'name' => basename( $file )
+				'name' => Utils\basename( $file )
 			);
 
 			$post_array= array(
@@ -243,7 +243,7 @@ function import( $args, $assoc_args = array() ) {
 			}
 
 			if ( empty( $post_array['post_title'] ) ) {
-				$post_array['post_title'] = preg_replace( '/\.[^.]+$/', '', basename( $file ) );
+				$post_array['post_title'] = preg_replace( '/\.[^.]+$/', '', Utils\basename( $file ) );
 			}
 
 			// Deletes the temporary file.
@@ -294,7 +294,7 @@ function import( $args, $assoc_args = array() ) {
 	// wp_tempnam() inexplicably forces a .tmp extension, which spoils MIME type detection
 	private function make_copy( $path ) {
 		$dir = get_temp_dir();
-		$filename = basename( $path );
+		$filename = Utils\basename( $path );
 		if ( empty( $filename ) )
 			$filename = time();
 

php/commands/plugin.php

@@ -961,7 +961,7 @@ protected function get_status( $file ) {
 	 */
 	private function get_details( $file ) {
 		$plugin_folder = get_plugins(  '/' . plugin_basename( dirname( $file ) ) );
-		$plugin_file = basename( $file );
+		$plugin_file = Utils\basename( $file );
 
 		return $plugin_folder[$plugin_file];
 	}

php/commands/scaffold.php

@@ -705,7 +705,7 @@ private function scaffold_plugin_theme_tests( $args, $assoc_args, $type ) {
 				WP_CLI::error( "Invalid {$type} directory specified." );
 			}
 			if ( empty( $slug ) ) {
-				$slug = basename( $target_dir );
+				$slug = Utils\basename( $target_dir );
 			}
 		}
 

php/utils.php

@@ -823,3 +823,16 @@ function parse_str_to_argv( $arguments ) {
 	}, $argv );
 	return $argv;
 }
+
+/**
+ * Locale-independent version of basename()
+ *
+ * @access public
+ *
+ * @param string $path
+ * @param string $suffix
+ * @return string
+ */
+function basename( $path, $suffix = '' ) {
+	return urldecode( \basename( str_replace( array( '%2F', '%5C' ), '/', urlencode( $path ) ), $suffix ) );
+}