Functions
	fl ($str)
	Format a field value for input or textarea : More...

	checkhostallow ($domain, $dns)
	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. More...

	checkhostallow_nodns ($domain)
	Check that a domain can be hosted in that server, without DNS managment. More...

	get_remote_ip ()
	Return the remote IP. More...

	checkurl ($url)
	Check that $url is a correct url (http:// or https:// or ftp://) More...

	checksubtxt ($txt)
	Check that TXT domain is correct. More...

	checkcname ($cname)
	Check that CNAME domain is correct. More...

	checkip ($ip)
	Check that $ip is a correct 4 Dotted ip. More...

	checkipv6 ($ip)
	Check that $ip is a correct ipv6 ip. More...

	checkloginmail ($mail)
	Check a login mail, cf http://www.bortzmeyer.org/arreter-d-interdire-des-adresses-legales.html. More...

	checkmail ($mail)
	Check an email address, use filter_var with emails, which works great ;) More...

	checkfqdn ($fqdn)
	Check that a domain name is fqdn compliant. More...

	checkuserpath ($path)

	getuserpath ($user=null)
	get the home of the user More...

	cbox ($test, $echo=true)
	ECHOes checked="checked" only if the parameter is true useful for checkboxes and radio buttons. More...

	selected ($bool, $echo=TRUE)
	ECHOes selected="selected" only if the parameter is true useful for checkboxes and radio buttons. More...

	ecif ($test, $tr, $fa="", $affiche=1)

	__ ($str)

	ife ($test, $tr, $fa="")

	format_size ($size, $html=0)

	getlinkhelp ($hid)

	linkhelp ($hid)

	format_date ($format, $date)

	ssla ($str)
	Strip slashes if needed : More...

	_md5cr ($pass, $salt="")
	Hashe a password using proper crypto function. More...

	split_mysql_database_name ($dbname)
	split mysql database name between username and custom database name More...

	xml_entities ($string)
	Echappe les caract�res pouvant perturber un flux XML standard : More...

	pretty_months ($months)
	Converti un nombre de mois en une chaine plus lisible. More...

string $name Nom pour le composasnt
Fabrique un drop-down pour les dur�es de comptes @selected number Option selection�e du composant Returns string Code html pour le drop-down @access private
	duration_list ($name, $selected=0)

	eoption ($values, $cur, $onedim=false)
	select_values($arr,$cur) echo des <option> du tableau $values ou de la table sql $values selectionne $current par defaut. More...

	ehe ($str, $display=TRUE)
	Echo the HTMLSpecialChars version of a value. More...

	eue ($str, $display=TRUE)
	Echo the URLENCODED version of a value. More...

	getFields ($fields, $requestOnly=false)
	Get the Fields of the posted form from $_REQUEST or POST or GET and check their type. More...

	printVar ($array)

	list_properties_order ($a, $b)

	pager ($offset, $count, $total, $url, $before="", $after="", $echo=true)
	Shows a pager : Previous page 0 1 2 ... More...

	create_pass ($length=10, $classcount=3)
	Create a password compatible with the password policy. More...

	display_div_generate_password ($pass_size=DEFAULT_PASS_SIZE, $fields_to_fill1="", $fields_to_fill2="", $classcount=3)
	Show a button to set a random password for a password field. More...

	display_browser ($dir="", $caller="main.dir", $width=350, $height=450)
	Show a button to select a folder on the server. More...

	fHSVtoRGB ($iH, $iS, $iV)

	hexa ($hex)

	PercentToColor ($p=0)

	panel_lock ()

	panel_unlock ()

	panel_islocked ()

	csrf_get ($return=false)
	Give a new CSRF uniq token for a form the session must be up since the CSRF is linked to the session cookie. More...

	csrf_check ($token=null)
	Check a CSRF token against the current session a token can be only checked once, it's disabled then. More...

	_sha512cr ($password, $salt=NULL)
	Create a SHA512-CRYPT hash of a string. More...

	_dovecot_hash ($password)
	Create a password hash for use with dovecot. More...

	add_line_to_file ($file, $line)
	Add the line of text $line into file $file. More...

	del_line_from_file ($file, $line)
	Remove the line of text $line from file $file. More...

Function Documentation

◆ __()

__ ( $str )

Parameters

string $str

Definition at line 404 of file functions.php.

                   {
     echo _($str);
 }

Referenced by display_div_generate_password(), and sub_domains_edit().

◆ _dovecot_hash()

_dovecot_hash ( $password )

Create a password hash for use with dovecot.

Definition at line 1239 of file functions.php.

                                   {
     // In any case the final password saved for dovecot can store the
     // scheme to override the default on a per-account basis.
     // Ideally this is updated to bcrypt or argon2 when those become
     // available in dovecot.
     // @see https://wiki.dovecot.org/Authentication/PasswordSchemes
     $hash = _sha512cr($password);
     return '{SHA512-CRYPT}' . $hash;
 }

References $password, and _sha512cr().

Referenced by m_mail\set_passwd().

◆ _md5cr()

_md5cr	(	$pass,
		$salt = `""`
	)

Hashe a password using proper crypto function.

Parameters

string $pass a cleartext password to hash

Returns: string the hash @access private

Definition at line 533 of file functions.php.

                                    {
     if (!$salt) {
         $chars = "./0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
         for ($i = 0; $i < 12; $i++) {
             $salt.=substr($chars, (mt_rand(0, strlen($chars))), 1);
         }
         $salt = "$1$" . $salt;
     }
     return crypt($pass, $salt);
 }

References $i.

Referenced by m_hta\add_user(), and m_hta\change_pass().

◆ _sha512cr()

_sha512cr	(	$password,
		$salt = `NULL`
	)

Create a SHA512-CRYPT hash of a string.

