Backup_Status::set_status_callback() - 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-09 22:04 UTC

Backup_Status::set_status_callback() A

↳ Parent: Backup_Status

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	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;
	}

	/**
	 * 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() );
	}

	/**
	 * 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			}
34
35			/**
36			* Start the tracking a backup process.
37			*
38			* This creates a backup running file and issues a file lock. This prevents duplicate
39			* instances of this backup process running concurrently and allows us to detect if
40			* the PHP thread running the process is killed as that will clear the lock.
41			*
42			* @param string $backup_filename The filename for the backup file that we're tracking
43			* @param string $status_message The initial status for the backup process
44			*
45			* @return boolean Whether the backup process was success marked as started
46			*/
47			public function start( $backup_filename, $status_message ) {
48			$this->filename = $backup_filename;
49
50			$this->lock_handler = new LockHandler( basename( $this->get_status_filepath() ), Path::get_path() );
51
52			if ( ! $this->lock_handler->lock() \|\| $this->get_status() ) {
53			return false;
54			}
55
56			return $this->set_status( $status_message );
57			}
58
59			/**
60			* Mark a backup process as finished.
61			*
62			* This removes the file lock and deletes the running file.
63			*/
64			public function finish() {
65
66			if ( isset( $this->lock_handler ) && is_a( $this->lock_handler, 'LockHandler' ) ) {
67			$this->lock_handler->release();
68			}
69
70			// Delete the backup running file
71			if ( file_exists( $this->get_status_filepath() ) ) {
72			return unlink( $this->get_status_filepath() );
73			}
74
75			return false;
76			}
77
78			/**
79			* Check if the backup has been started by checking if the runnign file
80			* exists.
81			*
82			* @return boolean Whether the backup process has been started
83			*/
84			public function is_started() {
85			return (bool) file_exists( $this->get_status_filepath() );
86			}
87
88			public function is_running() {
89
90			if ( ! $this->is_started() ) {
91			return false;
92			}
93
94			// If we're in the same thread then we know we must be running if the running file exists
95			if ( is_a( $this->lock_handler, 'LockHandler' ) ) {
96			return $this->is_started();
97			}
98
99			$lock_handler = new LockHandler( basename( $this->get_status_filepath() ), Path::get_path() );
100
101			return ! $lock_handler->lock();
102			}
103
104			/**
105			* If the running file exists but isn't locked then the thread that
106			* the backup process is running in must have been killed.
107			*
108			* You should only be running this command from a separate thread
109			*
110			* @return boolean Whether the backup process has crashed or not
111			*/
112			public function has_crashed() {
113			return ( $this->is_started() && ! $this->is_running() );
114			}
115
116			/**
117			* Get the filepath for the backup file we're tracking
118			*
119			* @return string The path to the backup file
120			*/
121			public function get_backup_filename() {
122
123			if ( $this->is_started() ) {
124			$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
125
126			if ( ! empty( $status->filename ) ) {
127			$this->filename = $status->filename;
128			}
129			}
130
131			return $this->filename;
132			}
133
134			/**
135			* Get the status of the running backup.
136			*
137			* @return string
138			*/
139			public function get_status() {
140
141			if ( ! file_exists( $this->get_status_filepath() ) ) {
142			return false;
			0 ignored issues – show Bug Best Practice introduced 2016-03-09 22:06 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...
143			}
144
145			$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
146
147			if ( ! empty( $status->status ) ) {
148			return $status->status;
149			}
150
151			return false;
			0 ignored issues – show Bug Best Practice introduced 2016-03-09 22:06 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...
152
153			}
154
155			/**
156			* Set the status of the running backup
157			*
158			* @param string $message
159			*
160			* @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...
161			*/
162			public function set_status( $message ) {
163
164			if ( is_callable( $this->callback ) ) {
165			call_user_func( $this->callback, $message );
166			}
167
168			// If start hasn't been called yet then we wont' have a backup filename
169			if ( ! $this->filename ) {
170			return false;
171			}
172
173			$status = json_encode( (object) array(
174			'filename' => $this->filename,
175			'started' => $this->get_start_time(),
176			'status' => $message,
177			) );
178
179			return (bool) file_put_contents( $this->get_status_filepath(), $status );
180
181			}
182
183			/**
184			* Get the time that the current running backup was started
185			*
186			* @return int $timestamp
187			*/
188			public function get_start_time() {
189
190			if ( ! file_exists( $this->get_status_filepath() ) ) {
191			return 0;
192			}
193
194			$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
195
196			if ( ! empty( $status->started ) && (int) (string) $status->started === $status->started ) {
197			return $status->started;
198			}
199
200			return time();
201
202			}
203
204			/**
205			* Get the path to the backup running file that stores the running backup status
206			*
207			* @return string
208			*/
209			public function get_status_filepath() {
210			return Path::get_path() . '/.backup-' . $this->id . '-running';
211			}
212
213			public function set_status_callback( $callback ) {
214			$this->callback = $callback;
215			}
216			}
217

humanmade / backupwordpress

GitHub Access Token became invalid

Pull Request — master (#1025)

Backup_Status::set_status_callback() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like