Tools::getPrice() - Code Metrics - MPOS/php-mpos - Measure and Improve Code Quality continuously with Scrutinizer

Tools::getPrice() D
last analyzed 2019-03-06 18:44 UTC

↳ Parent: Project

Complexity

Conditions	20
Paths	19

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	420

Importance

Changes

Metric	Value
dl	0
loc	63
ccs	0
cts	60
cp	0
rs	4.1666
c	0
b	0
f	0
cc	20
nc	19
nop	0
crap	420

How to fix Long Method Complexity

<?php
$defflip = (!cfip()) ? exit(header('HTTP/1.1 401 Unauthorized')) : 1;

/**
 * Helper class for our cronjobs
 * Implements some common cron tasks outside
 * the scope of our web application
 **/
class Tools extends Base {
  public function getOnlineVersions() {
    // Fetch version online, cache for a bit
    $key = $this->config['memcache']['keyprefix'] . 'ONLINE_VERSIONS';
class MyClass { }

$x = new MyClass();
$x->foo = true;
    if (! $mpos_versions = $this->memcache->get($key)) {
      $url = $this->config['version_url'];
      $curl = curl_init();
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($curl, CURLOPT_HEADER, false);
      $data = curl_exec($curl);
      preg_match('/define\(\'MPOS_VERSION\', \'(.*)\'\);/', $data, $match);
      $mpos_versions['MPOS_VERSION'] = @$match[1];
      preg_match('/define\(\'DB_VERSION\', \'(.*)\'\);/', $data, $match);
      $mpos_versions['DB_VERSION'] = @$match[1];
      preg_match('/define\(\'CONFIG_VERSION\', \'(.*)\'\);/', $data, $match);
      $mpos_versions['CONFIG_VERSION'] = @$match[1];
      curl_close($curl);
      return $this->memcache->setCache($key, $mpos_versions, 30);
class MyClass { }

$x = new MyClass();
$x->foo = true;
    } else {
      return $mpos_versions;
    }
  }
  /**
   * Fetch JSON data from an API
   * @param url string API URL
   * @param target string API method
   * @param auth array Optional authentication data to be sent with
   * @return dec array JSON decoded PHP array
   **/
  public function getApi($url, $target, $auth=NULL) {

    static $ch = null;
    static $ch = null;
    if (is_null($ch)) {
      $ch = curl_init();
      curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 30);
      curl_setopt($ch, CURLOPT_TIMEOUT, 30);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
      curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/4.0 (compatible; PHP client; '.php_uname('s').'; PHP/'.phpversion().')');
    }
    
    $url = rtrim($url, '/');
    $target = ltrim($target, '/');
    curl_setopt($ch, CURLOPT_URL, $url . '/' . $target);
    // curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);

    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);

    // run the query
    $res = curl_exec($ch);
    if ($res === false) {
      $this->setErrorMessage('Could not get reply: '.curl_error($ch));
      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());
}
    }
    $dec = json_decode($res, true);
    if (!$dec) {
      $this->setErrorMessage('Invalid data received, please make sure connection is working and requested API exists');
      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());
}
    }
    return $dec;
  }

  /**
   * Detect the API to properly extract information
   * @param url string API URL
   * @return data string API type
   **/
  private function getApiType($url) {
    if (preg_match('/coinchoose.com/', $url)) {
      return 'coinchoose';
    } else if (preg_match('/btc-e.nz/', $url)) {
      return 'btce';
    } else if (preg_match('/cryptopia.co.nz/', $url)) {
     return 'cryptopia';
    } else if (preg_match('/cryptorush.in/', $url)) {
      return 'cryptorush';
    } else if (preg_match('/mintpal.com/', $url)) {
      return 'mintpal';
    } else if (preg_match('/c-cex.com/', $url)) {
      return 'c-cex';
    } else if (preg_match('/bittrex.com/', $url)) {
      return 'bittrex';
    } else if (preg_match('/crypto-bridge.org/', $url)) {
      return 'cryptobridge';
    } else if (preg_match('/yobit.net/', $url)) {
      return 'yobit';
    } else if (preg_match('/binance.com/', $url)) {
      return 'binance';
    } else if (preg_match('/southxchange.com/', $url)) {
      return 'southxchange';
    } else if (preg_match('/mercatox.com/', $url)) {
      return 'mercatox';
    } else if (preg_match('/tradeogre.com/', $url)) {
      return 'tradeogre';
    }
    $this->setErrorMessage("API URL unknown");
    return false;
  }

  /**
   * Extract price information from API data
   **/
  public function getPrice() {
    $aData = $this->getApi($this->config['price']['url'], $this->config['price']['target']);
    $strBase = $this->config['currency'];
    $strQuote = $this->config['price']['currency'];
    // Check the API type for configured URL
    if (!$strApiType = $this->getApiType($this->config['price']['url']))
      return false;
    // if api data is valid, extract price depending on API type
    if (is_array($aData)) {
      switch ($strApiType) {
      	case 'coinchoose':
      	  foreach ($aData as $aItem) {
      	    if($strBase == $aItem[0])
      	      return $aItem['price'];
      	  }
      	  break;
      	case 'btce':
      	  return $aData['ticker']['last'];
      	  break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'cryptopia':
      	  return @$aData['Data']['LastPrice'];
      	  break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
      	case 'cryptorush':
      	  return @$aData["{$strBase}/{$strQuote}"]['last_trade'];
      	  break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
      	case 'mintpal':
      	  return @$aData['0']['last_price'];
      	  break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'c-cex':
          return @$aData['ticker']['lastprice'];
          break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
      	case 'bittrex':
      	  return @$aData['result']['Last'];
      	  break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'cryptobridge':
          foreach ($aData as $aItem) {
            if("{$strBase}_{$strQuote}" == $aItem['id'])
              return $aItem['last'];
          }
        case 'yobit':
          return @$aData[strtolower($strBase) . "_" . strtolower($strQuote)]['last'];
          break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'binance':
          return @$aData['price'];
          break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'southxchange':
          return @$aData['Last'];
          break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'mercatox':
          return @$aData['pairs']["{$strBase}_{$strQuote}"]['last'];
          break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'tradeogre':
          return @$aData['price'];
          break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
      }
    } else {
      $this->setErrorMessage("Got an invalid response from ticker API");
      return false;
    }
    // Catchall, we have no data extractor for this API url
    $this->setErrorMessage("Undefined API to getPrice() on URL " . $this->config['price']['url']);
    return false;
  }
}

