Checkpoint::checkpointExists() - Code Metrics - Inspection of "Removing checkpoints (inc. removal after restore)" - owncloud/updater - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#276)

by Victor

created 2016-03-11 17:01 UTC

Checkpoint::checkpointExists() A

↳ Parent: Checkpoint

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	3
ccs	0
cts	2
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	2

<?php
/**
 * @author Victor Dubiniuk <[email protected]>
 *
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace Owncloud\Updater\Utils;

use Owncloud\Updater\Console\Application;
use Owncloud\Updater\Utils\FilesystemHelper;
use Owncloud\Updater\Utils\Locator;

class Checkpoint {

	const CORE_DIR = 'core';
	const THIRDPARTY_DIR = '3rdparty';
	const APP_DIR = 'apps';

	/**
	 * @var Locator $locator
	 */
	protected $locator;

	/**
	 * @var Filesystemhelper $fsHelper
	 */
	protected $fsHelper;

	/**
	 *
	 * @param Locator $locator
	 * @param FilesystemHelper $fsHelper
	 */
	public function __construct(Locator $locator, FilesystemHelper $fsHelper){
		$this->locator = $locator;
		$this->fsHelper = $fsHelper;
	}

	/**
	 * Creates a checkpoint
	 * @return string
	 * @throws Exception if base checkpoint directory is not writable
	 */
	public function create(){
		$checkpointName = $this->createCheckpointId();
		$checkpointPath = $this->getCheckpointPath($checkpointName);
		try{
			if (!$this->fsHelper->isWritable($this->locator->getCheckpointDir())){
				throw new \Exception($this->locator->getCheckpointDir() . ' is not writable.');
			}
			$this->fsHelper->mkdir($checkpointPath);

			$checkpointCorePath = $checkpointPath . '/' . self::CORE_DIR;
			$this->fsHelper->mkdir($checkpointCorePath);
			$core = $this->locator->getRootDirItems();
			foreach ($core as $coreItem){
				$cpItemPath = $checkpointCorePath . '/' . basename($coreItem);
				$this->fsHelper->copyr($coreItem, $cpItemPath, true);
			}
			//copy config.php
			$configDirSrc = $this->locator->getOwncloudRootPath() . '/config';
			$configDirDst = $checkpointCorePath . '/config';
			$this->fsHelper->copyr($configDirSrc, $configDirDst, true);

			//copy 3rdparty
			$this->fsHelper->copyr($this->locator->getOwncloudRootPath() . '/' . self::THIRDPARTY_DIR, $checkpointCorePath . '/' . self::THIRDPARTY_DIR, true);

			$checkpointAppPath = $checkpointPath . '/' . self::APP_DIR;
			$this->fsHelper->mkdir($checkpointAppPath);
			$appManager = Application::$container['utils.appmanager'];
			$apps = $appManager->getAllApps();
			foreach ($apps as $appId){
				$appPath = $appManager->getAppPath($appId);
				if ($appPath){
					$this->fsHelper->copyr($appPath, $checkpointAppPath . '/' . $appId, true);
				}
			}

		} catch (\Exception $e){
			$application = Application::$container['application'];
			$application->getLogger()->error($e->getMessage());
			$this->fsHelper->removeIfExists($checkpointPath);
			throw $e;
		}
		return $checkpointName;
	}

	/**
	 * Restore a checkpoint by id
	 * @param string $checkpointId id of checkpoint
	 * @return array
	 * @throws UnexpectedValueException if there is no checkpoint with this id
	 */
	public function restore($checkpointId){
		$this->assertCheckpointExists($checkpointId);
		$checkpointDir = $this->locator->getCheckpointDir() . '/' . $checkpointId;
		$ocRoot = $this->locator->getOwncloudRootPath();
		$this->fsHelper->copyr($checkpointDir . '/' . self::CORE_DIR, $ocRoot, false);
		$this->fsHelper->copyr($checkpointDir . '/' . self::APP_DIR, $ocRoot . '/' . self::APP_DIR, false);
	}

	/**
	 * Remove a checkpoint by id
	 * @param string $checkpointId id of checkpoint
	 * @return array
	 * @throws UnexpectedValueException if there is no checkpoint with this id
	 */
	public function remove($checkpointId){
		$this->assertCheckpointExists($checkpointId);
		$checkpointPath = $this->getCheckpointPath($checkpointId);
		$this->fsHelper->removeIfExists($checkpointPath);
	}

	/**
	 * Return all checkpoints as an array of items [ 'title', 'date' ]
	 * @return array
	 */
	public function getAll(){
		$checkpoints = [];
		foreach ($this->getAllCheckpointIds() as $dir){
			$checkpoints[] = [
				'title' => $dir,
				'date' => date(
					"F d Y H:i", 
					$this->fsHelper->filemtime(
						$this->locator->getCheckpointDir() . '/' . $dir
					)
				)
			];
		}
		return $checkpoints;
	}

	/**
	 * Check if there is a checkpoint with a given id
	 * @param string $checkpointId id of checkpoint
	 * @return bool
	 */
	public function checkpointExists($checkpointId){
		return in_array($checkpointId, $this->getAllCheckpointIds());
	}

	/**
	 * Return array of all checkpoint ids
	 * @param string $checkpointId id of checkpoint
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @return array
	 */
	protected function getAllCheckpointIds(){
		$checkpointDir = $this->locator->getCheckpointDir();
		$content = $this->fsHelper->isDir($checkpointDir) ? $this->fsHelper->scandir($checkpointDir) : [];
		$checkpoints = array_filter(
 			$content,
 			function($dir){
 				$checkpointPath = $this->getCheckpointPath($dir);
 				return !in_array($dir, ['.', '..']) && $this->fsHelper->isDir($checkpointPath);
 			}
 		);
 		return $checkpoints;
	}

	/**
	 * Create an unique checkpoint id
	 * @param string $checkpointId id of checkpoint
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @return string
	 */
	protected function createCheckpointId(){
		$versionString = implode('.', $this->locator->getInstalledVersion());
		return uniqid($versionString . '-');
	}

	/**
	 * Get an absolute path to the checkpoint directory by checkpoint Id
	 * @param string $checkpointId id of checkpoint
	 * @return string
	 */
	protected function getCheckpointPath($checkpointId){
		return $this->locator->getCheckpointDir() . '/' . $checkpointId;
	}

	/**
	 * Produce an error on non-existing checkpoints
	 * @param string $checkpointId id of checkpoint
	 * @throws UnexpectedValueException if there is no checkpoint with this id
	 */
	private function assertCheckpointExists($checkpointId){
		if (!$this->checkpointExists($checkpointId) || $checkpointId === ''){
			$message = sprintf('Checkpoint %s does not exist.', $checkpointId);
			throw new \UnexpectedValueException($message);
		}
	}
}


