FTP account management class. More...

Public Member Functions
	m_ftp ()
	Constructor. More...

	alternc_password_policy ()
	Password kind used in this class (hook for admin class) More...

	hook_menu ()
	hook function called by menu class to add menu to the left panel More...

	authip_class ()
	Return the values needed to activate security access. More...

	switch_enabled ($id, $status=null)
	Switch enabled status of an account. More...

	get_list ()
	Retourne la liste des comptes FTP du compte h�berg� Retourne la liste des comptes FTP sous forme de tableau index� de tableaus associatifs comme suit : $a["id"]= ID du compte ftp $a["login"]= Nom de login du compte $a["dir"]= Dossier relatif � la racine du compte de l'utilisateur. More...

	get_ftp_details ($id)
	Retourne les details d'un compte FTP (voir get_list) Le tableau est celui du compte d'id specifie. More...

	prefix_list ()
	Retourne la liste des prefixes utilisables par le compte courant. More...

	check_login ($l)
	Check if the login is fine (syntax) More...

	select_prefix_list ($current)
	Affiche (ECHO) la liste des prefixes disponibles sous forme de champs d'option Les champs sont affich�s sous la forme <option>prefixe</option>... More...

	put_ftp_details ($id, $prefixe, $login, $pass, $dir)
	Modifie les param�tres du comptes FTP $id. More...

	delete_ftp ($id)
	Efface le compte ftp specifie. More...

	add_ftp ($prefixe, $login, $pass, $dir)
	Cree un nouveau compte FTP. More...

	is_ftp ($dir)
	Retourne TRUE si $dir possee un compte FTP. More...

	alternc_del_domain ($dom)
	Fonction appellee par domains quand un domaine est supprime pour le membre. More...

	alternc_del_member ()
	Fonction appellee par membres quand un membre est efface @access private. More...

	hook_quota_get ()
	Returns the used quota for the $name service for the current user. More...

	alternc_export_conf ()
	Exporte toutes les informations ftp du compte AlternC @access private EXPERIMENTAL 'sid' function ;) More...

Public Attributes
	$srv_proftpd

Detailed Description

FTP account management class.

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

Definition at line 26 of file m_ftp.php.

Member Function Documentation

◆ add_ftp()

m_ftp::add_ftp	(	$prefixe,
		$login,
		$pass,
		$dir
	)

Cree un nouveau compte FTP.

Parameters

string	$prefixe	Prefixe au login
string	$login	Login ftp (login=prefixe_login)
string	$pass	Mot de passe FTP
string	$dir	Repertoire racine du compte relatif à la racine du membre

Returns: boolean TRUE si le compte a ete cree, FALSE sinon.

Definition at line 359 of file m_ftp.php.

                                                     {
         global $db, $msg, $quota, $bro, $cuid, $admin;
         $msg->log("ftp", "add_ftp", $prefixe . "_" . $login);
         $dir = $bro->convertabsolute($dir);
         if (substr($dir, 0, 1) == "/") {
             $dir = substr($dir, 1);
         }
         $r = $this->prefix_list();
         if (empty($pass)) {
             $msg->raise("ERROR", "ftp", _("Password can't be empty"));
             return false;
         }
         if (!in_array($prefixe, $r) || $prefixe == "") {
             $msg->raise("ERROR", "ftp", _("The chosen prefix is not allowed"));
             return false;
         }
         $full_login = $prefixe;
         if ($login) {
             $full_login.="_" . $login;
         }
         if (!$this->check_login($full_login)) {
             return false;
         }
         $db->query("SELECT count(*) AS cnt FROM ftpusers WHERE name= ? ;", array($full_login));
         $db->next_record();
         if ($db->f("cnt")) {
             $msg->raise("ERROR", "ftp", _("This FTP account already exists"));
             return false;
         }
         $db->query("SELECT login FROM membres WHERE uid= ? ;", array($cuid));
         $db->next_record();
         $absolute = getuserpath() . "/$dir";
         if (!file_exists($absolute)) {
             system("/bin/mkdir -p $absolute"); // FIXME replace with action
         }
         if (!is_dir($absolute)) {
             $msg->raise("ERROR", "ftp", _("The directory cannot be created"));
             return false;
         }
  
         // Check this password against the password policy using common API : 
         if (is_callable(array($admin, "checkPolicy"))) {
             if (!$admin->checkPolicy("ftp", $full_login, $pass)) {
                 return false; // The error has been raised by checkPolicy()
             }
         }
  
         if ($quota->cancreate("ftp")) {
             $encrypted_password = _sha512cr($pass);
             $db->query("INSERT INTO ftpusers (name,password, encrypted_password,homedir,uid) VALUES ( ?, '', ?, ?, ?)", array($full_login, $encrypted_password, $absolute, $cuid));
             return true;
         } else {
             $msg->raise("ERROR", "ftp", _("Your FTP account quota is over. You cannot create more FTP accounts"));
             return false;
         }
     }

