CAT::__construct() - Code Metrics - Inspection of "ChromeOS installer is UI-less but we need to show..." - GEANT/CAT - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ee79b5...34b090 )

by Stefan

created 2016-08-26 06:55 UTC

CAT::__construct() A

↳ Parent: CAT

Complexity

Conditions	4
Paths	5

Size

Total Lines	18
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	14
nc	5
nop	0
dl	0
loc	18
rs	9.2
c	0
b	0
f	0

<?php
/* *********************************************************************************
 * (c) 2011-15 GÉANT on behalf of the GN3, GN3plus and GN4 consortia
 * License: see the LICENSE file in the root directory
 ***********************************************************************************/
?>
<?php
/**
 * 
 * 
 *  This is the definition of the CAT class
 * @author Stefan Winter <[email protected]>
 * @author Tomasz Wolniewicz <[email protected]>
 *
 * @package Developer
 */

/**
 * necessary includes
 */
session_start();
require_once("Helper.php");
require_once("Federation.php");

/**
 * Define some variables which need to be globally accessible
 * and some general purpose methods
 *
 * @author Stefan Winter <[email protected]>
 * @author Tomasz Wolniewicz <[email protected]>
 *
 * @package Developer
 */
class CAT {

    /** 
     * which version is this?
     * even if we are unreleased, keep track of internal version-to-be
     * developers need to set this in code. The user-displayed string
     * is generated into $VERSION below
     */
    public static $VERSION_MAJOR = 1;
    public static $VERSION_MINOR = 2;
    public static $VERSION_PATCH = 0;
    public static $VERSION_EXTRA = "";
    public static $RELEASE_VERSION = FALSE;
    public static $USER_API_VERSION = 2;
    
    /*
     * This is the user-displayed string; controlled by the four options above
     * It is generated in the constructor.
     */
    
    public static $VERSION;
    /**
   /**
     * database which this class queries by default
     * 
     * @var string
     */
    private static $LANG = '';
    private static $DB_TYPE = "INST";
    /**
     *  Constructor sets the language by calling set_lang 
     *  and stores language settings in object properties
     *  additionally it also sets static variables $laing_index and $root
     */
    public function __construct() {
        $A = $this->set_lang();
        self::$locale = $A[1];
        $a = __DIR__;
        self::$root = dirname($a);


        if (CAT::$RELEASE_VERSION) {
            $temp_version = "CAT-".CAT::$VERSION_MAJOR.".".CAT::$VERSION_MINOR;
            if (CAT::$VERSION_PATCH != 0)
                    $temp_version .= ".".CAT::$VERSION_PATCH;
            if (CAT::$VERSION_EXTRA != "")
                $temp_version .= "-".CAT::$VERSION_EXTRA;
            CAT::$VERSION = sprintf(_("Release %s"), $temp_version );
        }
        else
            CAT::$VERSION = _("Unreleased SVN Revision");
    }

    /** 
     * 
     */
    public function totalIdPs($level) {
        switch ($level) {
            case "ALL":
                $idpcount = DBConnection::exec(CAT::$DB_TYPE, "SELECT COUNT(inst_id) AS instcount FROM institution");
                break;
            case "VALIDPROFILE":
                $idpcount = DBConnection::exec(CAT::$DB_TYPE, "SELECT COUNT(DISTINCT institution.inst_id) AS instcount FROM institution,profile WHERE institution.inst_id = profile.inst_id AND profile.sufficient_config = 1");
                break;
            case "PUBLICPROFILE":
                $idpcount = DBConnection::exec(CAT::$DB_TYPE, "SELECT COUNT(DISTINCT institution.inst_id) AS instcount FROM institution,profile WHERE institution.inst_id = profile.inst_id AND profile.showtime = 1");
                break;
            default:
                return -1;
        }
        $dbresult = mysqli_fetch_object($idpcount);
        return $dbresult->instcount;
    }
    
    /**
     * Sets the gettext domain
     *
     * @param string $domain
     * @return string previous seting so that you can restore it later
     */
    public static function set_locale($domain) {
        $olddomain = textdomain(NULL);
        debug(4, "set_locale($domain)\n");
        debug(4, CAT::$root . "\n");
        textdomain($domain);
        bindtextdomain($domain, CAT::$root . "/translation/");
        return $olddomain;
    }

