Backup_Status - Code Metrics - Inspection of "Utilise file locking so we can track crashed proce..." - humanmade/backupwordpress - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1025)

unknown

created 2016-09-23 10:06 UTC

Backup_Status B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	280
Duplicated Lines	2.14 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
dl	6
loc	280
rs	8.3673
c	1
b	1
f	0
wmc	45
lcom	1
cbo	3

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	start()	0	18	5
B	finish()	0	15	6
A	is_started()	0	3	1
B	is_running()	0	21	5
A	has_crashed()	0	3	2
A	cleanup_after_crash()	3	20	4
B	catch_fatals()	3	24	6
A	get_backup_filename()	0	12	3
A	get_status()	0	14	3
A	set_status()	0	19	3
A	get_start_time()	0	14	4
A	get_status_filepath()	0	3	1
A	set_status_callback()	0	3	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 Backup_Status 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 Backup_Status, and based on these observations, apply Extract Interface, too.

<?php

namespace HM\BackUpWordPress;

use Symfony\Component\Filesystem\LockHandler;

/**
 * Manages status and progress of a backup
 */
class Backup_Status {

	/**
	 * The filename for the backup file we are the tracking status of.
	 *
	 * @var string
	 */
	private $filename = '';

	/**
	 * [$lock_handler description]
	 *
	 * @var LockHandler
	 */
	private $lock_handler = '';

	private $callback;

	/**
	 * @param string $id The unique id for the backup job.
	 */
	public function __construct( $id ) {
		$this->id = (string) $id;
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->cleanup_after_crash();
	}

	/**
	 * Start the tracking a backup process.
	 *
	 * This creates a backup running file and issues a file lock. This prevents duplicate
	 * instances of this backup process running concurrently and allows us to detect if
	 * the PHP thread running the process is killed as that will clear the lock.
	 *
	 * @param string $backup_filename The filename for the backup file that we're tracking.
	 * @param string $status_message  The initial status for the backup process.
	 *
	 * @return boolean                Whether the backup process was success marked as started.
	 */
	public function start( $backup_filename, $status_message ) {
		$this->filename = $backup_filename;

		// Clear any errors from previous backup runs.
		Notices::get_instance()->clear_notice_context( 'backup_failed' );

		add_action( 'shutdown', array( $this, 'catch_fatals' ), 10 );

		if ( ! defined( 'HMBKP_DISABLE_FILE_LOCKING' ) || ! HMBKP_DISABLE_FILE_LOCKING ) {
			$this->lock_handler = new LockHandler( basename( $this->get_status_filepath() ), Path::get_path() );

			if ( ! $this->lock_handler->lock() || $this->get_status() ) {
			    return false;
			}
		}

		return $this->set_status( $status_message );
	}

	/**
	 * Mark a backup process as finished.
	 *
	 * This removes the file lock and deletes the running file.
	 */
	public function finish() {

		if ( ! defined( 'HMBKP_DISABLE_FILE_LOCKING' ) || ! HMBKP_DISABLE_FILE_LOCKING ) {
			if ( isset( $this->lock_handler ) && is_a( $this->lock_handler, 'LockHandler' ) ) {
				$this->lock_handler->release();
			}
		}

		// Delete the backup running file.
		if ( file_exists( $this->get_status_filepath() ) ) {
			return unlink( $this->get_status_filepath() );
		}

		return false;
	}

	/**
	 * Check if the backup has been started by checking if the running file
	 * exists.
	 *
	 * @return boolean Whether the backup process has been started.
	 */
	public function is_started() {
		return (bool) file_exists( $this->get_status_filepath() );
	}

	public function is_running() {

		if ( ! $this->is_started() ) {
			return false;
		}

		if ( ! defined( 'HMBKP_DISABLE_FILE_LOCKING' ) || ! HMBKP_DISABLE_FILE_LOCKING ) {

			// If we're in the same thread then we know we must be running if the running file exists.
			if ( is_a( $this->lock_handler, 'LockHandler' ) ) {
				return $this->is_started();
			}

			$lock_handler = new LockHandler( basename( $this->get_status_filepath() ), Path::get_path() );

			return ! $lock_handler->lock();
		}

		// If the backup is started and we don't support file locks then we have to assume we're still running.
		return true;
	}