References $bro, $cuid, $db, $login, $msg, $r, _sha512cr(), check_login(), getuserpath(), and prefix_list().

◆ alternc_del_domain()

m_ftp::alternc_del_domain ( $dom )

Fonction appellee par domains quand un domaine est supprime pour le membre.

Parameters

string $dom Domaine à detruire. @access private

Definition at line 443 of file m_ftp.php.

                                       {
         global $db, $msg, $cuid;
         $msg->log("ftp", "alternc_del_domain", $dom);
         $db->query("DELETE FROM ftpusers WHERE uid= ? AND ( name LIKE ? OR name LIKE ?) ", array($cuid, $dom."\_%", $dom));
         return true;
     }

References $cuid, $db, $dom, and $msg.

◆ alternc_del_member()

m_ftp::alternc_del_member ( )

Fonction appellee par membres quand un membre est efface @access private.

Definition at line 455 of file m_ftp.php.

                                   {
         global $db, $msg, $cuid;
         $msg->log("ftp", "alternc_del_member");
         $db->query("DELETE FROM ftpusers WHERE uid= ?", array($cuid));
         return true;
     }

References $cuid, $db, and $msg.

◆ alternc_export_conf()

m_ftp::alternc_export_conf ( )

Exporte toutes les informations ftp du compte AlternC @access private EXPERIMENTAL 'sid' function ;)

Definition at line 486 of file m_ftp.php.

                                    {
         global $db, $msg;
         $msg->log("ftp", "export");
         $f = $this->get_list();
         $str = "  <ftp>";
         foreach ($f as $d => $v) {
             $str.="   <login>" . ($v["login"]) . "</login>\n";
             $str.="   <password>" . ($v["encrypted_password"]) . "</password>\n";
             $str.="   <directory>" . ($v["dir"]) . "<directory>\n";
         }
         $str.=" </ftp>\n";
         return $str;
     }

References $d, $db, $f, $msg, and get_list().

◆ alternc_password_policy()

m_ftp::alternc_password_policy ( )

Password kind used in this class (hook for admin class)

Definition at line 43 of file m_ftp.php.

                                        {
         return array("ftp" => "FTP accounts");
     }

◆ authip_class()

m_ftp::authip_class ( )

Return the values needed to activate security access.

See get_auth_class() in authip for more informations

Definition at line 86 of file m_ftp.php.

                             {
         $c = Array();
         $c['name'] = "FTP";
         $c['protocol'] = "ftp";
         $c['values'] = Array();
  
         $tt = $this->get_list();
         if (empty($tt) || !is_array($tt)) {
             return $c;
         }
         foreach ($this->get_list() as $v) {
             $c['values'][$v['id']] = $v['login'];
         }
  
         return $c;
     }

References $c, and get_list().

◆ check_login()

m_ftp::check_login ( $l )

Check if the login is fine (syntax)

Parameters

string $l

Definition at line 223 of file m_ftp.php.

                              {
         global $msg;
         // special chars and the max numbers of them allowed
         // to be able to give a specific error
         $vv = array('_' => '1', ' ' => 0);
         foreach ($vv as $k => $n) {
             if (substr_count($l, $k) > $n) { // if there is more than $n $k
                 $msg->raise("ERROR", 'ftp', sprintf(_("FTP login is incorrect: too many '%s'"), $k));
                 return false;
             }
         }
         // Explicitly look for only allowed chars
         if (!preg_match("/^[A-Za-z0-9]+[A-Za-z0-9_\.\-]*$/", $l)) {
             $msg->raise("ERROR", 'ftp', _("FTP login is incorrect"));
             return false;
         }
         return true;
     }