$tools = new Tools();
$tools->setDebug($debug);
$tools->setConfig($config);
$tools->setMemcache($memcache);


1			<?php
2			$defflip = (!cfip()) ? exit(header('HTTP/1.1 401 Unauthorized')) : 1;
3
4			/**
5			* Helper class for our cronjobs
6			* Implements some common cron tasks outside
7			* the scope of our web application
8			**/
9			class Tools extends Base {
10			public function getOnlineVersions() {
11			// Fetch version online, cache for a bit
12			$key = $this->config['memcache']['keyprefix'] . 'ONLINE_VERSIONS';
			0 ignored issues – show Bug introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report The property `config` 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...
13			if (! $mpos_versions = $this->memcache->get($key)) {
14			$url = $this->config['version_url'];
15			$curl = curl_init();
16			curl_setopt($curl, CURLOPT_URL, $url);
17			curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
18			curl_setopt($curl, CURLOPT_HEADER, false);
19			$data = curl_exec($curl);
20			preg_match('/define\(\'MPOS_VERSION\', \'(.*)\'\);/', $data, $match);
21			$mpos_versions['MPOS_VERSION'] = @$match[1];
22			preg_match('/define\(\'DB_VERSION\', \'(.*)\'\);/', $data, $match);
23			$mpos_versions['DB_VERSION'] = @$match[1];
24			preg_match('/define\(\'CONFIG_VERSION\', \'(.*)\'\);/', $data, $match);
25			$mpos_versions['CONFIG_VERSION'] = @$match[1];
26			curl_close($curl);
27			return $this->memcache->setCache($key, $mpos_versions, 30);
			0 ignored issues – show Bug introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report The property `memcache` 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...
28			} else {
29			return $mpos_versions;
30			}
31			}
32			/**
33			* Fetch JSON data from an API
34			* @param url string API URL
35			* @param target string API method
36			* @param auth array Optional authentication data to be sent with
37			* @return dec array JSON decoded PHP array
38			**/
39			public function getApi($url, $target, $auth=NULL) {
			0 ignored issues – show Unused Code introduced 2017-08-29 19:23 UTC by Report Bug Copy Issue Report The parameter `$auth` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
40			static $ch = null;
41			static $ch = null;
42			if (is_null($ch)) {
43			$ch = curl_init();
44			curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 30);
45			curl_setopt($ch, CURLOPT_TIMEOUT, 30);
46			curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
47			curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
48			curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/4.0 (compatible; PHP client; '.php_uname('s').'; PHP/'.phpversion().')');
49			}
50
51			$url = rtrim($url, '/');
52			$target = ltrim($target, '/');
53			curl_setopt($ch, CURLOPT_URL, $url . '/' . $target);
54			// curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
55
56			curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
57
58			// run the query
59			$res = curl_exec($ch);
60			if ($res === false) {
61			$this->setErrorMessage('Could not get reply: '.curl_error($ch));
62			return false;
			0 ignored issues – show Bug Best Practice introduced 2015-12-14 13:34 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `Tools::getApi` of type `dec`. 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...
63			}
64			$dec = json_decode($res, true);
65			if (!$dec) {
66			$this->setErrorMessage('Invalid data received, please make sure connection is working and requested API exists');
67			return false;
			0 ignored issues – show Bug Best Practice introduced 2015-12-14 13:34 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `Tools::getApi` of type `dec`. 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...
68			}
69			return $dec;
70			}
71
72			/**
73			* Detect the API to properly extract information
74			* @param url string API URL
75			* @return data string API type
76			**/
77			private function getApiType($url) {
78			if (preg_match('/coinchoose.com/', $url)) {
79			return 'coinchoose';
80			} else if (preg_match('/btc-e.nz/', $url)) {
81			return 'btce';
82			} else if (preg_match('/cryptopia.co.nz/', $url)) {
83			return 'cryptopia';
84			} else if (preg_match('/cryptorush.in/', $url)) {
85			return 'cryptorush';
86			} else if (preg_match('/mintpal.com/', $url)) {
87			return 'mintpal';
88			} else if (preg_match('/c-cex.com/', $url)) {
89			return 'c-cex';
90			} else if (preg_match('/bittrex.com/', $url)) {
91			return 'bittrex';
92			} else if (preg_match('/crypto-bridge.org/', $url)) {
93			return 'cryptobridge';
94			} else if (preg_match('/yobit.net/', $url)) {
95			return 'yobit';
96			} else if (preg_match('/binance.com/', $url)) {
97			return 'binance';
98			} else if (preg_match('/southxchange.com/', $url)) {
99			return 'southxchange';
100			} else if (preg_match('/mercatox.com/', $url)) {
101			return 'mercatox';
102			} else if (preg_match('/tradeogre.com/', $url)) {
103			return 'tradeogre';
104			}
105			$this->setErrorMessage("API URL unknown");
106			return false;
107			}
108
109			/**
110			* Extract price information from API data
111			**/
112			public function getPrice() {
113			$aData = $this->getApi($this->config['price']['url'], $this->config['price']['target']);
114			$strBase = $this->config['currency'];
115			$strQuote = $this->config['price']['currency'];
116			// Check the API type for configured URL
117			if (!$strApiType = $this->getApiType($this->config['price']['url']))
118			return false;
119			// if api data is valid, extract price depending on API type
120			if (is_array($aData)) {
121			switch ($strApiType) {
122			case 'coinchoose':
123			foreach ($aData as $aItem) {
124			if($strBase == $aItem[0])
125			return $aItem['price'];
126			}
127			break;
128			case 'btce':
129			return $aData['ticker']['last'];
130			break;
			0 ignored issues – show Unused Code introduced 2016-02-25 10:03 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
131			case 'cryptopia':
132			return @$aData['Data']['LastPrice'];
133			break;
			0 ignored issues – show Unused Code introduced 2016-02-25 10:03 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
134			case 'cryptorush':
135			return @$aData["{$strBase}/{$strQuote}"]['last_trade'];
136			break;
			0 ignored issues – show Unused Code introduced 2018-03-18 07:01 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
137			case 'mintpal':
138			return @$aData['0']['last_price'];
139			break;
			0 ignored issues – show Unused Code introduced 2015-12-14 13:34 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
140			case 'c-cex':
141			return @$aData['ticker']['lastprice'];
142			break;
			0 ignored issues – show Unused Code introduced 2015-12-14 13:34 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
143			case 'bittrex':
144			return @$aData['result']['Last'];
145			break;
			0 ignored issues – show Unused Code introduced 2016-02-25 10:03 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
146			case 'cryptobridge':
147			foreach ($aData as $aItem) {
148			if("{$strBase}_{$strQuote}" == $aItem['id'])
149			return $aItem['last'];
150			}
151			case 'yobit':
152			return @$aData[strtolower($strBase) . "_" . strtolower($strQuote)]['last'];
153			break;
			0 ignored issues – show Unused Code introduced 2018-03-18 07:01 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
154			case 'binance':
155			return @$aData['price'];
156			break;
			0 ignored issues – show Unused Code introduced 2018-03-18 07:01 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
157			case 'southxchange':
158			return @$aData['Last'];
159			break;
			0 ignored issues – show Unused Code introduced 2018-03-18 07:01 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
160			case 'mercatox':
161			return @$aData['pairs']["{$strBase}_{$strQuote}"]['last'];
162			break;
			0 ignored issues – show Unused Code introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
163			case 'tradeogre':
164			return @$aData['price'];
165			break;
			0 ignored issues – show Unused Code introduced 2018-03-18 07:43 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
166			}
167			} else {
168			$this->setErrorMessage("Got an invalid response from ticker API");
169			return false;
170			}
171			// Catchall, we have no data extractor for this API url
172			$this->setErrorMessage("Undefined API to getPrice() on URL " . $this->config['price']['url']);
173			return false;
174			}
175			}
176
177			$tools = new Tools();
178			$tools->setDebug($debug);
179			$tools->setConfig($config);
180			$tools->setMemcache($memcache);
181

MPOS / php-mpos

Tools::getPrice() D last analyzed 2019-03-06 18:44 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

Tools::getPrice() D
last analyzed 2019-03-06 18:44 UTC