DownloadController::getFeed() - Code Metrics - Inspection of "[WIP] Stabilization" - owncloud/updater - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#222)

by Victor

created 2016-02-06 10:37 UTC

DownloadController::getFeed() A

↳ Parent: DownloadController

Complexity

Conditions	3
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	3.1406

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	3
cts	4
cp	0.75
rs	9.4285
cc	3
eloc	4
nc	2
nop	1
crap	3.1406

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

use Owncloud\Updater\Utils\Fetcher;
use Owncloud\Updater\Utils\Registry;
use Owncloud\Updater\Utils\FilesystemHelper;

class DownloadController {
	
	/**
	 * @var Fetcher 
	 */
	protected $fetcher;

	/**
	 * @var Registry
	 */
	protected $registry;

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

	public function __construct(Fetcher $fetcher, Registry $registry, FilesystemHelper $fsHelper){
		$this->fetcher = $fetcher;
		$this->registry = $registry;
		$this->fsHelper = $fsHelper;
	}

	public function checkFeed(){
		$response = $this->getDefaultResponse();
		try {
			$feed = $this->fetcher->getFeed();
			$response['success'] = true;
			$response['data']['feed'] = $feed;
		} catch (\Exception $e){
			$response['exception'] = $e;
		}

		return $response;
	}

	public function downloadOwncloud($progressCallback = null){
		$response = $this->getDefaultResponse();
		if (is_null($progressCallback)){
			$progressCallback = function (){};
		}
		try {
			$feed = $this->getFeed();
			$path = $this->fetcher->getBaseDownloadPath($feed);
			// Fixme: Daily channel has no checksum
			$isDailyChannel = $this->fetcher->getUpdateChannel() == 'daily';
			if (!$isDailyChannel){
				$md5 = $this->fetcher->getMd5($feed);
			} else {
				// We can't check md5 so we don't trust the cache
				$this->fsHelper->removeIfExists($path);
			}
			if ($isDailyChannel || !$this->checkIntegrity($path, $md5)){
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
				$this->fetcher->getOwncloud($feed, $progressCallback);
			}

			if ($isDailyChannel || $this->checkIntegrity($path, $md5)){
				$response['success'] = true;
				$response['data']['path'] = $path;
			} else {
				$response['exception'] = new \Exception('Deleted ' . $feed->getDownloadedFileName() . ' due to wrong checksum');
			}
		} catch (\Exception $e) {
			if (isset($path)){
				$this->fsHelper->removeIfExists($path);
			}
			$response['exception'] = $e;
		}
		return $response;
	}

	/**
	 * Check if package is not corrupted on download
	 * @param string $path
	 * @param string $md5
	 * @return boolean
	 */
	protected function checkIntegrity($path, $md5){
			$fileExists = $this->fsHelper->fileExists($path);
			$checksumMatch = $md5 === $this->fsHelper->md5File($path);
			if ($fileExists && !$checksumMatch){
				$this->fsHelper->removeIfExists($path);
				$fileExists = false;
			}
			return $fileExists;
	}