References $msg.

Referenced by add_ftp(), and put_ftp_details().

◆ delete_ftp()

m_ftp::delete_ftp ( $id )

Efface le compte ftp specifie.

Parameters

integer $id Numero du compte FTP a supprimer.

Returns: boolean TRUE si le compte a ete efface, FALSE sinon.

Definition at line 336 of file m_ftp.php.

                              {
         global $db, $msg, $cuid;
         $msg->log("ftp", "delete_ftp", $id);
         $db->query("SELECT name FROM ftpusers WHERE id= ? and uid= ? ;", array($id, $cuid));
         $db->next_record();
         $name = $db->f("name");
         if (!$name) {
             $msg->raise("ERROR", "ftp", _("This FTP account does not exist"));
             return false;
         }
         $db->query("DELETE FROM ftpusers WHERE id= ? ;", array($id));
         return $name;
     }

References $cuid, $db, $id, and $msg.

◆ get_ftp_details()

m_ftp::get_ftp_details ( $id )

Retourne les details d'un compte FTP (voir get_list) Le tableau est celui du compte d'id specifie.

Parameters

integer $id Numero du compte dont on souhaite obtenir les d�tails

Returns: array Tableau associatif contenant les infos du comptes ftp

Definition at line 170 of file m_ftp.php.

                                   {
         global $db, $msg, $cuid;
         $msg->debug("ftp", "get_ftp_details", $id);
         $r = array();
         $db->query("SELECT id, name, homedir, enabled FROM ftpusers WHERE uid= ? AND id= ?;", array($cuid, $id));
         if ($db->num_rows()) {
             $db->next_record();
  
             $regexp = "/^" . preg_quote(getuserpath(), "/") . "\/(.*)$/";
             $match = array();
             preg_match($regexp, $db->f("homedir"), $match);
  
             $lg = explode("_", $db->f("name"));
             if ((!is_array($lg)) || (count($lg) != 2)) {
                 $lg[0] = $db->f("name");
                 $lg[1] = "";
             }
             $r[] = array(
                 "id" => $db->f("id"),
                 "prefixe" => $lg[0],
                 "login" => $lg[1],
                 "dir" => $match[1],
                 "enabled" => $db->f("enabled")
             );
             return $r;
         } else {
             $msg->raise("ERROR", "ftp", _("This FTP account does not exist"));
             return false;
         }
     }

References $cuid, $db, $id, $msg, $r, and getuserpath().

Referenced by switch_enabled().

◆ get_list()

m_ftp::get_list ( )

Retourne la liste des comptes FTP du compte h�berg� Retourne la liste des comptes FTP sous forme de tableau index� de tableaus associatifs comme suit : $a["id"]= ID du compte ftp $a["login"]= Nom de login du compte $a["dir"]= Dossier relatif � la racine du compte de l'utilisateur.

Returns: array Retourne le tableau des comptes

Definition at line 141 of file m_ftp.php.

                         {
         global $db, $msg, $cuid;
         $msg->debug("ftp", "get_list");
         $r = array();
         $db->query("SELECT id, name, homedir, enabled FROM ftpusers WHERE uid= ? ORDER BY name;", array($cuid));
         if ($db->num_rows()) {
             while ($db->next_record()) {
                 $r[] = array(
                     "id" => $db->f("id"),
                     "login" => $db->f("name"),
                     "enabled" => $db->f("enabled"),
                     //"dir"=>$match[1]
                     "dir" => $db->f("homedir")
                 );
             }
             return $r;
         } else {
             $msg->raise("INFO", "ftp", _("No FTP account found"));
             return array();
         }
     }

References $cuid, $db, $msg, and $r.

Referenced by alternc_export_conf(), and authip_class().

◆ hook_menu()

m_ftp::hook_menu ( )

hook function called by menu class to add menu to the left panel

Definition at line 52 of file m_ftp.php.

                          {
         global $quota;
         $q = $quota->getquota("ftp");
  
         $obj = array(
             'title' => _("FTP accounts"),
             'link' => 'toggle',
             'pos' => 100,
             'links' => array(),
         );
  
         if ($quota->cancreate("ftp")) {
             $obj['links'][] = array(
                 'txt' => _("Create a new ftp account"),
                 'url' => "ftp_edit.php?create=1",
                 'class' => '',
             );
         }
  
         if ($q['u'] > 0) { // if there are some FTP accounts
             $obj['links'][] = array(
                 'txt' => _("FTP accounts list"),
                 'url' => "ftp_list.php"
             );
         }
  
         return $obj;
     }