Definition at line 1213 of file functions.php.

                                             {
     if (!$salt) {
         // Aim to have a 16 character salt for SHA-512 crypt.
         // @see https://secure.php.net/manual/en/function.crypt.php
         if (function_exists('random_bytes')) {
             // PHP >= 7.0
             $salt = base64_encode(random_bytes(12));
         }
         else if (function_exists('mcrypt_create_iv')) {
             $salt = base64_encode(mcrypt_create_iv(12, MCRYPT_DEV_URANDOM));
         }
         else if (function_exists('openssl_random_pseudo_bytes')) {
             $salt  = base64_encode(openssl_random_pseudo_bytes(12));
         }
         if (!$salt) {
             throw Exception('Unable to generate salt');
         }
     }
     $salt = '$6$rounds=20000$' . $salt;
     $hash = crypt($password, $salt);
     return $hash;
 }

References $password.

Referenced by _dovecot_hash(), m_ftp\add_ftp(), and m_ftp\put_ftp_details().

◆ add_line_to_file()

add_line_to_file	(	$file,
		$line
	)

Add the line of text $line into file $file.

do not duplicate (check)

Parameters

$file	string the full path to the file where we should add the line
$line	string the line to add (without the termination , WILL BE ADDED)

Returns: boolean TRUE if the line has been added, or FALSE if the line ALREADY EXISTED

Definition at line 1258 of file functions.php.

                                        {
     $f=fopen($file,"rb");
     $found=false;
     while($s=fgets($f,1024)) {
         if (trim($s)==$line) {
             $found=true;
             return false;
         }
     }
     fclose($f);
     $f=fopen($file,"ab");
     fputs($f,trim($line)."\n");
     fclose($f);
     return true;
 }

References $f, and $found.

Referenced by m_mail\dkim_add(), and m_bind\hook_updatedomains_dns_add().

◆ cbox()

cbox	(	$test,
		$echo = `true`
	)

ECHOes checked="checked" only if the parameter is true useful for checkboxes and radio buttons.

Parameters

boolean	$test
boolean	$echo

Definition at line 345 of file functions.php.

                                    {
     if ($test) {
         $return = " checked=\"checked\"";
     } else {
         $return = '';
     }
     if ($echo) {
         echo $return;
     }
     return $return;
 }

Referenced by sub_domains_edit().

◆ checkcname()

checkcname ( $cname )

Check that CNAME domain is correct.

Parameters

string $cname

Returns: boolean

Definition at line 184 of file functions.php.

                             {
     if (($check = checkfqdn(rtrim($cname, ".")))) {
         if ($check != 4) { // ALLOW non-fully qualified (no .)
             return false; // bad FQDN
         }
     }
     if (substr($cname, -1) != ".") {
         // Not fully qualified : 
         if (strpos($cname, ".") === false) {
             // NO DOT in the middle, no DOT elsewhere => seems fine
             return true;
         } else {
             // NO DOT at the end, but A DOT ELSEWHERE => seems broken (please use fully qualified)
             return false;
         }
     }
     // fully qualified => fine
     return true;
 }

References checkfqdn().

Referenced by m_dom\check_type_value().

◆ checkfqdn()

checkfqdn ( $fqdn )

Check that a domain name is fqdn compliant.

Parameters

string $fqdn

Returns: int

Definition at line 258 of file functions.php.

                           {
     // (RFC 1035 http://www.ietf.org/rfc/rfc1035.txt)
     // Retourne 0 si tout va bien, sinon, retourne un code erreur...
     // 1. Nom de domaine complet trop long.
     // 2. L'un des membres est trop long.
     // 3. Caractere interdit dans l'un des membres.
     // 4. Le fqdn ne fait qu'un seul membre (il n'est donc pas fq...)
     if (strlen($fqdn) > 255) {
         return 1;
     }
     $members = explode(".", $fqdn);
     if (count($members) > 1) {
         $ret = 0;
     } else {
         $ret = 4;
     }
     reset($members);
     while (list ($key, $val) = each($members)) {
         if (strlen($val) > 63) {
             return 2;
         }
         // Note: a.foo.net is a valid domain
         // Note: RFC1035 tells us that a domain should not start by a digit, but every registrar allows such a domain to be created ... too bad.
         if (!preg_match("#^[a-z0-9_]([a-z0-9-]*[a-z0-9])?$#i", $val)) {
             return 3;
         }
     }
     return $ret;
 }

References $key, and $val.

Referenced by m_dom\add_domain(), checkcname(), checkurl(), m_dom\edit_domain(), m_dom\get_domain_all(), m_ssl\new_csr(), and m_dom\set_sub_domain().

◆ checkhostallow()

checkhostallow	(	$domain,
		$dns
	)

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.

Parameters

	global	string $L_NS1
	global	string $L_NS2
	global	m_mysql $db
	global	m_dom $dom
string	$domain
array	$dns

Returns: int

Definition at line 49 of file functions.php.

                                        {
     global $L_NS1, $L_NS2, $db, $dom;
     $sizefound = 0;
     $found = "";
     $db->query("SELECT tld,mode FROM tld;");
     while ($db->next_record()) {
         list($key, $val) = $db->Record;
         if (substr($domain, -1 - strlen($key)) == "." . $key) {
             if ($sizefound < strlen($key)) {
                 $sizefound = strlen($key);
                 $found = $key;
                 $fmode = $val;
             }
         }
     }
     if ($dom->tld_no_check_at_all) {
         return 0; // OK , the boss say that you can.
     }
     if (!$found || $fmode == 0) {   // TLD not allowed at all
         return -1;
     }
     if (($fmode != 4) && (!is_array($dns))) { // NO dns found in the whois, and domain MUST exists
         return -2;
     }
     if ($fmode > 2) { // OK, in the case 3 4 5
         return $found;
     }
     $n1 = false;
     $n2 = false;
     for ($i = 0; $i < count($dns); $i++) {
         if (strtolower($dns[$i]) == strtolower($L_NS1)) {
             $n1 = true;
         }
         if (strtolower($dns[$i]) == strtolower($L_NS2)) {
             $n2 = true;
         }
     }
     if ($fmode == 1 && $n1) {
         return $found;
     }
     if ($fmode == 2 && $n1 && $n2) {
         return $found;
     }
     return -3; // DNS incorrect in the whois
 }

