DDNS - Code Metrics - Inspection of "develop" - affenrakete/ddns - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (9f3f84)

by Peter

created 2017-02-27 19:20 UTC

DDNS A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	202
Duplicated Lines	71.29 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	144
loc	202
rs	10
c	0
b	0
f	0
wmc	30
lcom	1
cbo	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
B	readIni()	0	25	3
A	setIniFileDomain()	9	9	1
A	checkAccess()	2	7	3
B	inwxLogin()	24	24	4
A	inwxLogout()	15	15	3
B	inwxGetNameserverInfo()	36	36	6
B	inwxSetNameserverInfo()	36	36	6
A	updateIP()	22	22	3

How to fix Duplicated Code

<?php

/**
 * INWX DDNS Manager
 *
 * @author Peter Siemer <[email protected]>
 * @license https://opensource.org/licenses/GPL-3.0 GNU Public License
 * @link https://affenrakete.de
 *
 */
header('Content-type: text/plain; charset=utf-8'); // Set UFT-8 Header

define("DEBUG", false);
define("OUTPUT", true);

//error_reporting(E_ALL);

//ini_set("display_errors", 1);

require_once('./libraries/domrobot.php');

function precheck($str, $checkEmpty = false)

{
    $str = htmlspecialchars(trim($str), ENT_QUOTES, 'UTF-8');

    if($checkEmpty && empty($str))
        exit('something went wrong 7');


    return $str;
}

class DDNS
namespace YourVendor;

class YourClass { }
{
    protected $iniFilePath = "./conf/";
    protected $iniFileInwx = "inwx.ini";
    protected $iniFileDomain = "";

    protected $inwx = [];            // {apiurl, username, password}

    protected $domain = [];          // [inwx] => {domain, subdomain}, [ddns] => {apikey}

    protected $IP4 = [];          // {oldip, newip, id}

    protected $IP6 = [];          // {oldip, newip, id}

    
    protected $domrobot;

    public function __construct($apidomain = null, $apikey = null)
    {
        $this->setIniFileDomain($apidomain);
        $this->readIni();
        $this->checkAccess($apikey);
    }

    protected function setIniFileDomain($apidomain = null)

    {
        preg_match("/(?!.{253})((?!-)[A-Za-z0-9-]{1,63}(?<!-)\.){1,126}+[A-Za-z]{2,6}/", $apidomain, $domainReturn);
		$domainReturn[0] = str_replace('.', '-', $domainReturn[0]);
		
        $this->iniFileDomain = $domainReturn[0] . '.ini';

        return;        
    }

    protected function readIni()
    {
        // check if ini files exists
        if(!file_exists($this->iniFilePath . $this->iniFileDomain))
            exit('something went wrong 8');

        if(!file_exists($this->iniFilePath . $this->iniFileInwx))
            exit('something went wrong 1');


        // read domain.ini
        $ini = parse_ini_file($this->iniFilePath . $this->iniFileDomain, TRUE);
        
            $this->domain['inwx']['domain'] = precheck($ini['inwx']['domain'], true);
            $this->domain['inwx']['subdomain'] = precheck($ini['inwx']['subdomain'], true);
            $this->domain['ddns']['apikey'] = precheck($ini['ddns']['apikey'], true);
            $this->domain['log']['filepath'] = precheck($ini['log']['filepath'], true);

        //read inwx.ini
        $ini = parse_ini_file($this->iniFilePath . $this->iniFileInwx, TRUE);

            $this->inwx['apiurl'] =  precheck($ini['apiurl'], true);
            $this->inwx['username'] =  precheck($ini['username'], true);
            $this->inwx['password'] =  precheck($ini['password'], true);

        return;
    }

    protected function checkAccess($apikey = null)
    {
        if($apikey == null || $this->domain['ddns']['apikey'] !== $apikey)

            exit('something went wrong 3');


        return;
    }
    
    protected function inwxLogin()

    {
        // INWX Setup class
        $this->domrobot = new INWX\domrobot($this->inwx['apiurl']);
        $this->domrobot->setDebug(false);
        $this->domrobot->setLanguage('en');
        		
        // INWX Login
        $result = $this->domrobot->login($this->inwx['username'], $this->inwx['password']);

        if(DEBUG)
            print_r($result);        
        
        // check result
        if ($result['code'] != 1000)
        {
            if(OUTPUT)
                exit('badauth');

            
            exit('something went wrong 4');

        }
        
        return;
    }
    
    protected function inwxLogout()

    {
        $result = $this->domrobot->logout();

        if(DEBUG)
            print_r($result);
        
        // check result
        if ($result['code'] != 1500)
        {
            exit('something went wrong 5');

        }
        
        return;
    }
    
