API::scrub() - Code Metrics - Inspection of "Merge branch 'master' of github.com:GEANT/CAT" - GEANT/CAT - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( dd3535...a17294 )

by Stefan

created 2018-04-27 12:30 UTC

API::scrub() C

↳ Parent: API

Complexity

Conditions	16
Paths	44

Size

Total Lines	57
Code Lines	39

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	57
rs	6.5273
c	0
b	0
f	0
cc	16
eloc	39
nc	44
nop	2

How to fix Long Method Complexity

<?php

/*
 * ******************************************************************************
 * Copyright 2011-2018 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
 * ******************************************************************************
 */

namespace web\lib\admin;

use Exception;

require_once(dirname(dirname(dirname(dirname(__FILE__)))) . "/config/_config.php");

class API {

    const ERROR_API_DISABLED = 1;
    const ERROR_NO_APIKEY = 2;
    const ERROR_INVALID_APIKEY = 3;
    const ERROR_MISSING_PARAMETER = 4;
    const ERROR_INVALID_PARAMETER = 5;
    const ERROR_NO_ACTION = 6;
    const ERROR_INVALID_ACTION = 7;
    const ERROR_MALFORMED_REQUEST = 8;
    const ERROR_INTERNAL_ERROR = 9;
    const ACTION_NEWINST_BY_REF = "NEWINST-BY-REF";
    const ACTION_NEWINST = "NEWINST";
    const ACTION_DELINST = "DELINST";
    const ACTION_ADMIN_LIST = "ADMIN-LIST";
    const ACTION_ADMIN_ADD = "ADMIN-ADD";
    const ACTION_ADMIN_DEL = "ADMIN-DEL";
    const ACTION_STATISTICS_INST = "STATISTICS-INST";
    const ACTION_STATISTICS_FED = "STATISTICS-FED";
    const ACTION_NEWPROF_RADIUS = "NEWPROF-RADIUS";
    const ACTION_NEWPROF_SB = "NEWPROF-SB";
    const ACTION_ENDUSER_NEW = "ENDUSER-NEW";
    const ACTION_ENDUSER_DEACTIVATE = "ENDUSER-DEACTIVATE";
    const ACTION_ENDUSER_LIST = "ENDUSER-LIST";
    const ACTION_TOKEN_NEW = "TOKEN-NEW";
    const ACTION_TOKEN_REVOKE = "TOKEN-REVOKE";
    const ACTION_TOKEN_LIST = "TOKEN-LIST";
    const ACTION_CERT_LIST = "CERT-LIST";
    const ACTION_CERT_REVOKE = "CERT-REVOKE";
    const AUXATTRIB_ADMINID = "ATTRIB-ADMINID";
    const AUXATTRIB_ADMINEMAIL = "ATTRIB-ADMINEMAIL";
    const AUXATTRIB_EXTERNALID = "ATTRIB-EXTERNALID";
    const AUXATTRIB_CAT_INST_ID = "ATTRIB-CAT-INSTID";
    const AUXATTRIB_CAT_PROFILE_ID = "ATTRIB-CAT-PROFILEID";
    const AUXATTRIB_PROFILE_REALM = 'ATTRIB-PROFILE-REALM';
    const AUXATTRIB_PROFILE_OUTERVALUE = 'ATTRIB-PROFILE-OUTERVALUE';
    const AUXATTRIB_PROFILE_TESTUSER = 'ATTRIB-PROFILE-TESTUSER';
    const AUXATTRIB_PROFILE_INPUT_HINT = 'ATTRIB-PROFILE-HINTREALM';
    const AUXATTRIB_PROFILE_INPUT_VERIFY = 'ATTRIB-PROFILE-VERIFYREALM';
    const AUXATTRIB_PROFILE_EAPTYPE = "ATTRIB-PROFILE-EAPTYPE";

