FrmCreateFile::get_ftp_creds() - Code Metrics - Inspection of "Fix scrutinizer issues" - Strategy11/formidable-forms - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( ec16eb...0357f3 )

by Stephanie
created 2018-02-10 21:13 UTC
FrmCreateFile::get_ftp_creds() F

↳ Parent: FrmCreateFile
Complexity

Conditions	23
Paths	10368
Size

Total Lines	51
Code Lines	30
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	23
eloc	30
nc	10368
nop	1
dl	0
loc	51
rs	2.942
c	0
b	0
f	0
How to fix Long Method Complexity

<?php

if ( ! defined( 'ABSPATH' ) ) {
	die( 'You are not allowed to call this page directly.' );
}

class FrmCreateFile {

	public $folder_name;
	public $file_name;
	public $error_message;
	public $uploads;
	private $new_file_path;
	public $chmod_dir = 0755;
	public $chmod_file = 0644;
	private $has_permission = false;

	public function __construct( $atts ) {
		$this->folder_name = isset( $atts['folder_name'] ) ? $atts['folder_name'] : '';
		$this->file_name = $atts['file_name'];
		$this->error_message = isset( $atts['error_message'] ) ? $atts['error_message'] : '';
		$this->uploads = wp_upload_dir();
		$this->uploads = /** @scrutinizer ignore-call */ wp_upload_dir();
		$this->set_new_file_path( $atts );
		$this->chmod_dir = defined('FS_CHMOD_DIR') ? FS_CHMOD_DIR : ( fileperms( ABSPATH ) & 0777 | 0755 );

		$this->chmod_file = defined('FS_CHMOD_FILE') ? FS_CHMOD_FILE : ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 );


