Fix typos found by codespell

Changes.md

@@ -92,7 +92,7 @@ Changes in 2.1.2
 - [FEATURE #13] add TIMEOUTS constant to config/Diagnostics.php to eliminate
                 very long delays in testing sites - this requires updating 
                 your instance following the Diagnostics-template.php
-- [FEATURE #14] Improvemens to the linux python installed, in particular add support
+- [FEATURE #14] Improvements to the linux python installed, in particular add support
                 for Tkinker and yad provided by https://github.com/sdasda7777
 - [FEATURE #15] Removing the Registered Trademark character form the eduroam profile
                 name in Windows
@@ -101,7 +101,7 @@ Changes in 2.1.2
                 the deprecated FILTER_SANITIZE_STRING usage
 - [BUGFIX #2]   replaced slow SQL queries in Managed IdP area with much faster ones
 - [BUGFIX #3]   fixed blocking of Ajax requests caused by php sessions
-- [BUGFIX #4]   added several mising indexes in tables
+- [BUGFIX #4]   added several missing indexes in tables
 - [BUGFIX #5]   reduced number of database queries in overrvier_federation.php
 
 Changes in 2.1

config/ConfAssistant-template.php

@@ -122,7 +122,7 @@ class ConfAssistant
      * "testing" controls which instance of eduPKI we are using and also
      * the requested expiry time of the certificates (1y for testing, 5y for production)
      * "max_expiry" set to true means that we will be requesting certificates
-     * with maximum avaliable validity, controlled by eduPKI defaults (at the moment
+     * with maximum available validity, controlled by eduPKI defaults (at the moment
      * the expiry date of the CA certificate)
      */
     const eduPKI = [

config/Diagnostics-template.php

@@ -124,7 +124,7 @@ class Diagnostics
             'secret' => '1q2w3e4r5t0O9I8U7Y6TaZ',
         ];
         const TIMEOUTS = [
-            'ajax_radius_tests' => 15000, // miliseconds
+            'ajax_radius_tests' => 15000, // milliseconds
             'crl_download' => 10,         // seconds
         ];
 }

config/Master-template.php

@@ -175,7 +175,7 @@ class Master
             'certfilename' => NULL,
             'keyfilename' => NULL,
             'keypass' => NULL,
-            'notify_nro' => false, // normally should be set to TRUE abd causes 
+            'notify_nro' => false, // normally should be set to TRUE and cause 
                                    // notifications being sent to NRO admins when
                                    // important changes are made
         ];
@@ -280,8 +280,8 @@ class Master
              * We are now prepared to use a local cache database. For the eduroam case a daily
              * update is sufficient and is done by the utils/update_monitor_copy.php. In this case
              * the EXTERNAL is actually a local DB, and EXTERNAL_SOURCE is used as the actual
-             * source for caching. You may use the EXTERNAL as a real extermal database and
-             * do not worry about setting aything in EXTERNAL_SOURCE
+             * source for caching. You may use the EXTERNAL as a real external database and
+             * do not worry about setting anything in EXTERNAL_SOURCE
              * 
              * The code for the consortium "eduroam" is already written and may serve as template. See the functions in question. */
             // Marking this as readonly currently has no effect, as we only ever do SELECTs on that database

core/AbstractProfile.php

@@ -694,7 +694,7 @@ public function setRealm(string $realm)
      * register new supported EAP method for this profile
      *
      * @param \core\common\EAP $type       The EAP Type, as defined in class EAP
-     * @param int              $preference preference of this EAP Type. If a preference value is re-used, the order of EAP types of the same preference level is undefined.
+     * @param int              $preference preference of this EAP Type. If a preference value is reused, the order of EAP types of the same preference level is undefined.
      * @return void
      */
     public function addSupportedEapMethod(\core\common\EAP $type, $preference)

core/DeploymentManaged.php

@@ -846,7 +846,7 @@ public function setRADIUSconfig($onlyone = 0, $notify = 0, $torevoke = "")
         $response = array();
         foreach ($toPost as $key => $value) {
             $this->loggerInstance->debug(1, 'toPost ' . $toPost[$key] . "\n");
-            // temporarly one server $response['res[' . $key . ']'] = $this->sendToRADIUS($key, $toPost[$key]);
+            // temporarily one server $response['res[' . $key . ']'] = $this->sendToRADIUS($key, $toPost[$key]);
             /*if ($key == 2) {
                 $response['res[2]'] = 'OK'; 
             } else { */

core/EntityWithDBProperties.php

@@ -155,14 +155,14 @@ private function getRelevantIdentifier()
      * are not considered.
      *
      * @param string $optionName optionally, the name of the attribute that is to be retrieved
-     * @param string$omittedOptionName optionally drop attibutes with that name
+     * @param string$omittedOptionName optionally drop attributes with that name
      * @return array of arrays of attributes which were set for this IdP
      */
     public function getAttributes(string $optionName = NULL, string $omittedOptionName = NULL)
     {
         if ($optionName !== NULL) {
             if ($optionName === $omittedOptionName) {
-                throw new Exception("The attibute to be shown has the same name as that to be omitted");
+                throw new Exception("The attribute to be shown has the same name as that to be omitted");
             }
             $returnarray = [];
             foreach ($this->attributes as $theAttr) {

core/ExternalEduroamDBData.php

@@ -173,8 +173,8 @@ public function countAllServiceProviders() {
      * separate institution names as written in the eduroam DB into array
      * 
      * @param string $collapsed - '#' separated list of names - each name has
-     *      two-letter language prefic followed by ':'
-     * @return array $nameList - tle list contains both separate per-lang entires
+     *      two-letter language prefix followed by ':'
+     * @return array $nameList - tle list contains both separate per-lang entries
      *        and a joint one, just names no lang info - this used for comparison with CAT institution names
      */
     public static function dissectCollapsedInstitutionNames($collapsed) {
@@ -298,7 +298,7 @@ public function listExternalEntitiesByRealm($realm, $fields = []) {
 
     /**
      * retrieves the list of identifiers (external and local) of all institutions
-     * which have the admin email listed in the externam DB, thos that are synced to an
+     * which have the admin email listed in the external DB, those that are synced to an
      * existing CAT institution will also have the local identifier (else NULL)
      * 
      * @param string $userEmail

core/ExternalNothing.php

@@ -126,7 +126,7 @@ public function listExternalTlsServersInstitution($tld) {
 
     /**
      * retrieves the list of identifiers (external and local) of all institutions
-     * which have the admin email listed in the externam DB, thos that are synced to an
+     * which have the admin email listed in the external DB, those that are synced to an
      * existing CAT institution will also have the local identifier (else NULL)
      * 
      * @param string $userEmail

core/Federation.php

@@ -745,7 +745,7 @@ public function loadAdminsLogins() {
             } else {
                 $inactivityTimestamp = time() - $inactivityOverride[0]['value'] * 24 * 3600;
             }
-            // $active shows the time difference between the moment when a login thime would be considered as inactive
+            // $active shows the time difference between the moment when a login would be considered as inactive
             // and the start of the recording system. If this is negative then we we cannot tell that someone who
             // was not recorded was not actually active within the allowed period
             $active = $inactivityTimestamp - strtotime(\config\ConfAssistant::ADMIN_LOGINS['startday']);

core/ProfileSilverbullet.php

@@ -192,7 +192,7 @@ public function updateCache($device, $path, $mime, $integerEapType, $openRoaming
      * register new supported EAP method for this profile
      *
      * @param \core\common\EAP $type       The EAP Type, as defined in class EAP
-     * @param int              $preference preference of this EAP Type. If a preference value is re-used, the order of EAP types of the same preference level is undefined.
+     * @param int              $preference preference of this EAP Type. If a preference value is reused, the order of EAP types of the same preference level is undefined.
      * @return void
      * @throws Exception
      */
@@ -252,7 +252,7 @@ public function getUserExpiryDate($userId) {
      * 
      * @param int $userId the numerical user ID of the user in question
      * @param boolean $testActivity set true if we are only interested in checking
-     *        user existance in auth database
+     *        user existence in auth database
      * @return array
      */
     public function getUserAuthRecords($userId, $testActivity = false) {

core/UserManagement.php

@@ -386,7 +386,7 @@ public function listRecentlyExpiredInvitations()
     public function listInstitutionsByAdmin()
     {
         $edugain = $_SESSION['eduGAIN'];
-        // get the list of local identifers of institutions managed by this user
+        // get the list of local identifiers of institutions managed by this user
         // it will be returned as $this->currentInstitutions
         $this->getCurrentInstitutionsByAdmin();
         if (count($this->currentInstitutions) == 0) {
@@ -398,7 +398,7 @@ public function listInstitutionsByAdmin()
             return $this->currentInstitutions;
         }
         // now add additional institutions based on the external DB 
-        // proceed only if user has been authenticated fron an eduGAIN IdP        
+        // proceed only if user has been authenticated from an eduGAIN IdP        
         if ($edugain == false) {
             return $this->currentInstitutions;            
         }
@@ -407,7 +407,7 @@ public function listInstitutionsByAdmin()
         // get the list of identifiers in the external DB with this user listed as the admin and linked to CAT institutions
         $extInstList = $externalDB->listExternalEntitiesByUserEmail($email);
         $extInstListTmp = $extInstList;
-        // we begin by removing entites in $extInstList which are already managed by this user and synced -
+        // we begin by removing entities in $extInstList which are already managed by this user and synced -
         // these require no further checking
         foreach ($extInstListTmp as $country => $extInstCountryList) {
             $len = count($extInstCountryList);
@@ -488,11 +488,11 @@ private function doExternalDBAutoregisterNew($extInstCountryList, $fed) {
         }
         foreach ($extInstCountryList as $extInst) {
             common\Logging::debug_s(4, "Testing ".$extInst['external_db_id']." for potential new inst\n");
-            if ($extInst['inst_id'] != null) { // there alreay exeists a CAT institution synced to this one
+            if ($extInst['inst_id'] != null) { // there already exeists a CAT institution synced to this one
                 continue;
             }
             $country = strtoupper($fed->tld);
-            // now run checks against creating dupplicates in CAT DB
+            // now run checks against creating duplicates in CAT DB
             $disectedNames = ExternalEduroamDBData::dissectCollapsedInstitutionNames($extInst['name']);
             $names = $disectedNames['joint'];
             $realms = ExternalEduroamDBData::dissectCollapsedInstitutionRealms($extInst['realm']);
@@ -624,8 +624,8 @@ public function checkForCatMatch($extId, $ROid) {
     /**
      * get the list of current institutions of the given admin
      * 
-     * This method does not rerurn anything but sets $this->currentInstitutions
-     * it only fillsh the 'existing' block, leaving the other two for other methods
+     * This method does not return anything but sets $this->currentInstitutions
+     * it only fills the 'existing' block, leaving the other two for other methods
      * to deal with
      */
     private function getCurrentInstitutionsByAdmin() {
@@ -636,7 +636,7 @@ private function getCurrentInstitutionsByAdmin() {
             'entitlement' => []
         ];
         $userId = $_SESSION['user'];
-        // get the list of local identifers of institutions managed by this user
+        // get the list of local identifiers of institutions managed by this user
         $institutions = $this->databaseHandle->exec("SELECT ownership.institution_id as inst_id FROM ownership WHERE user_id = ? ORDER BY institution_id", "s", $userId);
         // SELECT -> resource, not boolean
         $catInstList = $institutions->fetch_all();
@@ -650,7 +650,7 @@ private function getCurrentInstitutionsByAdmin() {
      * given arrays of realms and names check if there already are institutions in CAT that 
      * could be a match - this is for ellimination and against creating duplicates
      * still this is not perfect, no realms given and institutions with a slightly different
-     * name will return no-match and thus open possibility for dupplicates
+     * name will return no-match and thus open possibility for duplicates
      * 
      * @param array $namesToTest
      * @param array $realmsToTest

core/common/OutsideComm.php

@@ -298,7 +298,7 @@ public static function adminInvitationMail($targets, $introtext, $newtoken, $idp
             OutsideComm::INVITE_CONTEXTS[0] => sprintf(_("a %s of the %s %s \"%s\" has invited you to manage the %s together with them."), Entity::$nomenclature_fed, \config\ConfAssistant::CONSORTIUM['display_name'], Entity::$nomenclature_participant, $idpPrettyName, Entity::$nomenclature_participant),
             OutsideComm::INVITE_CONTEXTS[1] => sprintf(_("a %s %s has invited you to manage the future %s  \"%s\" (%s). The organisation will be a %s."), \config\ConfAssistant::CONSORTIUM['display_name'], Entity::$nomenclature_fed, Entity::$nomenclature_participant, $idpPrettyName, strtoupper($federation->tld), $prettyPrintType),
             OutsideComm::INVITE_CONTEXTS[2] => sprintf(_("a %s %s has invited you to manage the %s  \"%s\". This is a %s."), \config\ConfAssistant::CONSORTIUM['display_name'], Entity::$nomenclature_fed, Entity::$nomenclature_participant, $idpPrettyName, $prettyPrintType),
-            OutsideComm::INVITE_CONTEXTS[3] => sprintf(_("You have succesfully invited yourself to manage %s %s.\n If this mail is not the result of an action taken by you then please report this to your %s %s administrator.\n"), Entity::$nomenclature_participant, $idpPrettyName, \config\ConfAssistant::CONSORTIUM['display_name'], Entity::$nomenclature_fed),
+            OutsideComm::INVITE_CONTEXTS[3] => sprintf(_("You have successfully invited yourself to manage %s %s.\n If this mail is not the result of an action taken by you then please report this to your %s %s administrator.\n"), Entity::$nomenclature_participant, $idpPrettyName, \config\ConfAssistant::CONSORTIUM['display_name'], Entity::$nomenclature_fed),
         ];
         $validity = sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X %Z", time() + 86400));
         // need some nomenclature

core/diag/RFC5997Tests.php

@@ -41,7 +41,7 @@ class RFC5997Tests extends AbstractTest
 
     const PACKET_TYPE_STATUS_SERVER = "\xc";
     const PACKET_TYPE_ACCESS_ACCEPT = "\x2";
-    const PACKET_LENGTH = "\x0\x2b"; // only calid for string CAT in NAS-Id
+    const PACKET_LENGTH = "\x0\x2b"; // only valid for string CAT in NAS-Id
     const ATTRIBUTE_NAS_IDENTIFIER = "\x20";
     const LENGTH_NAS_IDENTIFIER = "\x5"; // only valid for string CAT
     const VALUE_NAS_IDENTIFIER = "CAT";

devices/eap_config/DeviceXML.php

@@ -392,10 +392,10 @@ private function getProviderLogo()
 
     /**
      * Scales a logo to the desired byte imag size if necessary.
-     * If the image size is below tha alowed maximum, nothing is done;
+     * If the image size is below the allowed maximum, nothing is done;
      * if the image is larger than we run a series of scaling iterations to sizes
      * specified in $maxPixelSize and the moment we manage to end up below the $maxByte
-     * we returm the scaled blob - we always use png as the output format since it seems
+     * we return the scaled blob - we always use png as the output format since it seems
      * to behave best in scaling.
      * 
      * @param string $blob the image data

devices/ms/DeviceW8W10.php

@@ -95,7 +95,7 @@ public function writeInstaller()
                 $delProfiles[] = $ssid.' (TKIP)';
             }
         }
-        // the two lines below remove the eduroam® profiles we used to install, this is a temporary hack untill a better solution is implemented
+        // the two lines below remove the eduroam® profiles we used to install, this is a temporary hack until a better solution is implemented
         $delProfiles[] = 'eduroam®';
         $delProfiles[] = 'eduroam® via partner';
         // this removes the profile container that we used in CAT 2.1 and removed in 2.1.1

translation/nl_NL/web_admin.po

@@ -1415,7 +1415,7 @@ msgstr "Jouw attributen"
 
 #: web/admin/edit_user_result.php:28
 msgid "User Attributes - Summary of submitted data"
-msgstr "Gebruikersattibuten - Overzicht van verstrekte gegevens"
+msgstr "Gebruikersattributen - Overzicht van verstrekte gegevens"
 
 #. what are we supposed to do?
 #: web/admin/edit_user_result.php:32

utils/Update_eduroamDB1_2/config.php

@@ -3,7 +3,7 @@
 $databases = [
     'eduroam' => "eduroam1_1_tmp", // this is the local copy of eduroam (v1) database created by update_monitor_copy.php
     'eduroamv2' => "eduroam2_1_tmp", // this is the local copy of eduroam (v2) database created by update_monitor_copy.php
-    'cat' => "cat_twoln_214_test2",  // this is the curent production CAT database where we need to put in new identifiers
-    'eduroam_new' => "monitor_copy2_test_xxx" // this is the resulting monitor_copy database containing all data required by CAT it must exist but tables will be created by the sript
+    'cat' => "cat_twoln_214_test2",  // this is the current production CAT database where we need to put in new identifiers
+    'eduroam_new' => "monitor_copy2_test_xxx" // this is the resulting monitor_copy database containing all data required by CAT it must exist but tables will be created by the script
 ];
 

utils/Update_eduroamDB1_2/sync_databases.php

@@ -3,7 +3,7 @@
  * This a one-time procedure required to resync CAT with eduroamv2 institition
  * identifiers
  * 
- * First run update_monitor_copy.php with resultung databases set to the ones listed below
+ * First run update_monitor_copy.php with resulting databases set to the ones listed below
  * Next run this script
  * 
  */

utils/test_openroaming.php

@@ -11,7 +11,7 @@
 require_once dirname(dirname(__FILE__)) . "/config/_config.php";
 
 /**
- * The sctipt will be called from crontab
+ * The script will be called from crontab
  * 
  * list all profiles
  * foreach profile create the profile object

web/admin/duplicate_profile.php

@@ -20,7 +20,7 @@
  */
 
 /**
- * This page is used to preapre creation of a duplicate of a RADIUS profile by
+ * This page is used to prepare creation of a duplicate of a RADIUS profile by
  * its administrator.
  * The new profile will have the display names replaces with one velue set by
  * the admin during duplication. The production-ready flag will be removed.

web/admin/inc/manageDBLink.inc.php

@@ -67,7 +67,7 @@
                 header("Location: ../overview_federation.php");
                 exit;
             }
-            // okay, they did sumbit an inst. It's either a (string) handle from a promising 
+            // okay, they did submit an inst. It's either a (string) handle from a promising 
             // candidate, or "other" as selected from the drop-down list
             if ($_POST['inst_link'] != "other") {
                 $my_inst->setExternalDBId($validator->string(filter_input(INPUT_POST, 'inst_link')), $fedId); // validator will do additional checks