    /*
     * ACTIONS consists of a list of keywords, and associated REQuired and OPTional parameters
     * 
     */
    const ACTIONS = [
        # inst-level actions
        API::ACTION_NEWINST_BY_REF => [
            "REQ" => [API::AUXATTRIB_EXTERNALID,],
            "OPT" => [
                'general:geo_coordinates',
                'general:logo_file',
                'media:SSID',
                'media:SSID_with_legacy',
                'media:wired',
                'media:remove_SSID',
                'media:consortium_OI',
                'media:force_proxy',
                'support:email',
                'support:info_file',
                'support:phone',
                'support:url'
            ],
        ],
        API::ACTION_NEWINST => [
            "REQ" => [],
            "OPT" => [
                'general:instname',
                'general:geo_coordinates',
                'general:logo_file',
                'media:SSID',
                'media:SSID_with_legacy',
                'media:wired',
                'media:remove_SSID',
                'media:consortium_OI',
                'media:force_proxy',
                'support:email',
                'support:info_file',
                'support:phone',
                'support:url'
            ],
        ],
        API::ACTION_DELINST => [
            "REQ" => [API::AUXATTRIB_CAT_INST_ID],
            "OPT" => []
        ],
        # inst administrator management
        API::ACTION_ADMIN_LIST => [
            "REQ" => [API::AUXATTRIB_CAT_INST_ID],
            "OPT" => []
        ],
        API::ACTION_ADMIN_ADD => [
            "REQ" => [
                API::AUXATTRIB_ADMINID,
                API::AUXATTRIB_CAT_INST_ID
            ],
            "OPT" => [API::AUXATTRIB_ADMINEMAIL]
        ],
        API::ACTION_ADMIN_DEL => [
            "REQ" => [
                API::AUXATTRIB_ADMINID,
                API::AUXATTRIB_CAT_INST_ID
            ],
            "OPT" => []
        ],
        # statistics
        API::ACTION_STATISTICS_INST => [
            "REQ" => [API::AUXATTRIB_CAT_INST_ID],
            "OPT" => []
        ],
        API::ACTION_STATISTICS_FED => [
            "REQ" => [],
            "OPT" => []
        ],
        # RADIUS profile actions
        API::ACTION_NEWPROF_RADIUS => [
            "REQ" => [API::AUXATTRIB_CAT_INST_ID],
            "OPT" => [
                'eap:ca_file',
                'eap:server_name',
                'media:SSID',
                'media:SSID_with_legacy',
                'media:wired',
                'media:remove_SSID',
                'media:consortium_OI',
                'media:force_proxy',
                'profile:name',
                'profile:customsuffix',
                'profile:description',
                'profile:production',
                'support:email',
                'support:info_file',
                'support:phone',
                'support:url',
                API::AUXATTRIB_PROFILE_INPUT_HINT,
                API::AUXATTRIB_PROFILE_INPUT_VERIFY,
                API::AUXATTRIB_PROFILE_OUTERVALUE,
                API::AUXATTRIB_PROFILE_REALM,
                API::AUXATTRIB_PROFILE_TESTUSER,
                API::AUXATTRIB_PROFILE_EAPTYPE,
            ]
        ],
        # Silverbullet profile actions
        API::ACTION_NEWPROF_SB => [
            "REQ" => [],
            "OPT" => []
        ],
        API::ACTION_ENDUSER_NEW => [
            "REQ" => [],
            "OPT" => []
        ],
        API::ACTION_ENDUSER_DEACTIVATE => [
            "REQ" => [],
            "OPT" => []
        ],
        API::ACTION_ENDUSER_LIST => [
            "REQ" => [],
            "OPT" => []
        ],
        API::ACTION_TOKEN_NEW => [
            "REQ" => [],
            "OPT" => []
        ],
        API::ACTION_TOKEN_REVOKE => [
            "REQ" => [],
            "OPT" => []
        ],
        API::ACTION_TOKEN_LIST => [
            "REQ" => [],
            "OPT" => []
        ],
        API::ACTION_CERT_LIST => [
            "REQ" => [],
            "OPT" => []
        ],
        API::ACTION_CERT_REVOKE => [
            "REQ" => [],
            "OPT" => []
        ],
    ];

    /**
     *
     * @var \web\lib\common\InputValidation
     */
    private $validator;

    public function __construct() {
        $this->validator = new \web\lib\common\InputValidation();
    }