	/**
	 * If the running file exists but isn't locked then the thread that
	 * the backup process is running in must have been killed.
	 *
	 * You should only be running this command from a separate thread.
	 *
	 * @return boolean Whether the backup process has crashed or not.
	 */
	public function has_crashed() {
		return ( $this->is_started() && ! $this->is_running() );
	}

	/**
	 * Handle a process that's previously crashed.
	 *
	 * Delete the partially created backup if it exists and then
	 * run the standard cleanup tasks and set an error message for the user.
	 *
	 * @return bool Whether the crash was handled or not.
	 */
	public function cleanup_after_crash() {

		if ( ! $this->has_crashed() ) {
			return false;
		}

		if ( file_exists( trailingslashit( Path::get_path() ) . $this->get_backup_filename() ) ) {
			unlink( trailingslashit( Path::get_path() ) . $this->get_backup_filename() );
		}

		$this->finish();

		// If we already have a fatal error then let's not stomp on it.
		if ( Notices::get_instance()->get_notices( 'backup_failed' ) ) {
			$message = __( 'Your last backup failed. The backup process was killed before it could complete. Please contact your host for assistance or try excluding more files.', 'backupwordpress' );
			Notices::get_instance()->set_notices( 'backup_failed', array( $message ), true );
		}

		return true;
	}

	/**
	 * Catch fatal errors and react accordingly.
	 *
	 * Hooked into the shutdown action. If we've shutdown because of a Fatal error
	 * then we cleanup and set an error message for the user.
	 */
	public function catch_fatals() {

		$error = error_get_last();

		if ( empty( $error ) ) {
			return;
		}

		if ( ! isset( $error['type'] ) || ! defined( 'E_ERROR' ) || E_ERROR !== $error['type'] ) {
			return;
		}

		if ( file_exists( trailingslashit( Path::get_path() ) . $this->get_backup_filename() ) ) {
			unlink( trailingslashit( Path::get_path() ) . $this->get_backup_filename() );
		}

		$this->finish();

		$message = sprintf(
			__( 'Your last backup failed. The backup process encountered an error before it could complete. The error was %s. Please contact your host for assistance or try excluding more files.', 'backupwordpress' ),
			'<code>' . esc_html( $error['message'] ) . '</code>'
		);
		Notices::get_instance()->set_notices( 'backup_failed', array( $message ), true );
	}

	/**
	 * Get the filepath for the backup file we're tracking.
	 *
	 * @return string The path to the backup file.
	 */
	public function get_backup_filename() {

		if ( $this->is_started() ) {
			$status = json_decode( file_get_contents( $this->get_status_filepath() ) );

			if ( ! empty( $status->filename ) ) {
				$this->filename = $status->filename;
			}
		}

		return $this->filename;
	}

	/**
	 * Get the status of the running backup.
	 *
	 * @return string
	 */
	public function get_status() {

		if ( ! file_exists( $this->get_status_filepath() ) ) {
			return false;
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());
}
		}

		$status = json_decode( file_get_contents( $this->get_status_filepath() ) );

		if ( ! empty( $status->status ) ) {
			return $status->status;
		}

		return false;
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());
}
	}

	/**
	 * Set the status of the running backup.
	 *
	 * @param string $message
	 *
	 * @return null

	 */
	public function set_status( $message ) {

		if ( is_callable( $this->callback ) ) {
			call_user_func( $this->callback, $message );
		}

		// If start hasn't been called yet then we wont' have a backup filename.
		if ( ! $this->filename ) {
			return false;
		}

		$status = json_encode( (object) array(
			'filename' => $this->filename,
			'started'  => $this->get_start_time(),
			'status'   => $message,
		) );

		return (bool) file_put_contents( $this->get_status_filepath(), $status );
	}

	/**
	 * Get the time that the current running backup was started.
	 *
	 * @return int $timestamp
	 */
	public function get_start_time() {

		if ( ! file_exists( $this->get_status_filepath() ) ) {
			return 0;
		}

		$status = json_decode( file_get_contents( $this->get_status_filepath() ) );

		if ( ! empty( $status->started ) && (int) (string) $status->started === $status->started ) {
			return $status->started;
		}

		return time();
	}

	/**
	 * Get the path to the backup running file that stores the running backup status.
	 *
	 * @return string
	 */
	public function get_status_filepath() {
		return Path::get_path() . '/.backup-' . $this->id . '-running';
	}

	public function set_status_callback( $callback ) {
		$this->callback = $callback;
	}
}


