EEH_File - Code Metrics - Inspection of "Daily Inspection: Merge branch 'BUG-9103-dont-add-..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — BUG-8729-batch-processing-csv-... (3a9229)

unknown

created 2015-11-30 21:40 UTC

EEH_File D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	625
Duplicated Lines	7.2 %

Coupling/Cohesion

Components	1
Dependencies	2

Metric	Value
wmc	98
lcom	1
cbo	2
dl	45
loc	625
rs	4.7712

27 Methods

Rating	Name	Duplication	Size	Complexity
C	_get_wp_filesystem()	0	71	15
A	display_request_filesystem_credentials_form()	0	5	2
C	verify_filepath_and_permissions()	0	28	7
B	_permissions_error_for_unreadable_filepath()	0	22	4
D	ensure_folder_exists_and_is_writable()	13	33	9
A	verify_is_writable()	0	14	4
C	ensure_file_exists_and_is_writable()	13	23	7
A	get_parent_folder()	0	7	1
A	ensure_folder_exists_recursively()	0	3	1
A	get_file_contents()	0	9	2
C	write_to_file()	0	25	8
A	delete()	0	4	2
A	exists()	0	4	2
A	is_readable()	0	8	2
A	remove_filename_from_filepath()	0	3	1
A	get_filename_from_filepath()	0	3	1
A	get_file_extension()	0	3	1
A	add_htaccess_deny_from_all()	10	10	3
A	add_index_file()	9	9	3
A	get_classname_from_filepath_with_standard_filename()	0	7	1
A	standardise_directory_separators()	0	3	1
A	end_with_directory_separator()	0	3	1
A	standardise_and_end_with_directory_separator()	0	3	1
B	get_contents_of_folders()	0	23	6
D	copy()	0	38	10
A	is_in_uploads_folder()	0	4	2
A	convert_local_filepath_to_remote_filepath()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like EEH_File often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use EEH_File, and based on these observations, apply Extract Interface, too.

<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
/**
 * Event Espresso
 *
 * Event Registration and Management Plugin for WordPress
 *
 * @ package			Event Espresso
 * @ author			Seth Shoultes
 * @ copyright		(c) 2008-2011 Event Espresso  All Rights Reserved.
 * @ license			http://eventespresso.com/support/terms-conditions/   * see Plugin Licensing *
 * @ link					http://www.eventespresso.com
 * @ version		 	4.0
 *
 */
require_once( EE_HELPERS . 'EEH_Base.helper.php' );
require_once( EE_INTERFACES . 'EEI_Interfaces.php' );
/**
 *
 * Class EEH_File
 *
 * Description
 *
 * @package 			Event Espresso
 * @subpackage 	core
 * @author 				Brent Christensen
 * @since 				$VID:$
 *
 */
class EEH_File extends EEH_Base implements EEHI_File {

	/**
	 * @var string $_credentials_form
	 */
	private static $_credentials_form;
	
	protected static $_wp_filesystem_direct;
	
