UserNetAPI::JSON_listCountries() - Code Metrics - Inspection of "code cleanup" - GEANT/CAT - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 9948f7...7383fc )

by Tomasz

created 2017-12-27 10:34 UTC

UserNetAPI::JSON_listCountries() A

↳ Parent: UserNetAPI

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	0
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0

<?php

/*
 * ******************************************************************************
 * Copyright 2011-2017 DANTE Ltd. and GÉANT on behalf of the GN3, GN3+, GN4-1 
 * and GN4-2 consortia
 *
 * License: see the web/copyright.php file in the file structure
 * ******************************************************************************
 */

/**
 * This is the collection of methods dedicated for the user GUI
 * @author Tomasz Wolniewicz <[email protected]>
 * @author Stefan Winter <[email protected]>
 * @package UserAPI
 *
 * Parts of this code are based on simpleSAMLPhp discojuice module.
 * This product includes GeoLite data created by MaxMind, available from
 * http://www.maxmind.com
 */

namespace core;
use \Exception;

/**
 * This class collect methods used for comminication via network UserAPI
 * The methods are generally wrappers around more general UserAPI ones
 */

class UserNetAPI extends UserAPI {

    /**
     * nothing special to be done here.
     */
    public function __construct() {
        parent::__construct();
    }
    
    /**
     *  wrapper JSON function
     * 
     * @param array|bool|null $data the core data to be converted to JSON
     * @param int $status extra status information, defaults to 1
     * @return string JSON encoded data
     */
    public function returnJSON($data, $status = 1) {
        $returnArray = [];
        $returnArray['status'] = $status;
        $returnArray['data'] = $data;
        $returnArray['tou'] = "Please consult Terms of Use at: " . $this->getRootURL() . "/tou.php";
        return(json_encode($returnArray));
    }

    /**
     * outputs the list of supported languages.
     */
    public function JSON_listLanguages() {
        $returnArray = [];
        foreach (CONFIG['LANGUAGES'] as $id => $val) {
            $returnArray[] = ['lang' => $id, 'display' => $val['display'], 'locale' => $val['locale']];
        }
        echo $this->returnJSON($returnArray);
    }

    /**
     * outputs the list of countries with configured IdPs
     *
     */
    public function JSON_listCountries() {
        $federations = $this->printCountryList(1);
        $returnArray = [];
        foreach ($federations as $id => $val) {
            $returnArray[] = ['federation' => $id, 'display' => $val];
        }
        echo $this->returnJSON($returnArray);
    }

    /**
     * outputs the list of IdPs in a given country
     *
     * @param string $country the country we are interested in
     */
    public function JSON_listIdentityProviders($country) {
        $idps = $this->listAllIdentityProviders(1, $country);
        $returnArray = [];
        foreach ($idps as $idp) {

            $returnArray[] = ['idp' => $idp['entityID'], 'display' => $idp['title']];
        }
        echo $this->returnJSON($returnArray);
    }

    /**
     * outputs the list of all active IdPs
     *
     * The IdP list is formatted for DiscoJuice consumption
     */
    public function JSON_listIdentityProvidersForDisco() {
        $idps = $this->listAllIdentityProviders(1);
        $returnArray = [];
        foreach ($idps as $idp) {
            $idp['idp'] = $idp['entityID'];
            $returnArray[] = $idp;
        }
        echo json_encode($returnArray);
    }

    /**
     * outputs the list of IdPs in a given country ordered with respect to their distance to the user's location
     * 
     * @param string $country the country in question
     * @param array $location the coordinates of the approximate user location
     *
     */
    public function JSON_orderIdentityProviders($country, $location = NULL) {
        $idps = $this->orderIdentityProviders($country, $location);
        $returnArray = [];
        foreach ($idps as $idp) {

            $returnArray[] = ['idp' => $idp['id'], 'display' => $idp['title']];
        }
        echo $this->returnJSON($returnArray);
    }