    protected function inwxGetNameserverInfo()

    {
        $object = "nameserver";
        $methode = "info";
            
        $params = array();
        $params['domain'] = $this->domain['inwx']['domain'];
        $params['name'] = $this->domain['inwx']['subdomain'];
            
        $result = $this->domrobot->call($object, $methode, $params);
            
        if(DEBUG)
            print_r($result);
        
        // check result        
        if ($result['code'] != 1000)
        {                        
            exit('something went wrong 6');

        }
        
		foreach($result["resData"]["record"] as $value)
		{
			if($value['type'] == "A")
			{
				$this->IP4['id'] = $value['id'];
				$this->IP4['oldip'] = $value['content'];
			}
			if($value['type'] == "AAAA")
			{
				$this->IP6['id'] = $value['id'];
				$this->IP6['oldip'] = $value['content'];
			}
		}
		
        return;
    }
	
	protected function inwxSetNameserverInfo($type = null)

    {
        $object = "nameserver";
        $methode = "updateRecord";
            
        $params = array();
		
		if($type == 'ipv4')
		{
			$params['id'] = $this->IP4['id'];
			$params['content'] = $this->IP4['newip'];
		}
		elseif($type == 'ipv6')
		{
			$params['id'] = $this->IP6['id'];
			$params['content'] = $this->IP6['newip'];
		}
		else
			exit('something went wrong 9');	

            
        $result = $this->domrobot->call($object, $methode, $params);
            
        if(DEBUG)
            print_r($result);
        
        // check result        
        if ($result['code'] != 1000)
        {                        
            exit('something went wrong 10');

        }
		
	if(OUTPUT)
	    echo('good');
        		
        return;
    }
    
    public function updateIP($ipv4 = null, $ipv6 = null)

    {
        $this->inwxLogin();
        
        $this->inwxGetNameserverInfo();
		
		if(filter_var($ipv4, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4))
		{
			$this->IP4['newip'] = $ipv4;
			$this->inwxSetNameserverInfo('ipv4');
		}
            
		if(filter_var($ipv6, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6))
		{
			$this->IP6['newip'] = $ipv6;
			$this->inwxSetNameserverInfo('ipv6');
		}
		
        $this->inwxLogout();
        
        return;
    }
}

$input['domain'] = (isset($_GET['domain'])) ? precheck($_GET['domain'], true) : null;
$input['password'] = (isset($_GET['password'])) ? precheck($_GET['password'], true) : null;
$input['ipv4'] = (isset($_GET['ipv4'])) ? precheck($_GET['ipv4'], false) : null;
$input['ipv6'] = (isset($_GET['ipv6'])) ? precheck($_GET['ipv6'], false) : null;

$ddns = new DDNS($input['domain'], $input['password']);
$ddns->updateIP($input['ipv4'], $input['ipv6']);

?>



1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2017-02-27 17:47 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 12 and the first side effect is on line 10. 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...
2		/**
3		* INWX DDNS Manager
4		*
5		* @author Peter Siemer <[email protected]>
6		* @license https://opensource.org/licenses/GPL-3.0 GNU Public License
7		* @link https://affenrakete.de
8		*
9		*/
10		header('Content-type: text/plain; charset=utf-8'); // Set UFT-8 Header
11
12		define("DEBUG", false);
13		define("OUTPUT", true);
14
15		//error_reporting(E_ALL);
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-27 17:47 UTC by Report Bug Copy Issue Report `65%` 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...
16		//ini_set("display_errors", 1);
17
18		require_once('./libraries/domrobot.php');
19
20	View Code Duplication	function precheck($str, $checkEmpty = false)
		0 ignored issues – show Duplication introduced 2017-02-27 19:21 UTC by Report Bug Copy Issue Report This function seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
21		{
22		$str = htmlspecialchars(trim($str), ENT_QUOTES, 'UTF-8');
23
24		if($checkEmpty && empty($str))
25		exit('something went wrong 7');
		0 ignored issues – show Coding Style Compatibility introduced 2017-02-27 17:47 UTC by Report Bug Copy Issue Report The function precheck() contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
26
27		return $str;
28		}
29
30		class DDNS
		0 ignored issues – show Coding Style Compatibility introduced 2017-02-27 17:47 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...
31		{
32		protected $iniFilePath = "./conf/";
33		protected $iniFileInwx = "inwx.ini";
34		protected $iniFileDomain = "";
35

affenrakete / ddns

Branch — develop (9f3f84)

DDNS A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like