    /**
     * Only leave attributes in the request which are related to the ACTION.
     * Also sanitise by enforcing LANG attribute in multi-lang attributes.
     * 
     * @param array $inputJson the incoming JSON request
     * @param \core\Federation $fedObject the federation the user is acting within
     * @return array the scrubbed attributes
     */
    public function scrub($inputJson, $fedObject) {
        $optionInstance = \core\Options::instance();
        $parameters = [];
        $allPossibleAttribs = array_merge(API::ACTIONS[$inputJson['ACTION']]['REQ'], API::ACTIONS[$inputJson['ACTION']]['OPT']);
        // some actions don't need parameters. Don't get excited when there aren't any.
        if (!isset($inputJson['PARAMETERS'])) {
            $inputJson['PARAMETERS'] = [];
        }
        foreach ($inputJson['PARAMETERS'] as $number => $oneIncomingParam) {
            // index has to be an integer
            if (!is_int($number)) {
                continue;
            }
            // do we actually have a value?
            if (!array_key_exists("VALUE", $oneIncomingParam)) {
                continue;
            }
            // is this multi-lingual, and not an AUX attrib? Then check for presence of LANG and CONTENT before considering to add
            if (!preg_match("/^ATTRIB-/", $oneIncomingParam['NAME'])) {
                $optionProperties = $optionInstance->optionType($oneIncomingParam['NAME']);
                if ($optionProperties["flag"] == "ML" && !array_key_exists("LANG", $oneIncomingParam)) {
                    continue;
                }
            } else { // sanitise the AUX attr 
                switch ($oneIncomingParam['NAME']) {
                    case API::AUXATTRIB_CAT_INST_ID:
                        try {
                            $inst = $this->validator->IdP($oneIncomingParam['VALUE']);
                        } catch (Exception $e) {
                            continue;
                        }
                        if (strtoupper($inst->federation) != strtoupper($fedObject->tld)) {
                            // IdP in different fed, scrub it.
                            continue;
                        }
                        break;
                    case API::AUXATTRIB_ADMINEMAIL:
                        if ($this->validator->email($oneIncomingParam['VALUE']) === FALSE) {
                            continue;
                        }
                        break;
                    case API::AUXATTRIB_ADMINID:
                        try {
                            $oneIncomingParam['VALUE'] = $this->validator->string($oneIncomingParam['VALUE']);
                        } catch (Exception $e) {
                            continue;
                        }
                        break;
                    default:
                        continue;
                }
            }
            if (in_array($oneIncomingParam['NAME'], $allPossibleAttribs)) {
                $parameters[$number] = $oneIncomingParam;
            }
        }
        return $parameters;
    }

    /**
     * extracts the first occurence of a given parameter name from the set of inputs
     * 
     * @param array $inputs incoming set of arrays
     * @param string $expected attribute that is to be extracted
     * @return mixed the value, or FALSE if none was found
     */
    public function firstParameterInstance($inputs, $expected) {
        foreach ($inputs as $attrib) {
            if ($attrib['NAME'] == $expected) {
                return $attrib['VALUE'];
            }
        }
        return FALSE;
    }

