Tools::getApiType() - Code Metrics - Inspection of "Added remote mysql load checking, payouts values w..." - MPOS/php-mpos - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — development (#2658)

unknown

created 2018-01-15 23:27 UTC

Tools::getApiType() D

↳ Parent: Project

Complexity

Conditions	10
Paths	10

Size

Total Lines	25
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	25
rs	4.8196
c	0
b	0
f	0
cc	10
eloc	21
nc	10
nop	1

How to fix 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 {
namespace YourVendor;

class YourClass { }
  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_USERAGENT, 'Mozilla/4.0 (compatible; PHP client; '.php_uname('s').'; PHP/'.phpversion().')');
    }
    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 'coinchose';
    } else if (preg_match('/btc-e.com/', $url)) {
      return 'btce';
    } else if (preg_match('/cryptsy.com/', $url)) {
      return 'cryptsy';
    } 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('/yobit.net/', $url)) {
      return 'yobit';

      
    }
    $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']);
    $strCurrency = $this->config['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 'coinchose':
      	  foreach ($aData as $aItem) {
      	    if($strCurrency == $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 'cryptsy':
      	  return @$aData['return']['markets'][$strCurrency]['lasttradeprice'];
      	  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["$strCurrency/" . $this->config['price']['currency']]['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 'yobit':
          return @$aData[$this->config['price']['target']]['last'];
          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
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-22 07:52 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 9 and the first side effect is on line 1. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history... Security Bug introduced 2018-01-15 23:29 UTC by Report Bug Copy Issue Report It is not recommended to output anything before PHP's opening tag in non-template files. Loading history...
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 {
			0 ignored issues – show Coding Style Compatibility introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
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_USERAGENT, 'Mozilla/4.0 (compatible; PHP client; '.php_uname('s').'; PHP/'.phpversion().')');
48			}
49			curl_setopt($ch, CURLOPT_URL, $url . $target);
50			// curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-22 07:52 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
51
52			curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
53
54			// run the query
55			$res = curl_exec($ch);
56			if ($res === false) {
57			$this->setErrorMessage('Could not get reply: '.curl_error($ch));
58			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...
59			}
60			$dec = json_decode($res, true);
61			if (!$dec) {
62			$this->setErrorMessage('Invalid data received, please make sure connection is working and requested API exists');
63			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...
64			}
65			return $dec;
66			}
67
68			/**
69			* Detect the API to properly extract information
70			* @param url string API URL
71			* @return data string API type
72			**/
73			private function getApiType($url) {
74			if (preg_match('/coinchoose.com/', $url)) {
75			return 'coinchose';
76			} else if (preg_match('/btc-e.com/', $url)) {
77			return 'btce';
78			} else if (preg_match('/cryptsy.com/', $url)) {
79			return 'cryptsy';
80			} else if (preg_match('/cryptopia.co.nz/', $url)) {
81			return 'cryptopia';
82			} else if (preg_match('/cryptorush.in/', $url)) {
83			return 'cryptorush';
84			} else if (preg_match('/mintpal.com/', $url)) {
85			return 'mintpal';
86			} else if (preg_match('/c-cex.com/', $url)) {
87			return 'c-cex';
88			} else if (preg_match('/bittrex.com/', $url)) {
89			return 'bittrex';
90			} else if (preg_match('/yobit.net/', $url)) {
91			return 'yobit';
92
93
94			}
95			$this->setErrorMessage("API URL unknown");
96			return false;
97			}
98
99			/**
100			* Extract price information from API data
101			**/
102			public function getPrice() {
103			$aData = $this->getApi($this->config['price']['url'], $this->config['price']['target']);
104			$strCurrency = $this->config['currency'];
105			// Check the API type for configured URL
106			if (!$strApiType = $this->getApiType($this->config['price']['url']))
107			return false;
108			// if api data is valid, extract price depending on API type
109			if (is_array($aData)) {
110			switch ($strApiType) {
111			case 'coinchose':
112			foreach ($aData as $aItem) {
113			if($strCurrency == $aItem[0])
114			return $aItem['price'];
115			}
116			break;
117			case 'btce':
118			return $aData['ticker']['last'];
119			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...
120			case 'cryptsy':
121			return @$aData['return']['markets'][$strCurrency]['lasttradeprice'];
122			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...
123			case 'cryptopia':
124			return @$aData['Data']['LastPrice'];
125			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...
126			case 'cryptorush':
127			return @$aData["$strCurrency/" . $this->config['price']['currency']]['last_trade'];
128			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...
129			case 'mintpal':
130			return @$aData['0']['last_price'];
131			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...
132			case 'c-cex':
133			return @$aData['ticker']['lastprice'];
134			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...
135			case 'bittrex':
136			return @$aData['result']['Last'];
137			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...
138			case 'yobit':
139			return @$aData[$this->config['price']['target']]['last'];
140			break;
			0 ignored issues – show Unused Code introduced 2018-01-15 23:29 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...
141
142			}
143			} else {
144			$this->setErrorMessage("Got an invalid response from ticker API");
145			return false;
146			}
147			// Catchall, we have no data extractor for this API url
148			$this->setErrorMessage("Undefined API to getPrice() on URL " . $this->config['price']['url']);
149			return false;
150			}
151			}
152
153			$tools = new Tools();
154			$tools->setDebug($debug);
155			$tools->setConfig($config);
156			$tools->setMemcache($memcache);
157

MPOS / php-mpos

Pull Request — development (#2658)

Tools::getApiType() D

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like