core\UserAPI

Complexity

Total Complexity

143

Size/Duplication

Total Lines	781
Duplicated Lines	9.73 %

Coupling/Cohesion

Components	1
Dependencies	15

Importance

Changes

0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
D	generateInstaller()	0	43	10
B	getCache()	0	19	8
B	generateNewInstaller()	0	35	6
C	listDevices()	0	23	9
A	deviceInfo()	0	14	2
B	profileAttributes()	0	23	6
B	getRootURL()	0	24	6
A	return_json()	0	7	1
A	JSON_listLanguages()	0	7	2
A	JSON_listCountries()	0	8	2
A	JSON_listIdentityProviders()	3	8	2
A	JSON_listIdentityProvidersForDisco()	0	9	2
A	JSON_orderIdentityProviders()	3	8	2
B	JSON_listProfiles()	0	23	5
B	JSON_listDevices()	0	21	8
A	JSON_generateInstaller()	0	9	1
A	downloadInstaller()	0	22	2
A	processImage()	0	20	2
D	getIdpLogo()	32	32	10
D	getFedLogo()	32	32	10
A	sendLogo()	0	12	3
A	locateUser()	3	20	4
B	locateUser2()	3	24	4
A	JSON_locateUser()	0	19	4
A	JSON_profileAttributes()	0	4	1
A	geoDistance()	0	7	1
C	orderIdentityProviders()	0	44	11
D	detectOS()	0	28	10
A	JSON_detectOS()	0	9	2
A	getUserCerts()	0	18	3
A	JSON_getUserCerts()	0	9	2
A	profileSort()	0	3	1

<?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 <twoln@umk.pl>
 * @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 GeoIp2\Database\Reader;
use \Exception;

/**
 * The basic methoods for the user GUI
 * @package UserAPI
 *
 */
class UserAPI extends CAT {

    public function __construct() {
        parent::__construct();
    }

    /**
     * Prepare the device module environment and send back the link
     * This method creates a device module instance via the {@link DeviceFactory} call, 
     * then sets up the device module environment for the specific profile by calling 
     * {@link DeviceConfig::setup()} method and finally, called the devide writeInstaller meethod
     * passing the returned path name.
     * 
     * @param string $device identifier as in {@link devices.php}
     * @param int $profileId profile identifier
     *
     * @return array 
     *  array with the following fields: 
     *  profile - the profile identifier; 
     *  device - the device identifier; 
     *  link - the path name of the resulting installer
     *  mime - the mimetype of the installer
     */
    public function generateInstaller($device, $profileId, $generatedFor = "user", $token = NULL, $password = NULL) {
        $this->languageInstance->setTextDomain("devices");
        $this->loggerInstance->debug(4, "installer:$device:$profileId\n");
        $validator = new \web\lib\common\InputValidation();
        $profile = $validator->Profile($profileId);
        $attribs = $profile->getCollapsedAttributes();
        // test if the profile is production-ready and if not if the authenticated user is an owner
        if (!isset($attribs['profile:production']) || (isset($attribs['profile:production']) && $attribs['profile:production'][0] != "on")) {
            $this->loggerInstance->debug(4, "Attempt to download a non-production ready installer fir profile: $profileId\n");
            $auth = new \web\lib\admin\Authentication();
            if (!$auth->isAuthenticated()) {
                $this->loggerInstance->debug(2, "User NOT authenticated, rejecting request for a non-production installer\n");
                header("HTTP/1.0 403 Not Authorized");
                return;
            }

            $userObject = new User($_SESSION['user']);
            if (!$userObject->isIdPOwner($profile->institution)) {
                $this->loggerInstance->debug(2, "User not an owner of a non-production profile - access forbidden\n");
                header("HTTP/1.0 403 Not Authorized");
                return;
            }
            $this->loggerInstance->debug(4, "User is the owner - allowing access\n");
        }
        $installerProperties = [];
        $installerProperties['profile'] = $profileId;
        $installerProperties['device'] = $device;
        $cache = $this->getCache($device, $profile);
        $this->installerPath = $cache['path'];
        if ($this->installerPath && $token == NULL && $password == NULL) {
            $this->loggerInstance->debug(4, "Using cached installer for: $device\n");
            $installerProperties['link'] = "API.php?action=downloadInstaller&lang=" . $this->languageInstance->getLang() . "&profile=$profileId&device=$device&generatedfor=$generatedFor";
            $installerProperties['mime'] = $cache['mime'];
        } else {
            $myInstaller = $this->generateNewInstaller($device, $profile, $generatedFor, $token, $password);
            if ($myInstaller['link'] != 0) {
                $installerProperties['mime'] = $myInstaller['mime'];
            }
            $installerProperties['link'] = $myInstaller['link'];
        }
        $this->languageInstance->setTextDomain("web_user");
        return($installerProperties);
    }