    /**
     * set_lang does all language setting magic
     * checks if lang has been declared in the http call
     * if not, checks for saved lang in the SESSION
     * or finally checks browser properties.
     * Only one of the supported langiages can be set
     * if a match is not found, the default langiage is used
     * @param $hardsetlang - this is currently not used but
     * will allow to forst lang setting if this was ever required
     */
    private static function set_lang($hardsetlang = 0) {
        $lang_converted = [];
        if ($hardsetlang !== 0) {
            $hardsetlocale = $hardsetlang;
            $lang_converted[] = $hardsetlocale;
            $_SESSION['language'] = $hardsetlocale;
        } elseif (isset($_REQUEST['lang'])) {
            $hardsetlocale = $_REQUEST['lang'];
            $lang_converted[] = $hardsetlocale;
            $_SESSION['language'] = $hardsetlocale;
        } elseif (isset($_SESSION['language'])) {
            $hardsetlocale = $_SESSION['language'];
            $lang_converted[] = $hardsetlocale;
        } elseif (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
            $langs = explode(",", $_SERVER["HTTP_ACCEPT_LANGUAGE"]);
            foreach ($langs as $lang) {
                preg_match("/(.*);+.*/", $lang, $result);
                $lang_converted[] = (isset($result[1]) && $result[1] ? $result[1] : $lang);
            }
        };
        // always add configured locale as last resort
        $defaultlocale = Config::$APPEARANCE['defaultlocale'];
        $lang_converted[] = Config::$LANGUAGES[$defaultlocale]['locale'];
        $lang_index = $defaultlocale;

        setlocale(LC_ALL, 0);

        foreach ($lang_converted as $try_lang) {
            // madness! setlocale is completely unflexible. If $try_lang is "en"
            // it will fail, because it only knows en_US, en_GB a.s.o.
            // we need to map stuff manually
            $thelang = $try_lang;

            foreach (Config::$LANGUAGES as $language => $value)
                if (preg_match("/^" . $language . ".*/", $try_lang)) {
                    $thelang = $value['locale'];
                    $lang_index = $language;
                }

            // echo "Trying to set language to $thelang...";

//        putenv("LC_ALL=$thelang");
            if (setlocale(LC_ALL, $thelang))
                break;
        }
        putenv("LC_ALL=" . $thelang);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        debug(4, "selected lang:$lang_index:$thelang\n");
        debug(4, $lang_converted);
        return([$lang_index, $thelang]);
    }

    /**
     * gets the language setting in CAT
     */
    static public function get_lang() {
       if(self::$LANG === '')
         list(self::$LANG, $xx) = self::set_lang();
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
       return self::$LANG;
    }