	/**
	 * @param string|null $filepath the filepath we want to work in. If its in the 
	 * wp uploads directory, we'll want to just use the filesystem directly.
	 * If not provided, we have to assume its not in the uploads directory
	 * @throws EE_Error
	 * @return WP_Filesystem_Base
	 */
	private static function _get_wp_filesystem( $filepath = null) {
		if( apply_filters( 
				'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct', 
				$filepath && EEH_File::is_in_uploads_folder( $filepath ), 
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
				$filepath ) ) {
			if( ! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct ) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
				require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
				$method = 'direct';
				$wp_filesystem_direct_file = apply_filters( 'filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method );
				//check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem()
				if ( ! defined('FS_CHMOD_DIR') ) {
					define('FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
				}
				if ( ! defined('FS_CHMOD_FILE') ) {
					define('FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
				}
				require_once( $wp_filesystem_direct_file );
				EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct( array() );
			}
			return EEH_File::$_wp_filesystem_direct;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
		}
		global $wp_filesystem;
		// no filesystem setup ???
		if ( ! $wp_filesystem instanceof WP_Filesystem_Base ) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			// if some eager beaver's just trying to get in there too early...
			// let them do it, because we are one of those eager beavers! :P
			/**
			 * more explanations are probably merited. http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base
			 * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process
			 * is setup to mostly happen on 'init', and refactoring to have it happen on
			 * 'wp_loaded' is too much work on a BETA milestone.
			 * So this fix is expected to work if the WP files are owned by the server user,
			 * but probably not if the user needs to enter their FTP credentials to modify files
			 * and there may be troubles if the WP files are owned by a different user
			 * than the server user. But both of these issues should exist in 4.4 and earlier too
			 */
			if ( FALSE && ! did_action( 'wp_loaded' )) {
				$msg = __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso');
				if ( WP_DEBUG ) {
					$msg .= '<br />' .  __('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
				}
				throw new EE_Error( $msg );
			} else {
				// should be loaded if we are past the wp_loaded hook...
				if ( ! function_exists( 'WP_Filesystem' )) {
					require_once( ABSPATH . 'wp-admin/includes/file.php' );
					require_once( ABSPATH . 'wp-admin/includes/template.php' );
				}
				// turn on output buffering so that we can capture the credentials form
				ob_start();
				$credentials = request_filesystem_credentials( '' );
				// store credentials form for the time being
				EEH_File::$_credentials_form = ob_get_clean();
				// basically check for direct or previously configured access
				if ( ! WP_Filesystem( $credentials ) ) {
					// if credentials do NOT exist
					if ( $credentials === FALSE ) {
						add_action( 'admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999 );
						throw new EE_Error( __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
					} elseif( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->get_error_code() ) {
						add_action( 'admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999 );
						throw new EE_Error(
								sprintf(
										__( 'WP Filesystem Error: $1%s', 'event_espresso' ),
										$wp_filesystem->errors->get_error_message() ) );
					}
				}
			}
		}
		return $wp_filesystem;
	}

	/**
	 * display_request_filesystem_credentials_form
	 */
	public static function display_request_filesystem_credentials_form() {
		if ( ! empty( EEH_File::$_credentials_form )) {
			echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
		}
	}



	/**
	 *    verify_filepath_and_permissions
	 *    checks that a file is readable and has sufficient file permissions set to access
	 *
	 * @access public
	 * @param string $full_file_path - full server path to the folder or file
	 * @param string $file_name      - name of file if checking a file
	 * @param string $file_ext       - file extension (ie: "php") if checking a file
	 * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
	 * @throws EE_Error
	 * @return bool
	 */
	public static function verify_filepath_and_permissions( $full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '' ) {
		// load WP_Filesystem and set file permissions
		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
		if ( ! $wp_filesystem->is_readable( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) )) {
			$file_name = ! empty( $type_of_file ) ? $file_name . ' ' . $type_of_file : $file_name;
			$file_name .= ! empty( $file_ext ) ? ' file' : ' folder';
			$msg = sprintf(
				__( 'The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso' ),
				$file_name,
				'<br />'
			);
			if ( EEH_File::exists( $full_file_path )) {
				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path, $type_of_file );
			} else {
				// no file permissions means the file was not found
				$msg .= sprintf(
					__( 'Please ensure the following path is correct: "%s".', 'event_espresso' ),
					$full_file_path
				);
			}
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
				throw new EE_Error( $msg . '||' . $msg );
			}
			return FALSE;
		}
		return TRUE;
	}



	/**
	 * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a file or folder
	 *
	 * @access private
	 * @param string $full_file_path - full server path to the folder or file
	 * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages
	 * @return string
	 */
	private static function _permissions_error_for_unreadable_filepath( $full_file_path = '', $type_of_file = '' ){
		// load WP_Filesystem and set file permissions
		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
		// check file permissions
		$perms = $wp_filesystem->getchmod( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) );
		if ( $perms ) {
			// file permissions exist, but way be set incorrectly
			$type_of_file = ! empty( $type_of_file ) ? $type_of_file . ' ' : '';
			$type_of_file .= ! empty( $type_of_file ) ? 'file' : 'folder';
			return sprintf(
				__( 'File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso' ),
				$type_of_file,
				$perms
			);
		} else {
			// file exists but file permissions could not be read ?!?!
			return sprintf(
				__( 'Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso' ),
				$full_file_path
			);
		}
	}



	/**
	 * ensure_folder_exists_and_is_writable
	 * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
	 * Also ensures all the parent folders exist, and if not tries to create them.
	 * Also, if this function creates the folder, adds a .htaccess file and index.html file
	 * @param string $folder
	 * @throws EE_Error if the folder exists and is writeable, but for some reason we 
	 * can't write to it
	 * @return bool false if folder isn't writable; true if it exists and is writeable,
	 */
	public static function ensure_folder_exists_and_is_writable( $folder = '' ){
		if ( empty( $folder )) {
			return false;
		}
		// remove ending DS
		$folder = EEH_File::standardise_directory_separators( rtrim( $folder, '/\\' ));
		$parent_folder = EEH_File::get_parent_folder( $folder );
		// add DS to folder
		$folder = EEH_File::end_with_directory_separator( $folder );
		$wp_filesystem = EEH_File::_get_wp_filesystem( $folder );
		if ( ! $wp_filesystem->is_dir( EEH_File::convert_local_filepath_to_remote_filepath( $folder ) ) ) {
			//ok so it doesn't exist. Does its parent? Can we write to it?
			if(	! EEH_File::ensure_folder_exists_and_is_writable( $parent_folder ) ) {
				return false;
			}
			if ( ! EEH_File::verify_is_writable( $parent_folder, 'folder' )) {

				return false;
			} else {
				if ( ! $wp_filesystem->mkdir( EEH_File::convert_local_filepath_to_remote_filepath(  $folder ) ) ) {
					if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
						$msg = sprintf( __( '"%s" could not be created.', 'event_espresso' ), $folder );
						$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $folder );
						throw new EE_Error( $msg );
					}
					return false;
				}
				EEH_File::add_index_file( $folder );
			}
		} elseif ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
			return false;
		}
		return true;
	}



	/**
	 * verify_is_writable - checks if a file or folder is writable
	 * @param string $full_path      - full server path to file or folder
	 * @param string $file_or_folder - whether checking a file or folder
	 * @throws EE_Error
	 * @return bool
	 */
	public static function verify_is_writable( $full_path = '', $file_or_folder = 'folder' ){
		// load WP_Filesystem and set file permissions
		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_path );
		$full_path = EEH_File::standardise_directory_separators( $full_path );
		if ( ! $wp_filesystem->is_writable( EEH_File::convert_local_filepath_to_remote_filepath( $full_path ) ) ) {
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
				$msg = sprintf( __( 'The "%1$s" %2$s is not writable.', 'event_espresso' ), $full_path, $file_or_folder );
				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_path );
				throw new EE_Error( $msg );
			}
			return FALSE;
		}
		return TRUE;
	}



	/**
	 * ensure_file_exists_and_is_writable
	 * ensures that a file exists and is writable, will attempt to create file if it does not exist.
	 * Also ensures all the parent folders exist, and if not tries to create them.
	 * @param string $full_file_path
	 * @throws EE_Error
	 * @return bool
	 */
	public static function ensure_file_exists_and_is_writable( $full_file_path = '' ) {
		// load WP_Filesystem and set file permissions
		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
		$parent_folder = EEH_File::get_parent_folder( $full_file_path );
		if ( ! EEH_File::exists( $full_file_path )) {

			if( ! EEH_File::ensure_folder_exists_and_is_writable( $parent_folder ) ) {
				return false;
			}
			if ( ! $wp_filesystem->touch( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) ) ) {
				if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
					$msg = sprintf( __( 'The "%s" file could not be created.', 'event_espresso' ), $full_file_path );
					$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path );
					throw new EE_Error( $msg );
				}
				return false;
			}
		}
		if ( ! EEH_File::verify_is_writable( $full_file_path, 'file' )) {
			return false;
		}
		return true;
	}
	
	/**
	 * Gets the parent folder. If provided with file, gets the folder that contains it.
	 * If provided a folder, gets its parent folder.
	 * @param string $file_or_folder_path
	 * @return string parent folder, ENDING with a directory separator
	 */
	public static function get_parent_folder( $file_or_folder_path ) {
		//find the last DS, ignoring a DS on the very end
		//eg if given "/var/something/somewhere/", we want to get "somewhere"'s
		//parent folder, "/var/something/"
		$ds = strrpos( $file_or_folder_path, DS, -2 );
		return substr( $file_or_folder_path, 0, $ds + 1 );
	}
	
	public static function ensure_folder_exists_recursively( $folder ) {

		
	}



	/**
	 * get_file_contents
	 * @param string $full_file_path
	 * @return string
	 */
	public static function get_file_contents( $full_file_path = '' ){
		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
		if ( EEH_File::verify_filepath_and_permissions( $full_file_path, EEH_File::get_filename_from_filepath( $full_file_path ) , EEH_File::get_file_extension( $full_file_path ))) {
			// load WP_Filesystem and set file permissions
			$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
			return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) );
		}
		return '';
	}



	/**
	 * write_file
	 * @param string $full_file_path
	 * @param string $file_contents - the content to be written to the file
	 * @param string $file_type
	 * @throws EE_Error
	 * @return bool
	 */
	public static function write_to_file( $full_file_path = '', $file_contents = '', $file_type = '' ){
		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
		$file_type = ! empty( $file_type ) ? rtrim( $file_type, ' ' ) . ' ' : '';
		$folder = EEH_File::remove_filename_from_filepath( $full_file_path );
		if ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
				$msg = sprintf( __( 'The %1$sfile located at "%2$s" is not writable.', 'event_espresso' ), $file_type, $full_file_path );
				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path );
				throw new EE_Error( $msg );
			}
			return FALSE;
		}
		// load WP_Filesystem and set file permissions
		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
		// write the file
		if ( ! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ), $file_contents )) {
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
				$msg = sprintf( __( 'The %1$sfile located at "%2$s" could not be written to.', 'event_espresso' ), $file_type, $full_file_path );
				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path, 'f' );
				throw new EE_Error( $msg );
			}
			return FALSE;
		}
		return TRUE;
	}

	/**
	 * Wrapper for WP_Filesystem_Base::delete
	 *
	 * @param string $filepath
	 * @param boolean $recursive
	 * @param boolean|string $type 'd' for directory, 'f' for file
	 * @return boolean
	 */
	public static function delete( $filepath, $recursive = false, $type = false ) {
		$wp_filesystem = EEH_File::_get_wp_filesystem();
		return $wp_filesystem->delete( $filepath, $recursive, $type ) ? TRUE : FALSE;
	}



	/**
	 * exists
	 * checks if a file exists using the WP filesystem
	 *
	 * @param string $full_file_path
	 * @return bool
	 */
	public static function exists( $full_file_path = '' ) {
		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
		return $wp_filesystem->exists( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) ) ? TRUE : FALSE;
	}



	/**
	 * is_readable
	 * checks if a file is_readable using the WP filesystem
	 *
	 * @param string $full_file_path
	 * @return bool
	 */
	public static function is_readable( $full_file_path = '' ) {
		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
		if( $wp_filesystem->is_readable( EEH_File::convert_local_filepath_to_remote_filepath(  $full_file_path ) ) ) {
			return true;
		} else {
			return false;
		}
	}



	/**
	 * remove_filename_from_filepath
	 * given a full path to a file including the filename itself, this removes  the filename and returns the path, up to, but NOT including the filename OR slash
	 *
	 * @param string $full_file_path
	 * @return string
	 */
	public static function remove_filename_from_filepath( $full_file_path = '' ) {
		return pathinfo( $full_file_path, PATHINFO_DIRNAME );
	}


	/**
	 * get_filename_from_filepath. Arguably the same as basename()
	 *
	 * @param string $full_file_path
	 * @return string
	 */
	public static function get_filename_from_filepath( $full_file_path = '' ) {
		return pathinfo( $full_file_path, PATHINFO_BASENAME );
	}


	/**
	 * get_file_extension
	 *
	 * @param string $full_file_path
	 * @return string
	 */
	public static function get_file_extension( $full_file_path = '' ) {
		return pathinfo( $full_file_path, PATHINFO_EXTENSION );
	}



	/**
	 * add_htaccess_deny_from_all so the webserver cannot access this folder
	 * @param string $folder
	 * @return bool
	 */
	public static function add_htaccess_deny_from_all( $folder = '' ) {

		$folder = EEH_File::standardise_and_end_with_directory_separator( $folder );
		if ( ! EEH_File::exists( $folder . '.htaccess' ) ) {
			if ( ! EEH_File::write_to_file( $folder . '.htaccess', 'deny from all', '.htaccess' )) {
				return FALSE;
			}
		}
		
		return TRUE;
	}
	
	/**
	 * Adds an index file to this folder, so folks can't list all the file's contents
	 * @param string $folder
	 * @return boolean
	 */
	public static function add_index_file( $folder ) {

		$folder = EEH_File::standardise_and_end_with_directory_separator( $folder );
		if ( ! EEH_File::exists( $folder . 'index.html' ) ) {
			if ( ! EEH_File::write_to_file( $folder . 'index.html', 'You are not permitted to read from this folder', '.html' )) {
				return false;
			}
		}
		return true;
	}



	/**
	 * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php),
	 * extract that classname.
	 * @param string $file_path
	 * @return string
	 */
	public static function get_classname_from_filepath_with_standard_filename( $file_path ){
		//extract file from path
		$filename = basename( $file_path );
		//now remove the first period and everything after
		$pos_of_first_period = strpos( $filename,'.' );
		return substr($filename, 0, $pos_of_first_period);
	}



	/**
	 * standardise_directory_separators
	 *  convert all directory separators in a file path to whatever is set for DS
	 * @param string $file_path
	 * @return string
	 */
	public static function standardise_directory_separators( $file_path ){
		return str_replace( array( '\\', '/' ), DS, $file_path );
	}



	/**
	 * end_with_directory_separator
	 *  ensures that file path ends with DS
	 * @param string $file_path
	 * @return string
	 */
	public static function end_with_directory_separator( $file_path ){
		return rtrim( $file_path, '/\\' ) . DS;
	}



	/**
	 * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators
	 * @param $file_path
	 * @return string
	 */
	public static function standardise_and_end_with_directory_separator( $file_path ){
		return self::end_with_directory_separator( self::standardise_directory_separators( $file_path ));
	}



	/**
	 * takes the folder name (with or without trailing slash) and finds the files it in,
	 * and what the class's name inside of each should be.
	 * @param array $folder_paths
	 * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically;
	 *		if FALSE (Default), returned array will be indexed by the filenames minus extensions.
	 *		Set it TRUE if you know there are files in the directory with the same name but different extensions
	 * @throws \EE_Error
	 * @return array if $index_numerically == TRUE keys are numeric ,
	 *		if $index_numerically == FALSE (Default) keys are what the class names SHOULD be;
	 *		 and values are their filepaths
	 */
	public static function get_contents_of_folders( $folder_paths = array(), $index_numerically = FALSE ){
		$class_to_folder_path = array();
		foreach( $folder_paths as $folder_path ){
			$folder_path = self::standardise_and_end_with_directory_separator( $folder_path );
			// load WP_Filesystem and set file permissions
			$files_in_folder = glob( $folder_path . '*' );
			$class_to_folder_path = array();
			if ( $files_in_folder ) {

				foreach( $files_in_folder as $file_path ){
					//only add files, not folders
					if ( ! is_dir( $file_path )) {
						if ( $index_numerically ) {
							$class_to_folder_path[] = $file_path;
						} else {
							$classname = self::get_classname_from_filepath_with_standard_filename( $file_path );
							$class_to_folder_path[$classname] = $file_path;
						}
					}
				}
			}
		}
		return $class_to_folder_path;
	}



	/**
	 * Copies a file. Mostly a wrapper of WP_Filesystem::copy
	 * @param string $source_file
	 * @param string $destination_file
	 * @param boolean $overwrite
	 * @return boolean success
	 * @throws EE_Error
	 */
	public static function copy( $source_file, $destination_file, $overwrite = FALSE ){
		$full_source_path = EEH_File::standardise_directory_separators( $source_file );
		if( ! EEH_File::exists( $full_source_path ) ){
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
				$msg = sprintf( __( 'The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso' ), $full_source_path );
				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_source_path );
				throw new EE_Error( $msg );
			}
			return FALSE;
		}

		$full_dest_path = EEH_File::standardise_directory_separators( $destination_file );
		$folder = EEH_File::remove_filename_from_filepath( $full_dest_path );
		if ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
				$msg = sprintf( __( 'The file located at "%2$s" is not writable.', 'event_espresso' ), $full_dest_path );
				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_dest_path );
				throw new EE_Error( $msg );
			}
			return FALSE;
		}

		// load WP_Filesystem and set file permissions
		$wp_filesystem = EEH_File::_get_wp_filesystem( $destination_file );
		// write the file
		if ( ! $wp_filesystem->copy( 
						EEH_File::convert_local_filepath_to_remote_filepath( $full_source_path ), 
						EEH_File::convert_local_filepath_to_remote_filepath( $full_dest_path ), 
						$overwrite )) {
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
				$msg = sprintf( __( 'Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso' ), $full_source_path );
				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_source_path, 'f' );
				throw new EE_Error( $msg );
			}
			return FALSE;
		}
		return TRUE;
	}
	
	/**
	 * Reports whether or not the filepath is in the EE uploads folder or not
	 * @param string $filepath
	 * @return boolean
	 */
	public static function is_in_uploads_folder( $filepath ) {
		$uploads = wp_upload_dir();
		return strpos( $filepath, $uploads[ 'basedir' ] ) === 0 ? true : false;
	}
	
	/**
	 * Given a "local" filepath (what you probably thought was the only filepath),
	 * converts it into a "remote" filepath (the filepath the currently-in-use 
	 * $wp_filesystem needs to use access the folder or file).
	 * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins
	 * @param WP_Filesystem_Base $wp_filesystem we aren't initially sure which one
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * is in use, so you need to provide it
	 * @param string $local_filepath the filepath to the folder/file locally
	 * @return string the remote filepath (eg the filepath the filesystem method, eg 
	 * ftp or ssh, will use to access the folder
	 */
	public static function convert_local_filepath_to_remote_filepath( $local_filepath ) {
		$wp_filesystem = EEH_File::_get_wp_filesystem( $local_filepath );
		return str_replace( WP_CONTENT_DIR . DS, $wp_filesystem->wp_content_dir(), $local_filepath );
	}
}
// End of file EEH_File.helper.php
// Location: /helpers/EEH_File.helper.php

Branch — BUG-8729-batch-processing-csv-... (3a9229)

EEH_File D

Complexity

Size/Duplication

Coupling/Cohesion

27 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

eventespresso / event-espresso-core

Branch — BUG-8729-batch-processing-csv-... (3a9229)

EEH_File D

Complexity

Size/Duplication

Coupling/Cohesion

27 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like