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-12 01:09 UTC

Backup_Status A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	234
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	7
Bugs	0	Features	1

Metric	Value
wmc	32
c	7
b	0
f	1
lcom	1
cbo	3
dl	0
loc	234
rs	9.6

13 Methods

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

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

		$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
	 *
	 * If the partially created backup exists then delete it.
	 *
	 * @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( '', array( $message ), false );

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

humanmade / backupwordpress

GitHub Access Token became invalid

Pull Request — master (#1025)

Backup_Status A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

13 Methods

Duplication Side-by-Side

Filter issues like