    /**
     * This function tries to find a cached copy of an installer for a given
     * combination of Profile and device
     * @param string $device
     * @param AbstractProfile $profile
     * @return boolean|string the string with the path to the cached copy, or FALSE if no cached copy exists
     */
    private function getCache($device, $profile) {
        $deviceList = \devices\Devices::listDevices();
        $deviceConfig = $deviceList[$device];
        $noCache = (isset(\devices\Devices::$Options['no_cache']) && \devices\Devices::$Options['no_cache']) ? 1 : 0;
        if (isset($deviceConfig['options']['no_cache'])) {
            $noCache = $deviceConfig['options']['no_cache'] ? 1 : 0;
        }
        if ($noCache) {
            $this->loggerInstance->debug(5, "getCache: the no_cache option set for this device\n");
            return(FALSE);
        }
        $this->loggerInstance->debug(5, "getCache: caching option set for this device\n");
        $cache = $profile->testCache($device);
        $iPath = $cache['cache'];
        if ($iPath && is_file($iPath)) {
            return(['path' => $iPath, 'mime' => $cache['mime']]);
        }
        return(FALSE);
    }

    /**
     * Generates a new installer for the given combination of device and Profile
     * 
     * @param string $device
     * @param AbstractProfile $profile
     * @return array info about the new installer (mime and link)
     */
    private function generateNewInstaller($device, $profile, $generatedFor, $token, $password) {
        $this->loggerInstance->debug(5, "generateNewInstaller() - Enter");
        $factory = new DeviceFactory($device);
        $this->loggerInstance->debug(5, "generateNewInstaller() - created Device");
        $dev = $factory->device;
        $out = [];
        if (isset($dev)) {
            $dev->setup($profile, $token, $password);
            $this->loggerInstance->debug(5, "generateNewInstaller() - Device setup done");
            $installer = $dev->writeInstaller();

The method writeInstaller() cannot be called from this context as it is declared protected in class core\DeviceConfig.

            $this->loggerInstance->debug(5, "generateNewInstaller() - writeInstaller complete");
            $iPath = $dev->FPATH . '/tmp/' . $installer;
            if ($iPath && is_file($iPath)) {
                if (isset($dev->options['mime'])) {
                    $out['mime'] = $dev->options['mime'];
                } else {
                    $info = new \finfo();
                    $out['mime'] = $info->file($iPath, FILEINFO_MIME_TYPE);
                }
                $this->installerPath = $dev->FPATH . '/' . $installer;
                rename($iPath, $this->installerPath);
                $integerEap = (new \core\common\EAP($dev->selectedEap))->getIntegerRep();
                $profile->updateCache($device, $this->installerPath, $out['mime'], $integerEap);
                if (CONFIG['DEBUG_LEVEL'] < 4) {
                    \core\common\Entity::rrmdir($dev->FPATH . '/tmp');
                }
                $this->loggerInstance->debug(4, "Generated installer: " . $this->installerPath . ": for: $device, EAP:" . $integerEap . "\n");
                $out['link'] = "API.php?action=downloadInstaller&lang=" . $this->languageInstance->getLang() . "&profile=" . $profile->identifier . "&device=$device&generatedfor=$generatedFor";
            } else {
                $this->loggerInstance->debug(2, "Installer generation failed for: " . $profile->identifier . ":$device:" . $this->languageInstance->getLang() . "\n");
                $out['link'] = 0;
            }
        }
        return($out);
    }