References $q.

◆ hook_quota_get()

m_ftp::hook_quota_get ( )

Returns the used quota for the $name service for the current user.

Parameters

$name string name of the quota

Returns: integer the number of service used or false if an error occured @access private

Definition at line 469 of file m_ftp.php.

                               {
         global $db, $msg, $cuid;
         $msg->debug("ftp", "getquota");
         $q = Array("name" => "ftp", "description" => _("FTP accounts"), "used" => 0);
         $db->query("SELECT COUNT(*) AS cnt FROM ftpusers WHERE uid= ? ", array($cuid));
         if ($db->next_record()) {
             $q['used'] = $db->f("cnt");
         }
         return $q;
     }

References $cuid, $db, $msg, and $q.

◆ is_ftp()

m_ftp::is_ftp ( $dir )

Retourne TRUE si $dir possee un compte FTP.

Parameters

string $dir Dossier a tester, relatif a la racine du compte courant

Returns: boolean retourne TRUE si $dir a un compte FTP, FALSE sinon.

Definition at line 422 of file m_ftp.php.

                           {
         global $db, $msg;
         $msg->debug("ftp", "is_ftp", $dir);
         if (substr($dir, 0, 1) == "/") {
             $dir = substr($dir, 1);
         }
         $db->query("SELECT id FROM ftpusers WHERE homedir= ? ;", array( getuserpath() . "/" .$dir ));
         if ($db->num_rows()) {
             $db->next_record();
             return $db->f("id");
         } else {
             return false;
         }
     }

References $db, $msg, and getuserpath().

◆ m_ftp()

m_ftp::m_ftp ( )

Constructor.

Definition at line 34 of file m_ftp.php.

                      {
         global $L_FQDN;
         $this->srv_proftpd = variable_get('fqdn_proftpd', $L_FQDN, 'Human name for FTP server. If you change it, launch reload-certs', array('desc' => 'Name', 'type' => 'string'));
     }

References variable_get().

◆ prefix_list()

m_ftp::prefix_list ( )

Retourne la liste des prefixes utilisables par le compte courant.

Returns: array tableau contenant la liste des prefixes (domaines + login) du compte actuel.

Definition at line 207 of file m_ftp.php.

                            {
         global $db, $mem, $cuid;
         $r = array();
         $r[] = $mem->user["login"];
         $db->query("SELECT domaine FROM domaines WHERE compte= ? ORDER BY domaine;", array($cuid));
         while ($db->next_record()) {
             $r[] = $db->f("domaine");
         }
         return $r;
     }

References $cuid, $db, $mem, and $r.

Referenced by add_ftp(), put_ftp_details(), and select_prefix_list().

◆ put_ftp_details()

m_ftp::put_ftp_details	(	$id,
		$prefixe,
		$login,
		$pass,
		$dir
	)

Modifie les param�tres du comptes FTP $id.

Parameters

integer	$id	Num�ro du compte dont on veut modifier les param�tres
string	$prefixe	Prefixe du compte FTP
string	$login	login ajout� au pr�fixe ($prefixe_$login)
string	$pass	mot de passe
string	$dir	R�pertoire racine du compte

Returns: boolean TRUE si le compte a �t� modifi�, FALSE si une erreur est survenue.