    /**
     * we are coercing the submitted JSON-style parameters into the same format
     * we use for the HTML POST user-interactively.
     * That's ugly, hence the function name.
     * 
     * @param array $parameters
     */
    public function uglify($parameters) {
        $coercedInline = [];
        $coercedFile = [];
        $optionObject = \core\Options::instance();
        $cat = new \core\CAT();
        $dir = $cat->createTemporaryDirectory('test');
        foreach ($parameters as $number => $oneAttrib) {
            if (preg_match("/^ATTRIB-/", $oneAttrib['NAME'])) {
                continue;
            }
            $optionInfo = $optionObject->optionType($oneAttrib['NAME']);
            $basename = "S$number";
            $extension = "";
            switch ($optionInfo['type']) {

                case \core\Options::TYPECODE_COORDINATES:
                    $extension = \core\Options::TYPECODE_TEXT;
                    $coercedInline["option"][$basename] = $oneAttrib['NAME'] . "#";
                    $coercedInline["value"][$basename . "-" . $extension] = $oneAttrib['VALUE'];
                    break;
                case \core\Options::TYPECODE_TEXT:
                // fall-through: they all get the same treatment
                case \core\Options::TYPECODE_BOOLEAN:
                // fall-through: they all get the same treatment
                case \core\Options::TYPECODE_STRING:
                // fall-through: they all get the same treatment
                case \core\Options::TYPECODE_INTEGER:
                    $extension = $optionInfo['type'];
                    $coercedInline["option"][$basename] = $oneAttrib['NAME'] . "#";
                    $coercedInline["value"][$basename . "-" . $extension] = $oneAttrib['VALUE'];
                    if ($optionInfo['flag'] == "ML") {
                        $coercedInline["value"][$basename . "-lang"] = $oneAttrib['LANG'];
                    }
                    break;
                case \core\Options::TYPECODE_FILE:
                    // binary data is expected in base64 encoding. This is true
                    // also for PEM files!
                    $extension = $optionInfo['type'];
                    $coercedInline["option"][$basename] = $oneAttrib['NAME'] . "#";
                    file_put_contents($dir['dir'] . "/" . $basename . "-" . $extension, base64_decode($oneAttrib['VALUE']));
                    $coercedFile["value"]['tmp_name'][$basename . "-" . $extension] = $dir['dir'] . "/" . $basename . "-" . $extension;
                    break;
                default:
                    throw new Exception("We don't seem to know this type code!");
            }
        }
        return ["POST" => $coercedInline, "FILES" => $coercedFile];
    }

    public function returnError($code, $description) {
        echo json_encode(["result" => "ERROR", "details" => ["errorcode" => $code, "description" => $description]], JSON_PRETTY_PRINT);
        exit(1);

    }

    public function returnSuccess($details) {
        echo json_encode(["result" => "SUCCESS", "details" => $details], JSON_PRETTY_PRINT);
        exit(0);

    }

}