    /**
     * interface to Devices::listDevices() 
     */
    public function listDevices($showHidden = 0) {
        $dev = \devices\Devices::listDevices();
        $returnList = [];
        $count = 0;
        if ($showHidden !== 0 && $showHidden != 1) {
            throw new Exception("show_hidden is only be allowed to be 0 or 1, but it is $showHidden!");
        }
        foreach ($dev as $device => $deviceProperties) {
            if (isset($deviceProperties['options']['hidden']) && $deviceProperties['options']['hidden'] && $showHidden == 0) {
                continue;
            }
            $count++;

            $deviceProperties['device'] = $device;

            $group = isset($deviceProperties['group']) ? $deviceProperties['group'] : 'other';
            if (!isset($returnList[$group])) {
                $returnList[$group] = [];
            }
            $returnList[$group][$device] = $deviceProperties;
        }
        return $returnList;
    }

    public function deviceInfo($device, $profileId) {
        $this->languageInstance->setTextDomain("devices");
        $validator = new \web\lib\common\InputValidation();
        $out = 0;
        $profile = $validator->Profile($profileId);
        $factory = new DeviceFactory($device);
        $dev = $factory->device;
        if (isset($dev)) {
            $dev->setup($profile);
            $out = $dev->writeDeviceInfo();
        }
        $this->languageInstance->setTextDomain("web_user");
        echo $out;
    }

    /**
     * Prepare the support data for a given profile
     *
     * @param int $profId profile identifier
     * @return array
     * array with the following fields:
     * - local_email
     * - local_phone
     * - local_url
     * - description
     * - devices - an array of device names and their statuses (for a given profile)
     */
    public function profileAttributes($profId) {
        $this->languageInstance->setTextDomain("devices");
        $validator = new \web\lib\common\InputValidation();
        $profile = $validator->Profile($profId);
        $attribs = $profile->getCollapsedAttributes();
        $returnArray = [];
        $returnArray['silverbullet'] = $profile instanceof ProfileSilverbullet ? 1 : 0;
        if (isset($attribs['support:email'])) {
            $returnArray['local_email'] = $attribs['support:email'][0];
        }
        if (isset($attribs['support:phone'])) {
            $returnArray['local_phone'] = $attribs['support:phone'][0];
        }
        if (isset($attribs['support:url'])) {
            $returnArray['local_url'] = $attribs['support:url'][0];
        }
        if (isset($attribs['profile:description'])) {
            $returnArray['description'] = $attribs['profile:description'][0];
        }
        $returnArray['devices'] = $profile->listDevices();
        $this->languageInstance->setTextDomain("web_user");
        return($returnArray);
    }

    /*
      this method needs to be used with care, it could give wrong results in some
      cicumstances
     */

    private function getRootURL() {
        $backtrace = debug_backtrace();
        $backtraceFileInfo = array_pop($backtrace);
        $fileTemp = $backtraceFileInfo['file'];
        $file = substr($fileTemp, strlen(dirname(__DIR__)));
        if ($file === FALSE) {
            throw new Exception("No idea what's going wrong - filename cropping returned FALSE!");
        }
        while (substr($file, 0, 1) == '/') {
            $file = substr($file, 1);
            if ($file === FALSE) {
                throw new Exception("Unable to crop leading / from a string known to start with / ???");
            }
        }
        $slashCount = count(explode('/', $file));
        $out = $_SERVER['SCRIPT_NAME'];
        for ($iterator = 0; $iterator < $slashCount; $iterator++) {
            $out = dirname($out);
        }
        if ($out == '/') {
            $out = '';
        }
        return '//' . $_SERVER['SERVER_NAME'] . $out;
    }
    
    /* JSON functions */

    public function return_json($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));
    }

    /**
     * Return 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->return_json($returnArray);
    }

    /**
     * Return the list of countiers with configured IdPs
     *
     * @return string JSON encoded data
     */
    public function JSON_listCountries() {
        $federations = $this->printCountryList(1);
        $returnArray = [];
        foreach ($federations as $id => $val) {
            $returnArray[] = ['federation' => $id, 'display' => $val];
        }
        echo $this->return_json($returnArray);
    }

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

