[fix] code documentation, comments and cosmetic changes

bureau/class/class_system_bind.php

@@ -17,11 +17,20 @@ class system_bind {
   var $cache_domain_summary = array();
   var $zone_file_directory = '/var/lib/alternc/bind/zones/';
 
+  /**
+   * 
+   */
   function system_bind() {
     // Constructeur
   }
 
-  // Return the part of the conf we got from the database
+  /**
+   * Return the part of the conf we got from the database
+   * 
+   * @global m_mysql $db
+   * @param string $domain
+   * @return array $this->cache_conf_db
+   */
   function conf_from_db($domain=false) {
     global $db;
     // Use cache, fill cache if empty
@@ -53,11 +62,21 @@ class system_bind {
     return $this->cache_conf_db;
   }
 
-  // Return full path of the zone configuration file
+  /**
+   * Return full path of the zone configuration file
+   * 
+   * @param string $domain
+   * @return string
+   */
   function get_zone_file_uri($domain) {
     return $this->zone_file_directory.$domain;
   }
 
+  /**
+   * 
+   * @param string $domain
+   * @return string zone file path
+   */
   function get_zone_file($domain) {
     // Use cache, fill cache if empty
     if (!isset($this->cache_zone_file[$domain]) ) {
@@ -70,6 +89,11 @@ class system_bind {
     return $this->cache_zone_file[$domain] ;
   }
 
+  /**
+   * 
+   * @param string $domain
+   * @return string 
+   */
   function get_serial($domain) {
     // Return the next serial the domain must have.
     // Choose between a generated and an incremented.
@@ -89,7 +113,12 @@ class system_bind {
     return max(array($calc,$old)) + 1 ;
   }
 
-  // Return lines that are after ;;;END ALTERNC AUTOGENERATE CONFIGURATION
+  /**
+   * Return lines that are after ;;;END ALTERNC AUTOGENERATE CONFIGURATION
+   * 
+   * @param string $domain
+   * @return string
+   */
   function get_persistent($domain) {
     if ( ! isset($this->cache_get_persistent[$domain] )) {
       preg_match_all('/\;\s*END\sALTERNC\sAUTOGENERATE\sCONFIGURATION(.*)/s', $this->get_zone_file($domain), $output_array);
@@ -102,10 +131,21 @@ class system_bind {
     return $this->cache_get_persistent[$domain];
   }
   
+  /**
+   * 
+   * @param string $domain
+   * @return string 
+   */
   function get_zone_header($domain) {
     return file_get_contents($this->ZONE_TEMPLATE);
   }
   
+  /**
+   * 
+   * @global m_dom $dom
+   * @param string $domain
+   * @return string
+   */
   function get_domain_summary($domain=false) {
     global $dom;
 
@@ -118,6 +158,11 @@ class system_bind {
     else return $this->cache_domain_summary;
   }
 
+  /**
+   * 
+   * @param string $domain
+   * @return boolean
+   */
   function dkim_delete($domain) {
     $target_dir = "/etc/opendkim/keys/$domain";
     if (file_exists($target_dir)) {
@@ -128,7 +173,12 @@ class system_bind {
     return true;
   }
 
-  // Generate the domain DKIM key
+  /**
+   * Generate the domain DKIM key
+   * 
+   * @param string $domain
+   * @return boolean
+   */
   function dkim_generate_key($domain) {
     // Stop here if we do not manage the mail
     if ( !  $this->get_domain_summary($domain)['gesmx'] ) return;
@@ -152,8 +202,11 @@ class system_bind {
     return true; // FIXME handle error
   }
 
-  // Refresh DKIM configuration: be sure to list the domain having a private key (and only them)
+  /**
-  function dkim_refresh_list() { // so ugly... but there is only 1 pass, not 3. Still ugly.
+   * Refresh DKIM configuration: be sure to list the domain having a private key (and only them)
+   */
+  function dkim_refresh_list() { 
+    // so ugly... but there is only 1 pass, not 3. Still ugly.
     $trusted_host_new = "# WARNING: this file is auto generated by AlternC.\n# Add your changes after the last line\n";
     $keytable_new     = "# WARNING: this file is auto generated by AlternC.\n# Add your changes after the last line\n";
     $signingtable_new = "# WARNING: this file is auto generated by AlternC.\n# Add your changes after the last line\n";
@@ -206,7 +259,11 @@ class system_bind {
     }
 
   }
-
+  /**
+   * 
+   * @param string $domain
+   * @return string
+   */
   function dkim_entry($domain) {
     $keyfile="/etc/opendkim/keys/$domain/alternc.txt";
     if (! file_exists($keyfile) &&  $this->get_domain_summary($domain)['gesmx'] ) {
@@ -215,8 +272,13 @@ class system_bind {
     return @file_get_contents($keyfile);
   }
 
-  // Conditionnal generation autoconfig entry for outlook / thunderbird
+  /**
-  // If entry with the same name allready exist, skip it.
+   * Conditionnal generation autoconfig entry for outlook / thunderbird
+   * If entry with the same name allready exist, skip it.
+   * 
+   * @param string $domain
+   * @return string
+   */
   function mail_autoconfig_entry($domain) {
     $zone= implode("\n",$this->conf_from_db($domain))."\n".$this->get_persistent($domain);
 
@@ -236,7 +298,20 @@ class system_bind {
     return $entry;
   }
   
-  // Return a fully generated zone 
+  
+  /**
+   * 
+   * Return a fully generated zone
+   * 
+   * @global string $L_FQDN
+   * @global string $L_NS1_HOSTNAME
+   * @global string $L_NS2_HOSTNAME
+   * @global string $L_DEFAULT_MX
+   * @global string $L_DEFAULT_SECONDARY_MX
+   * @global string $L_PUBLIC_IP
+   * @param string $domain
+   * @return string
+   */
   function get_zone($domain) {
     global $L_FQDN, $L_NS1_HOSTNAME, $L_NS2_HOSTNAME, $L_DEFAULT_MX, $L_DEFAULT_SECONDARY_MX, $L_PUBLIC_IP;
 
@@ -271,6 +346,10 @@ class system_bind {
     return $zone;
   }
 
+  /**
+   * 
+   * @param string $domain
+   */
   function reload_zone($domain) {
     exec($this->RNDC." reload ".escapeshellarg($domain), $output, $return_value);
     if ($return_value != 0 ) {
@@ -278,7 +357,12 @@ class system_bind {
     }
   }
 
-  // return true if zone is locked
+  /**
+   * return true if zone is locked
+   * 
+   * @param string $domain
+   * @return boolean
+   */
   function is_locked($domain) {
     preg_match_all("/(\;\s*LOCKED:YES)/i", $this->get_zone_file($domain), $output_array);
     if (isset($output_array[1][0]) && !empty($output_array[1][0])) {
@@ -287,6 +371,13 @@ class system_bind {
     return false;
   }  
 
+  /**
+   * 
+   * @global m_mysql $db
+   * @global m_dom $dom
+   * @param string $domain
+   * @return boolean
+   */
   function save_zone($domain) {
     global $db, $dom;
 
@@ -307,16 +398,26 @@ class system_bind {
     return true; // fixme add tests
   }
 
-  // Delete the zone configuration file
+  /**
+   * Delete the zone configuration file
+   * 
+   * @param string $domain
+   * @return boolean
+   */
   function delete_zone($domain) {
     $file=$this->get_zone_file_uri($domain);
     if (file_exists($file)) {
       unlink($file);
     }
     $this->dkim_delete($domain);
-    return;
+    return true;
   }
 
+  /**
+   * 
+   * @global m_hooks $hooks
+   * @return boolean
+   */
   function reload_named() {
     global $hooks;
     // Generate the new conf file
@@ -342,7 +443,13 @@ class system_bind {
     return true;
   }
 
-  // Regenerate bind configuration and load it
+  /**
+   * Regenerate bind configuration and load it
+   * 
+   * @global m_hooks $hooks
+   * @param boolean $all
+   * @return boolean
+   */
   function regenerate_conf($all=false) {
     global $hooks;
 
@@ -365,10 +472,12 @@ class system_bind {
 
     $this->dkim_refresh_list();
     $this->reload_named();
-
+    return true;
-    return;
   }
 
+  /**
+   * 
+   */
   private function dummy_for_translation() {
     _("The zone file of this domain is locked. Contact your administrator.");
   }

bureau/class/config.php

@@ -40,8 +40,8 @@ session_name('AlternC_Panel');
 session_start();
 
 /*
-  Si vous voulez mettre le bureau en maintenance, décommentez le code ci-dessous
+  Si vous voulez mettre le bureau en maintenance, d<EFBFBD>commentez le code ci-dessous
-  et mettez votre ip dans le IF pour que seule votre ip puisse accéder au bureau : 
+  et mettez votre ip dans le IF pour que seule votre ip puisse acc<EFBFBD>der au bureau : 
 */
 
 /* * /
@@ -52,8 +52,8 @@ Merci de revenir plus tard.";
 }
 /* */
 
-/* Toutes les pages du bureau passent ici. On utilise une sémaphore pour 
+/* Toutes les pages du bureau passent ici. On utilise une s<EFBFBD>maphore pour 
-   s'assurer que personne ne pourra accéder à 2 pages du bureau en même temps.
+   s'assurer que personne ne pourra acc<EFBFBD>der <EFBFBD> 2 pages du bureau en m<EFBFBD>me temps.
 */
 /* * /
 // 1. Get a semaphore id for the alternc magic number (18577)
@@ -100,6 +100,7 @@ require_once(dirname(__FILE__)."/local.php");
 
 // Define constants from vars of /etc/alternc/local.sh
 // The you can't choose where is the AlternC Panel 
+define("DEFAULT_PASS_SIZE", 8);
 define('ALTERNC_MAIL',     "$L_ALTERNC_MAIL");
 define('ALTERNC_HTML',     "$L_ALTERNC_HTML");
 if(isset($L_ALTERNC_LOGS_ARCHIVE))
@@ -121,13 +122,13 @@ $root=ALTERNC_PANEL."/";
 require_once($root."/class/db_mysql.php");
 require_once($root."/class/functions.php");
 
-// Redirection si appel à https://(!fqdn)/
+// Redirection si appel <EFBFBD> https://(!fqdn)/
 if (isset($_SERVER["HTTPS"]) && $_SERVER["HTTPS"]=="on" && $host!=$L_FQDN) {
   header("Location: https://$L_FQDN/");
 }
 
 
-// Classe héritée de la classe db de la phplib.
+// Classe h<EFBFBD>rit<EFBFBD>e de la classe db de la phplib.
 /**
 * Class for MySQL management in the bureau 
 *

bureau/class/functions.php

@@ -27,19 +27,43 @@
 list($usec, $sec) = explode(' ', microtime());
 mt_srand((float) $sec + ((float) $usec * 100000));
 
-/* Format a field value for input or textarea : */
+/**
+ * Format a field value for input or textarea : 
+ * 
+ * @param string $str
+ * @return string
+ */
 function fl($str) { return str_replace("<","&lt;",str_replace("\"","&quot;",$str)); }
 
+/**
+ * 
+ * @global array $variables
+ * @param string $name
+ * @param mixed $default
+ * @param string $createit_comment
+ * @param struing $type
+ * @return mixed
+ */
 function variable_get($name, $default = null, $createit_comment = null, $type=null) {
   global $variables;
   return $variables->variable_get($name, $default, $createit_comment, $type);
 }
 
-/*
+
- Check if a domain can be hosted on this server :
+
- Return a negative value in case of an error,
+/**
- or a string for the index in $tld
+ *  Check if a domain can be hosted on this server :
-*/
+ * Return a negative value in case of an error,
+ * or a string for the index in $tld
+ * 
+ * @global string $L_NS1
+ * @global string $L_NS2
+ * @global m_mysql $db
+ * @global m_dom $dom
+ * @param string $domain
+ * @param array $dns
+ * @return int
+ */
 function checkhostallow($domain,$dns) {
   global $L_NS1,$L_NS2,$db,$dom;
   $sizefound=0;
@@ -76,9 +100,13 @@ function checkhostallow($domain,$dns) {
   return -3;	// DNS incorrect in the whois
 }
 
-/* Check that a domain can be hosted in that server, 
+/**
-without DNS managment. 
+ * Check that a domain can be hosted in that server, 
-*/
+ *   without DNS managment. 
+ * @global m_mysql $db
+ * @param type $domain
+ * @return int
+ */
 function checkhostallow_nodns($domain) {
   global $db;
   $sizefound=0;
@@ -103,13 +131,21 @@ function checkhostallow_nodns($domain) {
   return 0;
 }
 
+/**
+ * @return string
+ */
 function get_remote_ip() {
   // Return the remote IP.
   // If you are behind a proxy, use X_FORWARDED_FOR instead of REMOTE_ADDR
   return getenv('REMOTE_ADDR');
 }
 
-/* Check that $url is a correct url (http:// or https:// or ftp://)  */
+/**
+ * Check that $url is a correct url (http:// or https:// or ftp://) 
+ * 
+ * @param type $url
+ * @return boolean
+ */
 function checkurl($url) {
   // TODO : add a path/file check
   if (substr($url,0,7)!="http://" && substr($url,0,8)!="https://" && substr($url,0,6)!="ftp://") return false;
@@ -123,44 +159,73 @@ function checkurl($url) {
   return true;
 }
 
-/* Check that TXT domain is correct */
+/**
+ * Check that TXT domain is correct 
+ * 
+ * @param string $txt
+ * @return boolean
+ */
 function checksubtxt($txt) {
 	return true;
 }
-/* Check that CNAME domain is correct */
+/**
+ * Check that CNAME domain is correct 
+ * @param string $cname
+ * @return boolean
+ */
 function checkcname($cname) {
 	return true;
 }
 
-/* Check that $ip is a correct 4 Dotted ip */
+/**
+ * Check that $ip is a correct 4 Dotted ip
+ * @param string $ip
+ * @return type
+ */
 function checkip($ip) {
   // return true or false whether the ip is correctly formatted
   return filter_var($ip,FILTER_VALIDATE_IP, FILTER_FLAG_IPV4);
 }
 
-/* Check that $ip is a correct ipv6 ip */
+/**
+ * Check that $ip is a correct ipv6 ip 
+ * @param string $ip
+ * @return type
+ */
 function checkipv6($ip) {
   // return true or false whether the ip is correctly formatted
   return filter_var($ip,FILTER_VALIDATE_IP, FILTER_FLAG_IPV6);
 }
 
-/* Check a login mail, cf http://www.bortzmeyer.org/arreter-d-interdire-des-adresses-legales.html */
+/**
-/* FIXME: check who is using that function and delete it when unused */
+ * Check a login mail, cf http://www.bortzmeyer.org/arreter-d-interdire-des-adresses-legales.html 
+ * @todo Check who is using that function and delete it when unused 
+ * @param string $mail
+ * @return boolean
+ */
 function checkloginmail($mail) {
   return true;
 }
 
-/* Check an email address, use filter_var with emails, which works great ;)  */
+/**
-/* FIXME: check who is using that function and delete it when unused */
+ * Check an email address, use filter_var with emails, which works great ;) 
+ * @todo  check who is using that function and delete it when unused 
+ * @param string $mail
+ * @return boolean
+ */
 function checkmail($mail) {
   if (filter_var($mail,FILTER_VALIDATE_EMAIL)) {
-    return 0;
+    return FALSE;
   } else {
-    return 1;
+    return TRUE;
   }
 }
 
-/* Check that a domain name is fqdn compliant */
+/**
+ * Check that a domain name is fqdn compliant 
+ * @param string $fqdn
+ * @return int
+ */
 function checkfqdn($fqdn) {
   // (RFC 1035 http://www.ietf.org/rfc/rfc1035.txt)
   // Retourne 0 si tout va bien, sinon, retourne un code erreur...
@@ -186,12 +251,16 @@ function checkfqdn($fqdn) {
   return $ret;
 }
 
-function checkuserpath($path) {
+/**
-  /*
+ * 
-    return 0 if the path is not in the user's space
+ * @global m_mem $mem
-    return 1 if this is a directory
+ * @param string $path
-    return 2 if this is a regular file
+ * @return int 
+ * return 0 if the path is not in the user's space
+ * return 1 if this is a directory
+ * return 2 if this is a regular file
  */
+function checkuserpath($path) {
   global $mem;
   $user=$mem->user["login"];
   $usar=substr($user,0,1);
@@ -217,9 +286,10 @@ function checkuserpath($path) {
 /**
  * get the home of the user
  *
+ * @global m_mem $mem
  * @args string $user the username, if null will use the global $mem. no
  * security checks performed on path
- * @returns string the actual absolute path
+ * @return string the actual absolute path
  */
 function getuserpath($user = null) {
   if (is_null($user)) {
@@ -229,48 +299,93 @@ function getuserpath($user = null) {
   return rtrim(ALTERNC_HTML,"/")."/".substr($user,0,1)."/".$user;
 }
 
-/* ECHOes checked="checked" only if the parameter is true
+/**
+* ECHOes checked="checked" only if the parameter is true
  * useful for checkboxes and radio buttons
+ * 
+ * @param boolean $test
+ * @param boolean $echo
  */
-function cbox($test) {
+function cbox($test, $echo = TRUE) {
-  if ($test) echo (" checked=\"checked\"");
+  if ($test) {
-}
+      $return = " checked=\"checked\"";
-
-
-/* ECHOes selected="selected" only if the parameter is true
- * useful for checkboxes and radio buttons
- */
-function selected($bool) {
-  if ($bool) {
-    echo " selected=\"selected\"";
   }
+  if( $echo ){
+      echo $return;
+  }
+  return $return;
 }
 
-function ecif($test,$tr,$fa="",$affiche=1) {
-  if ($test)
-    $retour = $tr;
-  else
-    $retour = $fa;
 
-  if ($affiche) 
+/**
+ * ECHOes selected="selected" only if the parameter is true
+ * useful for checkboxes and radio buttons
+ * 
+ * @param boolean $bool
+ * @param boolean $echo
+ * @return string
+ */
+function selected($bool, $echo = TRUE) {
+  if ($bool) {
+      $return = " selected=\"selected\"";
+  }
+  if( $echo ){
+      echo $return;
+  }
+  return $return;
+}
+
+/**
+ * 
+ * @param boolean $test
+ * @param string $tr
+ * @param string $fa
+ * @param boolean $affiche
+ * @return string
+ */
+function ecif($test,$tr,$fa="",$affiche=1) {
+    if ($test){
+        $retour = $tr;
+    }
+    else{
+        $retour = $fa;
+    }
+    if ($affiche) {
       echo $retour;
-  else
+    }
     return $retour;
 }
 
+/**
+ * 
+ * @param string $str
+ */
 function __($str) {
   echo _($str);
 }
 
+/**
+ * 
+ * @param boolean $test
+ * @param string $tr
+ * @param string $fa
+ * @return string
+ */
 function ife($test,$tr,$fa="") {
-  if ($test)
+    if ($test){
         return $tr;
-  else
+    } 
     return $fa;
 }
 
+/**
+ * 
+ * @param int|string $size
+ * @param string $html
+ * @return string
+ */
 function format_size($size,$html=0) {
-  // Retourne une taille formattée en Octets, Kilo-octets, Méga-octets ou Giga-Octets, avec 2 décimales.
+  // Retourne une taille formatt<EFBFBD>e en Octets, Kilo-octets, M<>ga-octets ou Giga-Octets, avec 2 d<>cimales.
   if ("-" == $size) {
     return $size;
   }
@@ -307,13 +422,27 @@ function format_size($size,$html=0) {
   }
 }
 
+/**
+ * 
+ * @param int $hid
+ * @return string
+ */
 function getlinkhelp($hid) {
   return "(<a href=\"javascript:help($hid);\">?</a>)";
 }
+/**
+ * 
+ * @param int $hid
+ */
 function linkhelp($hid) {
   echo getlinkhelp($hid);
 }
-
+/**
+ * 
+ * @param string $format
+ * @param string $date
+ * @return string
+ */
 function format_date($format,$date) {
   $d=substr($date,8,2);
   $m=substr($date,5,2);
@@ -330,7 +459,11 @@ function format_date($format,$date) {
   return sprintf($format,$d,$m,$y,$h,$i,$hh,$am);
 }
 
-/* Strip slashes if needed : */
+/**
+ * Strip slashes if needed : 
+ * @param string $str
+ * @return string
+ */
 function ssla($str) {
   if (get_magic_quotes_gpc()) {
     return stripslashes($str);
@@ -340,9 +473,9 @@ function ssla($str) {
 }
 
   /* ----------------------------------------------------------------- */
-  /** Hashe un mot de passe en clair en MD5 avec un salt aléatoire
+  /** Hashe un mot de passe en clair en MD5 avec un salt al<EFBFBD>atoire
-   * @param string $pass Mot de passe à crypter (max 32 caractères)
+   * @param string $pass Mot de passe <EFBFBD> crypter (max 32 caract<EFBFBD>res)
-   * @return string Retourne le mot de passe crypté
+   * @return string Retourne le mot de passe crypt<EFBFBD>
    * @access private
    */
   function _md5cr($pass,$salt="") {
@@ -368,9 +501,9 @@ function split_mysql_database_name($dbname) {
 
 
 /* ----------------------------------------------------------------- */
-/** Echappe les caractères pouvant perturber un flux XML standard : 
+/** Echappe les caract<EFBFBD>res pouvant perturber un flux XML standard : 
- * @param string $string Chaine de caractère à encoder en valeur xml.
+ * @param string $string Chaine de caract<EFBFBD>re <EFBFBD> encoder en valeur xml.
- * @return string Retourne la chaîne modifiée si besoin.
+ * @return string Retourne la cha<EFBFBD>ne modifi<EFBFBD>e si besoin.
  * @access private
  */
 function xml_entities($string) {
@@ -380,7 +513,7 @@ function xml_entities($string) {
 /* ----------------------------------------------------------------- */
 /** Converti un nombre de mois en une chaine plus lisible
  * @param  number $months Nombre de mois
- * @return string Chaîne représentant le nombre de mois
+ * @return string Cha<EFBFBD>ne repr<EFBFBD>sentant le nombre de mois
  * @access private
  */
 function pretty_months($months) {
@@ -393,9 +526,9 @@ function pretty_months($months) {
 }
 
 /* ----------------------------------------------------------------- */
-/** Fabrique un drop-down pour les durées de comptes
+/** Fabrique un drop-down pour les dur<EFBFBD>es de comptes
  * @name string $name Nom pour le composasnt
- * @selected number Option selectionée du composant
+ * @selected number Option selection<EFBFBD>e du composant
  * @return string Code html pour le drop-down
  * @access private
  */
@@ -422,10 +555,15 @@ function duration_list($name, $selected=0) {
   return $res;
 }
 
-/* select_values($arr,$cur) echo des <option> du tableau $values ou de la table sql $values
+/**
-   selectionne $current par defaut. 
+ * select_values($arr,$cur) echo des <option> du tableau $values ou de la table sql $values
-   Si on lui demande poliement, il prend un tableau a une dimension
+ *  selectionne $current par defaut. 
-*/
+ *  Si on lui demande poliement, il prend un tableau a une dimension
+ * 
+ * @param array $values
+ * @param string $cur
+ * @param boolean $onedim
+ */
 function eoption($values,$cur,$onedim=false) {
   if (is_array($values)) {
     foreach ($values as $k=>$v) {
@@ -438,24 +576,35 @@ function eoption($values,$cur,$onedim=false) {
 }
 
 
+/**
 /* Echo the HTMLSpecialChars version of a value. 
  * Must be called when pre-filling fields values in forms such as : 
  * <input type="text" name="toto" value="<?php ehe($toto); ?>" />
  * Use the charset of the current language for transcription
+ * 
+ * @global string $charset
+ * @param string $str
+ * @param boolean $affiche
+ * @return string
  */
-function ehe($str,$affiche=1) {
+function ehe($str,$affiche = TRUE) {
     global $charset;
     $retour = htmlspecialchars($str,ENT_QUOTES,$charset); 
     if ($affiche) {
       echo $retour;
-  } else {
-    return $retour;
     } 
+    return $retour;
 }
 
 /* Get the Fields of the posted form from $_REQUEST or POST or GET
  * and check their type
  */
+/**
+ * 
+ * @param array $fields
+ * @param boolean $requestOnly
+ * @return array
+ */
 function getFields($fields, $requestOnly = false) {
   $vars = array();
   $methodType = array ("get", "post", "request", "files", "server");
@@ -500,11 +649,21 @@ function getFields($fields, $requestOnly = false) {
   return $vars;
 }
 
+/**
+ * 
+ * @param array $array
+ */
 function printVar($array) {
   echo "<pre style=\"border: 1px solid black; text-align: left; font-size: 9px\">\n";
   print_r($array);
   echo "</pre>\n";
 }
+/**
+ * 
+ * @param array $a
+ * @param array $b
+ * @return int
+ */
 function list_properties_order($a, $b) {
   if ( $a['label'] == $b['label']) {
     return 0;
@@ -513,16 +672,29 @@ function list_properties_order($a, $b) {
 } // end private function list_properties_order
 
 
-/** Show a pager as 
+
-  Previous page 0 1 2 ... 16 17 18 19 20 ... 35 36 37 Next page
+/**
-  Arguments are as follow : 
+ * Shows a pager : Previous page 0 1 2 ... 16 17 18 19 20 ... 35 36 37 Next page
-  $offset = the current offset from 0 
+ * 
-  $count = The number of elements shown per page 
+ * 
-  $total = The total number of elements 
+ * Arguments are as follow : 
-  $url = The url to show for each page. %%offset%% will be replace by the proper offset
+ * $offset = the current offset from 0 
-  $before & $after are HTML code to show before and after the pager **only if the pager is to be shown**
+ * $count = The number of elements shown per page 
+ * $total = The total number of elements 
+ * $url = The url to show for each page. %%offset%% will be replace by the proper offset
+ * $before & $after are HTML code to show before and after the pager **only if the pager is to be shown
+ * 
+ * @param int $offset
+ * @param int $count
+ * @param int $total
+ * @param string $url
+ * @param string $before
+ * @param string $after
+ * @param boolean $echo
+ * @return string
  */
-function pager($offset,$count,$total,$url,$before="",$after="") {
+function pager($offset,$count,$total,$url,$before="",$after="",$echo = TRUE) {
+    $return = "";
   $offset=intval($offset); 
   $count=intval($count); 
   $total=intval($total); 
@@ -534,73 +706,83 @@ function pager($offset,$count,$total,$url,$before="",$after="") {
   if ($total<=$count) { // When there is less element than 1 complete page, just don't do anything :-D
     return true;
   }
-  echo $before;
+  $return .= $before;
   // Shall-we show previous page link ?
   if ($offset) {
-    $o=max($offset-$count,0);
+    $o = max($offset-$count,0);
-    echo "<a href=\"".str_replace("%%offset%%",$o,$url)."\" alt=\"(Ctl/Alt-p)\" title=\"(Alt-p)\" accesskey=\"p\">"._("Previous Page")."</a> ";
+    $return .= "<a href=\"".str_replace("%%offset%%",$o,$url)."\" alt=\"(Ctl/Alt-p)\" title=\"(Alt-p)\" accesskey=\"p\">"._("Previous Page")."</a> ";
   } else {
-    echo _("Previous Page")." ";
+    $return .= _("Previous Page")." ";
   }
 
   if ($total>(2*$count)) { // On n'affiche le pager central (0 1 2 ...) s'il y a au moins 2 pages.
-    echo " - ";
+    $return .= " - ";
     if (($total<($count*10)) && ($total>$count)) {  // moins de 10 pages : 
       for($i=0;$i<$total/$count;$i++) {
 	$o=$i*$count;
 	if ($offset==$o) {
-	  echo $i." "; 
+	  $return .= $i." "; 
 	} else {
-	  echo "<a href=\"".str_replace("%%offset%%",$o,$url)."\">$i</a> ";
+	  $return .= "<a href=\"".str_replace("%%offset%%",$o,$url)."\">$i</a> ";
 	}
       }
-    } else { // Plus de 10 pages, on affiche 0 1 2 , 2 avant et 2 après la page courante, et les 3 dernieres
+    } else { // Plus de 10 pages, on affiche 0 1 2 , 2 avant et 2 apr<EFBFBD>s la page courante, et les 3 dernieres
       for($i=0;$i<=2;$i++) {
 	$o=$i*$count;
 	if ($offset==$o) {
-	  echo $i." "; 
+	  $return .= $i." "; 
 	} else {
-	  echo "<a href=\"".str_replace("%%offset%%",$o,$url)."\">$i</a> ";
+	  $return .= "<a href=\"".str_replace("%%offset%%",$o,$url)."\">$i</a> ";
 	}
       }
       if ($offset>=$count && $offset<($total-2*$count)) { // On est entre les milieux ...
-	// On affiche 2 avant jusque 2 après l'offset courant mais sans déborder sur les indices affichés autour
+	// On affiche 2 avant jusque 2 apr<EFBFBD>s l'offset courant mais sans d<>border sur les indices affich<63>s autour
 	$start=max(3,intval($offset/$count)-2);
 	$end=min(intval($offset/$count)+3,intval($total/$count)-3);
-	if ($start!=3) echo " ... ";
+	if ($start!=3) $return .= " ... ";
 	for($i=$start;$i<$end;$i++) {
 	  $o=$i*$count;
 	  if ($offset==$o) {
-	    echo $i." "; 
+	    $return .= $i." "; 
 	  } else {
-	    echo "<a href=\"".str_replace("%%offset%%",$o,$url)."\">$i</a> ";
+	    $return .= "<a href=\"".str_replace("%%offset%%",$o,$url)."\">$i</a> ";
 	  }
 	}
-	if ($end!=intval($total/$count)-3) echo " ... ";
+	if ($end!=intval($total/$count)-3) $return .= " ... ";
       } else {
-	echo " ... ";
+	$return .= " ... ";
       }
       for($i=intval($total/$count)-3;$i<$total/$count;$i++) {
 	$o=$i*$count;
 	if ($offset==$o) {
-	  echo $i." "; 
+	  $return .= $i." "; 
 	} else {
-	  echo "<a href=\"".str_replace("%%offset%%",$o,$url)."\">$i</a> ";
+	  $return .= "<a href=\"".str_replace("%%offset%%",$o,$url)."\">$i</a> ";
 	}
       }
-    echo " - ";
+    $return .= " - ";
     } // More than 10 pages?
   }
   // Shall-we show the next page link ?
   if ($offset+$count<$total) {
     $o=$offset+$count;
-    echo "<a href=\"".str_replace("%%offset%%",$o,$url)."\" alt=\"(Ctl/Alt-s)\" title=\"(Alt-s)\" accesskey=\"s\">"._("Next Page")."</a> ";
+    $return .= "<a href=\"".str_replace("%%offset%%",$o,$url)."\" alt=\"(Ctl/Alt-s)\" title=\"(Alt-s)\" accesskey=\"s\">"._("Next Page")."</a> ";
   } else {
-    echo _("Next Page")." ";
+    $return .= _("Next Page")." ";
   }
-  echo $after;
+  $return .= $after;
+  if( $echo ){
+      echo $return;
+  }
+  return $return;
+  
 }
 
+/**
+ * 
+ * @param int $length
+ * @return string
+ */
 function create_pass($length = 8){
   $chars = "1234567890abcdefghijkmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
   $i = 0;
@@ -612,9 +794,16 @@ function create_pass($length = 8){
   return $password;
 }
 
-define("DEFAULT_PASS_SIZE", 8);
 
-/* Affiche un bouton qui permet de generer automatiquement des mots de passes */
+
+/**
+ *  Affiche un bouton qui permet de generer automatiquement des mots de passes 
+ * 
+ * @param int $pass_size
+ * @param string $fields_to_fill1
+ * @param string $fields_to_fill2
+ * @return int
+ */
 function display_div_generate_password($pass_size=DEFAULT_PASS_SIZE, $fields_to_fill1="", $fields_to_fill2="") {
   $id=rand(1,1000);
   echo "<div id='z$id' style='display:none;'><a href=\"javascript:generate_password_html('$id',$pass_size,'$fields_to_fill1','$fields_to_fill2');\">";
@@ -624,7 +813,14 @@ function display_div_generate_password($pass_size=DEFAULT_PASS_SIZE, $fields_to_
   return 0;
 }
 
-/* Affiche un bouton pour selectionner un dossier sur le serveur */
+/**
+ * Affiche un bouton pour selectionner un dossier sur le serveur 
+ * 
+ * @param string    $dir
+ * @param string    $caller
+ * @param int       $width
+ * @param int       $height
+ */
 function display_browser($dir="", $caller="main.dir", $width=350, $height=450) {
   // Browser id
   $bid="b".rand(1,1000);
@@ -663,7 +859,14 @@ function display_browser($dir="", $caller="main.dir", $width=350, $height=450) {
   
 }
 
-// Insere un $wrap_string tous les $max caracteres dans $message
+/**
+ * Insere un $wrap_string tous les $max caracteres dans $message
+ * 
+ * @param string    $message
+ * @param int       $max
+ * @param string    $wrap_string
+ * @return string   
+ */
 function auto_wrap($message="",$max=10,$wrap_string="<wbr/>") {
   $cpt = 0;
   $mot = split(" ",$message);
@@ -677,19 +880,23 @@ function auto_wrap($message="",$max=10,$wrap_string="<wbr/>") {
   return $message;
 }
 
-/*
+/**
-**  Converts HSV to RGB values
+ *  Converts HSV to RGB values
-** -----------------------------------------------------
+ * -----------------------------------------------------
-**  Reference: http://en.wikipedia.org/wiki/HSL_and_HSV
+ *  Reference: http://en.wikipedia.org/wiki/HSL_and_HSV
-**  Purpose:   Useful for generating colours with
+ *  Purpose:   Useful for generating colours with
-**             same hue-value for web designs.
+ *             same hue-value for web designs.
-**  Input:     Hue        (H) Integer 0-360
+ *  Input:     Hue        (H) Integer 0-360
-**             Saturation (S) Integer 0-100
+ *             Saturation (S) Integer 0-100
-**             Lightness  (V) Integer 0-100
+ *             Lightness  (V) Integer 0-100
-**  Output:    String "R,G,B"
+ *  Output:    String "R,G,B"
-**             Suitable for CSS function RGB().
+ *             Suitable for CSS function RGB().
-*/
+ *  
-
+ * @param int   $iH
+ * @param int   $iS
+ * @param int   $iV
+ * @return array
+ */
 function fHSVtoRGB($iH, $iS, $iV) {
 
   if($iH < 0)   $iH = 0;   // Hue:
@@ -732,12 +939,22 @@ function fHSVtoRGB($iH, $iS, $iV) {
   return array('r'=>round($dR), 'g'=>round($dG), 'b'=>round($dB) );
 }
 
+/**
+ * 
+ * @param int   $hex
+ * @return int  
+ */
 function hexa($hex)
 {
   $num = dechex($hex);
   return (strlen("$num") >= 2) ? "$num" : "0$num";
 }
 
+/**
+ * 
+ * @param int   $p
+ * @return string
+ */
 function PercentToColor($p=0) {
   if ($p>100) $p=100;
   if ($p<0) $p=0;
@@ -750,18 +967,36 @@ function PercentToColor($p=0) {
   return $color;
 }
 
+/**
+ * 
+ * @global m_err    $err
+ * @global m_mem    $mem
+ * @global int          $cuid
+ * @return boolean
+ */
 function panel_lock() {
   global $err,$mem,$cuid;
   if ($cuid!=2000) return false;
   return touch(ALTERNC_LOCK_PANEL);
 }
 
+/**
+ * 
+ * @global m_err    $err
+ * @global m_mem    $mem
+ * @global int          $cuid
+ * @return boolean
+ */
 function panel_unlock() {
   global $err,$mem,$cuid;
   if ($cuid!=2000) return false;
   return unlink(ALTERNC_LOCK_PANEL);
 }
 
+/**
+ * 
+ * @return boolean
+ */
 function panel_islocked() {
   return file_exists(ALTERNC_LOCK_PANEL);
 }

bureau/class/m_admin.php

@@ -380,7 +380,7 @@ class m_admin {
       $err->raise("admin",_("Subject, message and sender are mandatory"));
       return false;
     }
-
+    //@todo remove cf functions.php
     if (checkmail($from) != 0) {
       $err->raise("admin",_("Sender is syntaxically incorrect"));
       return false;
@@ -512,6 +512,7 @@ class m_admin {
 	$err->raise("admin",_("All fields are mandatory"));
 	      return false;
       }
+        //@todo remove cf functions.php
       if (checkmail($mail)!=0){
 	$err->raise("admin",_("Please enter a valid email address"));
 	      return false;

bureau/class/m_cron.php

@@ -129,6 +129,8 @@ class m_cron {
     $user=urlencode($user);
     if (empty($user)) $password='';
     $password=urlencode($password);
+    
+    //@todo remove checkmail cf functions.php
     if (!empty($email) && ! checkmail($email) == 0 ){ 
         $err->raise("cron",_("Email address is not valid"));
       return false;

bureau/class/m_hta.php

@@ -178,7 +178,7 @@ class m_hta {
     if (!$file) {
       return false;
     }
-    // TODO: Tester la validité du .htpasswd
+    // TODO: Tester la validit<EFBFBD> du .htpasswd
     while (!feof($file)) {
       $s=fgets($file,1024);
       $t=explode(":",$s);
@@ -242,6 +242,7 @@ class m_hta {
       $err->raise("hta",printf(("The folder '%s' does not exist"),$dir));
       return false;
     }
+    // @todo delete cf!. functions.php checkloginemail definition
     if (checkloginmail($user)){
       // Check this password against the password policy using common API : 
       if (is_callable(array($admin,"checkPolicy"))) {