GEANT / CAT

web/admin/action_enrollment.php

Switch Indentation +8 added lines, -8 removed lines

@@ -53,14 +53,14 @@
 }
 
 switch ($_GET['token']) {
-    case "SELF-REGISTER":
-        $token = "SELF-REGISTER";
-        $checkval = \core\UserManagement::TOKENSTATUS_OK_NEW;
-        $federation = CONFIG_CONFASSISTANT['CONSORTIUM']['selfservice_registration'];
-        break;
-    default:
-        $token = $validator->token(filter_input(INPUT_GET,'token',FILTER_SANITIZE_STRING));
-        $checkval = $usermgmt->checkTokenValidity($token);
+        case "SELF-REGISTER":
+            $token = "SELF-REGISTER";
+            $checkval = \core\UserManagement::TOKENSTATUS_OK_NEW;
+            $federation = CONFIG_CONFASSISTANT['CONSORTIUM']['selfservice_registration'];
+            break;
+        default:
+            $token = $validator->token(filter_input(INPUT_GET,'token',FILTER_SANITIZE_STRING));
+            $checkval = $usermgmt->checkTokenValidity($token);
 }
 
 if ($checkval < 0) {

core/AbstractProfile.php

Doc Comments +6 added lines

@@ -96,6 +96,12 @@
      */
     protected $frontendHandle;
 
+    /**
+     * @param integer $idpIdentifier
+     * @param string $deviceId
+     * @param string $area
+     * @param string $lang
+     */
     protected function saveDownloadDetails($idpIdentifier, $profileId, $deviceId, $area, $lang, $eapType) {
         if (CONFIG['PATHS']['logdir']) {
             $file = fopen(CONFIG['PATHS']['logdir'] . "/download_details.log", "a");

core/diag/Telepath.php

Doc Comments +1 added lines, -1 removed lines

@@ -216,7 +216,7 @@
      * realm (and indirectly that of the links and statuses of involved proxies
      * and returns a judgment whether external Monitoring API tests are warranted
      * or not
-     * @return boolean TRUE if external tests have to be run
+     * @return boolean|null TRUE if external tests have to be run
      */
     private function CATInternalTests() {
         // we are expecting to get a REJECT from all runs, because that means the packet got through to the IdP.

web/admin/inc/sendinvite.inc.php

Switch Indentation +73 added lines, -73 removed lines

@@ -77,84 +77,84 @@
 }
 
 switch ($operationMode) {
-    case OPERATION_MODE_EDIT:
-        $idp = $validator->IdP($_GET['inst_id']);
-        // editing IdPs is done from within the popup. When we're done, send the 
-        // user back to the popup (append the result of the operation later)
-        $redirect_destination = "manageAdmins.inc.php?inst_id=" . $idp->identifier . "&";
-        $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
-        // is the user primary admin of this IdP?
-        $is_owner = $idp->isPrimaryOwner($_SESSION['user']);
-        // check if he is (also) federation admin for the federation this IdP is in. His invitations have more blessing then.
-        $fedadmin = $userObject->isFederationAdmin($idp->federation);
-        // check if he is either one, if not, complain
-        if (!$is_owner && !$fedadmin) {
-            echo "<p>" . sprintf(_("Something's wrong... you are a %s admin, but not for the %s the requested %s belongs to!"), $uiElements->nomenclature_fed, $uiElements->nomenclature_fed, $uiElements->nomenclature_inst) . "</p>";
-            exit(1);
-        }
+        case OPERATION_MODE_EDIT:
+            $idp = $validator->IdP($_GET['inst_id']);
+            // editing IdPs is done from within the popup. When we're done, send the 
+            // user back to the popup (append the result of the operation later)
+            $redirect_destination = "manageAdmins.inc.php?inst_id=" . $idp->identifier . "&";
+            $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
+            // is the user primary admin of this IdP?
+            $is_owner = $idp->isPrimaryOwner($_SESSION['user']);
+            // check if he is (also) federation admin for the federation this IdP is in. His invitations have more blessing then.
+            $fedadmin = $userObject->isFederationAdmin($idp->federation);
+            // check if he is either one, if not, complain
+            if (!$is_owner && !$fedadmin) {
+                echo "<p>" . sprintf(_("Something's wrong... you are a %s admin, but not for the %s the requested %s belongs to!"), $uiElements->nomenclature_fed, $uiElements->nomenclature_fed, $uiElements->nomenclature_inst) . "</p>";
+                exit(1);
+            }
 
-        $prettyprintname = $idp->name;
-        $newtoken = $mgmt->createToken($fedadmin, $mailaddress, $idp);
-        $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP " . $idp->identifier . " - Token created for " . $mailaddress);
-        $introtext = sprintf(_("a %s of the %s %s \"%s\" has invited you to manage the %s together with him."), $uiElements->nomenclature_fed, CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_inst, $prettyprintname, $uiElements->nomenclature_inst) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
-        break;
-    case OPERATION_MODE_NEWUNLINKED:
-        $redirect_destination = "../overview_federation.php?";
-        $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
-        // run an input check and conversion of the raw inputs... just in case
-        $newinstname = $validator->string($_POST['name']);
-        $newcountry = $validator->string($_POST['country']);
-        $new_idp_authorized_fedadmin = $userObject->isFederationAdmin($newcountry);
-        if ($new_idp_authorized_fedadmin !== TRUE) {
-            throw new Exception("Something's wrong... you want to create a new " . $uiElements->nomenclature_inst . ", but are not a " . $uiElements->nomenclature_fed . " admin for the " . $uiElements->nomenclature_fed . " it should be in!");
-        }
-        $federation = $validator->Federation($newcountry);
-        $prettyprintname = $newinstname;
-        $introtext = sprintf(_("a %s %s has invited you to manage the future %s  \"%s\" (%s)."), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_fed, $uiElements->nomenclature_inst, $prettyprintname, $newcountry) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
-        // send the user back to his federation overview page, append the result of the operation later
-        // do the token creation magic
-        $newtoken = $mgmt->createToken(TRUE, $mailaddress, $newinstname, 0, $newcountry);
-        $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP FUTURE  - Token created for " . $mailaddress);
-        break;
-    case OPERATION_MODE_NEWFROMDB:
-        $redirect_destination = "../overview_federation.php?";
-        $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
-        // a real external DB entry was submitted and all the required parameters are there
-        $newexternalid = $validator->string($_POST['externals']);
-        $extinfo = $catInstance->getExternalDBEntityDetails($newexternalid);
-        $new_idp_authorized_fedadmin = $userObject->isFederationAdmin($extinfo['country']);
-        if ($new_idp_authorized_fedadmin !== TRUE) {
-            throw new Exception("Something's wrong... you want to create a new " . $uiElements->nomenclature_inst . ", but are not a " . $uiElements->nomenclature_fed . " admin for the " . $uiElements->nomenclature_fed . " it should be in!");
-        }
-        $federation = $validator->Federation($extinfo['country']);
-        $newcountry = $extinfo['country'];
-        // see if the inst name is defined in the currently set language; if not, pick its English name; if N/A, pick the last in the list
-        $prettyprintname = "";
-        foreach ($extinfo['names'] as $lang => $name) {
-            if ($lang == $languageInstance->getLang()) {
-                $prettyprintname = $name;
+            $prettyprintname = $idp->name;
+            $newtoken = $mgmt->createToken($fedadmin, $mailaddress, $idp);
+            $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP " . $idp->identifier . " - Token created for " . $mailaddress);
+            $introtext = sprintf(_("a %s of the %s %s \"%s\" has invited you to manage the %s together with him."), $uiElements->nomenclature_fed, CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_inst, $prettyprintname, $uiElements->nomenclature_inst) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
+            break;
+        case OPERATION_MODE_NEWUNLINKED:
+            $redirect_destination = "../overview_federation.php?";
+            $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
+            // run an input check and conversion of the raw inputs... just in case
+            $newinstname = $validator->string($_POST['name']);
+            $newcountry = $validator->string($_POST['country']);
+            $new_idp_authorized_fedadmin = $userObject->isFederationAdmin($newcountry);
+            if ($new_idp_authorized_fedadmin !== TRUE) {
+                throw new Exception("Something's wrong... you want to create a new " . $uiElements->nomenclature_inst . ", but are not a " . $uiElements->nomenclature_fed . " admin for the " . $uiElements->nomenclature_fed . " it should be in!");
             }
-        }
-        if ($prettyprintname == "" && isset($extinfo['names']['en'])) {
-            $prettyprintname = $extinfo['names']['en'];
-        }
-        if ($prettyprintname == "") {
-            foreach ($extinfo['names'] as $name) {
-                $prettyprintname = $name;
+            $federation = $validator->Federation($newcountry);
+            $prettyprintname = $newinstname;
+            $introtext = sprintf(_("a %s %s has invited you to manage the future %s  \"%s\" (%s)."), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_fed, $uiElements->nomenclature_inst, $prettyprintname, $newcountry) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
+            // send the user back to his federation overview page, append the result of the operation later
+            // do the token creation magic
+            $newtoken = $mgmt->createToken(TRUE, $mailaddress, $newinstname, 0, $newcountry);
+            $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP FUTURE  - Token created for " . $mailaddress);
+            break;
+        case OPERATION_MODE_NEWFROMDB:
+            $redirect_destination = "../overview_federation.php?";
+            $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
+            // a real external DB entry was submitted and all the required parameters are there
+            $newexternalid = $validator->string($_POST['externals']);
+            $extinfo = $catInstance->getExternalDBEntityDetails($newexternalid);
+            $new_idp_authorized_fedadmin = $userObject->isFederationAdmin($extinfo['country']);
+            if ($new_idp_authorized_fedadmin !== TRUE) {
+                throw new Exception("Something's wrong... you want to create a new " . $uiElements->nomenclature_inst . ", but are not a " . $uiElements->nomenclature_fed . " admin for the " . $uiElements->nomenclature_fed . " it should be in!");
             }
-        }
-        // fill the rest of the text
-        $introtext = sprintf(_("a %s %s has invited you to manage the %s  \"%s\"."), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_fed, $uiElements->nomenclature_inst, $prettyprintname) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
-        // do the token creation magic
-        $newtoken = $mgmt->createToken(TRUE, $mailaddress, $prettyprintname, $newexternalid);
-        $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP FUTURE  - Token created for " . $mailaddress);
-        break;
-    default: // includes OPERATION_MODE_INVALID
-        $wrongcontent = print_r($_POST, TRUE);
-        echo "<pre>Wrong parameters in POST:
+            $federation = $validator->Federation($extinfo['country']);
+            $newcountry = $extinfo['country'];
+            // see if the inst name is defined in the currently set language; if not, pick its English name; if N/A, pick the last in the list
+            $prettyprintname = "";
+            foreach ($extinfo['names'] as $lang => $name) {
+                if ($lang == $languageInstance->getLang()) {
+                    $prettyprintname = $name;
+                }
+            }
+            if ($prettyprintname == "" && isset($extinfo['names']['en'])) {
+                $prettyprintname = $extinfo['names']['en'];
+            }
+            if ($prettyprintname == "") {
+                foreach ($extinfo['names'] as $name) {
+                    $prettyprintname = $name;
+                }
+            }
+            // fill the rest of the text
+            $introtext = sprintf(_("a %s %s has invited you to manage the %s  \"%s\"."), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_fed, $uiElements->nomenclature_inst, $prettyprintname) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
+            // do the token creation magic
+            $newtoken = $mgmt->createToken(TRUE, $mailaddress, $prettyprintname, $newexternalid);
+            $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP FUTURE  - Token created for " . $mailaddress);
+            break;
+        default: // includes OPERATION_MODE_INVALID
+            $wrongcontent = print_r($_POST, TRUE);
+            echo "<pre>Wrong parameters in POST:
 " . htmlspecialchars($wrongcontent) . "
 </pre>";
-        exit(1);
+            exit(1);
 }
 // are we on https?
 $proto = "http://";

core/ProfileSilverbullet.php

Doc Comments +1 added lines, -1 removed lines

@@ -254,7 +254,7 @@
      * create a CSR
      * 
      * @param resource $privateKey the private key to create the CSR with
-     * @return array with the CSR and some meta info
+     * @return integer with the CSR and some meta info
      */
     private function generateCsr($privateKey) {
         // token leads us to the NRO, to set the OU property of the cert

core/UserAPI.php

Doc Comments +7 added lines

@@ -138,6 +138,7 @@ 
      * 
      * @param string $device
      * @param AbstractProfile $profile
+     * @param string $generatedFor
      * @return array info about the new installer (mime and link)
      */
     private function generateNewInstaller($device, $profile, $generatedFor, $token, $password) {
@@ -327,6 +328,7 @@ 
      * @param string either 'idp' or 'federation' is allowed 
      * @param int $width maximum width of the generated image - if 0 then it is treated as no upper bound
      * @param int $height  maximum height of the generated image - if 0 then it is treated as no upper bound
+     * @param string $type
      * @return array|null array with image information or NULL if there is no logo
      */
     protected function getLogo($identifier, $type, $width = 0, $height = 0) {
@@ -371,6 +373,10 @@ 
         return ["filetype" => $filetype, "expires" => $expiresString, "blob" => $blob];
     }
     
+    /**
+     * @param integer $width
+     * @param integer $height
+     */
     private function testForResize($width, $height) {
         if (is_numeric($width) && is_numeric($height) && ($width > 0 || $height > 0)) {
             if ($height == 0) {
@@ -474,6 +480,7 @@ 
     /**
      * Order active identity providers according to their distance and name
      * @param array $currentLocation - current location
+     * @param string $country
      * @return array $IdPs -  list of arrays ('id', 'name');
      */
     public function orderIdentityProviders($country, $currentLocation = NULL) {

web/lib/admin/OptionDisplay.php

Doc Comments +11 added lines, -1 removed lines

@@ -142,6 +142,9 @@ 
         return $retval;
     }
 
+    /**
+     * @param integer $rowid
+     */
     private function selectElement($rowid, $list) {
         $jsmagic = "onchange='
                                if (/#ML#/.test(document.getElementById(\"option-S" . $rowid . "-select\").value)) {
@@ -183,6 +186,10 @@ 
         return ["TEXT" => $retval, "ACTIVE" => $activelisttype];
     }
 
+    /**
+     * @param integer $rowid
+     * @param boolean $makeVisible
+     */
     private function selectLanguage($rowid, $makeVisible) {
         $retval = "<select style='display:" . ($makeVisible ? "block" : "none") . "' name='value[S$rowid-lang]' id='S" . $rowid . "-input-langselect'>
             <option value='' name='select_language' selected>" . _("select language") . "</option>
@@ -203,6 +210,9 @@ 
         \core\Options::TYPECODE_TEXT => ["html" => "textarea cols='30' rows='3'", "tail" => '></textarea'],
     ];
 
+    /**
+     * @param integer $rowid
+     */
     private function inputFields($rowid, $activetype) {
         $retval = "";
         foreach (OptionDisplay::HTML_DATATYPE_TEXTS as $key => $type) {
@@ -235,7 +245,7 @@ 
      * @param int $rowid the HTML field base name of the option to be displayed
      * @param string $optionName the name of the option to display
      * @param string $optionValue the value of the option to display
-     * @param mixed $optionLang the language of the option to display
+     * @param null|string $optionLang the language of the option to display
      * @return string HTML code
      * @throws Exception
      */

devices/xml/Device_XML.php

Doc Comments +6 added lines

@@ -287,6 +287,9 @@ 
         }
     }
 
+    /**
+     * @param Type $eaptype
+     */
     private function setServerSideCredentials($eaptype) {
         $attr = $this->attributes;
         $serversidecredential = new ServerSideCredential();
@@ -331,6 +334,9 @@ 
         return($clientsidecredential);
     }
     
+    /**
+     * @param Type $eaptype
+     */
     private function setEapMethod($eaptype) {
         $attr = $this->attributes;
         $eapmethod = new EAPMethod();

devices/ms/WindowsCommon.php

Doc Comments +6 added lines

@@ -138,6 +138,9 @@ 
         return($out);
     }    
     
+    /**
+     * @param integer $maxSize
+     */
     private function scaleLogo($imagePath, $maxSize) {
         $imageObject = new \Imagick($imagePath);
         $imageSize = $imageObject->getImageGeometry();
@@ -226,6 +229,9 @@ 
         $this->loggerInstance->debug(4, "compileNSIS:$command\n");
     }
 
+    /**
+     * @param string $type
+     */
     private function getSupport($attr, $type) {
         $supportString = [
             'email' => 'SUPPORT',