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)

by Tom

created 2016-03-13 22:24 UTC

Backup_Status B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	266
Duplicated Lines	2.26 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	9
Bugs	0	Features	1

Metric	Value
wmc	38
c	9
b	0
f	1
lcom	1
cbo	3
dl	6
loc	266
rs	8.3999

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	start()	0	13	3
A	finish()	0	13	4
A	is_started()	0	3	1
A	is_running()	0	15	3
A	has_crashed()	0	3	2
A	cleanup_after_crash()	3	18	3
B	catch_fatals()	3	22	6
A	get_backup_filename()	0	12	3
A	get_status()	0	15	3
A	set_status()	0	20	3
A	get_start_time()	0	15	4
A	get_status_filepath()	0	3	1
A	set_status_callback()	0	3	1

How to fix Duplicated Code

<?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;

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

		$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 ( 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 runnign 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 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 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 previouly 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();

		$message = __( 'Your previous backup failed, the backup process was killed before it could complete. Please contact your host for assistance.', 'backupwordpress' );
		Notices::get_instance()->set_notices( 'backup_errors', 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 previous backup failed, the backup process encountered a %s before it could complete. The error was %s.', 'backupwordpress' ), '<code>PHP Fatal Error</code>', '<code>' . $error['message'] . '</code>' );
		Notices::get_instance()->set_notices( 'backup_errors', 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		add_action( 'shutdown', array( $this, 'catch_fatals' ), 10 );
52
53		$this->lock_handler = new LockHandler( basename( $this->get_status_filepath() ), Path::get_path() );
54
55		if ( ! $this->lock_handler->lock() \|\| $this->get_status() ) {
56		return false;
57		}
58
59		return $this->set_status( $status_message );
60		}
61
62		/**
63		* Mark a backup process as finished.
64		*
65		* This removes the file lock and deletes the running file.
66		*/
67		public function finish() {
68
69		if ( isset( $this->lock_handler ) && is_a( $this->lock_handler, 'LockHandler' ) ) {
70		$this->lock_handler->release();
71		}
72
73		// Delete the backup running file
74		if ( file_exists( $this->get_status_filepath() ) ) {
75		return unlink( $this->get_status_filepath() );
76		}
77
78		return false;
79		}
80
81		/**
82		* Check if the backup has been started by checking if the runnign file
83		* exists.
84		*
85		* @return boolean Whether the backup process has been started
86		*/
87		public function is_started() {
88		return (bool) file_exists( $this->get_status_filepath() );
89		}
90
91		public function is_running() {
92
93		if ( ! $this->is_started() ) {
94		return false;
95		}
96
97		// If we're in the same thread then we know we must be running if the running file exists
98		if ( is_a( $this->lock_handler, 'LockHandler' ) ) {
99		return $this->is_started();
100		}
101
102		$lock_handler = new LockHandler( basename( $this->get_status_filepath() ), Path::get_path() );
103
104		return ! $lock_handler->lock();
105		}
106
107		/**
108		* If the running file exists but isn't locked then the thread that
109		* the backup process is running in must have been killed.
110		*
111		* You should only be running this command from a separate thread
112		*
113		* @return boolean Whether the backup process has crashed or not
114		*/
115		public function has_crashed() {
116		return ( $this->is_started() && ! $this->is_running() );
117		}
118
119		/**
120		* Handle a process that's previouly crashed.
121		*
122		* Delete the partially created backup if it exists and then run the standard
123		* cleanup tasks and set an error message for the user.
124		*
125		* @return bool Whether the crash was handled or not
126		*/
127		public function cleanup_after_crash() {
128
129		if ( ! $this->has_crashed() ) {
130		return false;
131		}
132
133	View Code Duplication	if ( file_exists( trailingslashit( Path::get_path() ) . $this->get_backup_filename() ) ) {
134		unlink( trailingslashit( Path::get_path() ) . $this->get_backup_filename() );
135		}
136
137		$this->finish();
138
139		$message = __( 'Your previous backup failed, the backup process was killed before it could complete. Please contact your host for assistance.', 'backupwordpress' );
140		Notices::get_instance()->set_notices( 'backup_errors', array( $message ), true );
141
142		return true;
143
144		}
145
146		/**
147		* Catch fatal errors and react accordingly.
148		*
149		* Hooked into the shutdown action. If we've shutdown because of a Fatal error
150		* then we cleanup and set an error message for the user.
151		*/
152		public function catch_fatals() {
153
154		$error = error_get_last();
155
156		if ( empty( $error ) ) {
157		return;
158		}
159
160		if ( ! isset( $error['type'] ) \|\| ! defined( 'E_ERROR' ) \|\| E_ERROR !== $error['type'] ) {
161		return;
162		}
163
164	View Code Duplication	if ( file_exists( trailingslashit( Path::get_path() ) . $this->get_backup_filename() ) ) {
165		unlink( trailingslashit( Path::get_path() ) . $this->get_backup_filename() );
166		}
167
168		$this->finish();
169
170		$message = sprintf( __( 'Your previous backup failed, the backup process encountered a %s before it could complete. The error was %s.', 'backupwordpress' ), '<code>PHP Fatal Error</code>', '<code>' . $error['message'] . '</code>' );
171		Notices::get_instance()->set_notices( 'backup_errors', array( $message ), true );
172
173		}
174
175		/**
176		* Get the filepath for the backup file we're tracking
177		*
178		* @return string The path to the backup file
179		*/
180		public function get_backup_filename() {
181
182		if ( $this->is_started() ) {
183		$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
184
185		if ( ! empty( $status->filename ) ) {
186		$this->filename = $status->filename;
187		}
188		}
189
190		return $this->filename;
191		}
192
193		/**
194		* Get the status of the running backup.
195		*
196		* @return string
197		*/
198		public function get_status() {
199
200		if ( ! file_exists( $this->get_status_filepath() ) ) {
201		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-03-13 22:26 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...
202		}
203
204		$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
205
206		if ( ! empty( $status->status ) ) {
207		return $status->status;
208		}
209
210		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-03-13 22:26 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...
211
212		}
213
214		/**
215		* Set the status of the running backup
216		*
217		* @param string $message
218		*
219		* @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...
220		*/
221		public function set_status( $message ) {
222
223		if ( is_callable( $this->callback ) ) {
224		call_user_func( $this->callback, $message );
225		}
226
227		// If start hasn't been called yet then we wont' have a backup filename
228		if ( ! $this->filename ) {
229		return false;
230		}
231
232		$status = json_encode( (object) array(
233		'filename' => $this->filename,
234		'started' => $this->get_start_time(),
235		'status' => $message,
236		) );
237
238		return (bool) file_put_contents( $this->get_status_filepath(), $status );
239
240		}
241
242		/**
243		* Get the time that the current running backup was started
244		*
245		* @return int $timestamp
246		*/
247		public function get_start_time() {
248
249		if ( ! file_exists( $this->get_status_filepath() ) ) {
250		return 0;
251		}
252
253		$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
254
255		if ( ! empty( $status->started ) && (int) (string) $status->started === $status->started ) {
256		return $status->started;
257		}
258
259		return time();
260
261		}
262
263		/**
264		* Get the path to the backup running file that stores the running backup status
265		*
266		* @return string
267		*/
268		public function get_status_filepath() {
269		return Path::get_path() . '/.backup-' . $this->id . '-running';
270		}
271
272		public function set_status_callback( $callback ) {
273		$this->callback = $callback;
274		}
275		}
276

humanmade / backupwordpress

GitHub Access Token became invalid

Pull Request — master (#1025)

Backup_Status B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like