	/**
	 * Get a Feed instance
	 * @param bool $useCache
	 * @return \Owncloud\Updater\Utils\Feed
	 */
	protected function getFeed($useCache = true){
		if ($useCache && !is_null($this->registry->get('feed'))){
			return $this->registry->get('feed');
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());
}
		}
		return $this->fetcher->getFeed();
	}

	/**
	 * Init response array
	 * @return array
	 */
	protected function getDefaultResponse(){
		return [
			'success' => false,
			'exception' => '',
			'details' => '',
			'data' => []
		];
	}
}


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\Controller;
23
24		use Owncloud\Updater\Utils\Fetcher;
25		use Owncloud\Updater\Utils\Registry;
26		use Owncloud\Updater\Utils\FilesystemHelper;
27
28		class DownloadController {
29
30		/**
31		* @var Fetcher
32		*/
33		protected $fetcher;
34
35		/**
36		* @var Registry
37		*/
38		protected $registry;
39
40		/**
41		* @var FilesystemHelper
42		*/
43		protected $fsHelper;
44
45	4	public function __construct(Fetcher $fetcher, Registry $registry, FilesystemHelper $fsHelper){
46	4	$this->fetcher = $fetcher;
47	4	$this->registry = $registry;
48	4	$this->fsHelper = $fsHelper;
49	4	}
50
51	2	public function checkFeed(){
52	2	$response = $this->getDefaultResponse();
53		try {
54	2	$feed = $this->fetcher->getFeed();
55	1	$response['success'] = true;
56	1	$response['data']['feed'] = $feed;
57	2	} catch (\Exception $e){
58	1	$response['exception'] = $e;
59		}
60
61	2	return $response;
62		}
63
64	2	public function downloadOwncloud($progressCallback = null){
65	2	$response = $this->getDefaultResponse();
66	2	if (is_null($progressCallback)){
67		$progressCallback = function (){};
68	2	}
69		try {
70	2	$feed = $this->getFeed();
71	2	$path = $this->fetcher->getBaseDownloadPath($feed);
72		// Fixme: Daily channel has no checksum
73	2	$isDailyChannel = $this->fetcher->getUpdateChannel() == 'daily';
74	2	if (!$isDailyChannel){
75	2	$md5 = $this->fetcher->getMd5($feed);
76	2	} else {
77		// We can't check md5 so we don't trust the cache
78		$this->fsHelper->removeIfExists($path);
79		}
80	2	if ($isDailyChannel \|\| !$this->checkIntegrity($path, $md5)){
		0 ignored issues – show Bug introduced 2016-01-30 15:52 UTC by Report Bug Copy Issue Report The variable `$md5` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
81	1	$this->fetcher->getOwncloud($feed, $progressCallback);
82		}
83
84	1	if ($isDailyChannel \|\| $this->checkIntegrity($path, $md5)){
85	1	$response['success'] = true;
86	1	$response['data']['path'] = $path;
87	1	} else {
88		$response['exception'] = new \Exception('Deleted ' . $feed->getDownloadedFileName() . ' due to wrong checksum');
89		}
90	2	} catch (\Exception $e) {
91	1	if (isset($path)){
92	1	$this->fsHelper->removeIfExists($path);
93	1	}
94	1	$response['exception'] = $e;
95		}
96	2	return $response;
97		}
98
99		/**
100		* Check if package is not corrupted on download
101		* @param string $path
102		* @param string $md5
103		* @return boolean
104		*/
105	2	protected function checkIntegrity($path, $md5){
106	2	$fileExists = $this->fsHelper->fileExists($path);
107	2	$checksumMatch = $md5 === $this->fsHelper->md5File($path);
108	2	if ($fileExists && !$checksumMatch){
109	1	$this->fsHelper->removeIfExists($path);
110	1	$fileExists = false;
111	1	}
112	2	return $fileExists;
113		}
114
115		/**
116		* Get a Feed instance
117		* @param bool $useCache
118		* @return \Owncloud\Updater\Utils\Feed
119		*/
120	2	protected function getFeed($useCache = true){
121	2	if ($useCache && !is_null($this->registry->get('feed'))){
122	2	return $this->registry->get('feed');
		0 ignored issues – show Bug Best Practice introduced 2016-02-06 10:30 UTC by Report Bug Copy Issue Report The return type of `return $this->registry->get('feed');` (`object\|integer\|double\|string\|array\|boolean`) is incompatible with the return type documented by `Owncloud\Updater\Control...loadController::getFeed` of type `Owncloud\Updater\Utils\Feed`. 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...
123		}
124		return $this->fetcher->getFeed();
125		}
126
127		/**
128		* Init response array
129		* @return array
130		*/
131	4	protected function getDefaultResponse(){
132		return [
133	4	'success' => false,
134	4	'exception' => '',
135	4	'details' => '',
136	4	'data' => []
137	4	];
138		}
139		}
140

owncloud / updater

Pull Request — master (#222)

DownloadController::getFeed() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like