1		<?php
2		/**
3		* @author Victor Dubiniuk <[email protected]>
4		*
5		* @copyright Copyright (c) 2015, ownCloud, Inc.
6		* @license AGPL-3.0
7		*
8		* This code is free software: you can redistribute it and/or modify
9		* it under the terms of the GNU Affero General Public License, version 3,
10		* as published by the Free Software Foundation.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU Affero General Public License for more details.
16		*
17		* You should have received a copy of the GNU Affero General Public License, version 3,
18		* along with this program. If not, see <http://www.gnu.org/licenses/>
19		*
20		*/
21
22		namespace Owncloud\Updater\Utils;
23
24		use Owncloud\Updater\Console\Application;
25		use Owncloud\Updater\Utils\FilesystemHelper;
26		use Owncloud\Updater\Utils\Locator;
27
28		class Checkpoint {
29
30		const CORE_DIR = 'core';
31		const THIRDPARTY_DIR = '3rdparty';
32		const APP_DIR = 'apps';
33
34		/**
35		* @var Locator $locator
36		*/
37		protected $locator;
38
39		/**
40		* @var Filesystemhelper $fsHelper
41		*/
42		protected $fsHelper;
43
44		/**
45		*
46		* @param Locator $locator
47		* @param FilesystemHelper $fsHelper
48		*/
49	2	public function __construct(Locator $locator, FilesystemHelper $fsHelper){
50	2	$this->locator = $locator;
51	2	$this->fsHelper = $fsHelper;
52	2	}
53
54		/**
55		* Creates a checkpoint
56		* @return string
57		* @throws Exception if base checkpoint directory is not writable
58		*/
59		public function create(){
60		$checkpointName = $this->createCheckpointId();
61		$checkpointPath = $this->getCheckpointPath($checkpointName);
62		try{
63		if (!$this->fsHelper->isWritable($this->locator->getCheckpointDir())){
64		throw new \Exception($this->locator->getCheckpointDir() . ' is not writable.');
65		}
66		$this->fsHelper->mkdir($checkpointPath);
67
68		$checkpointCorePath = $checkpointPath . '/' . self::CORE_DIR;
69		$this->fsHelper->mkdir($checkpointCorePath);
70		$core = $this->locator->getRootDirItems();
71		foreach ($core as $coreItem){
72		$cpItemPath = $checkpointCorePath . '/' . basename($coreItem);
73		$this->fsHelper->copyr($coreItem, $cpItemPath, true);
74		}
75		//copy config.php
76		$configDirSrc = $this->locator->getOwncloudRootPath() . '/config';
77		$configDirDst = $checkpointCorePath . '/config';
78		$this->fsHelper->copyr($configDirSrc, $configDirDst, true);
79
80		//copy 3rdparty
81		$this->fsHelper->copyr($this->locator->getOwncloudRootPath() . '/' . self::THIRDPARTY_DIR, $checkpointCorePath . '/' . self::THIRDPARTY_DIR, true);
82
83		$checkpointAppPath = $checkpointPath . '/' . self::APP_DIR;
84		$this->fsHelper->mkdir($checkpointAppPath);
85		$appManager = Application::$container['utils.appmanager'];
86		$apps = $appManager->getAllApps();
87		foreach ($apps as $appId){
88		$appPath = $appManager->getAppPath($appId);
89		if ($appPath){
90		$this->fsHelper->copyr($appPath, $checkpointAppPath . '/' . $appId, true);
91		}
92		}
93
94		} catch (\Exception $e){
95		$application = Application::$container['application'];
96		$application->getLogger()->error($e->getMessage());
97		$this->fsHelper->removeIfExists($checkpointPath);
98		throw $e;
99		}
100		return $checkpointName;
101		}
102
103		/**
104		* Restore a checkpoint by id
105		* @param string $checkpointId id of checkpoint
106		* @return array
107		* @throws UnexpectedValueException if there is no checkpoint with this id
108		*/
109		public function restore($checkpointId){
110		$this->assertCheckpointExists($checkpointId);
111		$checkpointDir = $this->locator->getCheckpointDir() . '/' . $checkpointId;
112		$ocRoot = $this->locator->getOwncloudRootPath();
113		$this->fsHelper->copyr($checkpointDir . '/' . self::CORE_DIR, $ocRoot, false);
114		$this->fsHelper->copyr($checkpointDir . '/' . self::APP_DIR, $ocRoot . '/' . self::APP_DIR, false);
115		}
116
117		/**
118		* Remove a checkpoint by id
119		* @param string $checkpointId id of checkpoint
120		* @return array
121		* @throws UnexpectedValueException if there is no checkpoint with this id
122		*/
123		public function remove($checkpointId){
124		$this->assertCheckpointExists($checkpointId);
125		$checkpointPath = $this->getCheckpointPath($checkpointId);
126		$this->fsHelper->removeIfExists($checkpointPath);
127		}
128
129		/**
130		* Return all checkpoints as an array of items [ 'title', 'date' ]
131		* @return array
132		*/
133	2	public function getAll(){
134	2	$checkpoints = [];
135	2	foreach ($this->getAllCheckpointIds() as $dir){
136	1	$checkpoints[] = [
137	1	'title' => $dir,
138	1	'date' => date(
139	1	"F d Y H:i",
140	1	$this->fsHelper->filemtime(
141	1	$this->locator->getCheckpointDir() . '/' . $dir
142	1	)
143	1	)
144	1	];
145	2	}
146	2	return $checkpoints;
147		}
148
149		/**
150		* Check if there is a checkpoint with a given id
151		* @param string $checkpointId id of checkpoint
152		* @return bool
153		*/
154		public function checkpointExists($checkpointId){
155		return in_array($checkpointId, $this->getAllCheckpointIds());
156		}
157
158		/**
159		* Return array of all checkpoint ids
160		* @param string $checkpointId id of checkpoint
		0 ignored issues – show Bug introduced 2016-03-11 17:03 UTC by Report Bug Copy Issue Report There is no parameter named `$checkpointId`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
161		* @return array
162		*/
163	2	protected function getAllCheckpointIds(){
164	2	$checkpointDir = $this->locator->getCheckpointDir();
165	2	$content = $this->fsHelper->isDir($checkpointDir) ? $this->fsHelper->scandir($checkpointDir) : [];
166	2	$checkpoints = array_filter(
167	2	$content,
168	1	function($dir){
169	1	$checkpointPath = $this->getCheckpointPath($dir);
170	1	return !in_array($dir, ['.', '..']) && $this->fsHelper->isDir($checkpointPath);
171		}
172	2	);
173	2	return $checkpoints;
174		}
175
176		/**
177		* Create an unique checkpoint id
178		* @param string $checkpointId id of checkpoint
		0 ignored issues – show Bug introduced 2016-03-11 17:03 UTC by Report Bug Copy Issue Report There is no parameter named `$checkpointId`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
179		* @return string
180		*/
181		protected function createCheckpointId(){
182		$versionString = implode('.', $this->locator->getInstalledVersion());
183		return uniqid($versionString . '-');
184		}
185
186		/**
187		* Get an absolute path to the checkpoint directory by checkpoint Id
188		* @param string $checkpointId id of checkpoint
189		* @return string
190		*/
191	1	protected function getCheckpointPath($checkpointId){
192	1	return $this->locator->getCheckpointDir() . '/' . $checkpointId;
193		}
194
195		/**
196		* Produce an error on non-existing checkpoints
197		* @param string $checkpointId id of checkpoint
198		* @throws UnexpectedValueException if there is no checkpoint with this id
199		*/
200		private function assertCheckpointExists($checkpointId){
201		if (!$this->checkpointExists($checkpointId) \|\| $checkpointId === ''){
202		$message = sprintf('Checkpoint %s does not exist.', $checkpointId);
203		throw new \UnexpectedValueException($message);
204		}
205		}
206		}
207

owncloud / updater

Pull Request — master (#276)

Checkpoint::checkpointExists() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like