Zip_File_Backup_Engine::backup() - Code Metrics - Inspection of "Use Process for all our system calls" - humanmade/backupwordpress - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1001)

by Paul

created 2016-02-29 13:57 UTC

Zip_File_Backup_Engine::backup() C

↳ Parent: Zip_File_Backup_Engine

Complexity

Conditions	7
Paths	23

Size

Total Lines	51
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes	11
Bugs	0	Features	0

Metric	Value
c	11
b	0
f	0
dl	0
loc	51
rs	6.9743
cc	7
eloc	21
nc	23
nop	0

How to fix Long Method

<?php

namespace HM\BackUpWordPress;

use Symfony\Component\Process\Exception\ProcessTimedOutException;
use Symfony\Component\Process\Process as Process;

/**
 * Perform a file backup using the zip cli command
 */
class Zip_File_Backup_Engine extends File_Backup_Engine {

	/**
	 * The path to the zip executable
	 *
	 * @var string
	 */
	private $zip_executable_path = '';

	public function __construct() {
		parent::__construct();
	}

	/**
	 * Calculate the path to the zip executable.
	 *
	 * The executable path can be overridden using either the `HMBKP_ZIP_PATH`
	 * Constant or the `hmbkp_zip_executable_path` filter.
	 *
	 * If neither of those are set then we fallback to checking a number of
	 * common locations.
	 *
	 * @return string|false The path to the executable or false.
	 */
	public function get_zip_executable_path() {

		if ( defined( 'HMBKP_ZIP_PATH' ) ) {
			return HMBKP_ZIP_PATH;
		}

		/**
		 * Allow the executable path to be set via a filter
		 *
		 * @param string The path to the zip executable
		 */
		$this->zip_executable_path = apply_filters( 'hmbkp_zip_executable_path', '' );

		if ( ! $this->zip_executable_path ) {

			// List of possible zip locations
			$paths = array(
				'zip',
				'/usr/bin/zip',
				'/usr/local/bin/zip',
				'/opt/local/bin/zip',
			);

			$this->zip_executable_path = Backup_Utilities::get_executable_path( $paths );
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

		}

		return $this->zip_executable_path;

	}

	/**
	 * Perform the file backup.
	 *
	 * @return bool Whether the backup completed successfully or not.
	 */
	public function backup() {

		if ( ! $this->get_zip_executable_path() ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			return false;
		}

		// cd to the site root
		$command[] = 'cd ' . escapeshellarg( Path::get_root() );
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

		// Run the zip command with the recursive and quiet flags
		$command[] = '&& ' . escapeshellcmd( $this->get_zip_executable_path() ) . ' -rq';

		// Save the zip file to the correct path
		$command[] = escapeshellarg( $this->get_backup_filepath() ) . ' ./';

		// Pass exclude rules in if we have them
		if ( $this->get_exclude_string() ) {
			$command[] = '-x ' . $this->get_exclude_string();
		}

		$command = implode( ' ', $command );

		$process = new Process( $command );
		$process->setTimeout( HOUR_IN_SECONDS );

		try {

			$process->run();

			if ( ! $process->isSuccessful() ) {

				/**
				 * Exit Code 18 is returned when an unreadable file is encountered during the zip process.
				 *
				 * Given the zip process still completes correctly and the unreadable file is simple skipped
				 * we don't want to treat 18 as an actual error.
				 */
				if ( $process->getExitCode() !== 18 ) {
					$this->error( __CLASS__, $process->getErrorOutput() );
				}
			}

		} catch ( ProcessTimedOutException $e ) {
			$this->error( __CLASS__, $e->getMessage() );
		} catch ( \Exception $e ) {
			$this->error( __CLASS__, $e->getMessage() );
		}

		return $this->verify_backup();

	}

