CloudAssetsFullCheckTask - Code Metrics - markguinn/silverstripe-cloudassets - Measure and Improve Code Quality continuously with Scrutinizer

CloudAssetsFullCheckTask A
last analyzed 2018-09-25 15:47 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

Metric	Value
wmc	22
lcom	1
cbo	7
dl	0
loc	103
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	run()	0	35	10
C	processFile()	0	50	12

<?php
/**
 * Does a full status check on every file AND thumbnail/formatted/generated file.
 * Checks the following cases:
 *
 * 1. Local file doesn't exist                          -> downloads from cloud
 * 2. Local file is a placeholder but KeepLocal is true -> downloads from cloud
 * 3. Remote file is a placeholder but local in tact    -> clears status and re-uploads
 * 4. Meta data is missing                              -> restores meta
 * 5. Both remote and local are missing or corrupt      -> deletes if thumbnail, flags if not (writes to missing_files.csv)
 * 6. Local needs to be wrapped or uploaded             -> uploads as normal (via updateCloudStatus)
 *
 * @author Mark Guinn <[email protected]>
 * @date 02.06.2014
 * @package cloudassets
 * @subpackage tasks
 */
class CloudAssetsFullCheckTask extends BuildTask
{
	protected $title = 'Cloud Assets: Full Health Check';
	protected $description = 'Does a full status check on every file AND thumbnail/formatted/generated file.';

	protected $missing; // file handle


	/**
	 * @param $request
	 */
	public function run($request) {
		$buckets   = Config::inst()->get('CloudAssets', 'map');
		$start     = (int)$request->requestVar('start');
		$limit     = (int)$request->requestVar('limit');
		$path      = $request->requestVar('path');

		foreach ($buckets as $basePath => $cfg) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			if (!empty($path) && $basePath != $path) continue;
			echo "Processing $basePath...\n";
			$baseQuery = File::get()->filter('Filename:StartsWith', ltrim($basePath, '/'));
			$total     = $baseQuery->count();
			if ($start && !$limit) $limit = $total;
			if ($limit) $baseQuery = $baseQuery->limit($limit, $start);
			$query     = $baseQuery->dataQuery()->query()->execute();
			foreach ($query as $i => $row) {
				$class = $row['ClassName'];
				$file  = new $class($row);
				echo ($i+$start) . "/$total: " . $file->Filename;

				$this->processFile($file);

				if ($file instanceof CloudImage) {
					foreach ($file->DerivedImages() as $thumbStore) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
						$thumb = $thumbStore->getCloudImageCached();
						echo "\n   DERIVED: " . $thumb->Filename;
						$this->processFile($thumb);
					}
				}

				echo "\n";
			}
		}

		echo "done\n\n";
	}


	/**
	 * @param File $file
	 */
	protected function processFile(File $file) {
		$placeholder = Config::inst()->get('CloudAssets', 'file_placeholder');

		// 6. Local needs to be wrapped or uploaded             -> uploads as normal (via updateCloudStatus)
		$file->updateCloudStatus();

		$bucket = $file->getCloudBucket();
		if ($bucket && $bucket->hasMethod('getFileSize')) {
			$size = $bucket->getFileSize($file);

			// if the size matches the placeholder, go ahead and check the actual contents
			if ($size === strlen($placeholder)) {
				echo " Remote placeholder!";
				$content = $bucket->getContents($file);
				if ($content === $placeholder) $size = -1;
			}

			if ($size < 0) {
				if ($file->isLocalMissing()) {
					// 5. Both remote and local are missing or corrupt      -> deletes if thumbnail, flags if not (writes to missing_files.csv)
					if ($file instanceof CloudImageCached) {
						echo " Corrupted thumbnail deleted";
						$file->delete();
						return;
					} else {
						if (!isset($this->missing)) $this->missing = fopen(BASE_PATH . '/missing_files.csv', 'a');
						fputcsv($this->missing, array(date('Y-m-d H:i:s'), $file->ID, $file->Filename));
						echo " Corrupted in both locations!!!";
						return;
					}
				} else {
					// 3. Remote file is a placeholder but local in tact    -> clears status and re-uploads
					$file->CloudStatus = 'Local';
					$file->updateCloudStatus();
				}
			}
		}

		// 1. Local file doesn't exist                          -> downloads from cloud
		// 2. Local file is a placeholder but KeepLocal is true -> downloads from cloud
		$file->createLocalIfNeeded();

		// 4. Meta data is missing                              -> restores meta
		if ($file instanceof CloudImage && !$file->getCloudMeta('Dimensions')) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
			echo " Missing metadata!";
			if ($file->isLocalMissing()) $file->downloadFromCloud();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
			$file->setCloudMeta('Dimensions', $file->getDimensions('live'));
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
			$file->write();
		}
	}

}