1		<?php
2
3		namespace HM\BackUpWordPress;
4
5		use Symfony\Component\Filesystem\LockHandler;
6
7		/**
8		* Manages status and progress of a backup
9		*/
10		class Backup_Status {
11
12		/**
13		* The filename for the backup file we are the tracking status of.
14		*
15		* @var string
16		*/
17		private $filename = '';
18
19		/**
20		* [$lock_handler description]
21		*
22		* @var LockHandler
23		*/
24		private $lock_handler = '';
25
26		private $callback;
27
28		/**
29		* @param string $id The unique id for the backup job.
30		*/
31		public function __construct( $id ) {
32		$this->id = (string) $id;
		0 ignored issues – show Bug introduced 2016-03-09 22:06 UTC by Report Bug Copy Issue Report The property `id` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
33		$this->cleanup_after_crash();
34		}
35
36		/**
37		* Start the tracking a backup process.
38		*
39		* This creates a backup running file and issues a file lock. This prevents duplicate
40		* instances of this backup process running concurrently and allows us to detect if
41		* the PHP thread running the process is killed as that will clear the lock.
42		*
43		* @param string $backup_filename The filename for the backup file that we're tracking.
44		* @param string $status_message The initial status for the backup process.
45		*
46		* @return boolean Whether the backup process was success marked as started.
47		*/
48		public function start( $backup_filename, $status_message ) {
49		$this->filename = $backup_filename;
50
51		// Clear any errors from previous backup runs.
52		Notices::get_instance()->clear_notice_context( 'backup_failed' );
53
54		add_action( 'shutdown', array( $this, 'catch_fatals' ), 10 );
55
56		if ( ! defined( 'HMBKP_DISABLE_FILE_LOCKING' ) \|\| ! HMBKP_DISABLE_FILE_LOCKING ) {
57		$this->lock_handler = new LockHandler( basename( $this->get_status_filepath() ), Path::get_path() );
58
59		if ( ! $this->lock_handler->lock() \|\| $this->get_status() ) {
60		return false;
61		}
62		}
63
64		return $this->set_status( $status_message );
65		}
66
67		/**
68		* Mark a backup process as finished.
69		*
70		* This removes the file lock and deletes the running file.
71		*/
72		public function finish() {
73
74		if ( ! defined( 'HMBKP_DISABLE_FILE_LOCKING' ) \|\| ! HMBKP_DISABLE_FILE_LOCKING ) {
75		if ( isset( $this->lock_handler ) && is_a( $this->lock_handler, 'LockHandler' ) ) {
76		$this->lock_handler->release();
77		}
78		}
79
80		// Delete the backup running file.
81		if ( file_exists( $this->get_status_filepath() ) ) {
82		return unlink( $this->get_status_filepath() );
83		}
84
85		return false;
86		}
87
88		/**
89		* Check if the backup has been started by checking if the running file
90		* exists.
91		*
92		* @return boolean Whether the backup process has been started.
93		*/
94		public function is_started() {
95		return (bool) file_exists( $this->get_status_filepath() );
96		}
97
98		public function is_running() {
99
100		if ( ! $this->is_started() ) {
101		return false;
102		}
103
104		if ( ! defined( 'HMBKP_DISABLE_FILE_LOCKING' ) \|\| ! HMBKP_DISABLE_FILE_LOCKING ) {
105
106		// If we're in the same thread then we know we must be running if the running file exists.
107		if ( is_a( $this->lock_handler, 'LockHandler' ) ) {
108		return $this->is_started();
109		}
110
111		$lock_handler = new LockHandler( basename( $this->get_status_filepath() ), Path::get_path() );
112
113		return ! $lock_handler->lock();
114		}
115
116		// If the backup is started and we don't support file locks then we have to assume we're still running.
117		return true;
118		}
119
120		/**
121		* If the running file exists but isn't locked then the thread that
122		* the backup process is running in must have been killed.
123		*
124		* You should only be running this command from a separate thread.
125		*
126		* @return boolean Whether the backup process has crashed or not.
127		*/
128		public function has_crashed() {
129		return ( $this->is_started() && ! $this->is_running() );
130		}
131
132		/**
133		* Handle a process that's previously crashed.
134		*
135		* Delete the partially created backup if it exists and then
136		* run the standard cleanup tasks and set an error message for the user.
137		*
138		* @return bool Whether the crash was handled or not.
139		*/
140		public function cleanup_after_crash() {
141
142		if ( ! $this->has_crashed() ) {
143		return false;
144		}
145
146	View Code Duplication	if ( file_exists( trailingslashit( Path::get_path() ) . $this->get_backup_filename() ) ) {
147		unlink( trailingslashit( Path::get_path() ) . $this->get_backup_filename() );
148		}
149
150		$this->finish();
151
152		// If we already have a fatal error then let's not stomp on it.
153		if ( Notices::get_instance()->get_notices( 'backup_failed' ) ) {
154		$message = __( 'Your last backup failed. The backup process was killed before it could complete. Please contact your host for assistance or try excluding more files.', 'backupwordpress' );
155		Notices::get_instance()->set_notices( 'backup_failed', array( $message ), true );
156		}
157
158		return true;
159		}
160
161		/**
162		* Catch fatal errors and react accordingly.
163		*
164		* Hooked into the shutdown action. If we've shutdown because of a Fatal error
165		* then we cleanup and set an error message for the user.
166		*/
167		public function catch_fatals() {
168
169		$error = error_get_last();
170
171		if ( empty( $error ) ) {
172		return;
173		}
174
175		if ( ! isset( $error['type'] ) \|\| ! defined( 'E_ERROR' ) \|\| E_ERROR !== $error['type'] ) {
176		return;
177		}
178
179	View Code Duplication	if ( file_exists( trailingslashit( Path::get_path() ) . $this->get_backup_filename() ) ) {
180		unlink( trailingslashit( Path::get_path() ) . $this->get_backup_filename() );
181		}
182
183		$this->finish();
184
185		$message = sprintf(
186		__( 'Your last backup failed. The backup process encountered an error before it could complete. The error was %s. Please contact your host for assistance or try excluding more files.', 'backupwordpress' ),
187		'<code>' . esc_html( $error['message'] ) . '</code>'
188		);
189		Notices::get_instance()->set_notices( 'backup_failed', array( $message ), true );
190		}
191
192		/**
193		* Get the filepath for the backup file we're tracking.
194		*
195		* @return string The path to the backup file.
196		*/
197		public function get_backup_filename() {
198
199		if ( $this->is_started() ) {
200		$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
201
202		if ( ! empty( $status->filename ) ) {
203		$this->filename = $status->filename;
204		}
205		}
206
207		return $this->filename;
208		}
209
210		/**
211		* Get the status of the running backup.
212		*
213		* @return string
214		*/
215		public function get_status() {
216
217		if ( ! file_exists( $this->get_status_filepath() ) ) {
218		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-08-28 17:03 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `HM\BackUpWordPress\Backup_Status::get_status` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: 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()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
219		}
220
221		$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
222
223		if ( ! empty( $status->status ) ) {
224		return $status->status;
225		}
226
227		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-08-28 17:03 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `HM\BackUpWordPress\Backup_Status::get_status` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: 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()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
228		}
229
230		/**
231		* Set the status of the running backup.
232		*
233		* @param string $message
234		*
235		* @return null
		0 ignored issues – show Documentation introduced 2016-03-09 22:06 UTC by Report Bug Copy Issue Report Should the return type not be `boolean`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
236		*/
237		public function set_status( $message ) {
238
239		if ( is_callable( $this->callback ) ) {
240		call_user_func( $this->callback, $message );
241		}
242
243		// If start hasn't been called yet then we wont' have a backup filename.
244		if ( ! $this->filename ) {
245		return false;
246		}
247
248		$status = json_encode( (object) array(
249		'filename' => $this->filename,
250		'started' => $this->get_start_time(),
251		'status' => $message,
252		) );
253
254		return (bool) file_put_contents( $this->get_status_filepath(), $status );
255		}
256
257		/**
258		* Get the time that the current running backup was started.
259		*
260		* @return int $timestamp
261		*/
262		public function get_start_time() {
263
264		if ( ! file_exists( $this->get_status_filepath() ) ) {
265		return 0;
266		}
267
268		$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
269
270		if ( ! empty( $status->started ) && (int) (string) $status->started === $status->started ) {
271		return $status->started;
272		}
273
274		return time();
275		}
276
277		/**
278		* Get the path to the backup running file that stores the running backup status.
279		*
280		* @return string
281		*/
282		public function get_status_filepath() {
283		return Path::get_path() . '/.backup-' . $this->id . '-running';
284		}
285
286		public function set_status_callback( $callback ) {
287		$this->callback = $callback;
288		}
289		}
290

humanmade / backupwordpress

GitHub Access Token became invalid