	/**
	 * Convert the exclude rules to a format zip accepts
	 *
	 * @return string The exclude string ready to pass to `zip -x`
	 */
	public function get_exclude_string() {

		if ( ! $this->excludes ) {

			return '';
		}

		$excludes = $this->excludes->get_excludes();


		foreach ( $excludes as $key => &$rule ) {

			$file = $absolute = $fragment = false;

			// Files don't end with /
			if ( ! in_array( substr( $rule, - 1 ), array( '\\', '/' ) ) ) {
				$file = true;
			} // If rule starts with a / then treat as absolute path
			elseif ( in_array( substr( $rule, 0, 1 ), array( '\\', '/' ) ) ) {

				$absolute = true;
			} // Otherwise treat as dir fragment
			else {
				$fragment = true;
			}

			$rule = str_ireplace( Path::get_root(), '', untrailingslashit( wp_normalize_path( $rule ) ) );

			// Strip the preceeding slash
			if ( in_array( substr( $rule, 0, 1 ), array( '\\', '/' ) ) ) {

				$rule = substr( $rule, 1 );
			}

			// Wrap directory fragments and files in wildcards for zip
			if ( $fragment || $file ) {
				$rule = '*' . $rule . '*';
			}

			// Add a wildcard to the end of absolute url for zips
			if ( $absolute ) {
				$rule .= '*';
			}
		}

		// Escape shell args for zip command
		$excludes = array_map( 'escapeshellarg', array_unique( $excludes ) );

		return implode( ' -x ', $excludes );

	}
}