References $db, $dom, $domain, $found, $i, $key, and $val.

Referenced by m_dom\add_domain(), and m_dom\edit_domain().

◆ checkhostallow_nodns()

checkhostallow_nodns ( $domain )

Check that a domain can be hosted in that server, without DNS managment.

Parameters

	global	m_mysql $db
string	$domain

Returns: int

Definition at line 103 of file functions.php.

                                        {
     global $db;
     $sizefound = 0;
     $found = "";
     $db->query("SELECT tld,mode FROM tld;");
     while ($db->next_record()) {
         list($key, $val) = $db->Record;
         if (substr($domain, -1 - strlen($key)) == "." . $key) {
             if ($sizefound < strlen($key)) {
                 $sizefound = strlen($key);
                 $found = $key;
                 $fmode = $val;
             }
         }
     }
     // If we found a correct tld, let's find how many . before ;)
     if (!$found || $fmode == 0) {                      // TLD not allowed at all
         return 1;
     }
     if (count(explode(".", substr($domain, 0, -$sizefound))) > 2) {
         return 1;
     }
     return 0;
 }

References $db, $domain, $found, $key, and $val.

Referenced by m_dom\add_domain().

◆ checkip()

checkip ( $ip )

Check that $ip is a correct 4 Dotted ip.

Parameters

string $ip

Returns: type

Definition at line 210 of file functions.php.

                       {
     // return true or false whether the ip is correctly formatted
     return filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4);
 }

Referenced by m_dom\add_slave_ip(), m_dom\check_type_value(), m_dom\del_slave_ip(), m_authip\ip_save(), and m_authip\list_ip().

◆ checkipv6()

checkipv6 ( $ip )

Check that $ip is a correct ipv6 ip.

Parameters

string $ip

Returns: type

Definition at line 221 of file functions.php.

                         {
     // return true or false whether the ip is correctly formatted
     return filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6);
 }

Referenced by m_dom\check_type_value(), m_authip\ip_save(), and m_authip\list_ip().

◆ checkloginmail()

checkloginmail ( $mail )

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

Parameters

string $mail

Returns: boolean

Definition at line 233 of file functions.php.

                                {
     return true;
 }

Referenced by m_hta\add_user().

◆ checkmail()

checkmail ( $mail )

Check an email address, use filter_var with emails, which works great ;)

Todo:: check who is using that function and delete it when unused

Parameters

string $mail

Returns: boolean

Definition at line 244 of file functions.php.

                           {
     if (filter_var($mail, FILTER_VALIDATE_EMAIL)) {
         return FALSE;
     } else {
         return TRUE;
     }
 }

Referenced by m_cron\_update_one(), m_admin\add_mem(), and m_admin\mailallmembers().

◆ checksubtxt()

checksubtxt ( $txt )

Check that TXT domain is correct.

Parameters

string $txt

Returns: boolean

Definition at line 174 of file functions.php.

                            {
     return true;
 }

◆ checkurl()

checkurl ( $url )