    /**
     * Prepares a list of countries known to the CAT.
     * 
     * @param int $active_only is set and nonzero will cause that only countries with some institutions underneath will be listed
     * @return array Array indexed by (uppercase) lang codes and sorted according to the current locale
     */
    public function printCountryList($active_only = 0) {
        $olddomain = $this->set_locale("core");
        if ($active_only) {
            $federations = DBConnection::exec(CAT::$DB_TYPE, "SELECT DISTINCT LOWER(institution.country) AS country FROM institution JOIN profile
                          ON institution.inst_id = profile.inst_id WHERE profile.showtime = 1 ORDER BY country");
            while ($a = mysqli_fetch_object($federations)) {
                $b = $a->country;
                $F = new Federation($b);
                $c = strtoupper($F->name);
                $C[$c] = isset(Federation::$FederationList[$c]) ? Federation::$FederationList[$c] : $c;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            }
        } else {
            new Federation;
            $C = Federation::$FederationList;
        }
        asort($C, SORT_LOCALE_STRING);
        $this->set_locale($olddomain);
        return($C);
    }

    /**
     * Writes an audit log entry to the audit log file. These audits are semantic logs; they don't record every single modification
     * in the database, but provide a logical "who did what" overview. The exact modification SQL statements are logged
     * automatically with writeSQLAudit() instead. The log file path is configurable in _config.php.
     * 
     * @param string $user persistent identifier of the user who triggered the action
     * @param string $category type of modification, from the fixed vocabulary: "NEW", "OWN", "MOD", "DEL"
     * @param string $message message to log into the audit log
     * @return boolean TRUE if successful. Will terminate script execution on failure. 
     */
    public static function writeAudit($user, $category, $message) {
        switch ($category) {
            case "NEW": // created a new object
            case "OWN": // ownership changes
            case "MOD": // modified existing object
            case "DEL": // deleted an object
                ob_start();
                printf("%-015s",microtime(TRUE));
                print " ($category) ";
                print_r(" ".$user.": ".$message."\n");
// for HTML
$sanitized = htmlentities($tainted, ENT_QUOTES);

// for URLs
$sanitized = urlencode($tainted);
                $output = ob_get_clean();
                if (Config::$PATHS['logdir']) {

                    $f = fopen(Config::$PATHS['logdir'] . "/audit-activity.log", "a");
                    fwrite($f, $output);
                    fclose($f);
                } else {
                    print $output;
                }

                return TRUE;
            default:
                exit(1);
        }
    }

    /**
     * Write an audit log entry to the SQL log file. Every SQL statement which is not a simple SELECT one will be written
     * to the log file. The log file path is configurable in _config.php.
     * 
     * @param string $query the SQL query to be logged
     */
    public static function writeSQLAudit($query) {
        // clean up text to be in one line, with no extra spaces
        $logtext1 = preg_replace("/[\n\r]/", "", $query);
        $logtext = preg_replace("/ +/", " ", $logtext1);
        ob_start();
        printf("%-015s",microtime(TRUE));
        print(" ".$logtext."\n");
// for HTML
$sanitized = htmlentities($tainted, ENT_QUOTES);

// for URLs
$sanitized = urlencode($tainted);
        $output = ob_get_clean();
        if (Config::$PATHS['logdir']) {

            $f = fopen(Config::$PATHS['logdir'] . "/audit-SQL.log", "a");
            fwrite($f, $output);
            fclose($f);
        } else {
            print $output;
        }
    }

    /**
     * stores the location of the root directory
     * @static string $root
     */
    public static $root;

    /**
     * language display name for the language set by the constructor
     */
    public static $locale;

}

Push — master ( ee79b5...34b090 )

CAT::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

2 paths for user data to reach this point

General Strategies to prevent injection

15 paths for user data to reach this point

Preventing Cross-Site-Scripting Attacks

General Strategies to prevent injection

14 paths for user data to reach this point

Preventing Cross-Site-Scripting Attacks

General Strategies to prevent injection

1			<?php
2			/* *********************************************************************************
3			* (c) 2011-15 GÉANT on behalf of the GN3, GN3plus and GN4 consortia
4			* License: see the LICENSE file in the root directory
5			***********************************************************************************/
6			?>
7			<?php
8			/**
9			*
10			*
11			* This is the definition of the CAT class
12			* @author Stefan Winter <[email protected]>
13			* @author Tomasz Wolniewicz <[email protected]>
14			*
15			* @package Developer
16			*/
17
18			/**
19			* necessary includes
20			*/
21			session_start();
22			require_once("Helper.php");
23			require_once("Federation.php");
24
25			/**
26			* Define some variables which need to be globally accessible
27			* and some general purpose methods
28			*
29			* @author Stefan Winter <[email protected]>
30			* @author Tomasz Wolniewicz <[email protected]>
31			*
32			* @package Developer
33			*/
34			class CAT {
35
36			/**
37			* which version is this?
38			* even if we are unreleased, keep track of internal version-to-be
39			* developers need to set this in code. The user-displayed string
40			* is generated into $VERSION below

GEANT / CAT

Push — master ( ee79b5...34b090 )

CAT::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

2 paths for user data to reach this point

General Strategies to prevent injection

15 paths for user data to reach this point

Preventing Cross-Site-Scripting Attacks

General Strategies to prevent injection

14 paths for user data to reach this point

Preventing Cross-Site-Scripting Attacks

General Strategies to prevent injection

Duplication Side-by-Side

Filter issues like