1			<?php
2			/**
3			* Does a full status check on every file AND thumbnail/formatted/generated file.
4			* Checks the following cases:
5			*
6			* 1. Local file doesn't exist -> downloads from cloud
7			* 2. Local file is a placeholder but KeepLocal is true -> downloads from cloud
8			* 3. Remote file is a placeholder but local in tact -> clears status and re-uploads
9			* 4. Meta data is missing -> restores meta
10			* 5. Both remote and local are missing or corrupt -> deletes if thumbnail, flags if not (writes to missing_files.csv)
11			* 6. Local needs to be wrapped or uploaded -> uploads as normal (via updateCloudStatus)
12			*
13			* @author Mark Guinn <[email protected]>
14			* @date 02.06.2014
15			* @package cloudassets
16			* @subpackage tasks
17			*/
18			class CloudAssetsFullCheckTask extends BuildTask
19			{
20			protected $title = 'Cloud Assets: Full Health Check';
21			protected $description = 'Does a full status check on every file AND thumbnail/formatted/generated file.';
22
23			protected $missing; // file handle
24
25
26			/**
27			* @param $request
28			*/
29			public function run($request) {
30			$buckets = Config::inst()->get('CloudAssets', 'map');
31			$start = (int)$request->requestVar('start');
32			$limit = (int)$request->requestVar('limit');
33			$path = $request->requestVar('path');
34
35			foreach ($buckets as $basePath => $cfg) {
			0 ignored issues – show Bug introduced 2015-12-17 04:10 UTC by Report Bug Copy Issue Report The expression `$buckets` of type `array\|integer\|double\|string\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
36			if (!empty($path) && $basePath != $path) continue;
37			echo "Processing $basePath...\n";
38			$baseQuery = File::get()->filter('Filename:StartsWith', ltrim($basePath, '/'));
39			$total = $baseQuery->count();
40			if ($start && !$limit) $limit = $total;
41			if ($limit) $baseQuery = $baseQuery->limit($limit, $start);
42			$query = $baseQuery->dataQuery()->query()->execute();
43			foreach ($query as $i => $row) {
44			$class = $row['ClassName'];
45			$file = new $class($row);
46			echo ($i+$start) . "/$total: " . $file->Filename;
47
48			$this->processFile($file);
49
50			if ($file instanceof CloudImage) {
51			foreach ($file->DerivedImages() as $thumbStore) {
			0 ignored issues – show Documentation Bug introduced 2015-12-17 04:10 UTC by Report Bug Copy Issue Report The method `DerivedImages` does not exist on `object<CloudImage>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
52			$thumb = $thumbStore->getCloudImageCached();
53			echo "\n DERIVED: " . $thumb->Filename;
54			$this->processFile($thumb);
55			}
56			}
57
58			echo "\n";
59			}
60			}
61
62			echo "done\n\n";
63			}
64
65
66			/**
67			* @param File $file
68			*/
69			protected function processFile(File $file) {
70			$placeholder = Config::inst()->get('CloudAssets', 'file_placeholder');
71
72			// 6. Local needs to be wrapped or uploaded -> uploads as normal (via updateCloudStatus)
73			$file->updateCloudStatus();
74
75			$bucket = $file->getCloudBucket();
76			if ($bucket && $bucket->hasMethod('getFileSize')) {
77			$size = $bucket->getFileSize($file);
78
79			// if the size matches the placeholder, go ahead and check the actual contents
80			if ($size === strlen($placeholder)) {
81			echo " Remote placeholder!";
82			$content = $bucket->getContents($file);
83			if ($content === $placeholder) $size = -1;
84			}
85
86			if ($size < 0) {
87			if ($file->isLocalMissing()) {
88			// 5. Both remote and local are missing or corrupt -> deletes if thumbnail, flags if not (writes to missing_files.csv)
89			if ($file instanceof CloudImageCached) {
90			echo " Corrupted thumbnail deleted";
91			$file->delete();
92			return;
93			} else {
94			if (!isset($this->missing)) $this->missing = fopen(BASE_PATH . '/missing_files.csv', 'a');
95			fputcsv($this->missing, array(date('Y-m-d H:i:s'), $file->ID, $file->Filename));
96			echo " Corrupted in both locations!!!";
97			return;
98			}
99			} else {
100			// 3. Remote file is a placeholder but local in tact -> clears status and re-uploads
101			$file->CloudStatus = 'Local';
102			$file->updateCloudStatus();
103			}
104			}
105			}
106
107			// 1. Local file doesn't exist -> downloads from cloud
108			// 2. Local file is a placeholder but KeepLocal is true -> downloads from cloud
109			$file->createLocalIfNeeded();
110
111			// 4. Meta data is missing -> restores meta
112			if ($file instanceof CloudImage && !$file->getCloudMeta('Dimensions')) {
			0 ignored issues – show Documentation Bug introduced 2015-12-17 04:10 UTC by Report Bug Copy Issue Report The method `getCloudMeta` does not exist on `object<CloudImage>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
113			echo " Missing metadata!";
114			if ($file->isLocalMissing()) $file->downloadFromCloud();
			0 ignored issues – show Documentation Bug introduced 2015-12-17 04:10 UTC by Report Bug Copy Issue Report The method `downloadFromCloud` does not exist on `object<CloudImage>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() / class SomeClass extends ParentClass { } Loading history... Documentation Bug introduced 2015-12-17 04:10 UTC by Report Bug Copy Issue Report The method `isLocalMissing` does not exist on `object<CloudImage>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /* * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
115			$file->setCloudMeta('Dimensions', $file->getDimensions('live'));
			0 ignored issues – show Documentation Bug introduced 2015-12-17 04:10 UTC by Report Bug Copy Issue Report The method `setCloudMeta` does not exist on `object<CloudImage>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
116			$file->write();
117			}
118			}
119
120			}

markguinn / silverstripe-cloudassets

CloudAssetsFullCheckTask A last analyzed 2018-09-25 15:47 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like

CloudAssetsFullCheckTask A
last analyzed 2018-09-25 15:47 UTC