Check that $url is a correct url (http:// or https:// or ftp://)

1 *

Parameters

type $url

Returns: boolean

Definition at line 145 of file functions.php.

                         {
     // TODO : add a path/file check
     if (substr($url, 0, 7) != "http://" && substr($url, 0, 8) != "https://" && substr($url, 0, 6) != "ftp://") {
         return false;
     }
     if (substr($url, 0, 7) == "http://") {
         $fq = substr($url, 7);
     }
     if (substr($url, 0, 8) == "https://") {
         $fq = substr($url, 8);
     }
     if (substr($url, 0, 6) == "ftp://") {
         $fq = substr($url, 6);
     }
     $f = explode("/", $fq);
     if (!is_array($f)) {
         $f = array($f);
     }
     $t = checkfqdn($f[0]);
     return !$t;
 }

References $f, $t, and checkfqdn().

◆ checkuserpath()

checkuserpath ( $path )

Parameters

	global	m_mem $mem
string	$path

Returns: 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

Definition at line 297 of file functions.php.

                               {
     global $mem;
     $user = $mem->user["login"];
     $usar = substr($user, 0, 1);
     if (substr($path, 0, 1) != "/") {
         $path = "/" . $path;
     }
     $rpath = realpath(ALTERNC_HTML . "/$usar/$user$path");
     if (!$rpath) { // if file or directory does not exist
         return 1; // FIXME is it safe to say OK in this case ?
     }
     $userpath = getuserpath();
     if (strpos($rpath, $userpath) === 0) {
         if (is_dir(ALTERNC_HTML . "/$usar/$user$path")) {
             return 1;
         }
         if (is_file(ALTERNC_HTML . "/$usar/$user$path")) {
             return 2;
         }
     }
     return 0;
 }

References $mem, $user, ALTERNC_HTML, and getuserpath().

Referenced by m_dom\check_type_value().

◆ create_pass()

create_pass	(	$length = `10`,
		$classcount = `3`
	)

Create a password compatible with the password policy.

Parameters

int	$length
int	$classcount

Returns: string a random password

Definition at line 879 of file functions.php.

                                                     {
     $sets = array();
  
     // Use up to 4 character classes, 3 by default.
     if ($classcount < 4)
         $available_sets='lud';
     else
         $available_sets='luds';
  
     if(strpos($available_sets, 'l') !== false)
         $sets[] = 'abcdefghijklmnopqrstuvwxyz';
     if(strpos($available_sets, 'u') !== false)
         $sets[] = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
     if(strpos($available_sets, 'd') !== false)
         $sets[] = '0123456789';
     if(strpos($available_sets, 's') !== false)
         $sets[] = '(!#$%)*+,-./:;<=>?@[\]^_';
  
     $all = '';
     $password = '';
     foreach($sets as $set) {
         $password .= $set[array_rand(str_split($set))];
         $all .= $set;
     }
     
     $all = str_split($all);
     for($i = 0; $i < $length - count($sets); $i++)
         $password .= $all[array_rand($all)];
     
     $password = str_shuffle($password);
     
     return $password;
 }

References $i, and $password.

Referenced by m_mysql\add_db(), m_mysql\alternc_add_member(), and m_piwik\user_add().

◆ csrf_check()

csrf_check ( $token = null )

Check a CSRF token against the current session a token can be only checked once, it's disabled then.

Parameters

$token string the token to check in the DB + session

Returns: $result integer 0 for invalid token, 1 for good token, -1 for expired token (already used) if a token is invalid or expired, an $msg is raised, that can be displayed

Definition at line 1182 of file functions.php.

                                  {
     global $db,$msg;
  
     if (is_null($token)) $token=$_POST["csrf"];
  
     if (!isset($_SESSION["csrf"])) {
         $msg->raise("ERROR", "functions", _("The posted form token is incorrect. Maybe you need to allow cookies"));
         return 0; // no csrf cookie :/
     }
     if (strlen($token)!=32 || strlen($_SESSION["csrf"])!=32) {
         unset($_SESSION["csrf"]);
         $msg->raise("ERROR", "functions", _("Your cookie or token is invalid"));
         return 0; // invalid csrf cookie 
     }
     $db->query("SELECT used FROM csrf WHERE cookie=? AND token=?;",array($_SESSION["csrf"],$token));
     if (!$db->next_record()) {
         $msg->raise("ERROR", "functions", _("You can't post twice the same form, please retry."));
         return 0; // invalid csrf cookie 
     }
     if ($db->f("used")) {
         $msg->raise("ERROR", "functions", _("You can't post twice the same form, please retry."));
         return -1; // expired
     }
     $db->query("UPDATE csrf SET used=1 WHERE cookie=? AND token=?;",array($_SESSION["csrf"],$token)); 
     $db->exec("DELETE FROM csrf WHERE created<DATE_SUB(NOW(), INTERVAL 1 DAY);");
     return 1;
 }

References $db, and $msg.

◆ csrf_get()

csrf_get ( $return = false )

Give a new CSRF uniq token for a form the session must be up since the CSRF is linked to the session cookie.

We also need the $db pdo object

Returns: the csrf cookie to add into a csrf hidden field in your form

Definition at line 1159 of file functions.php.

                                  {
     global $db;
     static $token="";
     if (!isset($_SESSION["csrf"])) {
         $_SESSION["csrf"]=md5(mt_rand().mt_rand().mt_rand());
     }
     if ($token=="") {
         $token=md5(mt_rand().mt_rand().mt_rand());
         $db->query("INSERT INTO csrf SET cookie=?, token=?, created=NOW(), used=0;",array($_SESSION["csrf"],$token));
     }
     if ($return) 
         return $token;
     echo '<input type="hidden" name="csrf" value="'.$token.'" />';
     return true;        
 }

References $db.

Referenced by sub_domains_edit().

◆ del_line_from_file()

del_line_from_file	(	$file,
		$line
	)

Remove the line of text $line from file $file.

Parameters

$file	string the full path to the file where we should remove the line
$line	string the line to add (without the termination , WILL BE REMOVED)

Returns: boolean TRUE if the line has been found and removed, or FALSE if the line DIDN'T EXIST

Definition at line 1282 of file functions.php.

                                          {
     $f=fopen($file,"rb");
     $g=fopen($file.".new","wb");
     $found=false;
     while($s=fgets($f,1024)) {
         if (trim($s)!=$line) {
             fputs($g,$s);
         } else {
             $found=true;
         }
     }
     fclose($f);
     fclose($g);
     rename($file.".new",$file); // overwrite atomically
     return $found;
 }

References $f, and $found.

Referenced by m_mail\dkim_del(), and m_bind\hook_updatedomains_dns_del().

◆ display_browser()

display_browser	(	$dir = `""`,
		$caller = `"main.dir"`,
		$width = `350`,
		$height = `450`
	)

Show a button to select a folder on the server.

Parameters

string	$dir
string	$caller
int	$width
int	$height

Definition at line 941 of file functions.php.

                                                                                        {
     // Browser id
     static $id=0;
     $id++;
     $bid = "b" . $id;
     echo "<script type=\"text/javascript\">
         <!--
           $(function() {
               $( \"#" . $bid . "\" ).dialog({
               autoOpen: false,
               width: " . $width . ",
               height: " . $height . ",
               modal: true,
               open: function()
                 {
                     $('.ui-widget-overlay').css('opacity', .70);
                     $('.ui-dialog-content').css('background-color', '#F0F0FA');
                 },
             });
          
             $( \"#bt" . $bid . "\" )
               .button()
               .attr(\"class\", \"ina\")
               .click(function() {
                 $( \"#" . $bid . "\" ).dialog( \"open\" );
                 return false;
               });
           });
           
           
           document.write('&nbsp;<input type=\"button\" id=\"bt" . $bid . "\" value=\"" . _("Choose a folder...") . "\" class=\"ina\">');
           document.write('<div id=\"" . $bid . "\" title=\"" . _("Choose a folder...") . "\" style=\"display: none; bgcolor:red;\">');
           document.write('  <iframe src=\"/browseforfolder2.php?caller=" . $caller . "&amp;file=" . ehe($dir, false) . "&amp;bid=" . $bid . "\" width=\"" . ($width - 40) . "\" height=\"" . ($height - 64) . "\" frameborder=\"no\" id=\"browseiframe\"></iframe>');
           document.write('</div>');
         //  -->
         </script>
         ";
 }

References $id, and ehe().

Referenced by sub_domains_edit().

◆ display_div_generate_password()

display_div_generate_password	(	$pass_size = `DEFAULT_PASS_SIZE`,
		$fields_to_fill1 = `""`,
		$fields_to_fill2 = `""`,
		$classcount = `3`
	)

Show a button to set a random password for a password field.

Parameters

int	$pass_size	size of the password
string	$fields_to_fill1	html field where we will put the password
string	$fields_to_fill2	a second (password confirmation) field where we will put the password

Returns: int

Definition at line 922 of file functions.php.

                                                                                                                                       {
     static $id=1;
     echo "<div id='z$id' style='display:none;'><a href=\"javascript:generate_password_html('$id',$pass_size,'$fields_to_fill1','$fields_to_fill2',$classcount);\">";
     __("Click here to generate a password");
     echo "</a></div>";
     echo "<script type='text/javascript'>$('#z$id').show();</script>";
     $id++;
     return 0;
 }

References $id, and __().

◆ duration_list()

duration_list	(	$name,
		$selected = `0`
	)

Definition at line 586 of file functions.php.

                                              {
     $res = "<select name=\"$name\" id=\"$name\" class=\"inl\">";
  
     foreach (array(0, 1, 2, 3, 4, 6, 12, 24) as $dur) {
         $res .= "<option value=\"$dur\"";
         if ($selected == $dur) {
             $res .= ' selected="selected" ';
         }
  
         $res .= '>';
  
         if ($dur == 0) {
             $res .= _('Not managed');
         } else {
             $res .= pretty_months($dur);
         }
         $res .= '</option>';
     }
  
     $res .= '</select>';
     return $res;
 }

References $res, and pretty_months().

◆ ecif()

ecif	(	$test,
		$tr,
		$fa = `""`,
		$affiche = `1`
	)

Parameters

boolean	$test
string	$tr
string	$fa
integer	$affiche

Returns: string

Definition at line 387 of file functions.php.

                                                   {
     if ($test) {
         $retour = $tr;
     } else {
         $retour = $fa;
     }
     if ($affiche) {
         echo $retour;
     }
     return $retour;
 }

◆ ehe()

ehe	(	$str,
		$display = `TRUE`
	)

Echo the HTMLSpecialChars version of a value.

(or return it if display=false 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

Parameters

	global	string $charset
string	$str
boolean	$display

Returns: string

Definition at line 647 of file functions.php.

                                     {
     global $charset;
     $quoted = htmlspecialchars($str, ENT_QUOTES|ENT_SUBSTITUTE, $charset);
     if ($display) {
         echo $quoted;
     }
     return $quoted;
 }

Referenced by display_browser(), and sub_domains_edit().

◆ eoption()

eoption	(	$values,
		$cur,
		$onedim = `false`
	)

select_values($arr,$cur) echo des <option> du tableau $values ou de la table sql $values selectionne $current par defaut.

Si on lui demande poliement, il prend un tableau a une dimension

Parameters

array	$values
string	$cur
boolean	$onedim

Definition at line 619 of file functions.php.

                                                  {
     if (is_array($values)) {
         foreach ($values as $k => $v) {
             if ($onedim) {
                 $k = $v;
             }
             echo "<option value=\"$k\"";
             if ($k == $cur) {
                 echo " selected=\"selected\"";
             }
             echo ">" . $v . "</option>";
         }
     }
 }

◆ eue()

eue	(	$str,
		$display = `TRUE`
	)

Echo the URLENCODED version of a value.

(or return it if display=false) Must be called when pre-filling fields values in URLS such as : document.location='logs_tail.php?file=<?php eue($file); ?> Use the charset of the current language for transcription

Parameters

	global	string $charset
string	$str
boolean	$display

Returns: string

Definition at line 670 of file functions.php.

                                     {
     global $charset;
     $quoted = urlencode($str);
     if ($display) {
         echo $quoted;
     }
     return $quoted;
 }

◆ fHSVtoRGB()

fHSVtoRGB	(	$iH,
		$iS,
		$iV
	)

Converts HSV to RGB values

Reference: http://en.wikipedia.org/wiki/HSL_and_HSV Purpose: Useful for generating colours with same hue-value for web designs. Input: Hue (H) Integer 0-360 Saturation (S) Integer 0-100 Lightness (V) Integer 0-100 Output: String "R,G,B" Suitable for CSS function RGB().

Parameters

int	$iH
int	$iS
int	$iV

Returns: array

Definition at line 998 of file functions.php.

                                   {
  
     if ($iH < 0) {
         $iH = 0;   // Hue:
     }
     if ($iH > 360) {
         $iH = 360; //   0-360
     }
     if ($iS < 0) {
         $iS = 0;   // Saturation:
     }
     if ($iS > 100) {
         $iS = 100; //   0-100
     }
     if ($iV < 0) {
         $iV = 0;   // Lightness:
     }
     if ($iV > 100) {
         $iV = 100; //   0-100
     }
  
     $dS = $iS / 100.0; // Saturation: 0.0-1.0
     $dV = $iV / 100.0; // Lightness:  0.0-1.0
     $dC = $dV * $dS;   // Chroma:     0.0-1.0
     $dH = $iH / 60.0;  // H-Prime:    0.0-6.0
     $dT = $dH;       // Temp variable
  
     while ($dT >= 2.0) {
         $dT -= 2.0; // php modulus does not work with float
     }
     $dX = $dC * (1 - abs($dT - 1));     // as used in the Wikipedia link
  
     switch ($dH) {
     case($dH >= 0.0 && $dH < 1.0):
         $dR = $dC;
         $dG = $dX;
         $dB = 0.0;
         break;
     case($dH >= 1.0 && $dH < 2.0):
         $dR = $dX;
         $dG = $dC;
         $dB = 0.0;
         break;
     case($dH >= 2.0 && $dH < 3.0):
         $dR = 0.0;
         $dG = $dC;
         $dB = $dX;
         break;
     case($dH >= 3.0 && $dH < 4.0):
         $dR = 0.0;
         $dG = $dX;
         $dB = $dC;
         break;
     case($dH >= 4.0 && $dH < 5.0):
         $dR = $dX;
         $dG = 0.0;
         $dB = $dC;
         break;
     case($dH >= 5.0 && $dH < 6.0):
         $dR = $dC;
         $dG = 0.0;
         $dB = $dX;
         break;
     default:
         $dR = 0.0;
         $dG = 0.0;
         $dB = 0.0;
         break;
     }
  
     $dM = $dV - $dC;
     $dR += $dM;
     $dG += $dM;
     $dB += $dM;
     $dR *= 255;
     $dG *= 255;
     $dB *= 255;
  
     return array('r' => round($dR), 'g' => round($dG), 'b' => round($dB));
 }

Referenced by PercentToColor().

◆ fl()

fl ( $str )

Format a field value for input or textarea :

Copyright: AlternC-Team 2000-2017 https://alternc.com/

Parameters

string $str

Returns: string

Definition at line 31 of file functions.php.

                   {
     return str_replace("<", "&lt;", str_replace("\"", "&quot;", $str));
 }

◆ format_date()

format_date	(	$format,
		$date
	)

Parameters

string	$format
string	$date

Returns: string

Definition at line 494 of file functions.php.

                                      {
     $d = substr($date, 8, 2);
     $m = substr($date, 5, 2);
     $y = substr($date, 0, 4);
     $h = substr($date, 11, 2);
     $i = substr($date, 14, 2);
     if ($h > 12) {
         $hh = $h - 12;
         $am = "pm";
     } else {
         $hh = $h;
         $am = "am";
     }
  
     // we want every number to be treated as a string.
     $format=str_replace('$d', '$s', $format);
     return sprintf($format, $d, $m, $y, $h, $i, $hh, $am);
 }

References $d, and $i.

◆ format_size()

format_size	(	$size,
		$html = `0`
	)

Parameters

int \| string	$size
integer	$html

Returns: string

Definition at line 430 of file functions.php.

                                        {
     // Retourne une taille formatt�e en Octets, Kilo-octets, M�ga-octets ou Giga-Octets, avec 2 d�cimales.
     if ("-" == $size) {
         return $size;
     }
     $size = (float) $size;
     if ($size < 1024) {
         $r = $size;
         if ($size != 1) {
             $r.=" " . _("Bytes");
         } else {
             $r.=" " . _("Byte");
         }
     } else {
         $size = $size / 1024;
         if ($size < 1024) {
             $r = round($size, 2) . " " . _("Kb");
         } else {
             $size = $size / 1024;
             if ($size < 1024) {
                 $r = round($size, 2) . " " . _("Mb");
             } else {
                 $size = $size / 1024;
                 if ($size < 1024) {
                     $r = round($size, 2) . " " . _("Gb");
                 } else {
                     $r = round($size / 1024, 2) . " " . _("Tb");
                 }
             }
         }
     }
     if ($html) {
         return str_replace(" ", "&nbsp;", $r);
     } else {
         return $r;
     }
 }

References $html, and $r.

Referenced by m_quota\display_val(), and m_quota\hook_menu().

◆ get_remote_ip()

get_remote_ip ( )

Return the remote IP.

If you are behind a proxy, use X_FORWARDED_FOR instead of REMOTE_ADDR

Returns: string

Definition at line 134 of file functions.php.

                          {
     return getenv('REMOTE_ADDR');
 }

Referenced by m_mem\checkid(), m_messages\debug(), m_mem\del_session(), m_err\log(), m_messages\log(), m_messages\logAlternC(), m_mem\login(), m_mem\resetlast(), m_mem\setid(), and m_mem\temporary_login().

◆ getFields()

getFields	(	$fields,
		$requestOnly = `false`
	)

Get the Fields of the posted form from $_REQUEST or POST or GET and check their type.

Parameters

array	$fields
boolean	$requestOnly

Returns: array

Definition at line 688 of file functions.php.

                                                   {
     $vars = array();
     $methodType = array("get", "post", "request", "files", "server");
  
     foreach ($fields AS $name => $options) {
         if (in_array(strtolower($options[0]), $methodType) === false) {
             die("Unrecognized method type used for field " . $name . " : " . $options[0]);
         }
         if ($requestOnly === true) {
             $method = "_REQUEST";
         } else {
             $method = "_" . strtoupper($options[0]);
         }
         switch ($options[1]) {
         case "integer":
             $vars[$name] = (isset($GLOBALS[$method][$name]) && is_numeric($GLOBALS[$method][$name]) ? intval($GLOBALS[$method][$name]) : $options[2]);
             break;
         case "float":
             $vars[$name] = (isset($GLOBALS[$method][$name]) && is_numeric($GLOBALS[$method][$name]) ? floatval($GLOBALS[$method][$name]) : $options[2]);
             break;
         case "string":
             $vars[$name] = (isset($GLOBALS[$method][$name]) ? trim($GLOBALS[$method][$name]) : $options[2]);
             break;
         case "array":
             $vars[$name] = (isset($GLOBALS[$method][$name]) && is_array($GLOBALS[$method][$name]) ? $GLOBALS[$method][$name] : $options[2]);
             break;
         case "boolean":
             $vars[$name] = (isset($GLOBALS[$method][$name]) ? $GLOBALS[$method][$name] : $options[2]);
             break;
         case "file":
             $vars[$name] = (isset($GLOBALS[$method][$name]) ? $GLOBALS[$method][$name] : $options[2]);
             break;
         default:
             die("Illegal method type used for field " . $name . " : " . $options[1]);
         }
     }
  
     // Insert into $GLOBALS.
     foreach ($vars AS $var => $value) {
         $GLOBALS[$var] = $value;
     }
     return $vars;
 }

References $fields, and $value.

◆ getlinkhelp()

getlinkhelp ( $hid )

Parameters

int $hid

Returns: string

Definition at line 474 of file functions.php.

                            {
     return "(<a href=\"javascript:help($hid);\">?</a>)";
 }

Referenced by linkhelp().

◆ getuserpath()

getuserpath ( $user = null )

get the home of the user

Parameters

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

Definition at line 329 of file functions.php.

                                    {
     if (is_null($user)) {
         global $mem;
         $user = $mem->user['login'];
     }
     return rtrim(ALTERNC_HTML, "/") . "/" . substr($user, 0, 1) . "/" . $user;
 }

References $mem, $user, and ALTERNC_HTML.

Referenced by m_ftp\add_ftp(), m_admin\add_mem(), m_bro\alternc_export_data(), checkuserpath(), m_admin\del_mem(), m_bro\DeleteFile(), m_bro\DownloadTBZ(), m_bro\DownloadTGZ(), m_bro\DownloadZ(), m_ftp\get_ftp_details(), m_mysql\get_mysql_details(), m_bro\get_user_root(), m_apache\hook_updatedomains_web_add(), m_ftp\is_ftp(), and m_ftp\put_ftp_details().

◆ hexa()

hexa ( $hex )

Parameters

int $hex

Returns: int

Definition at line 1085 of file functions.php.

                     {
     $num = dechex($hex);
     return (strlen("$num") >= 2) ? "$num" : "0$num";
 }

Referenced by PercentToColor().

◆ ife()

ife	(	$test,
		$tr,
		$fa = `""`
	)

Parameters

boolean	$test
string	$tr
string	$fa

Returns: string

Definition at line 416 of file functions.php.

                                    {
     if ($test) {
         return $tr;
     }
     return $fa;
 }

Referenced by _subbrowse(), browseforfolder(), and m_bro\viewurl().

◆ linkhelp()

linkhelp ( $hid )

Parameters

int $hid

Definition at line 483 of file functions.php.

                         {
     echo getlinkhelp($hid);
 }

References getlinkhelp().

◆ list_properties_order()

list_properties_order	(	$a,
		$b
	)

Parameters

array	$a
array	$b

Returns: int

Definition at line 750 of file functions.php.

                                        {
     if ($a['label'] == $b['label']) {
         return 0;
     }
     return ($a['label'] < $b['label']) ? -1 : 1;
 }

◆ pager()

pager	(	$offset,
		$count,
		$total,
		$url,
		$before = `""`,
		$after = `""`,
		$echo = `true`
	)

Shows a pager : Previous page 0 1 2 ...

16 17 18 19 20 ... 35 36 37 Next page

Arguments are as follow : $offset = the current offset from 0 $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

Parameters

int	$offset
int	$count
int	$total
string	$url
string	$before
string	$after
boolean	$echo

Returns: string

Definition at line 777 of file functions.php.

                                                                                        {
     $return = "";
     $offset = intval($offset);
     $count = intval($count);
     $total = intval($total);
     if ($offset <= 0) {
         $offset = "0";
     }
     if ($count <= 1) {
         $count = "1";
     }
     if ($total <= 0) {
         $total = "0";
     }
     if ($total < $offset) {
         $offset = max(0, $total - $count);
     }
     if ($total <= $count) { // When there is less element than 1 complete page, just don't do anything :-D
         return true;
     }
     $return .= $before;
     // Shall-we show previous page link ?
     if ($offset) {
         $o = max($offset - $count, 0);
         $return .= "<a href=\"" . str_replace("%%offset%%", $o, $url) . "\" alt=\"(Ctl/Alt-p)\" title=\"(Alt-p)\" accesskey=\"p\">" . _("Previous Page") . "</a> ";
     } else {
         $return .= _("Previous Page") . " ";
     }
  
     if ($total > (2 * $count)) { // On n'affiche le pager central (0 1 2 ...) s'il y a au moins 2 pages.
         $return .= " - ";
         if (($total < ($count * 10)) && ($total > $count)) {  // moins de 10 pages : 
             for ($i = 0; $i < $total / $count; $i++) {
                 $o = $i * $count;
                 if ($offset == $o) {
                     $return .= $i . " ";
                 } else {
                     $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
             for ($i = 0; $i <= 2; $i++) {
                 $o = $i * $count;
                 if ($offset == $o) {
                     $return .= $i . " ";
                 } else {
                     $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
                 $start = max(3, intval($offset / $count) - 2);
                 $end = min(intval($offset / $count) + 3, intval($total / $count) - 3);
                 if ($start != 3) {
                     $return .= " ... ";
                 }
                 for ($i = $start; $i < $end; $i++) {
                     $o = $i * $count;
                     if ($offset == $o) {
                         $return .= $i . " ";
                     } else {
                         $return .= "<a href=\"" . str_replace("%%offset%%", $o, $url) . "\">$i</a> ";
                     }
                 }
                 if ($end != intval($total / $count) - 3) {
                     $return .= " ... ";
                 }
             } else {
                 $return .= " ... ";
             }
             for ($i = intval($total / $count) - 3; $i < $total / $count; $i++) {
                 $o = $i * $count;
                 if ($offset == $o) {
                     $return .= $i . " ";
                 } else {
                     $return .= "<a href=\"" . str_replace("%%offset%%", $o, $url) . "\">$i</a> ";
                 }
             }
             $return .= " - ";
         } // More than 10 pages?
     }
     // Shall-we show the next page link ?
     if ($offset + $count < $total) {
         $o = $offset + $count;
         $return .= "<a href=\"" . str_replace("%%offset%%", $o, $url) . "\" alt=\"(Ctl/Alt-s)\" title=\"(Alt-s)\" accesskey=\"s\">" . _("Next Page") . "</a> ";
     } else {
         $return .= _("Next Page") . " ";
     }
     $return .= $after;
     if ($echo) {
         echo $return;
     }
     return $return;
 }

References $i, and $total.

◆ panel_islocked()

panel_islocked ( )

Returns: boolean

Definition at line 1149 of file functions.php.

                           {
     return file_exists(ALTERNC_LOCK_PANEL);
 }

References ALTERNC_LOCK_PANEL.

Referenced by m_mem\checkid(), m_mem\login(), and m_mem\temporary_login().

◆ panel_lock()

panel_lock ( )

Parameters

global	m_messages $msg
global	m_mem $mem
global	int $cuid

Returns: boolean

Definition at line 1120 of file functions.php.

                       {
     global $cuid;
     if ($cuid != 2000) {
         return false;
     }
     return touch(ALTERNC_LOCK_PANEL);
 }

References $cuid, and ALTERNC_LOCK_PANEL.

◆ panel_unlock()

panel_unlock ( )

Parameters

global	m_messages $msg
global	m_mem $mem
global	int $cuid

Returns: boolean

Definition at line 1136 of file functions.php.

                         {
     global $cuid;
     if ($cuid != 2000) {
         return false;
     }
     return unlink(ALTERNC_LOCK_PANEL);
 }

References $cuid, and ALTERNC_LOCK_PANEL.

◆ PercentToColor()

PercentToColor ( $p = 0 )

Parameters

int $p

Returns: string

Definition at line 1096 of file functions.php.

                                 {
     if ($p > 100) {
         $p = 100;
     }
     if ($p < 0) {
         $p = 0;
     }
     // Pour aller de vert a rouge en passant par jaune et orange
     $h = 1 + ((100 - $p) * 130 / 100);
  
     $rvb = fHSVtoRGB((int) $h, 96, 93);
     $color = "#" . hexa($rvb['r']) . hexa($rvb['g']) . hexa($rvb['b']);
  
     return $color;
 }

References $p, fHSVtoRGB(), and hexa().

Referenced by m_quota\quota_displaybar().

◆ pretty_months()

pretty_months ( $months )

Converti un nombre de mois en une chaine plus lisible.

Parameters

integer $months Nombre de mois

Returns: string Cha�ne repr�sentant le nombre de mois @access private

Definition at line 570 of file functions.php.

                                 {
     if ($months % 12 == 0 && $months > 11) {
         $years = $months / 12;
         return "$years " . ($years > 1 ? _("years") : _("year"));
     } else {
         return "$months " . ($months > 1 ? _("months") : _("month"));
     }
 }

Referenced by duration_list().

◆ printVar()

printVar ( $array )

Parameters

array $array

Definition at line 737 of file functions.php.

                           {
     echo "<pre style=\"border: 1px solid black; text-align: left; font-size: 9px\">\n";
     print_r($array);
     echo "</pre>\n";
 }

◆ selected()

selected	(	$bool,
		$echo = `TRUE`
	)

ECHOes selected="selected" only if the parameter is true useful for checkboxes and radio buttons.

Parameters

boolean	$bool
boolean	$echo

Returns: string

Definition at line 366 of file functions.php.

                                        {
     if ($bool) {
         $return = " selected=\"selected\"";
     } else {
         $return = '';
     }
     if ($echo) {
         echo $return;
     }
     return $return;
 }

Referenced by sub_domains_edit().

◆ split_mysql_database_name()

split_mysql_database_name ( $dbname )

split mysql database name between username and custom database name

Parameters

string $dbname database name

Returns: array returns username as first element, custom name as second

Definition at line 548 of file functions.php.

                                             {
     $db_exploded_name = explode("_", $dbname);
     return array($db_exploded_name[0],
     implode("_", array_slice($db_exploded_name, 1)));
 }

Referenced by m_mysql\get_dblist(), and m_mysql\get_mysql_details().

◆ ssla()

ssla ( $str )

Strip slashes if needed :

Parameters

string $str

Returns: string

Definition at line 519 of file functions.php.

                     {
     if (get_magic_quotes_gpc()) {
         return stripslashes($str);
     } else {
         return $str;
     }
 }

Referenced by m_bro\ChangePermissions(), m_bro\CopyFile(), m_bro\CreateDir(), m_bro\CreateFile(), m_bro\DeleteFile(), m_bro\MoveFile(), and m_bro\RenameFile().

◆ xml_entities()

xml_entities ( $string )

Echappe les caract�res pouvant perturber un flux XML standard :

Parameters

string $string Chaine de caract�re � encoder en valeur xml.

Returns: string Retourne la cha�ne modifi�e si besoin. @access private

Definition at line 560 of file functions.php.

                                {
     return str_replace("<", "&lt;", str_replace(">", "&gt;", str_replace("&", "&amp;", $string)));
 }

References $string.

Referenced by m_mail\alternc_export_conf().

Functions

Function Documentation

◆ __()

◆ _dovecot_hash()

◆ _md5cr()

◆ _sha512cr()

◆ add_line_to_file()

◆ cbox()

◆ checkcname()

◆ checkfqdn()

◆ checkhostallow()

◆ checkhostallow_nodns()

◆ checkip()

◆ checkipv6()

◆ checkloginmail()

◆ checkmail()

◆ checksubtxt()

◆ checkurl()

◆ checkuserpath()

◆ create_pass()

◆ csrf_check()

◆ csrf_get()

◆ del_line_from_file()

◆ display_browser()

◆ display_div_generate_password()

◆ duration_list()

◆ ecif()

◆ ehe()

◆ eoption()

◆ eue()

◆ fHSVtoRGB()

Converts HSV to RGB values

◆ fl()

◆ format_date()

◆ format_size()

◆ get_remote_ip()

◆ getFields()

◆ getlinkhelp()

◆ getuserpath()

◆ hexa()

◆ ife()

◆ linkhelp()

◆ list_properties_order()

◆ pager()

◆ panel_islocked()

◆ panel_lock()

◆ panel_unlock()

◆ PercentToColor()

◆ pretty_months()

◆ printVar()

◆ selected()

◆ split_mysql_database_name()

◆ ssla()

◆ xml_entities()