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/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 +422 added lines, -422 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,391 +58,391 @@ 
      */
     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 = '/[ ()\/\'"]+/';
-      $lang_pointer = Config::$LANGUAGES[$this->lang_index]['latin_based'] == TRUE ? 0 : 1;
-      debug(4,"getInstallerBasename1:".$this->attributes['general:instname'][$lang_pointer]."\n");
-      $inst = iconv("UTF-8", "US-ASCII//TRANSLIT", preg_replace($replace_pattern, '_', $this->attributes['general:instname'][$lang_pointer]));
-      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'][$lang_pointer])) {
-             $prof = iconv("UTF-8", "US-ASCII//TRANSLIT", preg_replace($replace_pattern, '_', $this->attributes['profile:name'][$lang_pointer]));
-             $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 = '/[ ()\/\'"]+/';
+        $lang_pointer = Config::$LANGUAGES[$this->lang_index]['latin_based'] == TRUE ? 0 : 1;
+        debug(4,"getInstallerBasename1:".$this->attributes['general:instname'][$lang_pointer]."\n");
+        $inst = iconv("UTF-8", "US-ASCII//TRANSLIT", preg_replace($replace_pattern, '_', $this->attributes['general:instname'][$lang_pointer]));
+        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'][$lang_pointer])) {
+                $prof = iconv("UTF-8", "US-ASCII//TRANSLIT", preg_replace($replace_pattern, '_', $this->attributes['profile:name'][$lang_pointer]));
+                $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';
@@ -452,43 +452,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.
@@ -522,75 +522,75 @@ 
  * @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/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/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/RADIUSTests.php

Doc Comments +7 added lines, -4 removed lines

@@ -957,6 +957,11 @@ 
         return $anon_id;
     }
 