This code seems to be duplicated across your project.

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

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

    /**
     * Return the list of IdPs in a given country ordered with respect to the user location
     *
     * @return string JSON encoded data
     */
    public function JSON_orderIdentityProviders($country, $location = NULL) {
        $idps = $this->orderIdentityProviders($country, $location);
        $returnArray = [];
        foreach ($idps as $idp) {

This code seems to be duplicated across your project.

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

    /**
     * Produce 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
     * @return string JSON encoded data
     */
    public function JSON_listProfiles($idpIdentifier, $sort = 0) {
        $this->languageInstance->setTextDomain("web_user");
        $returnArray = [];
        try {
            $idp = new IdP($idpIdentifier);
        } catch (\Exception $fail) {
            echo $this->return_json($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->return_json($returnArray);
    }

    /**
     * Return the list of devices available for the given profile
     *
     * @param int $profileId the Profile identifier
     * @return string JSON encoded data
     */
    public function JSON_listDevices($profileId) {
        $this->languageInstance->setTextDomain("web_user");
        $returnArray = [];
        $profileAttributes = $this->profileAttributes($profileId);
        $thedevices = $profileAttributes['devices'];
        if (!isset($profile_redirect) || !$profile_redirect) {

The variable $profile_redirect seems only to be defined at a later point. As such the call to isset() seems to always evaluate to false.

            $profile_redirect = 0;

$profile_redirect is not used, you could remove the assignment.

            foreach ($thedevices as $D) {
                if (isset($D['options']) && isset($D['options']['hidden']) && $D['options']['hidden']) {
                    continue;
                }
                $disp = $D['display'];
                if ($D['device'] === '0') {
                    $profile_redirect = 1;

$profile_redirect is not used, you could remove the assignment.

                    $disp = $c;

The variable $c does not exist. Did you forget to declare it?

                }
                $returnArray[] = ['device' => $D['id'], 'display' => $disp, 'status' => $D['status'], 'redirect' => $D['redirect']];
            }
        }
        echo $this->return_json($returnArray);
    }

    /**
     * Call installer generation and return the link
     *
     * @param string $device identifier as in {@link devices.php}
     * @param int $prof_id profile identifier
     * @return string JSON encoded data
     */
    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');

67% of this comment could be valid code. Did you maybe forget this after debugging?

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

    /**
     * Generate and send the installer
     *
     * @param string $device identifier as in {@link devices.php}
     * @param int $prof_id profile identifier
     * @return string binary stream: installerFile
     */
    public function downloadInstaller($device, $prof_id, $generated_for = 'user', $token = NULL, $password = NULL) {
        $this->loggerInstance->debug(4, "downloadInstaller arguments: $device,$prof_id,$generated_for\n");
        $output = $this->generateInstaller($device, $prof_id, $generated_for, $token, $password);
        $this->loggerInstance->debug(4, "output from GUI::generateInstaller:");
        $this->loggerInstance->debug(4, print_r($output, true));
        if (!$output['link']) {
            header("HTTP/1.0 404 Not Found");
            return;
        }
        $validator = new \web\lib\common\InputValidation();
        $profile = $validator->Profile($prof_id);
        $profile->incrementDownloadStats($device, $generated_for);
        $file = $this->installerPath;
        $filetype = $output['mime'];
        $this->loggerInstance->debug(4, "installer MIME type:$filetype\n");
        header("Content-type: " . $filetype);
        header('Content-Disposition: inline; filename="' . basename($file) . '"');
        header('Content-Length: ' . filesize($file));
        ob_clean();
        flush();
        readfile($file);
    }

    private function processImage($inputImage, $destFile, $width, $height, $resize) {
        $info = new \finfo();
        $filetype = $info->buffer($inputImage, FILEINFO_MIME_TYPE);
        $offset = 60 * 60 * 24 * 30;
        // gmdate cannot fail here - time() is its default argument (and integer), and we are adding an integer to it
        $expiresString = "Expires: " . /** @scrutinizer ignore-type */ gmdate("D, d M Y H:i:s", time() + $offset) . " GMT";
        $blob = $inputImage;

        if ($resize) {
            $image = new \Imagick();
            $image->readImageBlob($inputImage);
            $image->setImageFormat('PNG');
            $image->thumbnailImage($width, $height, 1);
            $blob = $image->getImageBlob();
            $this->loggerInstance->debug(4, "Writing cached logo $destFile for IdP/Federation.\n");
            file_put_contents($destFile, $blob);
        }
        
        return ["filetype" => $filetype, "expires" => $expiresString, "blob" => $blob];
    }

    /**
     * Get and prepare logo file 
     *
     * When called for DiscoJuice, first check if file cache exists
     * If not then generate the file and save it in the cache
     * @param int $idp IdP identifier
     * @param int $disco flag turning on image generation for DiscoJuice
     * @param int $width maximum width of the generated image 

There is no parameter named $disco. Was it maybe removed?

     * @param int $height  maximum height of the generated image
     * if one of these is 0 then it is treated as no upper bound
     *
     */
    
        public function getIdpLogo($idp, $width = 0, $height = 0) {

This method seems to be duplicated in your project.

        $expiresString = '';
        $resize = 0;
        $logoFile = "";
        $validator = new \web\lib\common\InputValidation();
        $idpInstance = $validator->IdP($idp);
        $filetype = 'image/png'; // default, only one code path where it can become different
        if (($width || $height) && is_numeric($width) && is_numeric($height)) {
            $resize = 1;
            if ($height == 0) {
                $height = 10000;
            }
            if ($width == 0) {
                $width = 10000;
            }
            $logoFile = ROOT . '/web/downloads/logos/' . $idp . '_' . $width . '_' . $height . '.png';
        }
        if ($resize && is_file($logoFile)) {
            $this->loggerInstance->debug(4, "Using cached logo $logoFile for: " . $idp . "\n");
            $blob = file_get_contents($logoFile);
        } else {
            $logoAttribute = $idpInstance->getAttributes('general:logo_file');
            if (count($logoAttribute) == 0) {
                return;
            }
            $meta = $this->processImage($logoAttribute[0]['value'], $logoFile, $width, $height, $resize);
            $filetype = $meta['filetype'];
            $expiresString = $meta['expires'];
            $blob = $meta['blob'];
        }
        return ["filetype" => $filetype, "expires" => $expiresString, "blob" => $blob];
    }

    /**
     * Get and prepare logo file 
     *
     * When called for DiscoJuice, first check if file cache exists
     * If not then generate the file and save it in the cache
     * @param string $fedIdentifier federation identifier
     * @param int $width maximum width of the generated image 
     * @param int $height  maximum height of the generated image
     * if one of these is 0 then it is treated as no upper bound
     *
     */
    public function getFedLogo($fedIdentifier, $width = 0, $height = 0) {

This method seems to be duplicated in your project.

        $expiresString = '';
        $resize = 0;
        $logoFile = "";
        $validator = new \web\lib\common\InputValidation();
        $federation = $validator->Federation($fedIdentifier);
        if (($width || $height) && is_numeric($width) && is_numeric($height)) {
            $resize = 1;
            if ($height == 0) {
                $height = 10000;
            }
            if ($width == 0) {
                $width = 10000;
            }
            $logoFile = ROOT . '/web/downloads/logos/' . $fedIdentifier . '_' . $width . '_' . $height . '.png';
        }
        if ($resize && is_file($logoFile)) {
            $this->loggerInstance->debug(4, "Using cached logo $logoFile for: " . $fedIdentifier . "\n");
            $blob = file_get_contents($logoFile);
            $filetype = 'image/png';
        } else {
            $logoAttribute = $federation->getAttributes('fed:logo_file');
            if (count($logoAttribute) == 0) {
                return;
            }
            $meta = $this->processImage($logoAttribute[0]['value'], $logoFile, $width, $height, $resize);
            $filetype = $meta['filetype'];
            $expiresString = $meta['expires'];
            $blob = $meta['blob'];
        }
        return ["filetype" => $filetype, "expires" => $expiresString, "blob" => $blob];
    }


    public function sendLogo($identifier, $type, $width = 0, $height = 0) {
        if ($type === "federation") {
            $logo = $this->getFedLogo($identifier, $width, $height);
        }
        if ($type === "idp") {
            $logo = $this->getIdpLogo($identifier, $width, $height);
        }
        header("Content-type: " . $logo['filetype']);

The variable $logo does not seem to be defined for all execution paths leading up to this point.

        header("Cache-Control:max-age=36000, must-revalidate");
        header($logo['expires']);
        echo $logo['blob'];
    }
    
    public function locateUser() {
        if (CONFIG['GEOIP']['version'] != 1) {

This code seems to be duplicated across your project.

            return ['status' => 'error', 'error' => 'Function for GEOIPv1 called, but config says this is not the version to use!'];
        }
        //$host = $_SERVER['REMOTE_ADDR'];

67% of this comment could be valid code. Did you maybe forget this after debugging?

        $host = filter_input(INPUT_SERVER, 'REMOTE_ADDR', FILTER_VALIDATE_IP);
        $record = geoip_record_by_name($host);
        if ($record === FALSE) {
            return ['status' => 'error', 'error' => 'Problem listing countries'];
        }
        $result = ['status' => 'ok'];
        $result['country'] = $record['country_code'];
//  the two lines below are a dirty hack to take of the error in naming the UK federation
        if ($result['country'] == 'GB') {
            $result['country'] = 'UK';
        }
        $result['region'] = $record['region'];
        $result['geo'] = ['lat' => (float) $record['latitude'], 'lon' => (float) $record['longitude']];
        return($result);
    }

    public function locateUser2() {
        if (CONFIG['GEOIP']['version'] != 2) {

This code seems to be duplicated across your project.

            return ['status' => 'error', 'error' => 'Function for GEOIPv2 called, but config says this is not the version to use!'];
        }
        require_once CONFIG['GEOIP']['geoip2-path-to-autoloader'];
        $reader = new Reader(CONFIG['GEOIP']['geoip2-path-to-db']);
        $host = $_SERVER['REMOTE_ADDR'];
        try {
            $record = $reader->city($host);
        } catch (\Exception $e) {
            $result = ['status' => 'error', 'error' => 'Problem listing countries'];
            return($result);
        }
        $result = ['status' => 'ok'];
        $result['country'] = $record->country->isoCode;
//  the two lines below are a dirty hack to take of the error in naming the UK federation
        if ($result['country'] == 'GB') {
            $result['country'] = 'UK';
        }
        $result['region'] = $record->continent->name;

        $result['geo'] = ['lat' => (float) $record->location->latitude, 'lon' => (float) $record->location->longitude];
        return($result);
    }

    public function JSON_locateUser() {
        header('Content-type: application/json; utf-8');

        $geoipVersion = CONFIG['GEOIP']['version'] ?? 0;

        switch ($geoipVersion) {
            case 0:
                echo json_encode(['status' => 'error', 'error' => 'Geolocation not supported']);
                break;
            case 1:
                echo json_encode($this->locateUser());
                break;
            case 2:
                echo json_encode($this->locateUser2());
                break;
            default:
                throw new Exception("This version of GeoIP is not known!");
        }
    }

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

67% of this comment could be valid code. Did you maybe forget this after debugging?

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

    /**
     * Calculate the distence in km between two points given their
     * geo coordinates.
     * @param array $point1 - first point as an 'lat', 'lon' array 
     * @param array $profile1 - second point as an 'lat', 'lon' array 
     * @return float distance in km
     */
    private function geoDistance($point1, $profile1) {

        $distIntermediate = sin(deg2rad($point1['lat'])) * sin(deg2rad($profile1['lat'])) +
                cos(deg2rad($point1['lat'])) * cos(deg2rad($profile1['lat'])) * cos(deg2rad($point1['lon'] - $profile1['lon']));
        $dist = rad2deg(acos($distIntermediate)) * 60 * 1.1852;
        return(round($dist));
    }

    /**
     * Order active identity providers according to their distance and name
     * @param array $currentLocation - current location
     * @return array $IdPs -  list of arrays ('id', 'name');
     */
    public function orderIdentityProviders($country, $currentLocation = NULL) {
        $idps = $this->listAllIdentityProviders(1, $country);

        if (is_null($currentLocation)) {
            $currentLocation = ['lat' => "90", 'lon' => "0"];
            $userLocation = $this->locateUser();
            if ($userLocation['status'] == 'ok') {
                $currentLocation = $userLocation['geo'];
            }
        }
        $idpTitle = [];
        $resultSet = [];
        foreach ($idps as $idp) {
            $idpTitle[$idp['entityID']] = $idp['title'];
            $dist = 10000;
            if (isset($idp['geo'])) {
                $G = $idp['geo'];
                if (isset($G['lon'])) {
                    $d1 = $this->geoDistance($currentLocation, $G);
                    if ($d1 < $dist) {
                        $dist = $d1;
                    }
                } else {
                    foreach ($G as $g) {
                        $d1 = $this->geoDistance($currentLocation, $g);
                        if ($d1 < $dist) {
                            $dist = $d1;
                        }
                    }
                }
            }
            if ($dist > 100) {
                $dist = 10000;
            }
            $d = sprintf("%06d", $dist);
            $resultSet[$idp['entityID']] = $d . " " . $idp['title'];
        }
        asort($resultSet);
        $outarray = [];
        foreach (array_keys($resultSet) as $r) {
            $outarray[] = ['idp' => $r, 'title' => $idpTitle[$r]];
        }
        return($outarray);
    }

    /**
     * Detect the best device driver form the browser
     *
     * Detects the operating system and returns its id 
     * display name and group membership (as in devices.php)
     * @return array|false OS information, indexed by 'id', 'display', 'group'
     */
    public function detectOS() {
        $oldDomain = $this->languageInstance->setTextDomain("devices");
        $Dev = \devices\Devices::listDevices();
        $this->languageInstance->setTextDomain($oldDomain);
        if (isset($_REQUEST['device']) && isset($Dev[$_REQUEST['device']]) && (!isset($device['options']['hidden']) || $device['options']['hidden'] == 0)) {

The variable $device seems only to be defined at a later point. As such the call to isset() seems to always evaluate to false.

The variable $device seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

            $dev_id = $_REQUEST['device'];
            $device = $Dev[$dev_id];
            return(['device' => $dev_id, 'display' => $device['display'], 'group' => $device['group']]);
        }
        $browser = $_SERVER['HTTP_USER_AGENT'];
        $this->loggerInstance->debug(4, "HTTP_USER_AGENT=$browser\n");
        foreach ($Dev as $dev_id => $device) {
            if (!isset($device['match'])) {
                continue;
            }
            if (preg_match('/' . $device['match'] . '/', $browser)) {
                if (!isset($device['options']['hidden']) || $device['options']['hidden'] == 0) {
                    $this->loggerInstance->debug(4, "Browser_id: $dev_id\n");
                    return(['device' => $dev_id, 'display' => $device['display'], 'group' => $device['group']]);
                } else {
                    $this->loggerInstance->debug(2, "Unrecognised system: " . filter_input(INPUT_SERVER, 'HTTP_USER_AGENT', FILTER_SANITIZE_STRING) . "\n");
                    return(false);
                }
            }
        }
        $this->loggerInstance->debug(2, "Unrecognised system: " . filter_input(INPUT_SERVER, 'HTTP_USER_AGENT', FILTER_SANITIZE_STRING) . "\n");
        return(false);
    }

    public function JSON_detectOS() {
        $returnArray = $this->detectOS();
        if (is_array($returnArray)) {
            $status = 1;
        } else {
            $status = 0;
        }
        echo $this->return_json($returnArray, $status);
    }
    
    public function getUserCerts($token) {
        $validator = new \web\lib\common\InputValidation();
        $cleanToken = $validator->token($token);
        if ($cleanToken) {
            // check status of this silverbullet token according to info in DB:
            // it can be VALID (exists and not redeemed, EXPIRED, REDEEMED or INVALID (non existent)
            $tokenStatus = \core\ProfileSilverbullet::tokenStatus($cleanToken);
        } else {
            return false;
        }
        $profile = new \core\ProfileSilverbullet($tokenStatus['profile'], NULL);
        $userdata = $profile->userStatus($tokenStatus['db_id']);
        $allcerts = [];
        foreach ($userdata as $index => $content) {
            $allcerts = array_merge($allcerts, $content['cert_status']);
        }
        return $allcerts;
    }

    public function JSON_getUserCerts($token) {
        $returnArray = $this->getUserCerts($token);
        if ($returnArray) {
            $status = 1;
        } else {
            $status = 0;
        }
        echo $this->return_json($returnArray, $status);
    }

    public $device;
    private $installerPath;

    private static function profileSort($profile1, $profile2) {

This method is not used, and could be removed.

        return strcasecmp($profile1->name, $profile2->name);
    }

}