1			<?php
2
3			/*
4			* ******************************************************************************
5			* Copyright 2011-2018 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			namespace web\lib\admin;
13
14			use Exception;
15
16			require_once(dirname(dirname(dirname(dirname(__FILE__)))) . "/config/_config.php");
17
18			class API {
19
20			const ERROR_API_DISABLED = 1;
21			const ERROR_NO_APIKEY = 2;
22			const ERROR_INVALID_APIKEY = 3;
23			const ERROR_MISSING_PARAMETER = 4;
24			const ERROR_INVALID_PARAMETER = 5;
25			const ERROR_NO_ACTION = 6;
26			const ERROR_INVALID_ACTION = 7;
27			const ERROR_MALFORMED_REQUEST = 8;
28			const ERROR_INTERNAL_ERROR = 9;
29			const ACTION_NEWINST_BY_REF = "NEWINST-BY-REF";
30			const ACTION_NEWINST = "NEWINST";
31			const ACTION_DELINST = "DELINST";
32			const ACTION_ADMIN_LIST = "ADMIN-LIST";
33			const ACTION_ADMIN_ADD = "ADMIN-ADD";
34			const ACTION_ADMIN_DEL = "ADMIN-DEL";
35			const ACTION_STATISTICS_INST = "STATISTICS-INST";
36			const ACTION_STATISTICS_FED = "STATISTICS-FED";
37			const ACTION_NEWPROF_RADIUS = "NEWPROF-RADIUS";
38			const ACTION_NEWPROF_SB = "NEWPROF-SB";
39			const ACTION_ENDUSER_NEW = "ENDUSER-NEW";
40			const ACTION_ENDUSER_DEACTIVATE = "ENDUSER-DEACTIVATE";
41			const ACTION_ENDUSER_LIST = "ENDUSER-LIST";
42			const ACTION_TOKEN_NEW = "TOKEN-NEW";
43			const ACTION_TOKEN_REVOKE = "TOKEN-REVOKE";
44			const ACTION_TOKEN_LIST = "TOKEN-LIST";
45			const ACTION_CERT_LIST = "CERT-LIST";
46			const ACTION_CERT_REVOKE = "CERT-REVOKE";
47			const AUXATTRIB_ADMINID = "ATTRIB-ADMINID";
48			const AUXATTRIB_ADMINEMAIL = "ATTRIB-ADMINEMAIL";
49			const AUXATTRIB_EXTERNALID = "ATTRIB-EXTERNALID";
50			const AUXATTRIB_CAT_INST_ID = "ATTRIB-CAT-INSTID";
51			const AUXATTRIB_CAT_PROFILE_ID = "ATTRIB-CAT-PROFILEID";
52			const AUXATTRIB_PROFILE_REALM = 'ATTRIB-PROFILE-REALM';
53			const AUXATTRIB_PROFILE_OUTERVALUE = 'ATTRIB-PROFILE-OUTERVALUE';
54			const AUXATTRIB_PROFILE_TESTUSER = 'ATTRIB-PROFILE-TESTUSER';
55			const AUXATTRIB_PROFILE_INPUT_HINT = 'ATTRIB-PROFILE-HINTREALM';
56			const AUXATTRIB_PROFILE_INPUT_VERIFY = 'ATTRIB-PROFILE-VERIFYREALM';
57			const AUXATTRIB_PROFILE_EAPTYPE = "ATTRIB-PROFILE-EAPTYPE";
58
59			/*
60			* ACTIONS consists of a list of keywords, and associated REQuired and OPTional parameters
61			*
62			*/
63			const ACTIONS = [
64			# inst-level actions
65			API::ACTION_NEWINST_BY_REF => [
66			"REQ" => [API::AUXATTRIB_EXTERNALID,],
67			"OPT" => [
68			'general:geo_coordinates',
69			'general:logo_file',
70			'media:SSID',
71			'media:SSID_with_legacy',
72			'media:wired',
73			'media:remove_SSID',
74			'media:consortium_OI',
75			'media:force_proxy',
76			'support:email',
77			'support:info_file',
78			'support:phone',
79			'support:url'
80			],
81			],
82			API::ACTION_NEWINST => [
83			"REQ" => [],
84			"OPT" => [
85			'general:instname',
86			'general:geo_coordinates',
87			'general:logo_file',
88			'media:SSID',
89			'media:SSID_with_legacy',
90			'media:wired',
91			'media:remove_SSID',
92			'media:consortium_OI',
93			'media:force_proxy',
94			'support:email',
95			'support:info_file',
96			'support:phone',
97			'support:url'
98			],
99			],
100			API::ACTION_DELINST => [
101			"REQ" => [API::AUXATTRIB_CAT_INST_ID],
102			"OPT" => []
103			],
104			# inst administrator management
105			API::ACTION_ADMIN_LIST => [
106			"REQ" => [API::AUXATTRIB_CAT_INST_ID],
107			"OPT" => []
108			],
109			API::ACTION_ADMIN_ADD => [
110			"REQ" => [
111			API::AUXATTRIB_ADMINID,
112			API::AUXATTRIB_CAT_INST_ID
113			],
114			"OPT" => [API::AUXATTRIB_ADMINEMAIL]
115			],
116			API::ACTION_ADMIN_DEL => [
117			"REQ" => [
118			API::AUXATTRIB_ADMINID,
119			API::AUXATTRIB_CAT_INST_ID
120			],
121			"OPT" => []
122			],
123			# statistics
124			API::ACTION_STATISTICS_INST => [
125			"REQ" => [API::AUXATTRIB_CAT_INST_ID],
126			"OPT" => []
127			],
128			API::ACTION_STATISTICS_FED => [
129			"REQ" => [],
130			"OPT" => []
131			],
132			# RADIUS profile actions
133			API::ACTION_NEWPROF_RADIUS => [
134			"REQ" => [API::AUXATTRIB_CAT_INST_ID],
135			"OPT" => [
136			'eap:ca_file',
137			'eap:server_name',
138			'media:SSID',
139			'media:SSID_with_legacy',
140			'media:wired',
141			'media:remove_SSID',
142			'media:consortium_OI',
143			'media:force_proxy',
144			'profile:name',
145			'profile:customsuffix',
146			'profile:description',
147			'profile:production',
148			'support:email',
149			'support:info_file',
150			'support:phone',
151			'support:url',
152			API::AUXATTRIB_PROFILE_INPUT_HINT,
153			API::AUXATTRIB_PROFILE_INPUT_VERIFY,
154			API::AUXATTRIB_PROFILE_OUTERVALUE,
155			API::AUXATTRIB_PROFILE_REALM,
156			API::AUXATTRIB_PROFILE_TESTUSER,
157			API::AUXATTRIB_PROFILE_EAPTYPE,
158			]
159			],
160			# Silverbullet profile actions
161			API::ACTION_NEWPROF_SB => [
162			"REQ" => [],
163			"OPT" => []
164			],
165			API::ACTION_ENDUSER_NEW => [
166			"REQ" => [],
167			"OPT" => []
168			],
169			API::ACTION_ENDUSER_DEACTIVATE => [
170			"REQ" => [],
171			"OPT" => []
172			],
173			API::ACTION_ENDUSER_LIST => [
174			"REQ" => [],
175			"OPT" => []
176			],
177			API::ACTION_TOKEN_NEW => [
178			"REQ" => [],
179			"OPT" => []
180			],
181			API::ACTION_TOKEN_REVOKE => [
182			"REQ" => [],
183			"OPT" => []
184			],
185			API::ACTION_TOKEN_LIST => [
186			"REQ" => [],
187			"OPT" => []
188			],
189			API::ACTION_CERT_LIST => [
190			"REQ" => [],
191			"OPT" => []
192			],
193			API::ACTION_CERT_REVOKE => [
194			"REQ" => [],
195			"OPT" => []
196			],
197			];
198
199			/**
200			*
201			* @var \web\lib\common\InputValidation
202			*/
203			private $validator;
204
205			public function __construct() {
206			$this->validator = new \web\lib\common\InputValidation();
207			}
208
209			/**
210			* Only leave attributes in the request which are related to the ACTION.
211			* Also sanitise by enforcing LANG attribute in multi-lang attributes.
212			*
213			* @param array $inputJson the incoming JSON request
214			* @param \core\Federation $fedObject the federation the user is acting within
215			* @return array the scrubbed attributes
216			*/
217			public function scrub($inputJson, $fedObject) {
218			$optionInstance = \core\Options::instance();
219			$parameters = [];
220			$allPossibleAttribs = array_merge(API::ACTIONS[$inputJson['ACTION']]['REQ'], API::ACTIONS[$inputJson['ACTION']]['OPT']);
221			// some actions don't need parameters. Don't get excited when there aren't any.
222			if (!isset($inputJson['PARAMETERS'])) {
223			$inputJson['PARAMETERS'] = [];
224			}
225			foreach ($inputJson['PARAMETERS'] as $number => $oneIncomingParam) {
226			// index has to be an integer
227			if (!is_int($number)) {
228			continue;
229			}
230			// do we actually have a value?
231			if (!array_key_exists("VALUE", $oneIncomingParam)) {
232			continue;
233			}
234			// is this multi-lingual, and not an AUX attrib? Then check for presence of LANG and CONTENT before considering to add
235			if (!preg_match("/^ATTRIB-/", $oneIncomingParam['NAME'])) {
236			$optionProperties = $optionInstance->optionType($oneIncomingParam['NAME']);
237			if ($optionProperties["flag"] == "ML" && !array_key_exists("LANG", $oneIncomingParam)) {
238			continue;
239			}
240			} else { // sanitise the AUX attr
241			switch ($oneIncomingParam['NAME']) {
242			case API::AUXATTRIB_CAT_INST_ID:
243			try {
244			$inst = $this->validator->IdP($oneIncomingParam['VALUE']);
245			} catch (Exception $e) {
246			continue;
247			}
248			if (strtoupper($inst->federation) != strtoupper($fedObject->tld)) {
249			// IdP in different fed, scrub it.
250			continue;
251			}
252			break;
253			case API::AUXATTRIB_ADMINEMAIL:
254			if ($this->validator->email($oneIncomingParam['VALUE']) === FALSE) {
255			continue;
256			}
257			break;
258			case API::AUXATTRIB_ADMINID:
259			try {
260			$oneIncomingParam['VALUE'] = $this->validator->string($oneIncomingParam['VALUE']);
261			} catch (Exception $e) {
262			continue;
263			}
264			break;
265			default:
266			continue;
267			}
268			}
269			if (in_array($oneIncomingParam['NAME'], $allPossibleAttribs)) {
270			$parameters[$number] = $oneIncomingParam;
271			}
272			}
273			return $parameters;
274			}
275
276			/**
277			* extracts the first occurence of a given parameter name from the set of inputs
278			*
279			* @param array $inputs incoming set of arrays
280			* @param string $expected attribute that is to be extracted
281			* @return mixed the value, or FALSE if none was found
282			*/
283			public function firstParameterInstance($inputs, $expected) {
284			foreach ($inputs as $attrib) {
285			if ($attrib['NAME'] == $expected) {
286			return $attrib['VALUE'];
287			}
288			}
289			return FALSE;
290			}
291
292			/**
293			* we are coercing the submitted JSON-style parameters into the same format
294			* we use for the HTML POST user-interactively.
295			* That's ugly, hence the function name.
296			*
297			* @param array $parameters
298			*/
299			public function uglify($parameters) {
300			$coercedInline = [];
301			$coercedFile = [];
302			$optionObject = \core\Options::instance();
303			$cat = new \core\CAT();
304			$dir = $cat->createTemporaryDirectory('test');
305			foreach ($parameters as $number => $oneAttrib) {
306			if (preg_match("/^ATTRIB-/", $oneAttrib['NAME'])) {
307			continue;
308			}
309			$optionInfo = $optionObject->optionType($oneAttrib['NAME']);
310			$basename = "S$number";
311			$extension = "";
312			switch ($optionInfo['type']) {
313
314			case \core\Options::TYPECODE_COORDINATES:
315			$extension = \core\Options::TYPECODE_TEXT;
316			$coercedInline["option"][$basename] = $oneAttrib['NAME'] . "#";
317			$coercedInline["value"][$basename . "-" . $extension] = $oneAttrib['VALUE'];
318			break;
319			case \core\Options::TYPECODE_TEXT:
320			// fall-through: they all get the same treatment
321			case \core\Options::TYPECODE_BOOLEAN:
322			// fall-through: they all get the same treatment
323			case \core\Options::TYPECODE_STRING:
324			// fall-through: they all get the same treatment
325			case \core\Options::TYPECODE_INTEGER:
326			$extension = $optionInfo['type'];
327			$coercedInline["option"][$basename] = $oneAttrib['NAME'] . "#";
328			$coercedInline["value"][$basename . "-" . $extension] = $oneAttrib['VALUE'];
329			if ($optionInfo['flag'] == "ML") {
330			$coercedInline["value"][$basename . "-lang"] = $oneAttrib['LANG'];
331			}
332			break;
333			case \core\Options::TYPECODE_FILE:
334			// binary data is expected in base64 encoding. This is true
335			// also for PEM files!
336			$extension = $optionInfo['type'];
337			$coercedInline["option"][$basename] = $oneAttrib['NAME'] . "#";
338			file_put_contents($dir['dir'] . "/" . $basename . "-" . $extension, base64_decode($oneAttrib['VALUE']));
339			$coercedFile["value"]['tmp_name'][$basename . "-" . $extension] = $dir['dir'] . "/" . $basename . "-" . $extension;
340			break;
341			default:
342			throw new Exception("We don't seem to know this type code!");
343			}
344			}
345			return ["POST" => $coercedInline, "FILES" => $coercedFile];
346			}
347
348			public function returnError($code, $description) {
349			echo json_encode(["result" => "ERROR", "details" => ["errorcode" => $code, "description" => $description]], JSON_PRETTY_PRINT);
350			exit(1);
			0 ignored issues – show Best Practice introduced 2018-04-25 11:31 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
351			}
352
353			public function returnSuccess($details) {
354			echo json_encode(["result" => "SUCCESS", "details" => $details], JSON_PRETTY_PRINT);
355			exit(0);
			0 ignored issues – show Best Practice introduced 2018-04-25 15:05 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
356			}
357
358			}
359

GEANT / CAT

Push — master ( dd3535...a17294 )

API::scrub() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like