    /**
     * outputs a list of profiles available for a given IdP
     *
     * @param int $idpIdentifier the IdP identifier
     * @param int $sort should the result set be sorted? 0 = no, 1 = yes
     */
    public function JSON_listProfiles($idpIdentifier, $sort = 0) {
        $this->languageInstance->setTextDomain("web_user");
        $returnArray = [];
        try {
            $idp = new IdP($idpIdentifier);
        } catch (\Exception $fail) {
            echo $this->returnJSON($returnArray, 0);
            return;
        }
        $hasLogo = FALSE;
        $logo = $idp->getAttributes('general:logo_file');
        if (count($logo) > 0) {
            $hasLogo = 1;
        }
        $profiles = $idp->listProfiles(TRUE);
        if ($sort == 1) {
            usort($profiles, ["UserAPI", "profileSort"]);
        }
        foreach ($profiles as $profile) {
            $returnArray[] = ['profile' => $profile->identifier, 'display' => $profile->name, 'idp_name' => $profile->instName, 'logo' => $hasLogo];
        }
        echo $this->returnJSON($returnArray);
    }

    /**
     * outputs the list of devices available for the given profile
     *
     * @param int $profileId the Profile identifier
     */
    public function JSON_listDevices($profileId) {
        $this->languageInstance->setTextDomain("web_user");
        $returnArray = [];
        $profileAttributes = $this->profileAttributes($profileId);
        $thedevices = $profileAttributes['devices'];
        foreach ($thedevices as $D) {
            if (isset($D['options']) && isset($D['options']['hidden']) && $D['options']['hidden']) {
                continue;
            }
            if ($D['device'] === '0') {
                $disp = '';
            } else {
                $disp = $D['display'];
            }
            $returnArray[] = ['device' => $D['id'], 'display' => $disp, 'status' => $D['status'], 'redirect' => $D['redirect']];
        }
        echo $this->returnJSON($returnArray);
    }

    /**
     * outputs the link to the installers (additionally, actually generates it or takes it from cache)
     *
     * @param string $device identifier as in {@link devices.php}
     * @param int $prof_id profile identifier
     */
    public function JSON_generateInstaller($device, $prof_id) {
        $this->loggerInstance->debug(4, "JSON::generateInstaller arguments: $device,$prof_id\n");
        $output = $this->generateInstaller($device, $prof_id);
        $this->loggerInstance->debug(4, "output from GUI::generateInstaller:");
        $this->loggerInstance->debug(4, print_r($output, true));
        $this->loggerInstance->debug(4, json_encode($output));
//    header('Content-type: application/json; utf-8');

        echo $this->returnJSON($output);
    }

    /**
     * outputs OS guess in JSON
     */
    public function JSON_detectOS() {
        $returnArray = $this->detectOS();
        $status = is_array($returnArray) ? 1 : 0;
        echo $this->returnJSON($returnArray, $status);
    }
    
    /**
     * outputs user certificates pertaining to a given token in JSON
     * @param string $token
     */
    public function JSON_getUserCerts($token) {
        $returnArray = $this->getUserCerts($token);
        $status = is_array($returnArray) ? 1 : 0;
        echo $this->returnJSON($returnArray, $status);
    }
    
    /** outputs the user location as JSON
     * @throws Exception
     */
    public function JSON_locateUser() {
        header('Content-type: application/json; utf-8');
        echo json_encode($this->locateUser());
    }

    /**
     * outputs support data prepared within {@link GUI::profileAttributes()}
     */
    public function JSON_profileAttributes($prof_id) {
//    header('Content-type: application/json; utf-8');

        echo $this->returnJSON($this->profileAttributes($prof_id));
    }

    /**
     * outputs a logo
     * 
     * @param string|int $identifier
     * @param string $type "federation" or "idp"
     * @param int $width
     * @param int $height
     */
    public function sendLogo($identifier, $type, $width = 0, $height = 0) {

        $logo = $this->getLogo($identifier, $type, $width, $height);
        header("Content-type: " . $logo['filetype']);
        header("Cache-Control:max-age=36000, must-revalidate");
        header($logo['expires']);
        echo $logo['blob'];
    }
    
}