		$this->check_permission();
	}

	/**
	 * @since 3.0
	 */
	private function set_new_file_path( $atts ) {
		if ( isset( $atts['new_file_path'] ) ) {
			$this->new_file_path = $atts['new_file_path'] . '/' . $this->file_name;
		} else {
			$this->new_file_path = $this->uploads['basedir'] . '/' . $this->folder_name . '/' . $this->file_name;
		}
	}

	public function create_file( $file_content ) {
		if ( $this->has_permission ) {
			$dirs_exist = true;

			// Create the directories if need be
			$this->create_directories( $dirs_exist );

			// only write the file if the folders exist
			if ( $dirs_exist ) {

				global $wp_filesystem;
				$wp_filesystem->put_contents( $this->new_file_path, $file_content, $this->chmod_file );
			}
		}
	}

	/**
	 * @since 3.0
	 */
	public function append_file( $file_content ) {
		if ( $this->has_permission ) {

			if ( file_exists( $this->new_file_path ) ) {

				$existing_content = $this->get_contents();
				$file_content = $existing_content . $file_content;
			}

			$this->create_file( $file_content );
		}
	}

	/**
	 * Combine an array of files into one
	 *
	 * @since 3.0
	 *
	 * @param array $file_names And array of file paths
	 */
	public function combine_files( $file_names ) {
		if ( $this->has_permission ) {
			$content = '';
			foreach ( $file_names as $file_name ) {
				$content .= $this->get_contents( $file_name ) . "\n";
			}
			$this->create_file( $content );
		}
	}

	/**
	 * @since 3.0
	 */
	public function get_file_contents() {
		$content = '';

		if ( $this->has_permission ) {
			$content = $this->get_contents();
		}

		return $content;
	}

	/**
	 * @since 3.0
	 */
	private function get_contents( $file = '' ) {
		global $wp_filesystem;
		if ( empty( $file ) ) {
			$file = $this->new_file_path;
		}
		return $wp_filesystem->get_contents( $file );
	}

	/**
	 * @since 3.0
	 */
	private function check_permission() {
		$creds = $this->get_creds();

		$this->has_permission = true;
		if ( empty( $creds ) || ! WP_Filesystem( $creds ) ) {
		if ( empty( $creds ) || ! /** @scrutinizer ignore-call */ WP_Filesystem( $creds ) ) {
			// initialize the API - any problems and we exit
			$this->show_error_message();
			$this->has_permission = false;
		}
	}

	private function create_directories( &$dirs_exist ) {
		global $wp_filesystem;

		$needed_dirs = $this->get_needed_dirs();
		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, $this->chmod_dir ) ) {
				$index_path = $_dir . '/index.php';
				$wp_filesystem->put_contents( $index_path, "<?php\n// Silence is golden.\n?>", $this->chmod_file );
			} else {
				$dirs_exist = $wp_filesystem->is_dir( $_dir );
			}
		}
	}

	private function get_needed_dirs() {
		$dir_names = explode( '/', $this->folder_name );
		$needed_dirs = array();

		$next_dir = '';
		foreach ( $dir_names as $dir ) {
			$next_dir .= '/' . $dir;
			$needed_dirs[] = $this->uploads['basedir'] . $next_dir;
		}

		return $needed_dirs;
	}

	private function get_creds() {
		if ( ! function_exists('get_filesystem_method') ) {
			include_once( ABSPATH . 'wp-admin/includes/file.php' );

		}

		$access_type = get_filesystem_method();
		if ( $access_type === 'direct' ) {
			$creds = request_filesystem_credentials( site_url() . '/wp-admin/', '', false, false, array() );
			$creds = /** @scrutinizer ignore-call */ request_filesystem_credentials( site_url() . '/wp-admin/', '', false, false, array() );
		} else {
			$creds = $this->get_ftp_creds( $access_type );
		}
		return $creds;
	}

	private function get_ftp_creds( $type ) {
		$credentials = get_option( 'ftp_credentials', array(
		$credentials = /** @scrutinizer ignore-call */ get_option( 'ftp_credentials', array(
			'hostname' => '',
			'username' => '',
		) );

		$credentials['hostname'] = defined('FTP_HOST') ? FTP_HOST : $credentials['hostname'];

		$credentials['username'] = defined('FTP_USER') ? FTP_USER : $credentials['username'];

		$credentials['password'] = defined('FTP_PASS') ? FTP_PASS : '';


		// Check to see if we are setting the public/private keys for ssh
		$credentials['public_key'] = defined('FTP_PUBKEY') ? FTP_PUBKEY : '';

		$credentials['private_key'] = defined('FTP_PRIKEY') ? FTP_PRIKEY : '';


		// 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'], ':' ) ) {
			list( $credentials['hostname'], $credentials['port'] ) = explode( ':', $credentials['hostname'], 2 );
			if ( ! is_numeric( $credentials['port'] ) ) {
				unset( $credentials['port'] );
			}
		} else {
			unset( $credentials['port'] );
		}

		if ( ( defined( 'FTP_SSH' ) && FTP_SSH ) || ( defined( 'FS_METHOD' ) && 'ssh2' == FS_METHOD ) ) {

			$credentials['connection_type'] = 'ssh';
		} 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'] ) ) {
			//All else fails (And it's not defaulted to something else saved), Default to FTP
			$credentials['connection_type'] = 'ftp';
		}

		$has_creds = ( ! empty( $credentials['password'] ) && ! empty( $credentials['username'] ) && ! empty( $credentials['hostname'] ) );
		$can_ssh = ( 'ssh' == $credentials['connection_type'] && ! empty( $credentials['public_key'] ) && ! empty( $credentials['private_key'] ) );
		if ( $has_creds || $can_ssh ) {
			$stored_credentials = $credentials;
			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'] );

			return $credentials;
		}

		return false;
	}

	private function show_error_message() {
		if ( ! empty( $this->error_message ) ) {
			echo '<div class="message">' . $this->error_message . '</div>';

		}
	}
}

Strategy11 / formidable-forms

Push — master ( ec16eb...0357f3 )

FrmCreateFile::get_ftp_creds() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
