GEANT / CAT

core/CAT.php

Doc Comments +1 added lines, -1 removed lines

@@ -230,7 +230,7 @@
      * @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. 
+     * @return boolean|null TRUE if successful. Will terminate script execution on failure. 
      */
     public static function writeAudit($user, $category, $message) {
         switch ($category) {

Indentation +3 added lines, -3 removed lines

@@ -191,9 +191,9 @@
      * gets the language setting in CAT
      */
     static public function get_lang() {
-       if(self::$LANG === '')
-         list(self::$LANG, $xx) = self::set_lang();
-       return self::$LANG;
+        if(self::$LANG === '')
+            list(self::$LANG, $xx) = self::set_lang();
+        return self::$LANG;
     }
 
     /**

core/DBConnection.php

Doc Comments +4 added lines

@@ -87,6 +87,7 @@ 
     /**
      * executes a query and triggers logging to the SQL audit log if it's not a SELECT
      * @param string $querystring the query to be executed
+     * @param string $db
      * @return mixed the query result as mysqli_result object; or TRUE on non-return-value statements
      */
     public static function exec($db, $querystring) {
@@ -134,6 +135,8 @@ 
     /**
      * Checks if a raw data pointer is public data (return value FALSE) or if 
      * yes who the authorised admins to view it are (return array of user IDs)
+     * @param string $table
+     * @param string $row
      */
     public static function isDataRestricted($table, $row) {
         if ($table != "institution_option" && $table != "profile_option" && $table != "federation_option")
@@ -175,6 +178,7 @@ 
 
     /**
      * Retrieves the last auto-id of an INSERT. Needs to be called immediately after the corresponding exec() call
+     * @param string $db
      * @return int the last autoincrement-ID
      */
     public static function lastID($db) {

core/DeviceConfig.php

Doc Comments +2 added lines, -5 removed lines

@@ -172,7 +172,7 @@ 
     * named the same as device_id. The second option takes precedence.
     *
     * @param string $source_name The source file name
-    * @param string $output_name The destination file name
+    * @param integer $output_name The destination file name
     *
     * @return bool result of the copy operation
     * @final not to be redefined
@@ -216,8 +216,7 @@ 
     * named the same as device_id. The second option takes precedence.
     *
     * @param string $source_name The source file name
-    * @param string $output_name The destination file name
-    * @param int $use_win_cp Set Windows charset if non-zero
+    * @param integer $output_name The destination file name
     *
     * @final not to be redefined
     */
@@ -262,8 +261,6 @@ 
     * The second optional parameter, if nonzero, should be the character set understood by iconv
     * This is required by the Windows installer and is expected to go away in the future.
     *
-    * @param string $source_name The source file name
-    * @param int $use_win_cp Set Windows charset if non-zero
     *
     * @final not to be redefined
     */

Indentation +421 added lines, -421 removed lines

@@ -6,10 +6,10 @@ 
 ?>
 <?php
 /**
-  * This file defines the abstract Device class
-  *
-  * @package ModuleWriting
-  */
+ * This file defines the abstract Device class
+ *
+ * @package ModuleWriting
+ */
 
 /**
  * 
@@ -46,10 +46,10 @@ 
  */
 
 abstract class DeviceConfig {
-   /**
-    * stores the path to the temporary working directory for a module instance
-    * @var string $FPATH
-    */
+    /**
+     * stores the path to the temporary working directory for a module instance
+     * @var string $FPATH
+     */
     public $FPATH;
 
     /**
@@ -58,390 +58,390 @@ 
      */
     public $specialities;
 
-   /**
+    /**
      * device module constructor should be defined by each module, but if it is not, then here is a default one
      */
 
-      public function __construct() {
-      $this->supportedEapMethods  = [EAP::$TLS, EAP::$PEAP_MSCHAP2, EAP::$TTLS_PAP];
-      debug(4,"This device supports the following EAP methods: ");
-      debug(4,$this->supportedEapMethods);
+        public function __construct() {
+        $this->supportedEapMethods  = [EAP::$TLS, EAP::$PEAP_MSCHAP2, EAP::$TTLS_PAP];
+        debug(4,"This device supports the following EAP methods: ");
+        debug(4,$this->supportedEapMethods);
     }
 
 
-   /**
-    * Set up working environment for a device module
-    *
-    * Sets up the device module environment taking into account the actual profile
-    * selected by the user in the GUI. The selected profile is passed as the
-    * Profile $profile argumant.
-    *
-    * This method needs to be called after the device instance has been created (the GUI class does that)
-    *
-    * setup performs the following tasks:
-    * - collect profile attributes and pass them as the attributes property;
-    * - create the temporary working directory
-    * - process CA certificates and store them as 'internal:CAs' attribute
-    * - process and save optional info files and store references to them in
-    *   'internal:info_file' attribute
-    * @param Profile $profile the profile object which will be passed by the caller
-    * @final not to be redefined
-    */
+    /**
+     * Set up working environment for a device module
+     *
+     * Sets up the device module environment taking into account the actual profile
+     * selected by the user in the GUI. The selected profile is passed as the
+     * Profile $profile argumant.
+     *
+     * This method needs to be called after the device instance has been created (the GUI class does that)
+     *
+     * setup performs the following tasks:
+     * - collect profile attributes and pass them as the attributes property;
+     * - create the temporary working directory
+     * - process CA certificates and store them as 'internal:CAs' attribute
+     * - process and save optional info files and store references to them in
+     *   'internal:info_file' attribute
+     * @param Profile $profile the profile object which will be passed by the caller
+     * @final not to be redefined
+     */
     final public function setup(Profile $profile) {
-       debug(4,"module setup start\n");
-       if(! $profile instanceof Profile) {
-          debug(2,"No profile has been set\n");
-          error("No profile has been set");
-          exit;
-       }
-       $this->attributes = $this->getProfileAttributes($profile);
-       if(! $this->selected_eap) {
-          error("No EAP type specified.");
-          exit;
-       }
-       // create temporary directory, its full path will be saved in $this->FPATH;
-       $T = createTemporaryDirectory('installer');
-       $this->FPATH = $T['dir'];
-       mkdir($T['dir'].'/tmp');
-       chdir($T['dir'].'/tmp');
-       $CAs = [];
-       if(isset($this->attributes['eap:ca_file'])) {
-       foreach ($this->attributes['eap:ca_file'] as $ca) {
-          if($c = X509::processCertificate($ca))
-             $CAs[] = $c;
-          }
-          $this->attributes['internal:CAs'][0]=$CAs;
-       }
-       if(isset($this->attributes['support:info_file'])) {
-          $this->attributes['internal:info_file'][0] = 
-             $this->saveInfoFile($this->attributes['support:info_file'][0]);
-       }
-       if(isset($this->attributes['general:logo_file']))
-          $this->attributes['internal:logo_file'] = 
-             $this->saveLogoFile($this->attributes['general:logo_file']);
-       $this->attributes['internal:SSID'] = $this->getSSIDs()['add'];;
-       $this->attributes['internal:remove_SSID'] = $this->getSSIDs()['del'];;
-       $this->attributes['internal:consortia'] = $this->getConsortia();
-       $this->lang_index = CAT::get_lang();
-       // phpMD says the below is not needed. Wow.
-       // $idp = new IdP($profile->institution);
-       $olddomain = CAT::set_locale("core");
-       $this->support_email_substitute = sprintf(_("your local %s support"),Config::$CONSORTIUM['name']);
-       $this->support_url_substitute = sprintf(_("your local %s support page"),Config::$CONSORTIUM['name']);
-       CAT::set_locale($olddomain);
-
-       if($this->signer && $this->options['sign'])
-         $this->sign = CAT::$root . '/signer/'. $this->signer;
-       $this->installerBasename = $this->getInstallerBasename();
+        debug(4,"module setup start\n");
+        if(! $profile instanceof Profile) {
+            debug(2,"No profile has been set\n");
+            error("No profile has been set");
+            exit;
+        }
+        $this->attributes = $this->getProfileAttributes($profile);
+        if(! $this->selected_eap) {
+            error("No EAP type specified.");
+            exit;
+        }
+        // create temporary directory, its full path will be saved in $this->FPATH;
+        $T = createTemporaryDirectory('installer');
+        $this->FPATH = $T['dir'];
+        mkdir($T['dir'].'/tmp');
+        chdir($T['dir'].'/tmp');
+        $CAs = [];
+        if(isset($this->attributes['eap:ca_file'])) {
+        foreach ($this->attributes['eap:ca_file'] as $ca) {
+            if($c = X509::processCertificate($ca))
+                $CAs[] = $c;
+            }
+            $this->attributes['internal:CAs'][0]=$CAs;
+        }
+        if(isset($this->attributes['support:info_file'])) {
+            $this->attributes['internal:info_file'][0] = 
+                $this->saveInfoFile($this->attributes['support:info_file'][0]);
+        }
+        if(isset($this->attributes['general:logo_file']))
+            $this->attributes['internal:logo_file'] = 
+                $this->saveLogoFile($this->attributes['general:logo_file']);
+        $this->attributes['internal:SSID'] = $this->getSSIDs()['add'];;
+        $this->attributes['internal:remove_SSID'] = $this->getSSIDs()['del'];;
+        $this->attributes['internal:consortia'] = $this->getConsortia();
+        $this->lang_index = CAT::get_lang();
+        // phpMD says the below is not needed. Wow.
+        // $idp = new IdP($profile->institution);
+        $olddomain = CAT::set_locale("core");
+        $this->support_email_substitute = sprintf(_("your local %s support"),Config::$CONSORTIUM['name']);
+        $this->support_url_substitute = sprintf(_("your local %s support page"),Config::$CONSORTIUM['name']);
+        CAT::set_locale($olddomain);
+
+        if($this->signer && $this->options['sign'])
+            $this->sign = CAT::$root . '/signer/'. $this->signer;
+        $this->installerBasename = $this->getInstallerBasename();
     }
 
-  /**
-    * Selects the preferred eap method based on profile EAP configuration and device EAP capabilities
-    *
-    * @param array eap_array an array of eap methods supported by a given device
-    * @return the best matching EAP type for the profile; or 0 if no match was found
-    */   
-   public function getPreferredEapType($eap_array) {
-     foreach ($eap_array as $eap) {
-         if(in_array($eap,$this->supportedEapMethods)) {
+    /**
+     * Selects the preferred eap method based on profile EAP configuration and device EAP capabilities
+     *
+     * @param array eap_array an array of eap methods supported by a given device
+     * @return the best matching EAP type for the profile; or 0 if no match was found
+     */   
+    public function getPreferredEapType($eap_array) {
+        foreach ($eap_array as $eap) {
+            if(in_array($eap,$this->supportedEapMethods)) {
             $this->selected_eap = $eap;
             debug(4,"Selected EAP:");
             debug(4,$eap);
             return($eap);
-         }
-     }
-     return(0);
-   }
-  /**
-    * prepare usage information for the installer
-    * every device module should override this method
-    *
-    * @return String HTML text to be displayed
-    */ 
-   public function writeDeviceInfo() {
-     return _("Sorry, this should not happen - no additional information is available");
-   }
-
-  /**
-    *  Copy a file from the module location to the temporary directory.
-    *
-    * If the second argument is provided then the file will be saved under the name 
-    * taken form this argument. If only one parameter is given, source and destination
-    * filenames are the same
-    * Source file can be located either in the Files subdirectory or in the sibdirectory of Files
-    * named the same as device_id. The second option takes precedence.
-    *
-    * @param string $source_name The source file name
-    * @param string $output_name The destination file name
-    *
-    * @return bool result of the copy operation
-    * @final not to be redefined
-    */
-   final protected function copyFile($source_name, $output_name = 0) {
-      if  ( $output_name === 0)
+            }
+        }
+        return(0);
+    }
+    /**
+     * prepare usage information for the installer
+     * every device module should override this method
+     *
+     * @return String HTML text to be displayed
+     */ 
+    public function writeDeviceInfo() {
+        return _("Sorry, this should not happen - no additional information is available");
+    }
+
+    /**
+     *  Copy a file from the module location to the temporary directory.
+     *
+     * If the second argument is provided then the file will be saved under the name 
+     * taken form this argument. If only one parameter is given, source and destination
+     * filenames are the same
+     * Source file can be located either in the Files subdirectory or in the sibdirectory of Files
+     * named the same as device_id. The second option takes precedence.
+     *
+     * @param string $source_name The source file name
+     * @param string $output_name The destination file name
+     *
+     * @return bool result of the copy operation
+     * @final not to be redefined
+     */
+    final protected function copyFile($source_name, $output_name = 0) {
+        if  ( $output_name === 0)
         $output_name = $source_name;
 
-      debug(4,"fileCopy($source_name, $output_name)\n");
-      if(is_file($this->module_path.'/Files/'.$this->device_id.'/'.$source_name))
-         $source = $this->module_path.'/Files/'.$this->device_id.'/'.$source_name;
-      elseif(is_file($this->module_path.'/Files/'.$source_name))
-         $source = $this->module_path.'/Files/'.$source_name;
-      else {
+        debug(4,"fileCopy($source_name, $output_name)\n");
+        if(is_file($this->module_path.'/Files/'.$this->device_id.'/'.$source_name))
+            $source = $this->module_path.'/Files/'.$this->device_id.'/'.$source_name;
+        elseif(is_file($this->module_path.'/Files/'.$source_name))
+            $source = $this->module_path.'/Files/'.$source_name;
+        else {
         debug(2,"fileCopy:reqested file $source_name does not exist\n");
         return(FALSE);
-      }
-      debug(4,"Copying $source to $output_name\n");
-      $result = copy($source,"$output_name");
-      if(! $result )
+        }
+        debug(4,"Copying $source to $output_name\n");
+        $result = copy($source,"$output_name");
+        if(! $result )
         debug(2,"fileCopy($source_name, $output_name) failed\n");
-      return($result); 
-   }
-
-
-  /**
-    *  Copy a file from the module location to the temporary directory aplying transcoding.
-    *
-    * Transcoding is only required for Windows installers, and no Unicode support
-    * in NSIS (NSIS version below 3)
-    * Trancoding is only applied if the third optional parameter is set and nonzero
-    * If Config::$NSIS_VERSION is set to 3 or more, no transcoding will be applied
-    * regardless of the third parameter value.
-    * If the second argument is provided and is not equal to 0, then the file will be
-    * saved under the name taken from this argument.
-    * If only one parameter is given or the second is equal to 0, source and destination
-    * filenames are the same.
-    * The third optional parameter, if nonzero, should be the character set understood by iconv
-    * This is required by the Windows installer and is expected to go away in the future.
-    * Source file can be located either in the Files subdirectory or in the sibdirectory of Files
-    * named the same as device_id. The second option takes precedence.
-    *
-    * @param string $source_name The source file name
-    * @param string $output_name The destination file name
-    * @param int $use_win_cp Set Windows charset if non-zero
-    *
-    * @final not to be redefined
-    */
-
-   final protected function translateFile($source_name, $output_name = 0, $encoding = 0) {
-      if(Config::$NSIS_VERSION >= 3)
+        return($result); 
+    }
+
+
+    /**
+     *  Copy a file from the module location to the temporary directory aplying transcoding.
+     *
+     * Transcoding is only required for Windows installers, and no Unicode support
+     * in NSIS (NSIS version below 3)
+     * Trancoding is only applied if the third optional parameter is set and nonzero
+     * If Config::$NSIS_VERSION is set to 3 or more, no transcoding will be applied
+     * regardless of the third parameter value.
+     * If the second argument is provided and is not equal to 0, then the file will be
+     * saved under the name taken from this argument.
+     * If only one parameter is given or the second is equal to 0, source and destination
+     * filenames are the same.
+     * The third optional parameter, if nonzero, should be the character set understood by iconv
+     * This is required by the Windows installer and is expected to go away in the future.
+     * Source file can be located either in the Files subdirectory or in the sibdirectory of Files
+     * named the same as device_id. The second option takes precedence.
+     *
+     * @param string $source_name The source file name
+     * @param string $output_name The destination file name
+     * @param int $use_win_cp Set Windows charset if non-zero
+     *
+     * @final not to be redefined
+     */
+
+    final protected function translateFile($source_name, $output_name = 0, $encoding = 0) {
+        if(Config::$NSIS_VERSION >= 3)
         $encoding = 0;
-      if  ( $output_name === 0)
+        if  ( $output_name === 0)
         $output_name = $source_name;
 
-      debug(4,"translateFile($source_name, $output_name, $encoding)\n");
-      ob_start();
-      debug(4,$this->module_path.'/Files/'.$this->device_id.'/'.$source_name."\n");
-      if(is_file($this->module_path.'/Files/'.$this->device_id.'/'.$source_name))
-         $source = $this->module_path.'/Files/'.$this->device_id.'/'.$source_name;
-      elseif(is_file($this->module_path.'/Files/'.$source_name))
-         $source = $this->module_path.'/Files/'.$source_name;
-      include($source);
-      $output = ob_get_clean();
-      if($encoding) {
+        debug(4,"translateFile($source_name, $output_name, $encoding)\n");
+        ob_start();
+        debug(4,$this->module_path.'/Files/'.$this->device_id.'/'.$source_name."\n");
+        if(is_file($this->module_path.'/Files/'.$this->device_id.'/'.$source_name))
+            $source = $this->module_path.'/Files/'.$this->device_id.'/'.$source_name;
+        elseif(is_file($this->module_path.'/Files/'.$source_name))
+            $source = $this->module_path.'/Files/'.$source_name;
+        include($source);
+        $output = ob_get_clean();
+        if($encoding) {
         $output_c = iconv('UTF-8',$encoding.'//TRANSLIT',$output);
         if($output_c)
-           $output = $output_c;
-      }
-      $f = fopen("$output_name","w");
-      if(! $f)
-         debug(2,"translateFile($source, $output_name, $encoding) failed\n");
-      fwrite($f,$output);
-      fclose($f);
-      debug(4,"translateFile($source, $output_name, $encoding) end\n");
-   }
-
-
-  /**
-    * Transcode a string adding double quotes escaping
-    *
-    * Transcoding is only required for Windows installers, and no Unicode support
-    * in NSIS (NSIS version below 3)
-    * Trancoding is only applied if the third optional parameter is set and nonzero
-    * If Config::$NSIS_VERSION is set to 3 or more, no transcoding will be applied
-    * regardless of the second parameter value.
-    * The second optional parameter, if nonzero, should be the character set understood by iconv
-    * This is required by the Windows installer and is expected to go away in the future.
-    *
-    * @param string $source_name The source file name
-    * @param int $use_win_cp Set Windows charset if non-zero
-    *
-    * @final not to be redefined
-    */
-
-   final protected function translateString($source_string,$encoding = 0) {
-      if(Config::$NSIS_VERSION >= 3)
+            $output = $output_c;
+        }
+        $f = fopen("$output_name","w");
+        if(! $f)
+            debug(2,"translateFile($source, $output_name, $encoding) failed\n");
+        fwrite($f,$output);
+        fclose($f);
+        debug(4,"translateFile($source, $output_name, $encoding) end\n");
+    }
+
+
+    /**
+     * Transcode a string adding double quotes escaping
+     *
+     * Transcoding is only required for Windows installers, and no Unicode support
+     * in NSIS (NSIS version below 3)
+     * Trancoding is only applied if the third optional parameter is set and nonzero
+     * If Config::$NSIS_VERSION is set to 3 or more, no transcoding will be applied
+     * regardless of the second parameter value.
+     * The second optional parameter, if nonzero, should be the character set understood by iconv
+     * This is required by the Windows installer and is expected to go away in the future.
+     *
+     * @param string $source_name The source file name
+     * @param int $use_win_cp Set Windows charset if non-zero
+     *
+     * @final not to be redefined
+     */
+
+    final protected function translateString($source_string,$encoding = 0) {
+        if(Config::$NSIS_VERSION >= 3)
         $encoding = 0;
-      if($encoding)
+        if($encoding)
         $output_c = iconv('UTF-8',$encoding.'//TRANSLIT',$source_string);
-      else
+        else
         $output_c = $source_string;
-      if($output_c) 
-         $source_string  = str_replace('"','$\\"',$output_c);
-      else
-         debug(2,"Failed to convert string $source_string\n");
-      return $source_string;
-   }
-
-
-  /**
-   * Save certificate files in either DER or PEM format
-   *
-   * Certificate files will be saved in the module working directory.
-   * @param string $format  only "der" and "pem" are currently allowed
-   * @return array an array of arrays or FALSE on error
-   * saved certificate file names are avalable under the 'file' index
-   * additional array entries are indexed as 'sha1', 'md5', and 'root'.
-   * sha1 and md5 are correcponding certificate hashes
-   * root is set to 1 for the CA roor certicicate and 0 otherwise
-  */ 
-   final protected function saveCertificateFiles($format) {
-     if($format == 'der' || $format == 'pam') {
-       $i = 0;
-       $CA_files = [];
-       $ca_array = $this->attributes['internal:CAs'][0];
-       if(! $ca_array)
-         return(FALSE);
-       foreach ($ca_array as $CA) {
-         $f = fopen("cert-$i.crt","w");
-         if(! $f) die("problem opening the file\n");
-         if($format == "pem")
+        if($output_c) 
+            $source_string  = str_replace('"','$\\"',$output_c);
+        else
+            debug(2,"Failed to convert string $source_string\n");
+        return $source_string;
+    }
+
+
+    /**
+     * Save certificate files in either DER or PEM format
+     *
+     * Certificate files will be saved in the module working directory.
+     * @param string $format  only "der" and "pem" are currently allowed
+     * @return array an array of arrays or FALSE on error
+     * saved certificate file names are avalable under the 'file' index
+     * additional array entries are indexed as 'sha1', 'md5', and 'root'.
+     * sha1 and md5 are correcponding certificate hashes
+     * root is set to 1 for the CA roor certicicate and 0 otherwise
+     */ 
+    final protected function saveCertificateFiles($format) {
+        if($format == 'der' || $format == 'pam') {
+        $i = 0;
+        $CA_files = [];
+        $ca_array = $this->attributes['internal:CAs'][0];
+        if(! $ca_array)
+            return(FALSE);
+        foreach ($ca_array as $CA) {
+            $f = fopen("cert-$i.crt","w");
+            if(! $f) die("problem opening the file\n");
+            if($format == "pem")
             fwrite($f,$CA['pem']);
-         else
+            else
             fwrite($f,$CA['der']);
-         fclose($f);
-         $C = [];
-         $C['file'] = "cert-$i.crt";
-         $C['sha1'] = $CA['sha1'];
-         $C['md5'] = $CA['md5'];
-         $C['root'] = $CA['root'];
-         $CA_files[] = $C;
-         $i++;
-       }
-       return($CA_files);
-     } else {
-       debug(2, 'incorrect format value specified');
-       return(FALSE);
-     }
+            fclose($f);
+            $C = [];
+            $C['file'] = "cert-$i.crt";
+            $C['sha1'] = $CA['sha1'];
+            $C['md5'] = $CA['md5'];
+            $C['root'] = $CA['root'];
+            $CA_files[] = $C;
+            $i++;
+        }
+        return($CA_files);
+        } else {
+        debug(2, 'incorrect format value specified');
+        return(FALSE);
+        }
       
-   }
-
-   /**
-    * Generate installer filename base.
-    * Device module should use this name adding an extension.
-    * Normally the device identifier follows the Consortium name.
-    * The sting taken for the device identifier equals (by default) to the index in the listDevices array,
-    * but can be overriden with the 'device_id' device option.
-    */
-   private function getInstallerBasename() {
-      $replace_pattern = '/[ ()\/\'"]+/';
-      debug(4,"getInstallerBasename1:".$this->attributes['general:instname'][0]."\n");
-      $inst = iconv("UTF-8", "US-ASCII//TRANSLIT", preg_replace($replace_pattern, '_', $this->attributes['general:instname'][0]));
-      debug(4,"getInstallerBasename2:$inst\n");
-      $Inst_a = explode('_',$inst);
-      if(count($Inst_a) > 2) {
-         $inst = '';
-         foreach($Inst_a as $i)
-           $inst .= $i[0];
-      }   
-      $c_name = iconv("UTF-8", "US-ASCII//TRANSLIT", preg_replace($replace_pattern, '_', Config::$CONSORTIUM['name']));
-      if($this->attributes['internal:profile_count'][0] > 1) {
-         if(!empty($this->attributes['profile:name']) && ! empty($this->attributes['profile:name'][0])) {
-             $prof = iconv("UTF-8", "US-ASCII//TRANSLIT", preg_replace($replace_pattern, '_', $this->attributes['profile:name'][0]));
-             $prof = preg_replace('/_+$/','',$prof);
-             return $c_name. '-'. $this->getDeviceId() . $inst .'-'. $prof;
-         }
-      }
-      return $c_name. '-'. $this->getDeviceId() . $inst;
-  }
-
-  private function getDeviceId() {
+    }
+
+    /**
+     * Generate installer filename base.
+     * Device module should use this name adding an extension.
+     * Normally the device identifier follows the Consortium name.
+     * The sting taken for the device identifier equals (by default) to the index in the listDevices array,
+     * but can be overriden with the 'device_id' device option.
+     */
+    private function getInstallerBasename() {
+        $replace_pattern = '/[ ()\/\'"]+/';
+        debug(4,"getInstallerBasename1:".$this->attributes['general:instname'][0]."\n");
+        $inst = iconv("UTF-8", "US-ASCII//TRANSLIT", preg_replace($replace_pattern, '_', $this->attributes['general:instname'][0]));
+        debug(4,"getInstallerBasename2:$inst\n");
+        $Inst_a = explode('_',$inst);
+        if(count($Inst_a) > 2) {
+            $inst = '';
+            foreach($Inst_a as $i)
+            $inst .= $i[0];
+        }   
+        $c_name = iconv("UTF-8", "US-ASCII//TRANSLIT", preg_replace($replace_pattern, '_', Config::$CONSORTIUM['name']));
+        if($this->attributes['internal:profile_count'][0] > 1) {
+            if(!empty($this->attributes['profile:name']) && ! empty($this->attributes['profile:name'][0])) {
+                $prof = iconv("UTF-8", "US-ASCII//TRANSLIT", preg_replace($replace_pattern, '_', $this->attributes['profile:name'][0]));
+                $prof = preg_replace('/_+$/','',$prof);
+                return $c_name. '-'. $this->getDeviceId() . $inst .'-'. $prof;
+            }
+        }
+        return $c_name. '-'. $this->getDeviceId() . $inst;
+    }
+
+    private function getDeviceId() {
     $d_id = $this->device_id;
     if(isset($this->options['device_id'])) 
-      $d_id = $this->options['device_id'];
+        $d_id = $this->options['device_id'];
     if($d_id !== '')
-      $d_id .= '-';
+        $d_id .= '-';
     return $d_id;
-  }
+    }
 
 
-  private function getSSIDs() {
+    private function getSSIDs() {
     $S['add']=[];
     $S['del']=[];
     if (isset(Config::$CONSORTIUM['ssid'])) {
-       foreach (Config::$CONSORTIUM['ssid'] as $ssid) {
+        foreach (Config::$CONSORTIUM['ssid'] as $ssid) {
         if(isset(Config::$CONSORTIUM['tkipsupport']) && Config::$CONSORTIUM['tkipsupport'] == TRUE)
-          $S['add'][$ssid] = 'TKIP';
+            $S['add'][$ssid] = 'TKIP';
         else {
-          $S['add'][$ssid] = 'AES';
-          $S['del'][$ssid] = 'TKIP';
+            $S['add'][$ssid] = 'AES';
+            $S['del'][$ssid] = 'TKIP';
+        }
         }
-       }
     }
     if(isset($this->attributes['media:SSID'])) {
-      $SSID = $this->attributes['media:SSID'];
+        $SSID = $this->attributes['media:SSID'];
 
-      foreach($SSID as $ssid)
-         $S['add'][$ssid] = 'AES';
-      }
+        foreach($SSID as $ssid)
+            $S['add'][$ssid] = 'AES';
+        }
     if(isset($this->attributes['media:SSID_with_legacy'])) {
-      $SSID = $this->attributes['media:SSID_with_legacy'];
-      foreach($SSID as $ssid)
-         $S['add'][$ssid] = 'TKIP';
+        $SSID = $this->attributes['media:SSID_with_legacy'];
+        foreach($SSID as $ssid)
+            $S['add'][$ssid] = 'TKIP';
     }
     if(isset($this->attributes['media:remove_SSID'])) {
-      $SSID = $this->attributes['media:remove_SSID'];
-      foreach($SSID as $ssid)
-         $S['del'][$ssid] = 'DEL';
+        $SSID = $this->attributes['media:remove_SSID'];
+        foreach($SSID as $ssid)
+            $S['del'][$ssid] = 'DEL';
     }
     return $S;
-  }
+    }
 
-  private function getConsortia() {
-      $OIs = [];
-      $OIs = array_merge($OIs, Config::$CONSORTIUM['interworking-consortium-oi']);
-      if (isset($this->attributes['media:consortium_OI']))
-          foreach ($this->attributes['media:consortium_OI'] as $new_oi)
+    private function getConsortia() {
+        $OIs = [];
+        $OIs = array_merge($OIs, Config::$CONSORTIUM['interworking-consortium-oi']);
+        if (isset($this->attributes['media:consortium_OI']))
+            foreach ($this->attributes['media:consortium_OI'] as $new_oi)
             $OIs[] = $new_oi;
-      return $OIs;
-  }
+        return $OIs;
+    }
   
-  /**
-   * An array with shorthand definitions for MIME types
-   * @var array
-   */
-  private $mime_extensions = [
-     'text/plain' => 'txt',
-     'text/rtf' => 'rtf',
-     'application/pdf' =>'pdf',
-  ];
-
-  private function saveLogoFile($Logos) {
+    /**
+     * An array with shorthand definitions for MIME types
+     * @var array
+     */
+    private $mime_extensions = [
+        'text/plain' => 'txt',
+        'text/rtf' => 'rtf',
+        'application/pdf' =>'pdf',
+    ];
+
+    private function saveLogoFile($Logos) {
     $i=0;
     $returnarray= [];
     foreach ($Logos as $blob) {
-      $finfo = new finfo(FILEINFO_MIME_TYPE);
-      $mime = $finfo->buffer($blob);
-      if(preg_match('/^image\/(.*)/',$mime,$m))
+        $finfo = new finfo(FILEINFO_MIME_TYPE);
+        $mime = $finfo->buffer($blob);
+        if(preg_match('/^image\/(.*)/',$mime,$m))
         $ext = $m[1];
-      else
+        else
         $ext = 'unsupported';
-      debug(4,"saveLogoFile: $mime : $ext\n");
-      $f_name = 'logo-'.$i.'.'.$ext;
-      $f = fopen($f_name,"w");
-      if(! $f) {
-          debug(2,"saveLogoFile failed for: $f_name\n");
-          die("problem opening the file\n");
-      }
-      fwrite($f,$blob);
-      fclose($f);
-      $returnarray[]= ['name'=>$f_name,'mime'=>$ext];
-      $i++;
+        debug(4,"saveLogoFile: $mime : $ext\n");
+        $f_name = 'logo-'.$i.'.'.$ext;
+        $f = fopen($f_name,"w");
+        if(! $f) {
+            debug(2,"saveLogoFile failed for: $f_name\n");
+            die("problem opening the file\n");
+        }
+        fwrite($f,$blob);
+        fclose($f);
+        $returnarray[]= ['name'=>$f_name,'mime'=>$ext];
+        $i++;
     }
     return($returnarray);
-  }
+    }
 
 
-  private function saveInfoFile($blob) {
+    private function saveInfoFile($blob) {
     $finfo = new finfo(FILEINFO_MIME_TYPE);
     $mime = $finfo->buffer($blob);
     $ext = isset($this->mime_extensions[$mime]) ? $this->mime_extensions[$mime] : 'usupported';
@@ -451,43 +451,43 @@ 
     fwrite($f,$blob);
     fclose($f);
     return(['name'=>'local-info.'.$ext,'mime'=>$ext]);
-  }
-
-  private function getProfileAttributes(Profile $profile) {
-     $eaps = $profile->getEapMethodsinOrderOfPreference(1);
-     if($eap = $this->getPreferredEapType($eaps)) {
-          $a = $profile->getCollapsedAttributes($eap);
-          $a['eap'] = $eap;
-          $a['all_eaps'] = $eaps;
-          return($a);
-     } else {
-       error("No supported eap types found for this profile.");
-       return(FALSE);
-  }
-  }
+    }
+
+    private function getProfileAttributes(Profile $profile) {
+        $eaps = $profile->getEapMethodsinOrderOfPreference(1);
+        if($eap = $this->getPreferredEapType($eaps)) {
+            $a = $profile->getCollapsedAttributes($eap);
+            $a['eap'] = $eap;
+            $a['all_eaps'] = $eaps;
+            return($a);
+        } else {
+        error("No supported eap types found for this profile.");
+        return(FALSE);
+    }
+    }
 /**
-  * dumps attributes for debugging purposes
-  *
-  * dumpAttibutes method is supplied for debuging purposes, it simply dumps the attribute array
-  * to a file with name passed in the attribute.
-  * @param string $file the output file name
-  */
-  protected function dumpAttibutes($file) {
+     * dumps attributes for debugging purposes
+     *
+     * dumpAttibutes method is supplied for debuging purposes, it simply dumps the attribute array
+     * to a file with name passed in the attribute.
+     * @param string $file the output file name
+     */
+    protected function dumpAttibutes($file) {
         ob_start();
         print_r($this->attributes);
         $output = ob_get_clean();
         $f = fopen($file,"w");
         fwrite($f,$output);
         fclose($f);
-  }
+    }
 /** 
- * placeholder for the main device method
- *
- */
+     * placeholder for the main device method
+     *
+     */
 
-  protected function writeInstaller() {
-     return("download path");
-  }
+    protected function writeInstaller() {
+        return("download path");
+    }
 
 /**
  * Array passing all options to the device module.
@@ -521,76 +521,76 @@ 
  * @see X509::processCertificate()
  * @var array $attributes
  */
-  public $attributes;
+    public $attributes;
 /**
-  * stores the path to the module source location and is used 
-  * by copyFile and translateFile
-  * the only reason for it to be a public variable ies that it is set by the DeviceFactory class
-  * module_path should not be used by module drivers.
-  * @var string 
-  */
-  public $module_path;
+     * stores the path to the module source location and is used 
+     * by copyFile and translateFile
+     * the only reason for it to be a public variable ies that it is set by the DeviceFactory class
+     * module_path should not be used by module drivers.
+     * @var string 
+     */
+    public $module_path;
 
 /**
  * The optimal EAP type
  *
  */ 
 /**
-  * optimal EAP method selected given profile and device
-  * @var EAP::constant
-  */
-  public $selected_eap;
+ * optimal EAP method selected given profile and device
+ * @var EAP::constant
+ */
+    public $selected_eap;
 /**
-  * the path to the profile signing program
-  * device modules which require signing should use this property to exec the signer
-  * the signer program must accept two arguments - input and output file names
-  * the signer program mus operate in the local directory and filenames are relative to this
-  * directory
-  *
-  *@var string
-  */
-  public $sign;
-  public $signer;
+     * the path to the profile signing program
+     * device modules which require signing should use this property to exec the signer
+     * the signer program must accept two arguments - input and output file names
+     * the signer program mus operate in the local directory and filenames are relative to this
+     * directory
+     *
+     *@var string
+     */
+    public $sign;
+    public $signer;
 /**
- * the string referencing the language (index ot the Config::$LANGUAGES array).
- * It is set to the current language and may be used by the device module to
- * set its language
- *
- *@var string
- */
-  public $lang_index;
-  /**
-   * The string identifier of the device (don't show this to users)
-   * @var string
-   */
-  public $device_id;
-
-  /**
-   * See devices-template.php for a list of available options
-   * @var array
-   */
-  public $options;
-
-  /**
-   * This string will be shown if no support email was configured by the admin
-   * 
-   * @var string 
-   */
-  public static $support_email_substitute;
-
-  /**
-   * This string will be shown if no support URL was configured by the admin
-   * 
-   * @var string 
-   */
-  public static $support_url_substitute;
-
-  /**
-   * This string should be used by all installer modules to set the 
-   * installer file basename.
-   *
-   * @var string 
-   */
-  public static $installerBasename;
+     * the string referencing the language (index ot the Config::$LANGUAGES array).
+     * It is set to the current language and may be used by the device module to
+     * set its language
+     *
+     *@var string
+     */
+    public $lang_index;
+    /**
+     * The string identifier of the device (don't show this to users)
+     * @var string
+     */
+    public $device_id;
+
+    /**
+     * See devices-template.php for a list of available options
+     * @var array
+     */
+    public $options;
+
+    /**
+     * This string will be shown if no support email was configured by the admin
+     * 
+     * @var string 
+     */
+    public static $support_email_substitute;
+
+    /**
+     * This string will be shown if no support URL was configured by the admin
+     * 
+     * @var string 
+     */
+    public static $support_url_substitute;
+
+    /**
+     * This string should be used by all installer modules to set the 
+     * installer file basename.
+     *
+     * @var string 
+     */
+    public static $installerBasename;
 }
 ?>

core/Federation.php

Doc Comments +1 added lines, -1 removed lines

@@ -661,7 +661,7 @@
      * This function retrieves the federation attributes. If called with the optional parameter, only attribute values for the attribute
      * name in $option_name are retrieved; otherwise, all attributes are retrieved.
      *
-     * @param string $option_name optionally, the name of the attribute that is to be retrieved
+     * @param integer $option_name optionally, the name of the attribute that is to be retrieved
      * @return array of arrays of attributes which were set for this IdP
      */
     public function getAttributes($option_name = 0) {

Indentation +4 added lines, -4 removed lines

@@ -678,10 +678,10 @@
     }
     
         /**
-     * deletes all attributes in this federation except the _file ones, these are reported as array
-     *
-     * @return array list of row id's of file-based attributes which weren't deleted
-     */
+         * deletes all attributes in this federation except the _file ones, these are reported as array
+         *
+         * @return array list of row id's of file-based attributes which weren't deleted
+         */
     public function beginFlushAttributes() {
         DBConnection::exec(Federation::$DB_TYPE, "DELETE FROM federation_option WHERE federation_id = '$this->identifier' AND option_name NOT LIKE '%_file'");
         $exec_q = DBConnection::exec(Federation::$DB_TYPE, "SELECT row FROM federation_option WHERE federation_id = '$this->identifier'");

core/Helper.php

Doc Comments +2 added lines, -1 removed lines

@@ -32,6 +32,7 @@ 
 /**
  * write debug messages to the log
  *
+ * @param integer $level
  */
 function debug($level, $t) {
     if (Config::$DEBUG_LEVEL >= $level) {
@@ -130,7 +131,7 @@ 
  * generates a UUID
  *
  * @param string $prefix an extra prefix to set before the UUID
- * @return UUID (possibly prefixed)
+ * @return string (possibly prefixed)
  */
 function uuid($prefix = '', $deterministic_source = NULL) {
     if ($deterministic_source === NULL) 

Indentation +16 added lines, -16 removed lines

@@ -180,32 +180,32 @@ 
 function createTemporaryDirectory($purpose = 'installer',$fail = 1) {
         $name = md5(time().rand());
         switch($purpose) {
-           case 'installer':
+            case 'installer':
              $path = CAT::$root.'/var/installer_cache';
-             break;
-           case 'logo':
+                break;
+            case 'logo':
              $path = CAT::$root.'/web/downloads/logos';
-             break;
-           case 'test':
+                break;
+            case 'test':
              $path = CAT::$root.'/var/tmp';
-             break;
-           default:
+                break;
+            default:
              error("unable to create temporary directory for unknown purpose: $purpose\n");
-             exit;
+                exit;
         }
         $tmp_dir = $path .'/'. $name;
         debug(4,"temp dir: $purpose : $tmp_dir\n");
         if(! mkdir($tmp_dir,0700, true)) {
-          if($fail) {
-             error("unable to create temporary directory: $tmp_dir\n");
-             exit;
-          } else  {
+            if($fail) {
+                error("unable to create temporary directory: $tmp_dir\n");
+                exit;
+            } else  {
             debug(4, "Directory creation failed for $tmp_dir\n");
             return ['base'=>$path,'dir'=>'',$name=>''];
-          }
+            }
         } else
-         debug(4, "Directory created: $tmp_dir\n");
-     return ['base'=>$path,'dir'=>$tmp_dir,'name'=>$name];
+            debug(4, "Directory created: $tmp_dir\n");
+        return ['base'=>$path,'dir'=>$tmp_dir,'name'=>$name];
 }
 
 function png_inject_consortium_logo ($inputpngstring, $symbolsize = 12, $marginsymbols = 4) {
@@ -236,7 +236,7 @@ 
     $targetplacementy = $symbolsize * round(($sizeinput[1] / 2 - ($targetheight - $symbolsize) / 2)/$symbolsize);
     imagecopyresized($inputgd, $whiteimage, $targetplacementx-$symbolsize, $targetplacementy-$symbolsize, 0, 0, $targetwidth+2*$symbolsize, $targetheight+2*$symbolsize, $targetwidth+2*$symbolsize, $targetheight+2*$symbolsize);
     imagecopyresized($inputgd, $logogd,     $targetplacementx, $targetplacementy, 0, 0, $targetwidth   , $targetheight   , $sizelogo[0]   , $sizelogo[1]);
- // imagecopyresized($dst_image, $src_image, $dst_x,                               $dst_y,                                $src_x, $src_y, $dst_w,       $dst_h,        $src_w,       $src_h);
+    // imagecopyresized($dst_image, $src_image, $dst_x,                               $dst_y,                                $src_x, $src_y, $dst_w,       $dst_h,        $src_w,       $src_h);
     ob_start();
     imagepng($inputgd);
     return ob_get_clean();

core/IdP.php

Doc Comments +3 added lines, -2 removed lines

@@ -68,6 +68,7 @@ 
      * Cannot be used to define a new IdP in the database! This happens via Federation::newIdP()
      *
      * @param integer $i_id the database row identifier
+     * @return string
      */
     public function __construct($i_id) {
         debug(3, "--- BEGIN Constructing new IdP object ... ---\n");
@@ -247,7 +248,7 @@ 
      * This function retrieves the IdP-wide attributes. If called with the optional parameter, only attribute values for the attribute
      * name in $option_name are retrieved; otherwise, all attributes are retrieved.
      *
-     * @param string $option_name optionally, the name of the attribute that is to be retrieved
+     * @param integer $option_name optionally, the name of the attribute that is to be retrieved
      * @return array of arrays of attributes which were set for this IdP
      */
     public function getAttributes($option_name = 0) {
@@ -318,7 +319,7 @@ 
      * Adds a new profile to this IdP.
      * Only creates the DB entry for the Profile. If you want to add attributes later, see Profile::addAttribute().
      *
-     * @return object new Profile object if successful, or FALSE if an error occured
+     * @return Profile|null new Profile object if successful, or FALSE if an error occured
      */
     public function newProfile() {
         DBConnection::exec(IdP::$DB_TYPE, "INSERT INTO profile (inst_id) VALUES($this->identifier)");

Indentation +4 added lines, -4 removed lines

@@ -118,10 +118,10 @@
             }
         }
         $this->priv_attributes[] = ["name" => "internal:country", 
-                                         "value" => $this->federation, 
-                                         "level" => "IdP", 
-                                         "row" => 0, 
-                                         "flag" => NULL];
+                                            "value" => $this->federation, 
+                                            "level" => "IdP", 
+                                            "row" => 0, 
+                                            "flag" => NULL];
 
         $this->name = getLocalisedValue($this->getAttributes('general:instname', 0, 0), CAT::get_lang());
         debug(3, "--- END Constructing new IdP object ... ---\n");

core/Options.php

Doc Comments +1 added lines, -1 removed lines

@@ -94,7 +94,7 @@
      * 
      * @assert ("user") == Array("user:email","user:fedadmin","user:realname")
      * 
-     * @param string $class_name optionally specifies the class of options to be listed (class is the part of the option name before the : sign)
+     * @param integer $class_name optionally specifies the class of options to be listed (class is the part of the option name before the : sign)
      * @return array of options
      */
     public function availableOptions($class_name = 0) {

Indentation +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
  */
 class Options {
     
-   /**
+    /**
      * database which this class queries by default
      * 
      * @var string

core/phpqrcode.php

Doc Comments +108 added lines

@@ -96,6 +96,10 @@ 
 	define('QR_FORMAT_PNG',  1);

 	

 	class qrstr {

+
+		/**
+		 * @param string $repl
+		 */
 		public static function set(&$srctab, $x, $y, $repl, $replLen = false) {

 			$srctab[$y] = substr_replace($srctab[$y], ($replLen !== false)?substr($repl,0,$replLen):$repl, $x, ($replLen !== false)?$replLen:strlen($repl));

 		}

@@ -231,6 +235,11 @@ 
         }

 

         //----------------------------------------------------------------------

+
+        /**
+         * @param boolean $outfile
+         * @param string $err
+         */
         public static function log($outfile, $err)

         {

             if (QR_LOG_DIR !== false) {

@@ -256,6 +265,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param string $markerId
+         */
         public static function markTime($markerId)

         {

             list($usec, $sec) = explode(" ", microtime());

@@ -410,18 +423,30 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public static function getWidth($version)

         {

             return self::$capacity[$version][QRCAP_WIDTH];

         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public static function getRemainder($version)

         {

             return self::$capacity[$version][QRCAP_REMINDER];

         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $size
+         */
         public static function getMinimumVersion($size, $level)

         {

 

@@ -535,6 +560,9 @@ 
         //----------------------------------------------------------------------

         // CACHEABLE!!!

         

+        /**
+         * @param integer $version
+         */
         public static function getEccSpec($version, $level, array &$spec)

         {

             if (count($spec) < 5) {

@@ -857,12 +885,20 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param string $code
+         */
         public static function unserial($code)

         {

             return explode("\n", gzuncompress($code));

         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public static function newFrame($version)

         {

             if($version < 1 || $version > QRSPEC_VERSION_MAX) 

@@ -1236,6 +1272,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public function encodeBitStream($version)

         {

             try {

@@ -1313,6 +1353,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public function setVersion($version)

         {

             if($version < 0 || $version > QRSPEC_VERSION_MAX) {

@@ -1351,6 +1395,12 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param QRinput $mode
+         * @param integer $size
+         * @param integer $data
+         */
         public function append($mode, $size, $data)

         {

             try {

@@ -1446,6 +1496,10 @@ 
         ];

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $c
+         */
         public static function lookAnTable($c)

         {

             return (($c > 127)?-1:self::$anTable[$c]);

@@ -1531,6 +1585,10 @@ 
         

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public function estimateBitStreamSize($version)

         {

             $bits = 0;

@@ -1648,6 +1706,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param QRbitstream $bstream
+         */
         public function appendPaddingBit(&$bstream)

         {

             $bits = $bstream->size();

@@ -1977,6 +2039,10 @@ 
         public $modeHint;

 

         //----------------------------------------------------------------------

+
+        /**
+         * @param QRinput $input
+         */
         public function __construct($dataStr, $input, $modeHint) 

         {

             $this->dataStr  = $dataStr;

@@ -1985,6 +2051,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param string $str
+         */
         public static function isdigitat($str, $pos)

         {    

             if ($pos >= strlen($str))

@@ -1994,6 +2064,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param string $str
+         */
         public static function isalnumat($str, $pos)

         {

             if ($pos >= strlen($str))

@@ -2114,6 +2188,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @return integer
+         */
         public function eatKanji()

         {

             $p = 0;

@@ -2447,6 +2525,13 @@ 
         public static $items = [];

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $symsize
+         * @param integer $gfpoly
+         * @param integer $fcr
+         * @param integer $prim
+         */
         public static function init_rs($symsize, $gfpoly, $fcr, $prim, $nroots, $pad)

         {

             foreach(self::$items as $rs) {

@@ -2601,6 +2686,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param string $code
+         */
         public static function unserial($code)

         {

             $codeArr = [];

@@ -2661,6 +2750,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $length
+         */
         public function calcN1N3($length)

         {

             $demerit = 0;

@@ -2971,6 +3064,10 @@ 
         public $data; 

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $mask
+         */
         public function encodeMask(QRinput $input, $mask)

         {

             if($input->getVersion() < 0 || $input->getVersion() > QRSPEC_VERSION_MAX) {

@@ -3052,6 +3149,11 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         * @param integer $level
+         */
         public function encodeString8bit($string, $version, $level)

         {

             if(string == NULL) {

@@ -3071,6 +3173,12 @@ 
         }

 

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         * @param integer $level
+         * @param boolean $casesensitive
+         */
         public function encodeString($string, $version, $level, $hint, $casesensitive)

         {

 

Indentation +40 added lines, -40 removed lines

@@ -74,32 +74,32 @@ 
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

  */

  

-	// Encoding modes

+    // Encoding modes

 	 

-	define('QR_MODE_NUL', -1);

-	define('QR_MODE_NUM', 0);

-	define('QR_MODE_AN', 1);

-	define('QR_MODE_8', 2);

-	define('QR_MODE_KANJI', 3);

-	define('QR_MODE_STRUCTURE', 4);

-

-	// Levels of error correction.

-

-	define('QR_ECLEVEL_L', 0);

-	define('QR_ECLEVEL_M', 1);

-	define('QR_ECLEVEL_Q', 2);

-	define('QR_ECLEVEL_H', 3);

+    define('QR_MODE_NUL', -1);

+    define('QR_MODE_NUM', 0);

+    define('QR_MODE_AN', 1);

+    define('QR_MODE_8', 2);

+    define('QR_MODE_KANJI', 3);

+    define('QR_MODE_STRUCTURE', 4);

+

+    // Levels of error correction.

+

+    define('QR_ECLEVEL_L', 0);

+    define('QR_ECLEVEL_M', 1);

+    define('QR_ECLEVEL_Q', 2);

+    define('QR_ECLEVEL_H', 3);

 	

-	// Supported output formats

+    // Supported output formats

 	

-	define('QR_FORMAT_TEXT', 0);

-	define('QR_FORMAT_PNG',  1);

+    define('QR_FORMAT_TEXT', 0);

+    define('QR_FORMAT_PNG',  1);

 	

-	class qrstr {

-		public static function set(&$srctab, $x, $y, $repl, $replLen = false) {

-			$srctab[$y] = substr_replace($srctab[$y], ($replLen !== false)?substr($repl,0,$replLen):$repl, $x, ($replLen !== false)?$replLen:strlen($repl));

-		}

-	}	

+    class qrstr {

+        public static function set(&$srctab, $x, $y, $repl, $replLen = false) {

+            $srctab[$y] = substr_replace($srctab[$y], ($replLen !== false)?substr($repl,0,$replLen):$repl, $x, ($replLen !== false)?$replLen:strlen($repl));

+        }

+    }	

 

 

 

@@ -211,9 +211,9 @@ 
         //----------------------------------------------------------------------

         public static function buildCache()

         {

-			QRtools::markTime('before_build_cache');

+            QRtools::markTime('before_build_cache');

 			

-			$mask = new QRmask();

+            $mask = new QRmask();

             for ($a=1; $a <= QRSPEC_VERSION_MAX; $a++) {

                 $frame = QRspec::newFrame($a);

                 if (QR_IMAGE) {

@@ -221,13 +221,13 @@ 
                     QRimage::png(self::binarize($frame), $fileName, 1, 0);

                 }

 				

-				$width = count($frame);

-				$bitMask = array_fill(0, $width, array_fill(0, $width, 0));

-				for ($maskNo=0; $maskNo<8; $maskNo++)

-					$mask->makeMaskNo($maskNo, $width, $frame, $bitMask, true);

+                $width = count($frame);

+                $bitMask = array_fill(0, $width, array_fill(0, $width, 0));

+                for ($maskNo=0; $maskNo<8; $maskNo++)

+                    $mask->makeMaskNo($maskNo, $width, $frame, $bitMask, true);

             }

 			

-			QRtools::markTime('after_build_cache');

+            QRtools::markTime('after_build_cache');

         }

 

         //----------------------------------------------------------------------

@@ -647,10 +647,10 @@ 
 

         // Version information pattern -----------------------------------------

 

-		// Version information pattern (BCH coded).

+        // Version information pattern (BCH coded).

         // See Table 1 in Appendix D (pp.68) of JIS X0510:2004.

         

-		// size: [QRSPEC_VERSION_MAX - 6]

+        // size: [QRSPEC_VERSION_MAX - 6]

 		

         public static $versionPattern = [

             0x07c94, 0x085bc, 0x09a99, 0x0a4d3, 0x0bbf6, 0x0c762, 0x0d847, 0x0e60d,

@@ -1438,7 +1438,7 @@ 
             -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,

             -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,

             36, -1, -1, -1, 37, 38, -1, -1, -1, -1, 39, 40, -1, 41, 42, 43,

-             0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 44, -1, -1, -1, -1, -1,

+                0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 44, -1, -1, -1, -1, -1,

             -1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,

             25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, -1, -1, -1, -1, -1,

             -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,

@@ -2500,17 +2500,17 @@ 
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

  */

  

-	define('N1', 3);

-	define('N2', 3);

-	define('N3', 40);

-	define('N4', 10);

+    define('N1', 3);

+    define('N2', 3);

+    define('N3', 40);

+    define('N4', 10);

 

-	class QRmask {

+    class QRmask {

 	

-		public $runLength = [];

+        public $runLength = [];

 		

-		//----------------------------------------------------------------------

-		public function __construct() 

+        //----------------------------------------------------------------------

+        public function __construct() 

         {

             $this->runLength = array_fill(0, QRSPEC_WIDTH_MAX + 1, 0);

         }

core/Profile.php

Doc Comments +11 added lines, -9 removed lines

@@ -73,7 +73,7 @@ 
      * supported EAP types from the DB and stores them in the priv_ arrays.
      * 
      * @param int $p_id identifier of the profile in the DB
-     * @param IdP $idp_object optionally, the institution to which this Profile belongs. Saves the construction of the IdP instance. If omitted, an extra query and instantiation is executed to find out.
+     * @param integer $idp_object optionally, the institution to which this Profile belongs. Saves the construction of the IdP instance. If omitted, an extra query and instantiation is executed to find out.
      */
     public function __construct($p_id, $idp_object = 0) {
         debug(3, "--- BEGIN Constructing new Profile object ... ---\n");
@@ -372,6 +372,8 @@ 
      * 
      * @param string device the device identifier string
      * @param string path the path where the new installer can be found
+     * @param string $device
+     * @param string $path
      */
     public function updateCache($device, $path,$mime) {
         $device = DBConnection::escape_value(Profile::$DB_TYPE, $device);
@@ -384,9 +386,9 @@ 
     /**
      * Log a new download for our stats
      * 
-     * @param device the device id string
-     * @param area either admin or user
-     * @return TRUE if incrementing worked, FALSE if not
+     * @param device string device id string
+     * @param area string admin or user
+     * @return boolean if incrementing worked, FALSE if not
      */
     public function incrementDownloadStats($device, $area) {
         $device = DBConnection::escape_value(Profile::$DB_TYPE, $device);
@@ -399,7 +401,7 @@ 
 
     /**
      * Retrieve current download stats from database, either for one specific device or for all devices
-     * @param string $device the device id string
+     * @param integer $device the device id string
      * @return mixed user downloads of this profile; if device is given, returns the counter as int, otherwise an array with devicename => counter
      */
     public function getUserDownloadStats($device = 0) {
@@ -464,7 +466,7 @@ 
      * @param string $attr_name name of the attribute to set
      * @param string $attr_value value of the attribute to set
      * @param int $eap_type identifier of the EAP type in the database. 0 if the attribute is valid for all EAP types.
-     * @param string $device identifier of the device in the databse. Omit the argument if attribute is valid for all devices.
+     * @param integer $device identifier of the device in the databse. Omit the argument if attribute is valid for all devices.
      */
     public function addAttribute($attr_name, $attr_value, $eap_type, $device = 0) {
         $attr_name = DBConnection::escape_value(Profile::$DB_TYPE, $attr_name);
@@ -574,7 +576,7 @@ 
     /** Returns an array of the profile's attributes.
      * 
      * @param string option_name the name of a specific option. If set, only returns option values for this option name
-     * @param eapmethod the EAP type, in array ("OUTER/INNER") notation. If set, returns only attributes which are specific to that EAP type
+     * @param eapmethod integer EAP type, in array ("OUTER/INNER") notation. If set, returns only attributes which are specific to that EAP type
      * @param string device the device ID string. If set, returns only attributes which are specific to that device
      * @return array attributes of the profile
      */
@@ -658,7 +660,7 @@ 
     /**
      * list all devices marking their availabiblity and possible redirects
      *
-     * @param string $locale for text-based attributes, either returns values for the default value, or if specified here, in the locale specified
+     * @param integer $locale for text-based attributes, either returns values for the default value, or if specified here, in the locale specified
      * @return array of device ids display names and their status
      */
     public function listDevices($locale = 0) {
@@ -713,7 +715,7 @@ 
      * as wel as the chosen language.
      * can be called with an optional $eap argument
      * 
-     * @param array $eap if specified, retrieves attributes specific to the given EAP type
+     * @param integer $eap if specified, retrieves attributes specific to the given EAP type
      * @return array list of attributes in collapsed style (index is the attrib name, value is an array of different values)
      */
     public function getCollapsedAttributes($eap = 0) {

Indentation +15 added lines, -15 removed lines

@@ -680,27 +680,27 @@
             $redirect_url = getLocalisedValue($this->getAttributes("device-specific:redirect", 0, $d), $locale);
             $dev_status = AVAILABLE;
             if(isset($D['options']) && isset($D['options']['message']) && $D['options']['message']) 
-               $message = $D['options']['message'];
+                $message = $D['options']['message'];
             else
-               $message = 0;
+                $message = 0;
 
             if ($redirect_url === 0) {
                 if(isset($D['options']) && isset($D['options']['redirect']) && $D['options']['redirect']) {
-                   $dev_status = HIDDEN;
+                    $dev_status = HIDDEN;
                 }  else {
-                   $eap = $dev->getPreferredEapType($preferred_eap);
-                   if ($eap) {
-                       if (isset($EAP_options["eap-specific:customtext"][serialize($eap)]))
-                           $eap_customtext = $EAP_options["eap-specific:customtext"][serialize($eap)];
-                       else {
-                           $eap_customtext = getLocalisedValue($this->getAttributes("eap-specific:customtext", $eap, 0), $locale);
-                           $EAP_options["eap-specific:customtext"][serialize($eap)] = $eap_customtext;
-                       }
-                       $device_customtext = getLocalisedValue($this->getAttributes("device-specific:customtext", 0, $d), $locale);
-                   } else {
+                    $eap = $dev->getPreferredEapType($preferred_eap);
+                    if ($eap) {
+                        if (isset($EAP_options["eap-specific:customtext"][serialize($eap)]))
+                            $eap_customtext = $EAP_options["eap-specific:customtext"][serialize($eap)];
+                        else {
+                            $eap_customtext = getLocalisedValue($this->getAttributes("eap-specific:customtext", $eap, 0), $locale);
+                            $EAP_options["eap-specific:customtext"][serialize($eap)] = $eap_customtext;
+                        }
+                        $device_customtext = getLocalisedValue($this->getAttributes("device-specific:customtext", 0, $d), $locale);
+                    } else {
                     $dev_status = UNAVAILABLE;
-                   }
-               }
+                    }
+                }
             }
             $returnarray[] = ['id' => $d, 'display' => $D['display'], 'status' => $dev_status, 'redirect' => $redirect_url, 'eap_customtext' => $eap_customtext, 'device_customtext' => $device_customtext, 'message' => $message, 'options'=>$D['options']];
         }