1		<?php
2
3		namespace HM\BackUpWordPress;
4
5		use Symfony\Component\Process\Exception\ProcessTimedOutException;
6		use Symfony\Component\Process\Process as Process;
7
8		/**
9		* Perform a file backup using the zip cli command
10		*/
11		class Zip_File_Backup_Engine extends File_Backup_Engine {
12
13		/**
14		* The path to the zip executable
15		*
16		* @var string
17		*/
18		private $zip_executable_path = '';
19
20		public function __construct() {
21		parent::__construct();
22		}
23
24		/**
25		* Calculate the path to the zip executable.
26		*
27		* The executable path can be overridden using either the `HMBKP_ZIP_PATH`
28		* Constant or the `hmbkp_zip_executable_path` filter.
29		*
30		* If neither of those are set then we fallback to checking a number of
31		* common locations.
32		*
33		* @return string\|false The path to the executable or false.
34		*/
35		public function get_zip_executable_path() {
36
37		if ( defined( 'HMBKP_ZIP_PATH' ) ) {
38		return HMBKP_ZIP_PATH;
39		}
40
41		/**
42		* Allow the executable path to be set via a filter
43		*
44		* @param string The path to the zip executable
45		*/
46		$this->zip_executable_path = apply_filters( 'hmbkp_zip_executable_path', '' );
47
48		if ( ! $this->zip_executable_path ) {
49
50		// List of possible zip locations
51		$paths = array(
52		'zip',
53		'/usr/bin/zip',
54		'/usr/local/bin/zip',
55		'/opt/local/bin/zip',
56		);
57
58		$this->zip_executable_path = Backup_Utilities::get_executable_path( $paths );
		0 ignored issues – show Documentation Bug introduced 2015-11-22 13:57 UTC by Report Bug Copy Issue Report It seems like `\HM\BackUpWordPress\Back...executable_path($paths)` can also be of type `false`. However, the property `$zip_executable_path` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
59
60		}
61
62		return $this->zip_executable_path;
63
64		}
65
66		/**
67		* Perform the file backup.
68		*
69		* @return bool Whether the backup completed successfully or not.
70		*/
71		public function backup() {
72
73		if ( ! $this->get_zip_executable_path() ) {
		0 ignored issues – show Bug Best Practice introduced 2016-02-28 17:47 UTC by Report Bug Copy Issue Report The expression `$this->get_zip_executable_path()` of type `string\|false` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
74		return false;
75		}
76
77		// cd to the site root
78		$command[] = 'cd ' . escapeshellarg( Path::get_root() );
		0 ignored issues – show Coding Style Comprehensibility introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report `$command` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$command = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
79
80		// Run the zip command with the recursive and quiet flags
81		$command[] = '&& ' . escapeshellcmd( $this->get_zip_executable_path() ) . ' -rq';
82
83		// Save the zip file to the correct path
84		$command[] = escapeshellarg( $this->get_backup_filepath() ) . ' ./';
85
86		// Pass exclude rules in if we have them
87		if ( $this->get_exclude_string() ) {
88		$command[] = '-x ' . $this->get_exclude_string();
89		}
90
91		$command = implode( ' ', $command );
92
93		$process = new Process( $command );
94		$process->setTimeout( HOUR_IN_SECONDS );
95
96		try {
97
98		$process->run();
99
100		if ( ! $process->isSuccessful() ) {
101
102		/**
103		* Exit Code 18 is returned when an unreadable file is encountered during the zip process.
104		*
105		* Given the zip process still completes correctly and the unreadable file is simple skipped
106		* we don't want to treat 18 as an actual error.
107		*/
108		if ( $process->getExitCode() !== 18 ) {
109		$this->error( __CLASS__, $process->getErrorOutput() );
110		}
111		}
112
113		} catch ( ProcessTimedOutException $e ) {
114		$this->error( __CLASS__, $e->getMessage() );
115		} catch ( \Exception $e ) {
116		$this->error( __CLASS__, $e->getMessage() );
117		}
118
119		return $this->verify_backup();
120
121		}
122
123		/**
124		* Convert the exclude rules to a format zip accepts
125		*
126		* @return string The exclude string ready to pass to `zip -x`
127		*/
128		public function get_exclude_string() {
129
130		if ( ! $this->excludes ) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-30 00:15 UTC by Report Bug Copy Issue Report The expression `$this->excludes` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
131		return '';
132		}
133
134		$excludes = $this->excludes->get_excludes();
		0 ignored issues – show Bug introduced 2015-11-30 00:15 UTC by Report Bug Copy Issue Report The method `get_excludes` cannot be called on `$this->excludes` (of type `array`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
135
136		foreach ( $excludes as $key => &$rule ) {
137
138		$file = $absolute = $fragment = false;
139
140		// Files don't end with /
141		if ( ! in_array( substr( $rule, - 1 ), array( '\\', '/' ) ) ) {
142		$file = true;
143		} // If rule starts with a / then treat as absolute path
144	View Code Duplication	elseif ( in_array( substr( $rule, 0, 1 ), array( '\\', '/' ) ) ) {
		1 ignored issue – show Duplication introduced 2015-11-21 18:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
145		$absolute = true;
146		} // Otherwise treat as dir fragment
147		else {
148		$fragment = true;
149		}
150
151		$rule = str_ireplace( Path::get_root(), '', untrailingslashit( wp_normalize_path( $rule ) ) );
152
153		// Strip the preceeding slash
154	View Code Duplication	if ( in_array( substr( $rule, 0, 1 ), array( '\\', '/' ) ) ) {
		1 ignored issue – show Duplication introduced 2015-11-21 18:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
155		$rule = substr( $rule, 1 );
156		}
157
158		// Wrap directory fragments and files in wildcards for zip
159		if ( $fragment \|\| $file ) {
160		$rule = '' . $rule . '';
161		}
162
163		// Add a wildcard to the end of absolute url for zips
164		if ( $absolute ) {
165		$rule .= '*';
166		}
167		}
168
169		// Escape shell args for zip command
170		$excludes = array_map( 'escapeshellarg', array_unique( $excludes ) );
171
172		return implode( ' -x ', $excludes );
173
174		}
175		}
176

humanmade / backupwordpress

GitHub Access Token became invalid

Pull Request — master (#1001)

Zip_File_Backup_Engine::backup() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like