Definition at line 274 of file m_ftp.php.

                                                                  {
         global $db, $msg, $bro, $cuid, $admin;
         $msg->log("ftp", "put_ftp_details", $id);
         $db->query("SELECT count(*) AS cnt FROM ftpusers WHERE id= ? and uid= ?;", array($id, $cuid));
         $db->next_record();
         if (!$db->f("cnt")) {
             $msg->raise("ERROR", "ftp", _("This FTP account does not exist"));
             return false;
         }
         $dir = $bro->convertabsolute($dir);
         if (substr($dir, 0, 1) == "/") {
             $dir = substr($dir, 1);
         }
         $r = $this->prefix_list();
         if (!in_array($prefixe, $r)) {
             $msg->raise("ERROR", "ftp", _("The chosen prefix is not allowed"));
             return false;
         }
  
         $full_login = $prefixe;
         if ($login) {
             $full_login.="_" . $login;
         }
         if (!$this->check_login($full_login)) {
             return false;
         }
         $db->query("SELECT COUNT(*) AS cnt FROM ftpusers WHERE id!= ? AND name= ?;", array($id, $full_login));
         $db->next_record();
         if ($db->f("cnt")) {
             $msg->raise("ERROR", "ftp", _("This FTP account already exists"));
             return false;
         }
         $absolute = getuserpath() . "/$dir";
         if (!file_exists($absolute)) {
             system("/bin/mkdir -p $absolute");
         }
         if (!is_dir($absolute)) {
             $msg->raise("ERROR", "ftp", _("The directory cannot be created"));
             return false;
         }
         if (trim($pass)) {
  
             // Check this password against the password policy using common API : 
             if (is_callable(array($admin, "checkPolicy"))) {
                 if (!$admin->checkPolicy("ftp", $full_login, $pass)) {
                     return false; // The error has been raised by checkPolicy()
                 }
             }
             $encrypted_password = _sha512cr($pass);
             $db->query("UPDATE ftpusers SET name= ? , password='', encrypted_password= ?, homedir= ?, uid= ? WHERE id= ?;", array($full_login, $encrypted_password, $absolute, $cuid, $id));
         } else {
             $db->query("UPDATE ftpusers SET name= ? , homedir= ? , uid= ? WHERE id= ? ;", array($full_login, $absolute, $cuid, $id));
         }
         return true;
     }

References $bro, $cuid, $db, $id, $login, $msg, $r, _sha512cr(), check_login(), getuserpath(), and prefix_list().

◆ select_prefix_list()

m_ftp::select_prefix_list ( $current )

Affiche (ECHO) la liste des prefixes disponibles sous forme de champs d'option Les champs sont affich�s sous la forme <option>prefixe</option>...

La valeur $current se voit affubl�e de la balise SELECTED.

Parameters

string $current Prefixe s�lectionn� par d�faut

Returns: boolean TRUE.

Definition at line 250 of file m_ftp.php.

                                           {
         $r = $this->prefix_list();
         reset($r);
         while (list($key, $val) = each($r)) {
             if ($current == $val) {
                 $c = " selected=\"selected\"";
             } else {
                 $c = "";
             }
             echo "<option$c>$val</option>";
         }
         return true;
     }

References $c, $key, $r, $val, and prefix_list().

◆ switch_enabled()

m_ftp::switch_enabled	(	$id,
		$status = `null`
	)

Switch enabled status of an account.

Definition at line 107 of file m_ftp.php.

                                                  {
         global $cuid, $db, $msg;
         if (!$jj = $this->get_ftp_details($id)) {
             $msg->raise("ERROR", 'ftp', _("This account do not exist or is not of this account"));
             return false;
         }
         if ($status == null) {
             if ($jj[0]['enabled'] == true) {
                 $status = 0;
             } else {
                 $status = 1;
             }
         }
         // Be sure what is in $status, in case of it was a parameter
         $status = ($status ? 1 : 0);
  
         if (!$db->query("UPDATE ftpusers SET enabled = ? WHERE uid = ? AND id = ? ;", array($status, $cuid, $id))) {
             $msg->raise("ERROR", 'ftp', _("Error during update"));
             return false;
         } else {
             return true;
         }
     }

References $cuid, $db, $id, $msg, and get_ftp_details().

Member Data Documentation

◆ $srv_proftpd

m_ftp::$srv_proftpd

Definition at line 28 of file m_ftp.php.

The documentation for this class was generated from the following file:

bureau/class/m_ftp.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ add_ftp()

◆ alternc_del_domain()

◆ alternc_del_member()

◆ alternc_export_conf()

◆ alternc_password_policy()

◆ authip_class()

◆ check_login()

◆ delete_ftp()

◆ get_ftp_details()

◆ get_list()

◆ hook_menu()

◆ hook_quota_get()

◆ is_ftp()

◆ m_ftp()

◆ prefix_list()

◆ put_ftp_details()

◆ select_prefix_list()

◆ switch_enabled()

Member Data Documentation

◆ $srv_proftpd