+    /**
+     * @param string $inner_user
+     * @param string $password
+     * @param string $clientcertdata
+     */
     public function UDP_login($probeindex, $eaptype, $inner_user, $password, $outer_user = '', $opname_check = TRUE, $frag = TRUE, $clientcertdata = NULL) {
         if (!isset(Config::$RADIUSTESTS['UDP-hosts'][$probeindex])) {
             $this->UDP_reachability_executed = RETVAL_NOTCONFIGURED;
@@ -1478,10 +1483,8 @@ 
     /**
      * This function executes openssl s_client command
      * 
-     * @param string $key points NAPTR_hostname_records
-     * @param string $bracketaddr IP address
-     * @param int $port
-     * @param string $arg arguments to add to the openssl command 
+     * @param string $arg arguments to add to the openssl command
+     * @param string $host 
      * @return string result of oenssl s_client ...
      */
     function openssl_s_client($host, $arg, &$testresults) {

Indentation -1 removed lines

@@ -328,7 +328,6 @@
      * - RETVAL_NOT_CONFIGURED; needs Config::$RADIUSTESTS['TLS-discoverytag']
      * - RETVAL_INVALID (at least one format error)
      * - RETVAL_OK (all fine)
-
      * @return int one of two RETVALs above
      */
     public function NAPTR_compliance() {

core/SanityTests.php

Doc Comments +3 added lines

@@ -138,6 +138,9 @@
         $this->test_result['global'] = max($this->test_result['global'],$level);
     }
 
+    /**
+     * @param string $s
+     */
     private function get_exec_path($s) {
         $the_path = "";
         $exec_is = "UNDEFINED";

Indentation +301 added lines, -301 removed lines

@@ -45,13 +45,13 @@ 
 
 /* List all required NSIS modules below */
     private $NSIS_Modules = [
-             "nsArray.nsh",
-             "FileFunc.nsh",
-             "LogicLib.nsh",
-             "WordFunc.nsh",
-             "FileFunc.nsh",
-             "x64.nsh",
-         ];
+                "nsArray.nsh",
+                "FileFunc.nsh",
+                "LogicLib.nsh",
+                "WordFunc.nsh",
+                "FileFunc.nsh",
+                "x64.nsh",
+            ];
 
 /* set $profile_option_ct to the number of rows returned by "SELECT * FROM profile_option_dict" */
     private $profile_option_ct = 28;
@@ -64,9 +64,9 @@ 
     public $name;
 
     public function __construct() {
-       parent::__construct();
-       $this->test_result = [];
-       $this->test_result['global'] = 0;
+        parent::__construct();
+        $this->test_result = [];
+        $this->test_result['global'] = 0;
     }
 
     /**
@@ -74,15 +74,15 @@ 
      * @param string $test the test name
      */
     public function test($test) {
-       $this->out[$test] =[];
-       $this->name = $test;
-       $m_name = $test.'_test';
-       $this->test_result[$test] = 0;
-       if(! method_exists($this,$m_name)) {
-           $this->test_return($test,L_ERROR,"Configuration error, no test configured for <strong>$test</strong>.");
-           return;
-       }
-       $this->$m_name();
+        $this->out[$test] =[];
+        $this->name = $test;
+        $m_name = $test.'_test';
+        $this->test_result[$test] = 0;
+        if(! method_exists($this,$m_name)) {
+            $this->test_return($test,L_ERROR,"Configuration error, no test configured for <strong>$test</strong>.");
+            return;
+        }
+        $this->$m_name();
     }
 
     /**
@@ -95,27 +95,27 @@ 
      * and returned a success.
      */
     public function run_tests($Tests) {
-       foreach ($Tests as $t) {
-         if(preg_match('/(.+)=>(.+)/',$t,$m)) {
+        foreach ($Tests as $t) {
+            if(preg_match('/(.+)=>(.+)/',$t,$m)) {
             $tst = $m[1];
             $subtst=$m[2];
             if($this->test_result[$tst]  < L_ERROR)
-               $this->test($subtst);
-         }
-         else
+                $this->test($subtst);
+            }
+            else
             $this->test($t);
-       }
+        }
     }
 
     public function get_test_names() {
-       $T = get_class_methods($this);
-       $out = [];
-       foreach($T as $t) {
-         if(preg_match('/^(.*)_test$/',$t,$m)) {
+        $T = get_class_methods($this);
+        $out = [];
+        foreach($T as $t) {
+            if(preg_match('/^(.*)_test$/',$t,$m)) {
             $out[] = $m[1];
-         } 
-       }
-       return $out;
+            } 
+        }
+        return $out;
     }
 
     /**
@@ -141,84 +141,84 @@ 
         $the_path = "";
         $exec_is = "UNDEFINED";
         if (!empty(Config::$PATHS[$s])) {
-             preg_match('/([^ ]+) ?/',Config::$PATHS[$s],$m);
-             $exe = $m[1];
-             $the_path = exec("which " . Config::$PATHS[$s]);
-             if ($the_path == $exe)
-                 $exec_is = "EXPLICIT";
-             else
-                 $exec_is = "IMPLICIT";
-         } 
+                preg_match('/([^ ]+) ?/',Config::$PATHS[$s],$m);
+                $exe = $m[1];
+                $the_path = exec("which " . Config::$PATHS[$s]);
+                if ($the_path == $exe)
+                    $exec_is = "EXPLICIT";
+                else
+                    $exec_is = "IMPLICIT";
+            } 
         return(['exec'=>$the_path,'exec_is'=>$exec_is]);
     }
 
     /**
-      *  Test for php version
-      */
+     *  Test for php version
+     */
     private function php_test() {
-         if (version_compare(phpversion(), $this->php_needversion, '>='))
+            if (version_compare(phpversion(), $this->php_needversion, '>='))
             $this->test_return(L_OK,"<strong>PHP</strong> is sufficiently recent. You are running " . phpversion() . ".");
-         else
+            else
             $this->test_return(L_ERROR,"<strong>PHP</strong> is too old. We need at least $this->php_needversion, but you only have ".phpversion(). ".");
     }
 
     /**
-      * test for simpleSAMLphp
-      */
+     * test for simpleSAMLphp
+     */
     private function ssp_test() {
-         if (!is_file(CONFIG::$AUTHENTICATION['ssp-path-to-autoloader']))
-             $this->test_return(L_ERROR,"<strong>simpleSAMLphp</strong> not found!");
-         else
-             $this->test_return(L_OK,"<strong>simpleSAMLphp</strong> autoloader found.");
+            if (!is_file(CONFIG::$AUTHENTICATION['ssp-path-to-autoloader']))
+                $this->test_return(L_ERROR,"<strong>simpleSAMLphp</strong> not found!");
+            else
+                $this->test_return(L_OK,"<strong>simpleSAMLphp</strong> autoloader found.");
     }
 
     /**
-      * test for security setting
-      */
+     * test for security setting
+     */
     private function security_test() {
-         if (in_array("I do not care about security!", Config::$SUPERADMINS))
-             $this->test_return(L_WARN,"You do not care about security. This page should be made accessible to the CAT admin only! See config.php 'Superadmins'!");
+            if (in_array("I do not care about security!", Config::$SUPERADMINS))
+                $this->test_return(L_WARN,"You do not care about security. This page should be made accessible to the CAT admin only! See config.php 'Superadmins'!");
     }
 
     /**
-      * test if zip is available
-      */
+     * test if zip is available
+     */
     private function zip_test() {
-         if (exec("which zip") != "")
-             $this->test_return(L_OK,"<strong>zip</strong> binary found.");
-         else
-             $this->test_return(L_ERROR,"<strong>zip</strong> not found in your \$PATH!");
+            if (exec("which zip") != "")
+                $this->test_return(L_OK,"<strong>zip</strong> binary found.");
+            else
+                $this->test_return(L_ERROR,"<strong>zip</strong> not found in your \$PATH!");
     }
 
     /**
-      * test if eapol_test is availabe and reacent enough
-      */
+     * test if eapol_test is availabe and reacent enough
+     */
     private function eapol_test_test() {
-         exec(Config::$PATHS['eapol_test'], $out, $retval);
-         if($retval == 255 ) {
+            exec(Config::$PATHS['eapol_test'], $out, $retval);
+            if($retval == 255 ) {
             $o = preg_grep('/-o<server cert/',$out);
-               if(count($o) > 0)
-                   $this->test_return(L_OK,"<strong>eapol_test</strong> script found.");
-               else
-                   $this->test_return(L_ERROR,"<strong>eapol_test</strong> found, but is too old!");
-         }
-         else
+                if(count($o) > 0)
+                    $this->test_return(L_OK,"<strong>eapol_test</strong> script found.");
+                else
+                    $this->test_return(L_ERROR,"<strong>eapol_test</strong> found, but is too old!");
+            }
+            else
             $this->test_return(L_ERROR,"<strong>eapol_test</strong> not found!");
     }
 
     /**
-      * test if logdir exists and is writable
-      */
+     * test if logdir exists and is writable
+     */
     private function logdir_test() {
-         if (fopen(Config::$PATHS['logdir'] . "/debug.log", "a") == FALSE)
-             $this->test_return(L_WARN,"Log files in <strong>" . Config::$PATHS['logdir'] . "</strong> are not writable!");
-         else
-             $this->test_return(L_OK,"Log directory is writable.");
+            if (fopen(Config::$PATHS['logdir'] . "/debug.log", "a") == FALSE)
+                $this->test_return(L_WARN,"Log files in <strong>" . Config::$PATHS['logdir'] . "</strong> are not writable!");
+            else
+                $this->test_return(L_OK,"Log directory is writable.");
     }
 
     /**
-      * test for required PHP modules
-      */
+     * test for required PHP modules
+     */
     private function phpModules_test() {
         if (function_exists('idn_to_ascii'))
             $this->test_return(L_OK,"PHP can handle internationalisation.");
@@ -228,7 +228,7 @@ 
         if (function_exists('gettext'))
             $this->test_return(L_OK,"PHP extension <strong>GNU Gettext</strong> is installed.");
         else
-           $this->test_return(L_ERROR,"PHP extension <strong>GNU Gettext</strong> not found!");
+            $this->test_return(L_ERROR,"PHP extension <strong>GNU Gettext</strong> not found!");
 
         if (function_exists('openssl_sign'))
             $this->test_return(L_OK,"PHP extension <strong>OpenSSL</strong> is installed.");
@@ -270,193 +270,193 @@ 
      */
 
     private function geoip_test() {
-       $host_4 = '145.0.2.50';
-       $host_6 = '2001:610:188:444::50';
-       switch (Config::$GEOIP['version']) {
-           case 0:
+        $host_4 = '145.0.2.50';
+        $host_6 = '2001:610:188:444::50';
+        switch (Config::$GEOIP['version']) {
+            case 0:
               $this->test_return(L_REMARK,"As set in the config, no geolocation service will be used");
-              break;
-           case 1:
+                break;
+            case 1:
               if (!function_exists('geoip_record_by_name')) {
-                  $this->test_return(L_ERROR,"PHP extension <strong>GeoIP</strong> (legacy) not found! Get it from your distribution or <a href='http://pecl.php.net/package/geoip'>here</a> or better install GeoIP2 from <a href='https://github.com/maxmind/GeoIP2-php'>here</a>.");
-                  return;
-              }
-              $record = geoip_record_by_name($host_4);
-              if(! $record) {
-                 $this->test_return(L_ERROR,"PHP extension <strong>GeoIP</strong> (legacy) found but not working properly, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
-                 return;
-              }
-              if($record['city'] != 'Utrecht') {
-                 $this->test_return(L_ERROR,"PHP extension <strong>GeoIP</strong> (legacy) found but not working properly, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
-                 return;
-              }
-              $this->test_return(L_REMARK,"PHP extension <strong>GeoIP</strong> (legacy) is installed and working. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly. We stronly advise to replace the legacy GeoIP with GeoIP2 from <a href='https://github.com/maxmind/GeoIP2-php'>here</a>.");
-              break;
-           case 2:
+                    $this->test_return(L_ERROR,"PHP extension <strong>GeoIP</strong> (legacy) not found! Get it from your distribution or <a href='http://pecl.php.net/package/geoip'>here</a> or better install GeoIP2 from <a href='https://github.com/maxmind/GeoIP2-php'>here</a>.");
+                    return;
+                }
+                $record = geoip_record_by_name($host_4);
+                if(! $record) {
+                    $this->test_return(L_ERROR,"PHP extension <strong>GeoIP</strong> (legacy) found but not working properly, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
+                    return;
+                }
+                if($record['city'] != 'Utrecht') {
+                    $this->test_return(L_ERROR,"PHP extension <strong>GeoIP</strong> (legacy) found but not working properly, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
+                    return;
+                }
+                $this->test_return(L_REMARK,"PHP extension <strong>GeoIP</strong> (legacy) is installed and working. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly. We stronly advise to replace the legacy GeoIP with GeoIP2 from <a href='https://github.com/maxmind/GeoIP2-php'>here</a>.");
+                break;
+            case 2:
               if(! is_file(Config::$GEOIP['geoip2-path-to-autoloader'])) {
-                 $this->test_return(L_ERROR,"PHP extension <strong>GeoIP2</strong> not found! Get it from <a href='https://github.com/maxmind/GeoIP2-php'>here</a>.");
-                 return;
-              }
-              if(! is_file(Config::$GEOIP['geoip2-path-to-db'])) {
-                 $this->test_return(L_ERROR,"<strong>GeoIP2 database</strong> not found! See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
-                 return;
-              }
-              require_once Config::$GEOIP['geoip2-path-to-autoloader'];
-              $reader = new Reader(Config::$GEOIP['geoip2-path-to-db']);
-              try {
-                 $record = $reader->city($host_4);
-              } catch (Exception $e) {
-                 $this->test_return(L_ERROR,"PHP extension <strong>GeoIP2</strong> found but not working properly, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
-                 return;
-              }
-              if( $record->city->name != 'Utrecht') {
-                 $this->test_return(L_ERROR,"PHP extension <strong>GeoIP2</strong> found but not working properly, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
-                 return;
-              }
-              try {
-                 $record = $reader->city($host_6);
-              } catch (Exception $e) {
-                 $this->test_return(L_ERROR,"PHP extension <strong>GeoIP2</strong> found but not working properly with IPv6, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
-                 return;
-              }
-              if( $record->city->name != 'Utrecht') {
-                 $this->test_return(L_ERROR,"PHP extension <strong>GeoIP2</strong> found but not working properly with IPv6, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
-                 return;
-              }
-              $this->test_return(L_OK,"PHP extension <strong>GeoIP2</strong> is installed and working. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
-              break;
-           default:
+                    $this->test_return(L_ERROR,"PHP extension <strong>GeoIP2</strong> not found! Get it from <a href='https://github.com/maxmind/GeoIP2-php'>here</a>.");
+                    return;
+                }
+                if(! is_file(Config::$GEOIP['geoip2-path-to-db'])) {
+                    $this->test_return(L_ERROR,"<strong>GeoIP2 database</strong> not found! See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
+                    return;
+                }
+                require_once Config::$GEOIP['geoip2-path-to-autoloader'];
+                $reader = new Reader(Config::$GEOIP['geoip2-path-to-db']);
+                try {
+                    $record = $reader->city($host_4);
+                } catch (Exception $e) {
+                    $this->test_return(L_ERROR,"PHP extension <strong>GeoIP2</strong> found but not working properly, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
+                    return;
+                }
+                if( $record->city->name != 'Utrecht') {
+                    $this->test_return(L_ERROR,"PHP extension <strong>GeoIP2</strong> found but not working properly, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
+                    return;
+                }
+                try {
+                    $record = $reader->city($host_6);
+                } catch (Exception $e) {
+                    $this->test_return(L_ERROR,"PHP extension <strong>GeoIP2</strong> found but not working properly with IPv6, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
+                    return;
+                }
+                if( $record->city->name != 'Utrecht') {
+                    $this->test_return(L_ERROR,"PHP extension <strong>GeoIP2</strong> found but not working properly with IPv6, perhaps you need to download the databases. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
+                    return;
+                }
+                $this->test_return(L_OK,"PHP extension <strong>GeoIP2</strong> is installed and working. See utils/GeoIP-update.sh in the CAT distribution and use it tu update the GeoIP database regularly.");
+                break;
+            default:
               $this->test_return(L_ERROR,'Check Config::$GEOIP[\'version\'], it must be set to either 1 or 2');
-              break;
-       }
+                break;
+        }
     }
 
     /**
-      * test if openssl is available
-      */
+     * test if openssl is available
+     */
     private function openssl_test() {
-         $A = $this->get_exec_path('openssl');    
-         if($A['exec'] != "") {
-             $t = exec($A['exec'] . ' version');
-             if($A['exec_is'] == "EXPLICIT")
+            $A = $this->get_exec_path('openssl');    
+            if($A['exec'] != "") {
+                $t = exec($A['exec'] . ' version');
+                if($A['exec_is'] == "EXPLICIT")
                 $this->test_return(L_OK,"<strong>$t</strong> was found and is configured explicitly in your config.");
-             else
+                else
                 $this->test_return(L_WARN,"<strong>$t</strong> was found, but is not configured with an absolute path in your config.");
-         } else
+            } else
             $this->test_return(L_ERROR,"<strong>openssl</strong> was not found on your system!");
     }
 
     /**
-      * test if makensis is available
-      */
+     * test if makensis is available
+     */
     private function makensis_test() {
-         if(! is_numeric(Config::$NSIS_VERSION)) {
+            if(! is_numeric(Config::$NSIS_VERSION)) {
             $this->test_return(L_ERROR,"NSIS_VERSION needs to be numeric!");
             return;
-         }
-         if(Config::$NSIS_VERSION < 2) {
+            }
+            if(Config::$NSIS_VERSION < 2) {
             $this->test_return(L_ERROR,"NSIS_VERSION needs to be at least 2!");
             return;
-         }
-         $A = $this->get_exec_path('makensis');    
-         if($A['exec'] != "") {
-             $t = exec($A['exec'] . ' -VERSION');
-             if($A['exec_is'] == "EXPLICIT") 
+            }
+            $A = $this->get_exec_path('makensis');    
+            if($A['exec'] != "") {
+                $t = exec($A['exec'] . ' -VERSION');
+                if($A['exec_is'] == "EXPLICIT") 
                 $this->test_return(L_OK,"<strong>makensis $t</strong> was found and is configured explicitly in your config.");
-             else
+                else
                 $this->test_return(L_WARN,"<strong>makensis $t</strong> was found, but is not configured with an absolute path in your config.");
-             exec($A['exec'] . ' -HELP',$t);
-             $t1 = count(preg_grep('/INPUTCHARSET/',$t));
-             if($t1 == 1 && Config::$NSIS_VERSION == 2)
+                exec($A['exec'] . ' -HELP',$t);
+                $t1 = count(preg_grep('/INPUTCHARSET/',$t));
+                if($t1 == 1 && Config::$NSIS_VERSION == 2)
                 $this->test_return(L_ERROR,"Declared NSIS_VERSION does not seem to match the file pointed to by PATHS['makensis']!");
-             if($t1 == 0 && Config::$NSIS_VERSION >= 3)
+                if($t1 == 0 && Config::$NSIS_VERSION >= 3)
                 $this->test_return(L_ERROR,"Declared NSIS_VERSION does not seem to match the file pointed to by PATHS['makensis']!");
-         } else
+            } else
             $this->test_return(L_ERROR,"<strong>makensis</strong> was not found on your system!");
     }
 
     /**
-      * test if all required NSIS modules are available
-      */
+     * test if all required NSIS modules are available
+     */
     private function NSISmodules_test() {
-         $tmp_dir = createTemporaryDirectory('installer',0)['dir'];
-         if(!chdir($tmp_dir)) {
-           debug(2, "Cannot chdir to $tmp_dir\n");
-           $this->test_return(L_ERROR,"NSIS modules test - problem with temporary directory permissions, cannot continue");
-           return;
-         }
-         $exe= 'tt.exe';
-         $NSIS_Module_status = [];
-         foreach ($this->NSIS_Modules as $module) {
+            $tmp_dir = createTemporaryDirectory('installer',0)['dir'];
+            if(!chdir($tmp_dir)) {
+            debug(2, "Cannot chdir to $tmp_dir\n");
+            $this->test_return(L_ERROR,"NSIS modules test - problem with temporary directory permissions, cannot continue");
+            return;
+            }
+            $exe= 'tt.exe';
+            $NSIS_Module_status = [];
+            foreach ($this->NSIS_Modules as $module) {
             unset($out);
             exec(Config::$PATHS['makensis']." -V1 '-X!include $module' '-XOutFile $exe' '-XSection X' '-XSectionEnd'", $out, $retval);
             if($retval > 0) 
-               $NSIS_Module_status[$module] = 0;
+                $NSIS_Module_status[$module] = 0;
             else
-               $NSIS_Module_status[$module] = 1;
-         }
-         if(is_file($exe))
+                $NSIS_Module_status[$module] = 1;
+            }
+            if(is_file($exe))
             unlink($exe);
-         foreach ($NSIS_Module_status as $module => $status) {
+            foreach ($NSIS_Module_status as $module => $status) {
             if($status == 1)
-               $this->test_return(L_OK,"NSIS module <strong>$module</strong> was found.");
+                $this->test_return(L_OK,"NSIS module <strong>$module</strong> was found.");
             else
-               $this->test_return(L_ERROR,"NSIS module <strong>$module</strong> was not found or is not working correctly.");
-         }
+                $this->test_return(L_ERROR,"NSIS module <strong>$module</strong> was not found or is not working correctly.");
+            }
     }
     private function NSIS_GetVersion_test() {
-         $tmp_dir = createTemporaryDirectory('installer',0)['dir'];
-         if(!chdir($tmp_dir)) {
-           debug(2, "Cannot chdir to $tmp_dir\n");
-           $this->test_return(L_ERROR,"NSIS module <strong>GetVersion</strong> - problem with temporary directory permissions, cannot continue");
-           return;
-         }
-         $exe= 'tt.exe';
-         exec(Config::$PATHS['makensis']." -V1 '-XOutFile $exe' '-XSection X' '-XGetVersion::WindowsName' '-XSectionEnd'", $out, $retval);
-         if($retval > 0)
+            $tmp_dir = createTemporaryDirectory('installer',0)['dir'];
+            if(!chdir($tmp_dir)) {
+            debug(2, "Cannot chdir to $tmp_dir\n");
+            $this->test_return(L_ERROR,"NSIS module <strong>GetVersion</strong> - problem with temporary directory permissions, cannot continue");
+            return;
+            }
+            $exe= 'tt.exe';
+            exec(Config::$PATHS['makensis']." -V1 '-XOutFile $exe' '-XSection X' '-XGetVersion::WindowsName' '-XSectionEnd'", $out, $retval);
+            if($retval > 0)
             $this->test_return(L_ERROR,"NSIS module <strong>GetVersion</strong> was not found or is not working correctly.");
-         else
+            else
             $this->test_return(L_OK,"NSIS module <strong>GetVersion</strong> was found.");
-         if(is_file($exe))
+            if(is_file($exe))
             unlink($exe);
     }
 
     /**
-      * test access to dowloads directories
-      */
+     * test access to dowloads directories
+     */
     private function directories_test() {
-               $Dir = createTemporaryDirectory('installer',0);
-               $dir = $Dir['dir'];
-               $base = $Dir['base'];
-               if($dir) {
-                  $this->test_return(L_OK,"Installer cache directory is writable.");
-                  rrmdir($dir);
-               } else {
-                  $this->test_return(L_ERROR,"Installer cache directory $base does not exist or is not writable!");
-               }
-               $Dir = createTemporaryDirectory('test',0);
-               $dir = $Dir['dir'];
-               $base = $Dir['base'];
-               if($dir) {
-                  $this->test_return(L_OK,"Test directory is writable.");
-                  rrmdir($dir);
-               } else {
-                  $this->test_return(L_ERROR,"Test directory  $base does not exist or is not writable!");
-               }
-               $Dir = createTemporaryDirectory('logo',0);
-               $dir = $Dir['dir'];
-               $base = $Dir['base'];
-               if($dir) {
-                  $this->test_return(L_OK,"Logos cache directory is writable.");
-                  rrmdir($dir);
-               } else {
-                  $this->test_return(L_ERROR,"Logos cache directory  $base does not exist or is not writable!");
-               }
+                $Dir = createTemporaryDirectory('installer',0);
+                $dir = $Dir['dir'];
+                $base = $Dir['base'];
+                if($dir) {
+                    $this->test_return(L_OK,"Installer cache directory is writable.");
+                    rrmdir($dir);
+                } else {
+                    $this->test_return(L_ERROR,"Installer cache directory $base does not exist or is not writable!");
+                }
+                $Dir = createTemporaryDirectory('test',0);
+                $dir = $Dir['dir'];
+                $base = $Dir['base'];
+                if($dir) {
+                    $this->test_return(L_OK,"Test directory is writable.");
+                    rrmdir($dir);
+                } else {
+                    $this->test_return(L_ERROR,"Test directory  $base does not exist or is not writable!");
+                }
+                $Dir = createTemporaryDirectory('logo',0);
+                $dir = $Dir['dir'];
+                $base = $Dir['base'];
+                if($dir) {
+                    $this->test_return(L_OK,"Logos cache directory is writable.");
+                    rrmdir($dir);
+                } else {
+                    $this->test_return(L_ERROR,"Logos cache directory  $base does not exist or is not writable!");
+                }
     }
 
     /**
-      * test if all required locales are enabled
-      */
+     * test if all required locales are enabled
+     */
     private function locales_test() {
                 $locales = shell_exec("locale -a");
                 $allthere = "";
@@ -479,8 +479,8 @@ 
 
 
     /**
-      * test if detalts in the config have been replaced with some real values
-      */
+     * test if detalts in the config have been replaced with some real values
+     */
     private function defaults_test() {
                 $defaultvalues = "";
                 $missingvalues = "";
@@ -531,121 +531,121 @@ 
                     $this->test_return(L_OK,"Your configuration does not contain any unchanged defaults, which is a good sign.");
     }
 
-   /**
+    /**
      * test access to databases
      */
-   private function databases_test() {
+    private function databases_test() {
         $DB = 'INST';
         $db = mysqli_connect(Config::$DB[$DB]['host'], Config::$DB[$DB]['user'], Config::$DB[$DB]['pass'], Config::$DB[$DB]['db']);
         if(! $db) {
-           $this->test_return(L_ERROR,"Connection to the  $DB database failed");
+            $this->test_return(L_ERROR,"Connection to the  $DB database failed");
         } else {
-           $r = mysqli_query($db,'select * from profile_option_dict');
-           if($r->num_rows == $this->profile_option_ct)
-              $this->test_return(L_OK,"The $DB database appears to be OK.");
-           else
-              $this->test_return(L_ERROR,"The $DB database is reacheable but probably not updated to this version of CAT.");
+            $r = mysqli_query($db,'select * from profile_option_dict');
+            if($r->num_rows == $this->profile_option_ct)
+                $this->test_return(L_OK,"The $DB database appears to be OK.");
+            else
+                $this->test_return(L_ERROR,"The $DB database is reacheable but probably not updated to this version of CAT.");
         }
         $DB = 'USER';
         $db = mysqli_connect(Config::$DB[$DB]['host'], Config::$DB[$DB]['user'], Config::$DB[$DB]['pass'], Config::$DB[$DB]['db']);
         if(! $db) {
-           $this->test_return(L_ERROR,"Connection to the  $DB database failed");
+            $this->test_return(L_ERROR,"Connection to the  $DB database failed");
         } else {
-           $r = mysqli_query($db,'desc view_admin');
-           if($r->num_rows == $this->view_admin_ct)
-              $this->test_return(L_OK,"The $DB database appears to be OK.");
-           else
-              $this->test_return(L_ERROR,"The $DB is reacheable but there is something wrong with the schema");
+            $r = mysqli_query($db,'desc view_admin');
+            if($r->num_rows == $this->view_admin_ct)
+                $this->test_return(L_OK,"The $DB database appears to be OK.");
+            else
+                $this->test_return(L_ERROR,"The $DB is reacheable but there is something wrong with the schema");
         }
         $DB = 'EXTERNAL';
         if(! empty(Config::$DB[$DB])) {
         $db = mysqli_connect(Config::$DB[$DB]['host'], Config::$DB[$DB]['user'], Config::$DB[$DB]['pass'], Config::$DB[$DB]['db']);
         if(! $db) {
-           $this->test_return(L_ERROR,"Connection to the  $DB database failed");
+            $this->test_return(L_ERROR,"Connection to the  $DB database failed");
         } else {
-           $r = mysqli_query($db,'desc view_admin');
-           if($r->num_rows == $this->view_admin_ct)
-              $this->test_return(L_OK,"The $DB database appears to be OK.");
-           else
-              $this->test_return(L_ERROR,"The $DB is reacheable but there is something wrong with the schema");
+            $r = mysqli_query($db,'desc view_admin');
+            if($r->num_rows == $this->view_admin_ct)
+                $this->test_return(L_OK,"The $DB database appears to be OK.");
+            else
+                $this->test_return(L_ERROR,"The $DB is reacheable but there is something wrong with the schema");
         }
         }
-   }
+    }
 
 
-   /**
+    /**
      * test devices.php for the no_cache option
      */
-   private function device_cache_test() {
-       if((! empty(Devices::$Options['no_cache'])) && Devices::$Options['no_cache'])
-          $global_no_cache = 1;
-       else
-          $global_no_cache = 0;
-
-       if($global_no_cache == 1)
-          $this->test_return(L_WARN,"Devices no_cache global option is set, this is not a good idea in a production setting\n");
-       $Devs = Devices::listDevices();
-       $no_cache_dev = '';
-       $no_cache_dev_count = 0;
-       if($global_no_cache) {
-          foreach ($Devs as $dev=>$D) {
-             if(empty($D['options']['no_cache']) || $D['options']['no_cache'] != 0) {
+    private function device_cache_test() {
+        if((! empty(Devices::$Options['no_cache'])) && Devices::$Options['no_cache'])
+            $global_no_cache = 1;
+        else
+            $global_no_cache = 0;
+
+        if($global_no_cache == 1)
+            $this->test_return(L_WARN,"Devices no_cache global option is set, this is not a good idea in a production setting\n");
+        $Devs = Devices::listDevices();
+        $no_cache_dev = '';
+        $no_cache_dev_count = 0;
+        if($global_no_cache) {
+            foreach ($Devs as $dev=>$D) {
+                if(empty($D['options']['no_cache']) || $D['options']['no_cache'] != 0) {
                 $no_cache_dev .= $dev." ";
                 $no_cache_dev_count++;
-             }
-          }
-       } else {
-          foreach ($Devs as $dev=>$D) {
-             if(!empty($D['options']['no_cache']) && $D['options']['no_cache'] != 0) {
+                }
+            }
+        } else {
+            foreach ($Devs as $dev=>$D) {
+                if(!empty($D['options']['no_cache']) && $D['options']['no_cache'] != 0) {
                 $no_cache_dev .= $dev." ";
                 $no_cache_dev_count++;
-             }
-          }
-       }
+                }
+            }
+        }
 
 
-       if($no_cache_dev_count > 1 ) 
-          $this->test_return(L_WARN,"The following devices will not be cached: $no_cache_dev");
-       if($no_cache_dev_count == 1 ) 
-          $this->test_return(L_WARN,"The following device will not be cached: $no_cache_dev");
+        if($no_cache_dev_count > 1 ) 
+            $this->test_return(L_WARN,"The following devices will not be cached: $no_cache_dev");
+        if($no_cache_dev_count == 1 ) 
+            $this->test_return(L_WARN,"The following device will not be cached: $no_cache_dev");
 
-   }
+    }
 
-   /**
+    /**
      * test if mailer works
      */
-   private function mailer_test() {
-      if (empty(Config::$APPEARANCE['abuse-mail']) || Config::$APPEARANCE['abuse-mail'] == "my-abuse-contact@your-cat-installation.example") {
-         $this->test_return(L_ERROR,"Your abuse-mail has not been set, cannot continue with mailer tests.");
-         return;
-      }
-      $mail = new PHPMailer\PHPMailer\PHPMailer();
-      $mail->isSMTP();
-      $mail->Port = 587;
-      $mail->SMTPAuth = true;
-      $mail->SMTPSecure = 'tls';
-      $mail->Host = Config::$MAILSETTINGS['host'];
-      $mail->Username = Config::$MAILSETTINGS['user'];
-      $mail->Password = Config::$MAILSETTINGS['pass'];
-      $mail->WordWrap = 72;
-      $mail->isHTML(FALSE);
-      $mail->CharSet = 'UTF-8';
-      $mail->From = Config::$APPEARANCE['from-mail'];
-      $mail->FromName = Config::$APPEARANCE['productname'] . " Invitation System";
-      $mail->addAddress(Config::$APPEARANCE['abuse-mail']);
-      $mail->Subject = "testing CAT configuration mail";
-      $mail->Body = "Testing CAT mailing\n";
-      $sent = $mail->send();
-      if($sent)
-          $this->test_return(L_OK,"mailer settings appear to be working, check ".Config::$APPEARANCE['abuse-mail']." mailbox if the message was receiced.");
-      else
-          $this->test_return(L_ERROR,"mailer settings failed, check the Config::MAILSETTINGS");
-
-   }
+    private function mailer_test() {
+        if (empty(Config::$APPEARANCE['abuse-mail']) || Config::$APPEARANCE['abuse-mail'] == "my-abuse-contact@your-cat-installation.example") {
+            $this->test_return(L_ERROR,"Your abuse-mail has not been set, cannot continue with mailer tests.");
+            return;
+        }
+        $mail = new PHPMailer\PHPMailer\PHPMailer();
+        $mail->isSMTP();
+        $mail->Port = 587;
+        $mail->SMTPAuth = true;
+        $mail->SMTPSecure = 'tls';
+        $mail->Host = Config::$MAILSETTINGS['host'];
+        $mail->Username = Config::$MAILSETTINGS['user'];
+        $mail->Password = Config::$MAILSETTINGS['pass'];
+        $mail->WordWrap = 72;
+        $mail->isHTML(FALSE);
+        $mail->CharSet = 'UTF-8';
+        $mail->From = Config::$APPEARANCE['from-mail'];
+        $mail->FromName = Config::$APPEARANCE['productname'] . " Invitation System";
+        $mail->addAddress(Config::$APPEARANCE['abuse-mail']);
+        $mail->Subject = "testing CAT configuration mail";
+        $mail->Body = "Testing CAT mailing\n";
+        $sent = $mail->send();
+        if($sent)
+            $this->test_return(L_OK,"mailer settings appear to be working, check ".Config::$APPEARANCE['abuse-mail']." mailbox if the message was receiced.");
+        else
+            $this->test_return(L_ERROR,"mailer settings failed, check the Config::MAILSETTINGS");
+
+    }
 
     /**
-      * TODO test if RADIUS connections work
-      */
+     * TODO test if RADIUS connections work
+     */
     private function UDPhosts_test() {
 //        if(empty)
     }

core/UserAPI.php

Doc Comments -2 removed lines

@@ -260,7 +260,6 @@ 
 /**
  * Return the list of IdPs in a given country
  *
- * @param int $idp_id the IdP identifier
  * @return string JSON encoded data
  */
 
@@ -301,7 +300,6 @@ 
 /**
  * Return the list of IdPs in a given country ordered with respect to the user location
  *
- * @param int $idp_id the IdP identifier
  * @return string JSON encoded data
  */
 

Indentation +391 added lines, -391 removed lines

@@ -52,7 +52,7 @@ 
  *  link - the path name of the resulting installer
  *  mime - the mimetype of the installer
  */
-  public function generateInstaller($device,$prof_id, $generated_for = "user") {
+    public function generateInstaller($device,$prof_id, $generated_for = "user") {
     $this->set_locale("devices");
     $Dev = Devices::listDevices();
     $Config = $Dev[$device];
@@ -61,93 +61,93 @@ 
     $attribs = $profile->getCollapsedAttributes();
     // test if the profile is production-ready and if not if the authenticated user is an owner
     if (!isset($attribs['profile:production']) || (isset($attribs['profile:production']) && $attribs['profile:production'][0] != "on")) {
-       debug(4,"Attempt to download a non-production ready installer fir profile: $prof_id\n");
-       require_once(Config::$AUTHENTICATION['ssp-path-to-autoloader']);
-       $as = new SimpleSAML_Auth_Simple(Config::$AUTHENTICATION['ssp-authsource']);
-       if($as->isAuthenticated()) {
-          $user_object = new User($_SESSION['user']);
-          if($user_object->isIdPOwner($profile->institution)) {
-              debug(4, "User is the owner - allowing access\n");
-          } else {
-             debug(2, "User not an owner of a non-production profile - access forbidden\n");
-       header("HTTP/1.0 403 Not Authorized");
-             return;
-          }
-       } else {
-          debug(2, "User NOT authenticated, rejecting request for a non-production installer\n");
-          header("HTTP/1.0 403 Not Authorized");
-          return;
-       }
+        debug(4,"Attempt to download a non-production ready installer fir profile: $prof_id\n");
+        require_once(Config::$AUTHENTICATION['ssp-path-to-autoloader']);
+        $as = new SimpleSAML_Auth_Simple(Config::$AUTHENTICATION['ssp-authsource']);
+        if($as->isAuthenticated()) {
+            $user_object = new User($_SESSION['user']);
+            if($user_object->isIdPOwner($profile->institution)) {
+                debug(4, "User is the owner - allowing access\n");
+            } else {
+                debug(2, "User not an owner of a non-production profile - access forbidden\n");
+        header("HTTP/1.0 403 Not Authorized");
+                return;
+            }
+        } else {
+            debug(2, "User NOT authenticated, rejecting request for a non-production installer\n");
+            header("HTTP/1.0 403 Not Authorized");
+            return;
+        }
     }
     $a = [];
     $a['profile'] = $prof_id;
     $a['device'] = $device;
     if( (isset(Devices::$Options['no_cache']) && Devices::$Options['no_cache'] ) || ( isset($Config['options']['no_cache']) && $Config['options']['no_cache'] ))
-      $this->i_path = FALSE;
+        $this->i_path = FALSE;
     else {
-      $cache = $profile->testCache($device);
-      $this->i_path = $cache['cache'];
+        $cache = $profile->testCache($device);
+        $this->i_path = $cache['cache'];
     }
     if($this->i_path && is_file($this->i_path)) { 
-      debug(4,"Using cached installer for: $device\n");
-      $a['link'] = "API.php?api_version=$version&action=downloadInstaller&lang=".CAT::get_lang()."&profile=$prof_id&device=$device&generatedfor=$generated_for";
-      $a['mime'] = $cache['mime'];
+        debug(4,"Using cached installer for: $device\n");
+        $a['link'] = "API.php?api_version=$version&action=downloadInstaller&lang=".CAT::get_lang()."&profile=$prof_id&device=$device&generatedfor=$generated_for";
+        $a['mime'] = $cache['mime'];
     } else {
-      $factory = new DeviceFactory($device);
-      $dev = $factory->device;
-      if(isset($dev)) {
-         $dev->setup($profile);
-         $installer = $dev->writeInstaller();
-         $i_path = $dev->FPATH.'/tmp/'.$installer;
-         if($i_path && is_file($i_path)) {
-         if(isset($dev->options['mime']))
-               $a['mime'] = $dev->options['mime'];
-         else {
-           $info = new finfo();
-           $a['mime'] = $info->file($i_path, FILEINFO_MIME_TYPE);
-         }
-         $this->i_path = $dev->FPATH.'/'.$installer;
-         rename($i_path, $this->i_path);
-         $profile->updateCache($device,$this->i_path,$a['mime']);
+        $factory = new DeviceFactory($device);
+        $dev = $factory->device;
+        if(isset($dev)) {
+            $dev->setup($profile);
+            $installer = $dev->writeInstaller();
+            $i_path = $dev->FPATH.'/tmp/'.$installer;
+            if($i_path && is_file($i_path)) {
+            if(isset($dev->options['mime']))
+                $a['mime'] = $dev->options['mime'];
+            else {
+            $info = new finfo();
+            $a['mime'] = $info->file($i_path, FILEINFO_MIME_TYPE);
+            }
+            $this->i_path = $dev->FPATH.'/'.$installer;
+            rename($i_path, $this->i_path);
+            $profile->updateCache($device,$this->i_path,$a['mime']);
 //         rrmdir($dev->FPATH.'/tmp');
-         debug(4,"Generated installer: ".$this->i_path.": for: $device\n");
-         $a['link'] = "API.php?api_version=$version&action=downloadInstaller&lang=".CAT::get_lang()."&profile=$prof_id&device=$device&generatedfor=$generated_for";
-         } else {
-         debug(2,"Installer generation failed for: $prof_id:$device:".CAT::get_lang()."\n");
-         $a['link'] = 0;
-         }
-      } 
+            debug(4,"Generated installer: ".$this->i_path.": for: $device\n");
+            $a['link'] = "API.php?api_version=$version&action=downloadInstaller&lang=".CAT::get_lang()."&profile=$prof_id&device=$device&generatedfor=$generated_for";
+            } else {
+            debug(2,"Installer generation failed for: $prof_id:$device:".CAT::get_lang()."\n");
+            $a['link'] = 0;
+            }
+        } 
     }
     $this->set_locale("web_user");
     return($a);
- }
+    }
 
- /**
-  * interface to Devices::listDevices() 
-  */
- public function listDevices($show_hidden = 0) {
+    /**
+     * interface to Devices::listDevices() 
+     */
+    public function listDevices($show_hidden = 0) {
     $Dev = Devices::listDevices();
     $R = [];
     $ct = 0;
     if($show_hidden !== 0 && $show_hidden != 1)
-      return;
+        return;
     foreach ($Dev as $device => $D) {
-      if(isset($D['options']['hidden']) && $D['options']['hidden'] && $show_hidden == 0)
-         continue;
-      $ct ++;
-      if($this->version == 1)
-         $D['device'] = $device;
-      else
-         $D['device'] = $device;
-      $group = isset($D['group']) ? $D['group'] : 'other';
-      if (! isset($R[$group]))
-         $R[$group] = [];
-      $R[$group][$device] = $D;
-    }
-   return $R;
- }
-
- public function deviceInfo($device,$prof_id) {
+        if(isset($D['options']['hidden']) && $D['options']['hidden'] && $show_hidden == 0)
+            continue;
+        $ct ++;
+        if($this->version == 1)
+            $D['device'] = $device;
+        else
+            $D['device'] = $device;
+        $group = isset($D['group']) ? $D['group'] : 'other';
+        if (! isset($R[$group]))
+            $R[$group] = [];
+        $R[$group][$device] = $D;
+    }
+    return $R;
+    }
+
+    public function deviceInfo($device,$prof_id) {
     $this->set_locale("devices");
     $out = 0;
     $profile = new Profile($prof_id);
@@ -155,11 +155,11 @@ 
     $dev = $factory->device;
     if(isset($dev)) {
 //       $dev->setup($profile);
-       $out = $dev->writeDeviceInfo();
-   }
+        $out = $dev->writeDeviceInfo();
+    }
     $this->set_locale("web_user");
     echo $out;
- }
+    }
 
 /**
  * Prepare the support data for a given profile
@@ -173,23 +173,23 @@ 
  * - description
  * - devices - an array of device names and their statuses (for a given profile)
  */
- public function profileAttributes($prof_id) {
+    public function profileAttributes($prof_id) {
     $this->set_locale("devices");
-      $profile = new Profile($prof_id);
-      $attr = $profile->getCollapsedAttributes();
-      $a = [];
-      if(isset($attr['support:email']))
-         $a['local_email'] = $attr['support:email'][0];
-      if(isset($attr['support:phone']))
-         $a['local_phone'] = $attr['support:phone'][0];
-      if(isset($attr['support:url']))
-         $a['local_url'] = $attr['support:url'][0];
-      if(isset($attr['profile:description']))
-         $a['description'] = $attr['profile:description'][0];
-      $a['devices'] = $profile->listDevices();
-      $this->set_locale("web_user");
-      return($a);
- }
+        $profile = new Profile($prof_id);
+        $attr = $profile->getCollapsedAttributes();
+        $a = [];
+        if(isset($attr['support:email']))
+            $a['local_email'] = $attr['support:email'][0];
+        if(isset($attr['support:phone']))
+            $a['local_phone'] = $attr['support:phone'][0];
+        if(isset($attr['support:url']))
+            $a['local_url'] = $attr['support:url'][0];
+        if(isset($attr['profile:description']))
+            $a['description'] = $attr['profile:description'][0];
+        $a['devices'] = $profile->listDevices();
+        $this->set_locale("web_user");
+        return($a);
+    }
 
 /*
    this method needs to be used with care, it could give wrong results in some
@@ -201,13 +201,13 @@ 
     $file= $F['file'];
     $file = substr($file,strlen(dirname(__DIR__)));
     while(substr($file,0,1) == '/')
-       $file = substr($file,1);
+        $file = substr($file,1);
     $n = count(explode('/',$file));
     $out = $_SERVER['SCRIPT_NAME'];
     for ($i= 0; $i < $n; $i++)
-      $out = dirname($out);
+        $out = dirname($out);
     if ($out == '/')
-      $out = '';
+        $out = '';
     $s = isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] ? 'https' : 'http';
     $s .= '://'.$_SERVER['HTTP_HOST'] . $out;
     return $s;
@@ -215,29 +215,29 @@ 
 
 /* JSON functions */
 
-  public function return_json($data,$status=1) {
-     $return_array = [];
-     $return_array['status'] = $status;
-     $return_array['data'] = $data;
-     $return_array['tou'] =  "Please consult Terms of Use at: ".$this->GetRootURL()."/tou.php";
-     return(json_encode($return_array));
-  }
+    public function return_json($data,$status=1) {
+        $return_array = [];
+        $return_array['status'] = $status;
+        $return_array['data'] = $data;
+        $return_array['tou'] =  "Please consult Terms of Use at: ".$this->GetRootURL()."/tou.php";
+        return(json_encode($return_array));
+    }
 
 /**
-  * Return the list of supported languages.
-  *
-  * 
-  */
-  public function JSON_listLanguages() {
-     $return_array = [];
-     foreach(Config::$LANGUAGES as $id => $val){
-       if($this->version == 1)
-          $return_array[] = ['id'=>$id,'display'=>$val['display'],'locale'=>$val['locale']];
-       else
-          $return_array[] = ['lang'=>$id,'display'=>$val['display'],'locale'=>$val['locale']];
-     }
-     echo $this->return_json($return_array);
-  }
+ * Return the list of supported languages.
+ *
+ * 
+ */
+    public function JSON_listLanguages() {
+        $return_array = [];
+        foreach(Config::$LANGUAGES as $id => $val){
+        if($this->version == 1)
+            $return_array[] = ['id'=>$id,'display'=>$val['display'],'locale'=>$val['locale']];
+        else
+            $return_array[] = ['lang'=>$id,'display'=>$val['display'],'locale'=>$val['locale']];
+        }
+        echo $this->return_json($return_array);
+    }
 
 /**
  * Return the list of countiers with configured IdPs
@@ -245,17 +245,17 @@ 
  * @return string JSON encoded data
  */
 
-  public function JSON_listCountries() {
-     $FED = $this->printCountryList(1);
-     $return_array = [];
-     foreach ($FED as $id => $val) {
-       if($this->version == 1)
-          $return_array[] = ['id'=>$id,'display'=>$val];
-       else
-          $return_array[] = ['federation'=>$id,'display'=>$val];
-     }
-     echo $this->return_json($return_array);
-  }
+    public function JSON_listCountries() {
+        $FED = $this->printCountryList(1);
+        $return_array = [];
+        foreach ($FED as $id => $val) {
+        if($this->version == 1)
+            $return_array[] = ['id'=>$id,'display'=>$val];
+        else
+            $return_array[] = ['federation'=>$id,'display'=>$val];
+        }
+        echo $this->return_json($return_array);
+    }
 
 /**
  * Return the list of IdPs in a given country
@@ -264,17 +264,17 @@ 
  * @return string JSON encoded data
  */
 
-  public function JSON_listIdentityProviders($country) {
-     $idps = Federation::listAllIdentityProviders(1,$country);
-     $return_array = [];
-     foreach ($idps as $idp) {
+    public function JSON_listIdentityProviders($country) {
+        $idps = Federation::listAllIdentityProviders(1,$country);
+        $return_array = [];
+        foreach ($idps as $idp) {
         if($this->version == 1)
-           $return_array[] = ['id'=>$idp['entityID'],'display'=>$idp['title']];
+            $return_array[] = ['id'=>$idp['entityID'],'display'=>$idp['title']];
         else
-           $return_array[] = ['idp'=>$idp['entityID'],'display'=>$idp['title']];
-     }
-     echo $this->return_json($return_array);
-  }
+            $return_array[] = ['idp'=>$idp['entityID'],'display'=>$idp['title']];
+        }
+        echo $this->return_json($return_array);
+    }
 
 /**
  * return the list of all active IdPs
@@ -283,18 +283,18 @@ 
  * @return string JSON encoded data
  */
 
-  public function JSON_listIdentityProvidersForDisco() {
-     $idps = Federation::listAllIdentityProviders(1);
-     $return_array = [];
-     foreach ($idps as $idp) {
+    public function JSON_listIdentityProvidersForDisco() {
+        $idps = Federation::listAllIdentityProviders(1);
+        $return_array = [];
+        foreach ($idps as $idp) {
         if($this->version == 1)
-           $idp['id'] = $idp['entityID'];
-         else
-           $idp['idp'] = $idp['entityID'];
+            $idp['id'] = $idp['entityID'];
+            else
+            $idp['idp'] = $idp['entityID'];
         $return_array[] = $idp;
-      }
-     echo json_encode($return_array);
-  }
+        }
+        echo json_encode($return_array);
+    }
 
 
 
@@ -306,17 +306,17 @@ 
  */
 
 
-  public function JSON_orderIdentityProviders($country,$L=NULL) {
-     $idps = $this->orderIdentityProviders($country,$L);
-     $return_array = [];
-     foreach ($idps as $idp) {
+    public function JSON_orderIdentityProviders($country,$L=NULL) {
+        $idps = $this->orderIdentityProviders($country,$L);
+        $return_array = [];
+        foreach ($idps as $idp) {
         if($this->version == 1)
-           $return_array[] = ['id'=>$idp['id'],'display'=>$idp['title']];
+            $return_array[] = ['id'=>$idp['id'],'display'=>$idp['title']];
         else
-           $return_array[] = ['idp'=>$idp['id'],'display'=>$idp['title']];
-     }
-     echo $this->return_json($return_array);
-  }
+            $return_array[] = ['idp'=>$idp['id'],'display'=>$idp['title']];
+        }
+        echo $this->return_json($return_array);
+    }
 
 /**
  * Produce a list of profiles available for a given IdP
@@ -324,31 +324,31 @@ 
  * @param int $idp_id the IdP identifier
  * @return string JSON encoded data
  */
-  public function JSON_listProfiles($idp_id,$sort = 0) {
-     $this->set_locale("web_user");
-     $return_array = [];
-     try {     
-         $idp = new IdP($idp_id);
-     }
-     catch (Exception $fail) {
+    public function JSON_listProfiles($idp_id,$sort = 0) {
+        $this->set_locale("web_user");
+        $return_array = [];
+        try {     
+            $idp = new IdP($idp_id);
+        }
+        catch (Exception $fail) {
         echo $this->return_json($return_array,0);
         return;
-     }
-     $l = 0;
-     $logo = $idp->getAttributes('general:logo_file');
-     if($logo)
-       $l = 1;
-     $profiles = $idp->listProfiles(1);
-     if($sort == 1)
+        }
+        $l = 0;
+        $logo = $idp->getAttributes('general:logo_file');
+        if($logo)
+        $l = 1;
+        $profiles = $idp->listProfiles(1);
+        if($sort == 1)
         usort($profiles,"profile_sort");
-     foreach ($profiles as $P) {
-       if($this->version == 1)
-          $return_array[] = ['id'=>$P->identifier,'display'=>$P->name, 'idp_name'=>$P->inst_name,'logo'=>$l]; 
-       else
-          $return_array[] = ['profile'=>$P->identifier,'display'=>$P->name, 'idp_name'=>$P->inst_name,'logo'=>$l]; 
-     }
-     echo $this->return_json($return_array);
-  }
+        foreach ($profiles as $P) {
+        if($this->version == 1)
+            $return_array[] = ['id'=>$P->identifier,'display'=>$P->name, 'idp_name'=>$P->inst_name,'logo'=>$l]; 
+        else
+            $return_array[] = ['profile'=>$P->identifier,'display'=>$P->name, 'idp_name'=>$P->inst_name,'logo'=>$l]; 
+        }
+        echo $this->return_json($return_array);
+    }
 
 /**
  * Return the list of devices available for the given profile
@@ -356,34 +356,34 @@ 
  * @param int $profile_id the Profile identifier
  * @return string JSON encoded data
  */
-  public function JSON_listDevices($profile_id) {
-     $this->set_locale("web_user");
-     $return_array = [];
-     $a = $this->profileAttributes($profile_id);
-     $thedevices = $a['devices'];
-     if(!isset($profile_redirect) || ! $profile_redirect) {
-         $profile_redirect = 0;
-         foreach ($thedevices as $D) {
-              if(isset($D['options']) && isset($D['options']['hidden']) &&  $D['options']['hidden'])
-                   continue;
-              $disp = $D['display'];
-              if($this->version == 1) {
-                 if($D['id'] === '0') {
-                     $profile_redirect = 1;
-                     $disp = $c;
-                 }
+    public function JSON_listDevices($profile_id) {
+        $this->set_locale("web_user");
+        $return_array = [];
+        $a = $this->profileAttributes($profile_id);
+        $thedevices = $a['devices'];
+        if(!isset($profile_redirect) || ! $profile_redirect) {
+            $profile_redirect = 0;
+            foreach ($thedevices as $D) {
+                if(isset($D['options']) && isset($D['options']['hidden']) &&  $D['options']['hidden'])
+                    continue;
+                $disp = $D['display'];
+                if($this->version == 1) {
+                    if($D['id'] === '0') {
+                        $profile_redirect = 1;
+                        $disp = $c;
+                    }
                 $return_array[] = ['id'=>$D['id'], 'display'=>$disp, 'status'=>$D['status'], 'redirect'=>$D['redirect']];
-             } else {
-                 if($D['device'] === '0') {
-                     $profile_redirect = 1;
-                     $disp = $c;
-                 }
+                } else {
+                    if($D['device'] === '0') {
+                        $profile_redirect = 1;
+                        $disp = $c;
+                    }
                 $return_array[] = ['device'=>$D['id'], 'display'=>$disp, 'status'=>$D['status'], 'redirect'=>$D['redirect']];
-             }
-         }
+                }
+            }
 
-  }
-  echo $this->return_json($return_array);
+    }
+    echo $this->return_json($return_array);
 }
   
 /**
@@ -393,7 +393,7 @@ 
  * @param int $prof_id profile identifier
  * @return string JSON encoded data
  */
-  public function JSON_generateInstaller($device,$prof_id) {
+    public function JSON_generateInstaller($device,$prof_id) {
     debug(4,"JSON::generateInstaller arguments: $device,$prof_id\n");
     $o = $this->generateInstaller($device,$prof_id);
     debug(4,"output from GUI::generateInstaller:");
@@ -401,7 +401,7 @@ 
     debug(4,json_encode($o));
 //    header('Content-type: application/json; utf-8');
     echo $this->return_json($o);
- }
+    }
 
 /**
  * Generate and send the installer
@@ -411,14 +411,14 @@ 
  * @return binary installerFile
  */
 
- public function downloadInstaller($device,$prof_id,$generated_for='user') {
+    public function downloadInstaller($device,$prof_id,$generated_for='user') {
     debug(4,"downloadInstaller arguments: $device,$prof_id,$generated_for\n");
     $o = $this->generateInstaller($device,$prof_id);
     debug(4,"output from GUI::generateInstaller:");
     debug(4,$o);
     if(! $o['link']) {
-       header("HTTP/1.0 404 Not Found");
-       return;
+        header("HTTP/1.0 404 Not Found");
+        return;
     }
     $profile = new Profile($prof_id);
     $profile->incrementDownloadStats($device, $generated_for);
@@ -431,242 +431,242 @@ 
     ob_clean();
     flush();
     readfile($file);
- }
+    }
 /**
- * Get and prepare logo file 
- *
- * When called for DiscoJuice, first check if file cache exists
- * If not then generate the file and save it in the cache
- * @param int $idp_id IdP identifier
- * @param int $disco flag turning on image generation for DiscoJuice
- * @param int $width, $height  maximum width and height of the generated image 
- * if one of these is 0 then it is treated as no upper bound
- *
- */
+     * Get and prepare logo file 
+     *
+     * When called for DiscoJuice, first check if file cache exists
+     * If not then generate the file and save it in the cache
+     * @param int $idp_id IdP identifier
+     * @param int $disco flag turning on image generation for DiscoJuice
+     * @param int $width, $height  maximum width and height of the generated image 
+     * if one of these is 0 then it is treated as no upper bound
+     *
+     */
+
+    public function sendLogo($idp_id, $disco=FALSE, $width=0, $height=0) {
+    $ExpStr = '';
+    $resize = 0;
+    if(($width || $height) && is_numeric($width) && is_numeric($height)) {
+        $resize = 1;
+        if($height == 0)
+            $height = 10000;
+        if($width == 0)
+            $width = 10000;
+        $logo_file = CAT::$root.'/web/downloads/logos/'.$idp_id.'_'.$width.'_'.$height.'.png';
+    } elseif($disco == 1) {
+        $width = 120;
+        $height = 40;
+        $resize = 1;
+        $logo_file = CAT::$root.'/web/downloads/logos/'.$idp_id.'_'.$width.'_'.$height.'.png';
+    }
 
- public function sendLogo($idp_id, $disco=FALSE, $width=0, $height=0) {
-   $ExpStr = '';
-   $resize = 0;
-   if(($width || $height) && is_numeric($width) && is_numeric($height)) {
-       $resize = 1;
-       if($height == 0)
-          $height = 10000;
-       if($width == 0)
-          $width = 10000;
-       $logo_file = CAT::$root.'/web/downloads/logos/'.$idp_id.'_'.$width.'_'.$height.'.png';
-   } elseif($disco == 1) {
-       $width = 120;
-       $height = 40;
-       $resize = 1;
-       $logo_file = CAT::$root.'/web/downloads/logos/'.$idp_id.'_'.$width.'_'.$height.'.png';
-   }
-
-   if($resize && is_file($logo_file)){
-      debug(4,"Using cached logo $logo_file for: $idp_id\n");
-      $blob = file_get_contents($logo_file);
-      $filetype = 'image/png';
-   }
-   else {
-      $idp = new IdP($idp_id);
-      $at = $idp->getAttributes('general:logo_file');
-      $blob =  $at[0]['value'];
-      $info = new finfo();
-      $filetype = $info->buffer($blob, FILEINFO_MIME_TYPE);
-      $offset = 60 * 60 * 24 * 30;
-      $ExpStr = "Expires: " . gmdate( "D, d M Y H:i:s", time() + $offset ) . " GMT";
-      if($resize) {
-         $filetype = 'image/png';
-         $image = new Imagick();
-         $image->readImageBlob($blob);
-         if( $image->setImageFormat('PNG')) {
-           $image->thumbnailImage($width,$height,1);
-           $blob = $image->getImageBlob();
-           debug(4,"Writing cached logo $logo_file for: $idp_id\n");
-           file_put_contents($logo_file,$blob);
-         }
-         else
-           $blob = "XXXXXX";
-      }
-   }
-   header( "Content-type: ".$filetype );
-   header( "Cache-Control:max-age=36000, must-revalidate" );
-   header( $ExpStr );
-   echo $blob;
- }
-
- public function locateUser() {
-   $host = $_SERVER['REMOTE_ADDR'];
-   $record = geoip_record_by_name($host);
-   if($record) {
-     $result = ['status' => 'ok'];
-     $result['country'] = $record['country_code'];
+    if($resize && is_file($logo_file)){
+        debug(4,"Using cached logo $logo_file for: $idp_id\n");
+        $blob = file_get_contents($logo_file);
+        $filetype = 'image/png';
+    }
+    else {
+        $idp = new IdP($idp_id);
+        $at = $idp->getAttributes('general:logo_file');
+        $blob =  $at[0]['value'];
+        $info = new finfo();
+        $filetype = $info->buffer($blob, FILEINFO_MIME_TYPE);
+        $offset = 60 * 60 * 24 * 30;
+        $ExpStr = "Expires: " . gmdate( "D, d M Y H:i:s", time() + $offset ) . " GMT";
+        if($resize) {
+            $filetype = 'image/png';
+            $image = new Imagick();
+            $image->readImageBlob($blob);
+            if( $image->setImageFormat('PNG')) {
+            $image->thumbnailImage($width,$height,1);
+            $blob = $image->getImageBlob();
+            debug(4,"Writing cached logo $logo_file for: $idp_id\n");
+            file_put_contents($logo_file,$blob);
+            }
+            else
+            $blob = "XXXXXX";
+        }
+    }
+    header( "Content-type: ".$filetype );
+    header( "Cache-Control:max-age=36000, must-revalidate" );
+    header( $ExpStr );
+    echo $blob;
+    }
+
+    public function locateUser() {
+    $host = $_SERVER['REMOTE_ADDR'];
+    $record = geoip_record_by_name($host);
+    if($record) {
+        $result = ['status' => 'ok'];
+        $result['country'] = $record['country_code'];
 //  the two lines below are a dirty hack to take of the error in naming the UK federation
-     if($result['country'] == 'GB')
-         $result['country'] = 'UK';
-     $result['region'] = $record['region'];
-     $result['geo'] = ['lat' => (float)$record['latitude'] , 'lon' => (float)$record['longitude']];
-   } else {
-     $result = ['status' => 'error', 'error' =>'Problem listing countries']; 
-   }
-   return($result);
- }
-
-
- public function locateUser2() {
-   require_once Config::$GEOIP['geoip2-path-to-autoloader'];
-   $reader = new Reader(Config::$GEOIP['geoip2-path-to-db']);
-   $host = $_SERVER['REMOTE_ADDR'];
-   try {
-      $record = $reader->city($host);
-   } catch (Exception $e) {
-      $result = ['status' => 'error', 'error' =>'Problem listing countries']; 
-      return($result);
-   }
-   $result = ['status' => 'ok'];
-   $result['country'] = $record->country->isoCode;
+        if($result['country'] == 'GB')
+            $result['country'] = 'UK';
+        $result['region'] = $record['region'];
+        $result['geo'] = ['lat' => (float)$record['latitude'] , 'lon' => (float)$record['longitude']];
+    } else {
+        $result = ['status' => 'error', 'error' =>'Problem listing countries']; 
+    }
+    return($result);
+    }
+
+
+    public function locateUser2() {
+    require_once Config::$GEOIP['geoip2-path-to-autoloader'];
+    $reader = new Reader(Config::$GEOIP['geoip2-path-to-db']);
+    $host = $_SERVER['REMOTE_ADDR'];
+    try {
+        $record = $reader->city($host);
+    } catch (Exception $e) {
+        $result = ['status' => 'error', 'error' =>'Problem listing countries']; 
+        return($result);
+    }
+    $result = ['status' => 'ok'];
+    $result['country'] = $record->country->isoCode;
 //  the two lines below are a dirty hack to take of the error in naming the UK federation
-   if($result['country'] == 'GB')
-       $result['country'] = 'UK';
-   $result['region'] = $record->continent->name;
+    if($result['country'] == 'GB')
+        $result['country'] = 'UK';
+    $result['region'] = $record->continent->name;
 
-   $result['geo'] = ['lat' => (float)$record->location->latitude , 'lon' => (float)$record->location->longitude];
-   return($result);
- }
+    $result['geo'] = ['lat' => (float)$record->location->latitude , 'lon' => (float)$record->location->longitude];
+    return($result);
+    }
 
 public function JSON_locateUser() {
     header('Content-type: application/json; utf-8');
    
     if(empty(Config::$GEOIP['version']) || Config::$GEOIP['version'] == 0)
-      echo json_encode(['status' => 'error', 'error' =>'Geolocation not supported']);
+        echo json_encode(['status' => 'error', 'error' =>'Geolocation not supported']);
     if(Config::$GEOIP['version'] == 1)
-      echo json_encode($this->locateUser());
+        echo json_encode($this->locateUser());
     if(Config::$GEOIP['version'] == 2)
-      echo json_encode($this->locateUser2());
+        echo json_encode($this->locateUser2());
 }
 
 /**
  * Produce support data prepared within {@link GUI::profileAttributes()}
  * @return string JSON encoded data
  */
-  public function JSON_profileAttributes($prof_id) {
+    public function JSON_profileAttributes($prof_id) {
 //    header('Content-type: application/json; utf-8');
     echo $this->return_json($this->profileAttributes($prof_id));
-  }
+    }
 
 /**
-  * Calculate the distence in km between two points given their
-  * geo coordinates.
-  * @param array $P1 - first point as an 'lat', 'lon' array 
-  * @param array $P2 - second point as an 'lat', 'lon' array 
-  * @return float distance in km
-  */
+ * Calculate the distence in km between two points given their
+ * geo coordinates.
+ * @param array $P1 - first point as an 'lat', 'lon' array 
+ * @param array $P2 - second point as an 'lat', 'lon' array 
+ * @return float distance in km
+ */
 private function geoDistance($P1,$P2) {
 
-  $dist = sin(deg2rad($P1['lat'])) * sin(deg2rad($P2['lat'])) +  
+    $dist = sin(deg2rad($P1['lat'])) * sin(deg2rad($P2['lat'])) +  
          cos(deg2rad($P1['lat'])) * cos(deg2rad($P2['lat'])) * cos(deg2rad($P1['lon'] - $P2['lon']));
-  $dist = rad2deg(acos($dist)) * 60 * 1.1852 ;
-  return(round($dist));
+    $dist = rad2deg(acos($dist)) * 60 * 1.1852 ;
+    return(round($dist));
 }
 
 /**
-  * Order active identity providers according to their distance and name
-  * @param array $L - current location
-  * @return array $IdPs -  list of arrays ('id', 'name');
-  */
+ * Order active identity providers according to their distance and name
+ * @param array $L - current location
+ * @return array $IdPs -  list of arrays ('id', 'name');
+ */
 
 public function orderIdentityProviders($country,$L=NULL) {
-     $idps = Federation::listAllIdentityProviders(1,$country);
-
-  if(is_null($L)) {
-     $U = $this->locateUser();
-     if($U['status'] == 'ok') {
-     $L = $U['geo'];
-     } else {
-       $L = ['lat'=>"90",'lon'=>"0"];
-     }
-  }
-  $T=[];
-  $R=[];
-     foreach ($idps as $idp) {
+        $idps = Federation::listAllIdentityProviders(1,$country);
+
+    if(is_null($L)) {
+        $U = $this->locateUser();
+        if($U['status'] == 'ok') {
+        $L = $U['geo'];
+        } else {
+        $L = ['lat'=>"90",'lon'=>"0"];
+        }
+    }
+    $T=[];
+    $R=[];
+        foreach ($idps as $idp) {
         $T[$idp['entityID']] = $idp['title'];
         $dist = 10000;
         if(isset($idp['geo'])) {
-          $G=$idp['geo'];
-          if(isset($G['lon'])) {
-             $d1 = $this->geoDistance($L,$G); 
-             if( $d1 < $dist)
+            $G=$idp['geo'];
+            if(isset($G['lon'])) {
+                $d1 = $this->geoDistance($L,$G); 
+                if( $d1 < $dist)
                 $dist = $d1;
-          } else {
+            } else {
             foreach ($G as $g) {
-             $d1 = $this->geoDistance($L,$g); 
-             if( $d1 < $dist)
+                $d1 = $this->geoDistance($L,$g); 
+                if( $d1 < $dist)
                 $dist = $d1;
             }
-          }
+            }
         }
-       if($dist > 100)
-         $dist=10000;
-      $d = sprintf("%06d",$dist);
-      $R[$idp['entityID']] = $d." ".$idp['title'];
-     }
-     asort($R);
-     foreach (array_keys($R) as $r) {
-      if($this->version == 1)
-         $outarray[] = ['id'=>$r, 'title'=>$T[$r]];
-      else
-         $outarray[] = ['idp'=>$r, 'title'=>$T[$r]];
-      }
-     return($outarray);
+        if($dist > 100)
+            $dist=10000;
+        $d = sprintf("%06d",$dist);
+        $R[$idp['entityID']] = $d." ".$idp['title'];
+        }
+        asort($R);
+        foreach (array_keys($R) as $r) {
+        if($this->version == 1)
+            $outarray[] = ['id'=>$r, 'title'=>$T[$r]];
+        else
+            $outarray[] = ['idp'=>$r, 'title'=>$T[$r]];
+        }
+        return($outarray);
 }
 
 /**
-  * Detect the best device driver form the browser
-  *
-  * Detects the operating system and returns its id 
-  * display name and group membership (as in devices.php)
-  * @return array indexed by 'id', 'display', 'group'
-  */
+ * Detect the best device driver form the browser
+ *
+ * Detects the operating system and returns its id 
+ * display name and group membership (as in devices.php)
+ * @return array indexed by 'id', 'display', 'group'
+ */
 
 public function detectOS() {
-   $Dev = Devices::listDevices();
-   if( isset($_REQUEST['device']) && isset($Dev[$_REQUEST['device']]) && (!isset($device['options']['hidden']) || $device['options']['hidden'] == 0)) {
-      $dev_id = $_REQUEST['device'];
-      $device = $Dev[$dev_id];
-      if($this->version == 1)
-         return(['id'=>$dev_id,'display'=>$device['display'], 'group'=>$device['group']]);
-      else
-         return(['device'=>$dev_id,'display'=>$device['display'], 'group'=>$device['group']]);
-   }
-   $browser = $_SERVER['HTTP_USER_AGENT'];
-   debug(4,"HTTP_USER_AGENT=$browser\n");
-   foreach ($Dev as $dev_id => $device) {
-     if(!isset($device['match']))
+    $Dev = Devices::listDevices();
+    if( isset($_REQUEST['device']) && isset($Dev[$_REQUEST['device']]) && (!isset($device['options']['hidden']) || $device['options']['hidden'] == 0)) {
+        $dev_id = $_REQUEST['device'];
+        $device = $Dev[$dev_id];
+        if($this->version == 1)
+            return(['id'=>$dev_id,'display'=>$device['display'], 'group'=>$device['group']]);
+        else
+            return(['device'=>$dev_id,'display'=>$device['display'], 'group'=>$device['group']]);
+    }
+    $browser = $_SERVER['HTTP_USER_AGENT'];
+    debug(4,"HTTP_USER_AGENT=$browser\n");
+    foreach ($Dev as $dev_id => $device) {
+        if(!isset($device['match']))
         continue;
-     if(preg_match('/'.$device['match'].'/',$browser)) {
-       if(!isset($device['options']['hidden']) || $device['options']['hidden'] == 0) {
-          debug(4,"Browser_id: $dev_id\n");
-          if($this->version == 1)
-             return(['id'=>$dev_id,'display'=>$device['display'], 'group'=>$device['group']]);
-          else
-             return(['device'=>$dev_id,'display'=>$device['display'], 'group'=>$device['group']]);
-       }
-       else {
-         debug(2, "Unrecognised system: ".$_SERVER['HTTP_USER_AGENT']."\n");
-         return(false);
-       }
-     }
-   }
-   debug(2, "Unrecognised system: ".$_SERVER['HTTP_USER_AGENT']."\n");
-   return(false);
+        if(preg_match('/'.$device['match'].'/',$browser)) {
+        if(!isset($device['options']['hidden']) || $device['options']['hidden'] == 0) {
+            debug(4,"Browser_id: $dev_id\n");
+            if($this->version == 1)
+                return(['id'=>$dev_id,'display'=>$device['display'], 'group'=>$device['group']]);
+            else
+                return(['device'=>$dev_id,'display'=>$device['display'], 'group'=>$device['group']]);
+        }
+        else {
+            debug(2, "Unrecognised system: ".$_SERVER['HTTP_USER_AGENT']."\n");
+            return(false);
+        }
+        }
+    }
+    debug(2, "Unrecognised system: ".$_SERVER['HTTP_USER_AGENT']."\n");
+    return(false);
 }
 
 public function JSON_detectOS() {
-     $return_array=$this->detectOS();
-     if($return_array)
+        $return_array=$this->detectOS();
+        if($return_array)
         $status = 1;
-     else
+        else
         $status = 0;
-     echo $this->return_json($return_array,$status);
+        echo $this->return_json($return_array,$status);
 }
 
 
@@ -676,5 +676,5 @@ 
   
 }
 function profile_sort($P1,$P2) {
-   return strcasecmp($P1->name, $P2->name);
+    return strcasecmp($P1->name, $P2->name);
 } 
\ No newline at end of file

devices/chromebook/chromebook.php

Doc Comments -3 removed lines

@@ -78,9 +78,6 @@
      * It is CRUTCIAL that the constructor sets $this->supportedEapMethods to an array of methods
      * available for the particular device.
      * {@source}
-     * @param string $device a pointer to a device module, which must
-     * be an index of one of the devices defined in the {@link Devices}
-     * array in {@link devices.php}.
      * @final not to be redefined
      */
     final public function __construct() {

devices/ms/W8.php

Doc Comments +3 added lines

@@ -308,6 +308,9 @@
 
 /**
  * produce PEAP, TLS and TTLS configuration files for Windows 8
+ * @param string $auth
+ * @param string $encryption
+ * @param integer $i
  */
   private function writeWLANprofile($wlan_profile_name,$ssid,$auth,$encryption,$eap_config,$i) {
 $profile_file_contents = '<?xml version="1.0"?>

Indentation +114 added lines, -114 removed lines

@@ -26,74 +26,74 @@ 
  */
 class Device_W8 extends WindowsCommon {
     final public function __construct() {
-      $this->supportedEapMethods = [EAP::$TLS, EAP::$PEAP_MSCHAP2, EAP::$TTLS_PAP, EAP::$TTLS_MSCHAP2, EAP::$PWD];
+        $this->supportedEapMethods = [EAP::$TLS, EAP::$PEAP_MSCHAP2, EAP::$TTLS_PAP, EAP::$TTLS_MSCHAP2, EAP::$PWD];
 #      $this->supportedEapMethods = array(EAP::$TLS, EAP::$PEAP_MSCHAP2, EAP::$TTLS_PAP, EAP::$PWD);
-      debug(4,"This device supports the following EAP methods: ");
-      debug(4,$this->supportedEapMethods);
-      $this->specialities['anon_id'][serialize(EAP::$PEAP_MSCHAP2)] = _("Anonymous identities do not use the realm as specified in the profile - it is derived from the suffix of the user's username input instead.");
+        debug(4,"This device supports the following EAP methods: ");
+        debug(4,$this->supportedEapMethods);
+        $this->specialities['anon_id'][serialize(EAP::$PEAP_MSCHAP2)] = _("Anonymous identities do not use the realm as specified in the profile - it is derived from the suffix of the user's username input instead.");
     }
 
-  public function writeInstaller() {
-      $dom = textdomain(NULL);
-      textdomain("devices");
-   // create certificate files and save their names in $CA_files arrary
-     $CA_files = $this->saveCertificateFiles('der');
+    public function writeInstaller() {
+        $dom = textdomain(NULL);
+        textdomain("devices");
+    // create certificate files and save their names in $CA_files arrary
+        $CA_files = $this->saveCertificateFiles('der');
 
-     $SSIDs = $this->attributes['internal:SSID'];
-     $delSSIDs = $this->attributes['internal:remove_SSID'];
-     $this->prepareInstallerLang();
-     $set_wired = isset($this->attributes['media:wired'][0]) && $this->attributes['media:wired'][0] == 'on' ? 1 : 0;
+        $SSIDs = $this->attributes['internal:SSID'];
+        $delSSIDs = $this->attributes['internal:remove_SSID'];
+        $this->prepareInstallerLang();
+        $set_wired = isset($this->attributes['media:wired'][0]) && $this->attributes['media:wired'][0] == 'on' ? 1 : 0;
 //   create a list of profiles to be deleted after installation
-     $delProfiles = [];
-     foreach ($delSSIDs as $ssid => $cipher) {
-         if($cipher == 'DEL')
-          $delProfiles[] = $ssid;
-         if($cipher == 'TKIP')
-          $delProfiles[] = $ssid.' (TKIP)';
-     }
-
-
-     if ($this->selected_eap == EAP::$TLS || $this->selected_eap == EAP::$PEAP_MSCHAP2 || $this->selected_eap ==  EAP::$TTLS_PAP || $this->selected_eap == EAP::$TTLS_MSCHAP2 || $this->selected_eap == EAP::$PWD) {
-       $WindowsProfile = [];
-       $eap_config = $this->prepareEapConfig($this->attributes);
-       $i = 0;
-       foreach ($SSIDs as $ssid => $cipher) {
-          if($cipher == 'TKIP') {
-             $WindowsProfile[$i] = $this->writeWLANprofile ($ssid.' (TKIP)',$ssid,'WPA','TKIP',$eap_config,$i);
-             $i++;
-          }
-          $WindowsProfile[$i] = $this->writeWLANprofile ($ssid,$ssid,'WPA2','AES',$eap_config,$i);
-          $i++;
-       }
-       if($set_wired) {
-         $this->writeLANprofile($eap_config);
-       }
-     } else {
-       error("  this EAP type is not handled yet");
-       return;
-     }
+        $delProfiles = [];
+        foreach ($delSSIDs as $ssid => $cipher) {
+            if($cipher == 'DEL')
+            $delProfiles[] = $ssid;
+            if($cipher == 'TKIP')
+            $delProfiles[] = $ssid.' (TKIP)';
+        }
+
+
+        if ($this->selected_eap == EAP::$TLS || $this->selected_eap == EAP::$PEAP_MSCHAP2 || $this->selected_eap ==  EAP::$TTLS_PAP || $this->selected_eap == EAP::$TTLS_MSCHAP2 || $this->selected_eap == EAP::$PWD) {
+        $WindowsProfile = [];
+        $eap_config = $this->prepareEapConfig($this->attributes);
+        $i = 0;
+        foreach ($SSIDs as $ssid => $cipher) {
+            if($cipher == 'TKIP') {
+                $WindowsProfile[$i] = $this->writeWLANprofile ($ssid.' (TKIP)',$ssid,'WPA','TKIP',$eap_config,$i);
+                $i++;
+            }
+            $WindowsProfile[$i] = $this->writeWLANprofile ($ssid,$ssid,'WPA2','AES',$eap_config,$i);
+            $i++;
+        }
+        if($set_wired) {
+            $this->writeLANprofile($eap_config);
+        }
+        } else {
+        error("  this EAP type is not handled yet");
+        return;
+        }
     debug(4,"WindowsProfile"); debug(4,$WindowsProfile);
     
     $this->writeProfilesNSH($WindowsProfile, $CA_files,$set_wired);
     $this->writeAdditionalDeletes($delProfiles);
     if(isset($additional_deletes) && count($additional_deletes))
-       $this->writeAdditionalDeletes($additional_deletes);
+        $this->writeAdditionalDeletes($additional_deletes);
     $this->copyFiles($this->selected_eap);
     if(isset($this->attributes['internal:logo_file']))
-       $this->combineLogo($this->attributes['internal:logo_file']);
+        $this->combineLogo($this->attributes['internal:logo_file']);
     $this->writeMainNSH($this->selected_eap,$this->attributes);
     $this->compileNSIS();
     $installer_path = $this->signInstaller($this->attributes); 
 
     textdomain($dom);
     return($installer_path);  
-  }
+    }
 
-  public function writeDeviceInfo() {
+    public function writeDeviceInfo() {
     $ssid_ct=count($this->attributes['internal:SSID']);
-   $out = "<p>";
-   $out .= sprintf(_("%s installer will be in the form of an EXE file. It will configure %s on your device, by creating wireless network profiles.<p>When you click the download button, the installer will be saved by your browser. Copy it to the machine you want to configure and execute."),Config::$CONSORTIUM['name'],Config::$CONSORTIUM['name']);
-   $out .= "<p>";
+    $out = "<p>";
+    $out .= sprintf(_("%s installer will be in the form of an EXE file. It will configure %s on your device, by creating wireless network profiles.<p>When you click the download button, the installer will be saved by your browser. Copy it to the machine you want to configure and execute."),Config::$CONSORTIUM['name'],Config::$CONSORTIUM['name']);
+    $out .= "<p>";
     if($ssid_ct > 1) {
         if($ssid_ct > 2) {
             $out .= sprintf(_("In addition to <strong>%s</strong> the installer will also configure access to the following networks:"),implode(', ',Config::$CONSORTIUM['ssid']))." ";
@@ -101,52 +101,52 @@ 
             $out .= sprintf(_("In addition to <strong>%s</strong> the installer will also configure access to:"),implode(', ',Config::$CONSORTIUM['ssid']))." ";
         $i = 0;
         foreach ($this->attributes['internal:SSID'] as $ssid=>$v) {
-           if(! in_array($ssid, Config::$CONSORTIUM['ssid'])) {
-             if($i > 0)
-           $out .= ", ";
-         $i++;
-         $out .= "<strong>$ssid</strong>";
-       }
+            if(! in_array($ssid, Config::$CONSORTIUM['ssid'])) {
+                if($i > 0)
+            $out .= ", ";
+            $i++;
+            $out .= "<strong>$ssid</strong>";
+        }
     }
     $out .= "<p>";
     }
 
 if($this->eap == EAP::$TLS)
-   $out .= _("In order to connect to the network you will need an a personal certificate in the form of a p12 file. You should obtain this certificate from your home institution. Consult the support page to find out how this certificate can be obtained. Such certificate files are password protected. You should have both the file and the password available during the installation process.");
+    $out .= _("In order to connect to the network you will need an a personal certificate in the form of a p12 file. You should obtain this certificate from your home institution. Consult the support page to find out how this certificate can be obtained. Such certificate files are password protected. You should have both the file and the password available during the installation process.");
 else {
-   $out .= _("In order to connect to the network you will need an account from your home institution. You should consult the support page to find out how this account can be obtained. It is very likely that your account is already activated.");
-   $out .= "<p>";
-   $out .= _("When you are connecting to the network for the first time, Windows will pop up a login box, where you should enter your user name and password. This information will be saved so that you will reconnect to the network automatically each time you are in the range.");
+    $out .= _("In order to connect to the network you will need an account from your home institution. You should consult the support page to find out how this account can be obtained. It is very likely that your account is already activated.");
+    $out .= "<p>";
+    $out .= _("When you are connecting to the network for the first time, Windows will pop up a login box, where you should enter your user name and password. This information will be saved so that you will reconnect to the network automatically each time you are in the range.");
         if($ssid_ct > 1) {
-             $out .= "<p>";
-             $out .= _("You will be required to enter the same credentials for each of the configured notworks:")." ";
-             $i = 0;
+                $out .= "<p>";
+                $out .= _("You will be required to enter the same credentials for each of the configured notworks:")." ";
+                $i = 0;
             foreach ($this->attributes['internal:SSID'] as $ssid=>$v) {
-                 if($i > 0)
-                   $out .= ", ";
-                 $i++;
-                 $out .= "<strong>$ssid</strong>";
+                    if($i > 0)
+                    $out .= ", ";
+                    $i++;
+                    $out .= "<strong>$ssid</strong>";
             }
     }
 
 
 }
     return $out;
-  }
+    }
 
 
 private function prepareEapConfig($attr) {
-   $eap = $this->selected_eap;
-   $w8_ext = '';
-   $use_anon = $attr['internal:use_anon_outer'] [0];
-   if ($use_anon) {
-     $outer_user = $attr['internal:anon_local_value'][0];
-     $outer_id = $outer_user.'@'.$attr['internal:realm'][0];
-   }
+    $eap = $this->selected_eap;
+    $w8_ext = '';
+    $use_anon = $attr['internal:use_anon_outer'] [0];
+    if ($use_anon) {
+        $outer_user = $attr['internal:anon_local_value'][0];
+        $outer_id = $outer_user.'@'.$attr['internal:realm'][0];
+    }
 //   $servers = preg_quote(implode(';',$attr['eap:server_name']));
-   $servers = implode(';',$attr['eap:server_name']);
+    $servers = implode(';',$attr['eap:server_name']);
    
-   $ca_array = $attr['internal:CAs'][0];
+    $ca_array = $attr['internal:CAs'][0];
 
 
 $profile_file_contents = '<EAPConfig><EapHostConfig xmlns="http://www.microsoft.com/provisioning/EapHostConfig">
@@ -162,7 +162,7 @@ 
 $profile_file_contents .= '<AuthorId xmlns="http://www.microsoft.com/provisioning/EapCommon">0</AuthorId>
 </EapMethod>
 ';
-  $profile_file_contents .= '
+    $profile_file_contents .= '
 
 <Config xmlns:baseEap="http://www.microsoft.com/provisioning/BaseEapConnectionPropertiesV1" 
   xmlns:eapTls="http://www.microsoft.com/provisioning/EapTlsConnectionPropertiesV1">
@@ -178,14 +178,14 @@ 
 if($ca_array) {
 foreach ($ca_array as $CA)
     if($CA['root'])
-       $profile_file_contents .= "<eapTls:TrustedRootCA>".$CA['sha1']."</eapTls:TrustedRootCA>\n";
+        $profile_file_contents .= "<eapTls:TrustedRootCA>".$CA['sha1']."</eapTls:TrustedRootCA>\n";
 }
 $profile_file_contents .= '</eapTls:ServerValidation>
 ';
 if(isset($attr['eap-specific:tls_use_other_id']) && $attr['eap-specific:tls_use_other_id'][0] == 'on')
-   $profile_file_contents .= '<eapTls:DifferentUsername>true</eapTls:DifferentUsername>';
+    $profile_file_contents .= '<eapTls:DifferentUsername>true</eapTls:DifferentUsername>';
 else
-   $profile_file_contents .= '<eapTls:DifferentUsername>false</eapTls:DifferentUsername>';
+    $profile_file_contents .= '<eapTls:DifferentUsername>false</eapTls:DifferentUsername>';
 $profile_file_contents .= '
 </eapTls:EapType>
 </baseEap:Eap>
@@ -193,9 +193,9 @@ 
 ';
 } elseif ( $eap == EAP::$PEAP_MSCHAP2) {
 if(isset($attr['eap:enable_nea']) && $attr['eap:enable_nea'][0] == 'on')
-   $nea = 'true';
+    $nea = 'true';
 else
-   $nea = 'false';
+    $nea = 'false';
 $profile_file_contents .= '<AuthorId xmlns="http://www.microsoft.com/provisioning/EapCommon">0</AuthorId>
 </EapMethod>
 ';
@@ -260,10 +260,10 @@ 
 <Phase2Authentication>
 ';
 if ( $eap == EAP::$TTLS_PAP) {
-   $w8_ext .='<PAPAuthentication /> ';
+    $w8_ext .='<PAPAuthentication /> ';
 }
 if ( $eap == EAP::$TTLS_MSCHAP2)  {
-   $w8_ext .='<MSCHAPv2Authentication>
+    $w8_ext .='<MSCHAPv2Authentication>
 <UseWinlogonCredentials>false</UseWinlogonCredentials>
 </MSCHAPv2Authentication>
 ';
@@ -272,16 +272,16 @@ 
 <Phase1Identity>
 ';
 if($use_anon == 1) {
-  $w8_ext .= '<IdentityPrivacy>true</IdentityPrivacy> 
+    $w8_ext .= '<IdentityPrivacy>true</IdentityPrivacy> 
 ';
-  if(isset($outer_id) && $outer_id) 
+    if(isset($outer_id) && $outer_id) 
     $w8_ext .='<AnonymousIdentity>'.$outer_id.'</AnonymousIdentity>
 ';
-  else
+    else
     $w8_ext .='<AnonymousIdentity/>
 ';
 } else {
-  $w8_ext .= '<IdentityPrivacy>false</IdentityPrivacy>
+    $w8_ext .= '<IdentityPrivacy>false</IdentityPrivacy>
 ';
 }
 $w8_ext .='</Phase1Identity>
@@ -292,7 +292,7 @@ 
 $profile_file_contents .= '<AuthorId xmlns="http://www.microsoft.com/provisioning/EapCommon">0</AuthorId>
 </EapMethod>
 ';
-   $profile_file_contents .= '<ConfigBlob></ConfigBlob>';
+    $profile_file_contents .= '<ConfigBlob></ConfigBlob>';
 }
 
 $profile_file_contents_end = '</EapHostConfig></EAPConfig>';
@@ -309,7 +309,7 @@ 
 /**
  * produce PEAP, TLS and TTLS configuration files for Windows 8
  */
-  private function writeWLANprofile($wlan_profile_name,$ssid,$auth,$encryption,$eap_config,$i) {
+    private function writeWLANprofile($wlan_profile_name,$ssid,$auth,$encryption,$eap_config,$i) {
 $profile_file_contents = '<?xml version="1.0"?>
 <WLANProfile xmlns="http://www.microsoft.com/networking/WLAN/profile/v1">
 <name>'.$wlan_profile_name.'</name>
@@ -349,7 +349,7 @@ 
 ';
 
 if(! is_dir('w8'))
-  mkdir('w8');
+    mkdir('w8');
 $xml_f_name = "w8/wlan_prof-$i.xml";
 $xml_f = fopen($xml_f_name,'w');
 fwrite($xml_f,$profile_file_contents. $eap_config['w8']. $closing) ;
@@ -376,7 +376,7 @@ 
 ';
 
 if(! is_dir('w8'))
-  mkdir('w8');
+    mkdir('w8');
 $xml_f_name = "w8/lan_prof.xml";
 $xml_f = fopen($xml_f_name,'w');
 fwrite($xml_f,$profile_file_contents. $eap_config['w8']. $closing) ;
@@ -435,7 +435,7 @@ 
 ';
 
 if(isset($this->attributes['media:wired'][0]) && $attr['media:wired'][0] == 'on')
-  $fcontents .= '!define WIRED
+    $fcontents .= '!define WIRED
 ';
 
 $f = fopen('main.nsh','w');
@@ -448,7 +448,7 @@ 
 debug(4,"writeProfilesNSH");
 debug(4,$P);
 $fcontents = '';
-  foreach($P as $p) 
+    foreach($P as $p) 
     $fcontents .= "!insertmacro define_wlan_profile $p\n";
 
 $f = fopen('profiles.nsh','w');
@@ -459,8 +459,8 @@ 
 $f = fopen('certs.nsh','w');
 if($ca_array) {
 foreach ($ca_array as $CA) {
-      $store = $CA['root'] ? "root" : "ca";
-      $fcontents .= '!insertmacro install_ca_cert "'.$CA['file'].'" "'.$CA['sha1'].'" "'.$store."\"\n";
+        $store = $CA['root'] ? "root" : "ca";
+        $fcontents .= '!insertmacro install_ca_cert "'.$CA['file'].'" "'.$CA['sha1'].'" "'.$store."\"\n";
     }
 fwrite($f, $fcontents);
 }
@@ -471,26 +471,26 @@ 
 
 private function copyFiles ($eap) {
 debug(4,"copyFiles start\n");
-   $result;
-   $result = $this->copyFile('wlan_test.exe');
-   $result = $this->copyFile('check_wired.cmd');
-   $result = $this->copyFile('install_wired.cmd');
-   $result = $this->copyFile('setEAPCred.exe');
-   $result = $this->copyFile('cat_bg.bmp');
-   $result = $this->copyFile('base64.nsh');
-   $result = $result && $this->copyFile('cat32.ico');
-   $result = $result && $this->copyFile('cat_150.bmp');
-   $this->translateFile('common.inc','common.nsh',$this->code_page);
-   if($eap["OUTER"] == PWD) {
-     $this->translateFile('pwd.inc','cat.NSI',$this->code_page);
-     $result = $result && $this->copyFile('Aruba_Networks_EAP-pwd_x32.msi');
-     $result = $result && $this->copyFile('Aruba_Networks_EAP-pwd_x64.msi');
-   } else {
-   $this->translateFile('eap_w8.inc','cat.NSI',$this->code_page);
-   $result = 1;
-   }
+    $result;
+    $result = $this->copyFile('wlan_test.exe');
+    $result = $this->copyFile('check_wired.cmd');
+    $result = $this->copyFile('install_wired.cmd');
+    $result = $this->copyFile('setEAPCred.exe');
+    $result = $this->copyFile('cat_bg.bmp');
+    $result = $this->copyFile('base64.nsh');
+    $result = $result && $this->copyFile('cat32.ico');
+    $result = $result && $this->copyFile('cat_150.bmp');
+    $this->translateFile('common.inc','common.nsh',$this->code_page);
+    if($eap["OUTER"] == PWD) {
+        $this->translateFile('pwd.inc','cat.NSI',$this->code_page);
+        $result = $result && $this->copyFile('Aruba_Networks_EAP-pwd_x32.msi');
+        $result = $result && $this->copyFile('Aruba_Networks_EAP-pwd_x64.msi');
+    } else {
+    $this->translateFile('eap_w8.inc','cat.NSI',$this->code_page);
+    $result = 1;
+    }
 debug(4,"copyFiles end\n");
-   return($result);
+    return($result);
 }
 
 }
\ No newline at end of file