1		<?php
2
3		/*
4		* ******************************************************************************
5		* Copyright 2011-2017 DANTE Ltd. and GÉANT on behalf of the GN3, GN3+, GN4-1
6		* and GN4-2 consortia
7		*
8		* License: see the web/copyright.php file in the file structure
9		* ******************************************************************************
10		*/
11
12		/**
13		* This is the collection of methods dedicated for the user GUI
14		* @author Tomasz Wolniewicz <[email protected]>
15		* @author Stefan Winter <[email protected]>
16		* @package UserAPI
17		*
18		* Parts of this code are based on simpleSAMLPhp discojuice module.
19		* This product includes GeoLite data created by MaxMind, available from
20		* http://www.maxmind.com
21		*/
22
23		namespace core;
24		use \Exception;
25
26		/**
27		* This class collect methods used for comminication via network UserAPI
28		* The methods are generally wrappers around more general UserAPI ones
29		*/
30
31		class UserNetAPI extends UserAPI {
32
33		/**
34		* nothing special to be done here.
35		*/
36		public function __construct() {
37		parent::__construct();
38		}
39
40		/**
41		* wrapper JSON function
42		*
43		* @param array\|bool\|null $data the core data to be converted to JSON
44		* @param int $status extra status information, defaults to 1
45		* @return string JSON encoded data
46		*/
47		public function returnJSON($data, $status = 1) {
48		$returnArray = [];
49		$returnArray['status'] = $status;
50		$returnArray['data'] = $data;
51		$returnArray['tou'] = "Please consult Terms of Use at: " . $this->getRootURL() . "/tou.php";
52		return(json_encode($returnArray));
53		}
54
55		/**
56		* outputs the list of supported languages.
57		*/
58		public function JSON_listLanguages() {
59		$returnArray = [];
60		foreach (CONFIG['LANGUAGES'] as $id => $val) {
61		$returnArray[] = ['lang' => $id, 'display' => $val['display'], 'locale' => $val['locale']];
62		}
63		echo $this->returnJSON($returnArray);
64		}
65
66		/**
67		* outputs the list of countries with configured IdPs
68		*
69		*/
70		public function JSON_listCountries() {
71		$federations = $this->printCountryList(1);
72		$returnArray = [];
73		foreach ($federations as $id => $val) {
74		$returnArray[] = ['federation' => $id, 'display' => $val];
75		}
76		echo $this->returnJSON($returnArray);
77		}
78
79		/**
80		* outputs the list of IdPs in a given country
81		*
82		* @param string $country the country we are interested in
83		*/
84		public function JSON_listIdentityProviders($country) {
85		$idps = $this->listAllIdentityProviders(1, $country);
86		$returnArray = [];
87	View Code Duplication	foreach ($idps as $idp) {
		0 ignored issues – show Duplication introduced 2017-08-31 11:47 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
88		$returnArray[] = ['idp' => $idp['entityID'], 'display' => $idp['title']];
89		}
90		echo $this->returnJSON($returnArray);
91		}
92
93		/**
94		* outputs the list of all active IdPs
95		*
96		* The IdP list is formatted for DiscoJuice consumption
97		*/
98		public function JSON_listIdentityProvidersForDisco() {
99		$idps = $this->listAllIdentityProviders(1);
100		$returnArray = [];
101		foreach ($idps as $idp) {
102		$idp['idp'] = $idp['entityID'];
103		$returnArray[] = $idp;
104		}
105		echo json_encode($returnArray);
106		}
107
108		/**
109		* outputs the list of IdPs in a given country ordered with respect to their distance to the user's location
110		*
111		* @param string $country the country in question
112		* @param array $location the coordinates of the approximate user location
113		*
114		*/
115		public function JSON_orderIdentityProviders($country, $location = NULL) {
116		$idps = $this->orderIdentityProviders($country, $location);
117		$returnArray = [];
118	View Code Duplication	foreach ($idps as $idp) {
		0 ignored issues – show Duplication introduced 2017-08-31 11:47 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
119		$returnArray[] = ['idp' => $idp['id'], 'display' => $idp['title']];
120		}
121		echo $this->returnJSON($returnArray);
122		}
123
124		/**
125		* outputs a list of profiles available for a given IdP
126		*
127		* @param int $idpIdentifier the IdP identifier
128		* @param int $sort should the result set be sorted? 0 = no, 1 = yes
129		*/
130		public function JSON_listProfiles($idpIdentifier, $sort = 0) {
131		$this->languageInstance->setTextDomain("web_user");
132		$returnArray = [];
133		try {
134		$idp = new IdP($idpIdentifier);
135		} catch (\Exception $fail) {
136		echo $this->returnJSON($returnArray, 0);
137		return;
138		}
139		$hasLogo = FALSE;
140		$logo = $idp->getAttributes('general:logo_file');
141		if (count($logo) > 0) {
142		$hasLogo = 1;
143		}
144		$profiles = $idp->listProfiles(TRUE);
145		if ($sort == 1) {
146		usort($profiles, ["UserAPI", "profileSort"]);
147		}
148		foreach ($profiles as $profile) {
149		$returnArray[] = ['profile' => $profile->identifier, 'display' => $profile->name, 'idp_name' => $profile->instName, 'logo' => $hasLogo];
150		}
151		echo $this->returnJSON($returnArray);
152		}
153
154		/**
155		* outputs the list of devices available for the given profile
156		*
157		* @param int $profileId the Profile identifier
158		*/
159		public function JSON_listDevices($profileId) {
160		$this->languageInstance->setTextDomain("web_user");
161		$returnArray = [];
162		$profileAttributes = $this->profileAttributes($profileId);
163		$thedevices = $profileAttributes['devices'];
164		foreach ($thedevices as $D) {
165		if (isset($D['options']) && isset($D['options']['hidden']) && $D['options']['hidden']) {
166		continue;
167		}
168		if ($D['device'] === '0') {
169		$disp = '';
170		} else {
171		$disp = $D['display'];
172		}
173		$returnArray[] = ['device' => $D['id'], 'display' => $disp, 'status' => $D['status'], 'redirect' => $D['redirect']];
174		}
175		echo $this->returnJSON($returnArray);
176		}
177
178		/**
179		* outputs the link to the installers (additionally, actually generates it or takes it from cache)
180		*
181		* @param string $device identifier as in {@link devices.php}
182		* @param int $prof_id profile identifier
183		*/
184		public function JSON_generateInstaller($device, $prof_id) {
185		$this->loggerInstance->debug(4, "JSON::generateInstaller arguments: $device,$prof_id\n");
186		$output = $this->generateInstaller($device, $prof_id);
187		$this->loggerInstance->debug(4, "output from GUI::generateInstaller:");
188		$this->loggerInstance->debug(4, print_r($output, true));
189		$this->loggerInstance->debug(4, json_encode($output));
190		// header('Content-type: application/json; utf-8');
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-23 14:00 UTC by Report Bug Copy Issue Report `67%` 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...
191		echo $this->returnJSON($output);
192		}
193
194		/**
195		* outputs OS guess in JSON
196		*/
197		public function JSON_detectOS() {
198		$returnArray = $this->detectOS();
199		$status = is_array($returnArray) ? 1 : 0;
200		echo $this->returnJSON($returnArray, $status);
201		}
202
203		/**
204		* outputs user certificates pertaining to a given token in JSON
205		* @param string $token
206		*/
207		public function JSON_getUserCerts($token) {
208		$returnArray = $this->getUserCerts($token);
209		$status = is_array($returnArray) ? 1 : 0;
210		echo $this->returnJSON($returnArray, $status);
211		}
212
213		/** outputs the user location as JSON
214		* @throws Exception
215		*/
216		public function JSON_locateUser() {
217		header('Content-type: application/json; utf-8');
218		echo json_encode($this->locateUser());
219		}
220
221		/**
222		* outputs support data prepared within {@link GUI::profileAttributes()}
223		*/
224		public function JSON_profileAttributes($prof_id) {
225		// header('Content-type: application/json; utf-8');
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-23 14:00 UTC by Report Bug Copy Issue Report `67%` 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...
226		echo $this->returnJSON($this->profileAttributes($prof_id));
227		}
228
229		/**
230		* outputs a logo
231		*
232		* @param string\|int $identifier
233		* @param string $type "federation" or "idp"
234		* @param int $width
235		* @param int $height
236		*/
237	View Code Duplication	public function sendLogo($identifier, $type, $width = 0, $height = 0) {
		0 ignored issues – show Duplication introduced 2017-12-27 10:51 UTC by Report Bug Copy Issue Report This method 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...
238		$logo = $this->getLogo($identifier, $type, $width, $height);
239		header("Content-type: " . $logo['filetype']);
240		header("Cache-Control:max-age=36000, must-revalidate");
241		header($logo['expires']);
242		echo $logo['blob'];
243		}
244
245		}

GEANT / CAT

Push — master ( 9948f7...7383fc )

UserNetAPI::JSON_listCountries() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like