Public Member Functions
	__construct ()
	Constructor m_mysql([$mid]) Constructeur de la classe m_mysql, initialise le membre concerne. More...

	reload_dbus ()

	list_db_servers ()

	hook_menu ()

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

	get_dblist ()
	Get the list of the database for the current user. More...

	php_myadmin_connect ()
	Get the login and password of the special user able to connect to phpmyadmin. More...

	get_mysql_details ($dbn)
	Returns the details of a user's database. More...

	add_db ($dbn)
	Create a new database for the current user. More...

	del_db ($dbname)
	Delete a database for the current user. More...

	put_mysql_backup ($dbn, $bck_mode, $bck_history, $bck_gzip, $bck_dir)
	Set the backup parameters for the database $db. More...

	put_mysql_details ($password)
	Change the password of the user in MySQL. More...

	grant ($base, $user, $rights=null, $pass=null, $table=' *')
	Function used to grant SQL rights to users: @base :database @user : database user @rights : rights to apply ( optional, every rights apply given if missing @pass : user password ( optional, if not given the pass stays the same, else it takes the new value ) @table : sql tables to apply rights. More...

	restore ($file, $stdout, $id)
	Restore a sql database. More...

	get_db_size ($dbname)
	Get the size of a database. More...

	get_userslist ($all=null)
	Returns the list of database users of an account. More...

	get_defaultsparam ($dbn)

	add_user ($usern, $password, $passconf)
	Create a new user in MySQL rights tables. More...

	change_user_password ($usern, $password, $passconf)
	Change a user's MySQL password. More...

	del_user ($user, $all=false, $caller_is_deldb=false)
	Delete a user in MySQL rights tables. More...

	get_user_dblist ($user)
	Return the list of the database rights of user $user. More...

	set_user_rights ($user, $dbn, $rights)
	Set the access rights of user $user to database $dbn to be rights $rights. More...

	available_sql_rights ()
	list of all possible SQL rights More...

	hook_lxc_params ($params)
	Hook function called by the lxc class to set mysql_host and port parameters @access private. More...

	hook_quota_get ()
	Hook function called by the quota class to compute user used quota Returns the used quota for the $name service for the current user. More...

	alternc_add_member ()
	Hook function called when a user is created. More...

	alternc_del_member ()
	Hook function called when a user is deleted. More...

	alternc_del_session ()
	Hook function called when a user is logged out. More...

	alternc_export_conf ()
	Exports all the mysql information of an account @access private EXPERIMENTAL 'sid' function ;) More...

	alternc_export_data ($dir)
	Exports all the mysql databases a of give account to $dir directory @access private EXPERIMENTAL 'sid' function ;) More...

	get_dbus_size ($db_name, $db_host, $db_login, $db_password, $db_client)
	Return the size of each databases in a SQL Host given in parameter. More...

Public Attributes
	$dbus

Detailed Description

Definition at line 58 of file m_mysql.php.

Constructor & Destructor Documentation

◆ __construct()

m_mysql::__construct ( )

Constructor m_mysql([$mid]) Constructeur de la classe m_mysql, initialise le membre concerne.

Definition at line 67 of file m_mysql.php.

                            {
         global $cuid;
         if (!empty($cuid)) {
             $this->dbus = new DB_users();
         }
         variable_get('sql_allow_users_backups', 1, 'Set 1 to allow users to configure backup of their databases, 0 if you want do disable this feature. Warning: it will not stop configured backup made by sqlbackup.sh');
     }

References $cuid, and variable_get().

Member Function Documentation

◆ add_db()

m_mysql::add_db ( $dbn )

Create a new database for the current user.

Parameters

$dbn	string Database name ($user_$dbn is the mysql db name)

Returns: boolean if the database $user_$db has been successfully created, or FALSE if an error occured, such as over quota user.

Definition at line 224 of file m_mysql.php.

                           {
         global $db, $msg, $quota, $cuid, $admin;
         $msg->log("mysql", "add_db", $dbn);
         $password_user = "";
         if (!$quota->cancreate("mysql")) {
             $msg->raise("ERROR", "mysql", _("Your databases quota is over. You cannot create more databases"));
             return false;
         }
         $pos = strpos($dbn, '_');
         if ($pos === false) {
             $dbname = $dbn;
         } else {
             $dbncomp = explode('_', $dbn);
             $dbname = $dbn;
             $dbn = $dbncomp[1];
             if (empty($dbn)) { // If nothing after the '_'
                 $msg->raise("ERROR", "mysql", _("Database can't have empty suffix"));
                 return false;
             }
         }
         if (!preg_match("#^[0-9a-z]*$#", $dbn)) {
             $msg->raise("ERROR", "mysql", _("Database name can contain only letters and numbers"));
             return false;
         }
  
         $len=variable_get("sql_max_database_length", 64);
         if (strlen($dbname) > $len) {
             $msg->raise("ERROR", "mysql", _("Database name cannot exceed %d characters"), $len);
             return false;
         }
         $db->query("SELECT * FROM db WHERE db= ? ;", array($dbname));
         if ($db->num_rows()) {
             $msg->raise("ERROR", "mysql", _("Database %s already exists"), $dbn);
             return false;
         }
         
         // We prevent the automatic creation of user account longer than the max allowed lenght of a MySQL username 
         $len=variable_get('sql_max_username_length', NULL);
         if (strlen($dbname) <= $len) {
             $db->query("SELECT name from dbusers where name= ? and enable='ACTIVATED' ;", array($dbname));
             if (!$db->num_rows()) {
                 // We get the password complexity set in the policy and ensure we have that complexity in the create_pass() call
                 $c=$admin->listPasswordPolicies();
                 $passwd_classcount = $c['mysql']['classcount'];
                 
                 $password_user = create_pass(10, $passwd_classcount);
                 if ($this->add_user($dbn, $password_user, $password_user)) {
                     $msg->raise("INFO", "mysql", "L'utilisateur '$dbname' a été créé et les droits sur cette base de données lui ont été attribué.");
                 } else {
                     $msg->raise("ALERT", "mysql", "L'utilisateur '$dbname' n'a pas pu être créé.<br>Allez à la page 'Utilisateurs Mysql' pour en créer manuellement.<br>Et n'oubliez pas de lui donner les droits sur la base de données.");
                 }
             }
         } else {
             $msg->raise("ALERT", "mysql", "L'utilisateur '$dbname' n'a pas été automatiquement créé car il dépasse la limite de taille pour les utilisateurs qui est à $len<br>Allez à la page 'Utilisateurs Mysql' pour en créer un avec le nom que vous voulez.<br>Et n'oubliez pas de lui donner les droits sur la base de données.");
         }
         
         // checking for the phpmyadmin user
         $db->query("SELECT * FROM dbusers WHERE uid= ? AND enable='ADMIN';", array($cuid));
         if ($db->num_rows()) {
             $db->next_record();
             $myadm = $db->f("name");
             $password = $db->f("password");
         } else {
             $msg->raise("ERROR", "mysql", _("There is a problem with the special PhpMyAdmin user. Contact the administrator"));
             return false;
         }
  
         // Grant the special user every rights.
         if ($this->dbus->exec("CREATE DATABASE $dbname;")) { // secured: dbname is checked against ^[0-9a-z]*$
             $msg->log("mysql", "add_db", "Success: ".$dbn);
             // Ok, database does not exist, quota is ok and dbname is compliant. Let's proceed
             $db->query("INSERT INTO db (uid,login,pass,db,bck_mode) VALUES (?, ?, ?, ? ,0)", array($cuid, $myadm, $password, $dbname));
             $dbuser = $dbname;
             $dbname = str_replace('_', '\_', $dbname);
             $this->grant($dbname, $myadm, "ALL PRIVILEGES", $password);
             if (!empty($password_user)) {
                 $this->grant($dbname, $dbuser, "ALL PRIVILEGES", $password_user);
             }
             $this->dbus->query("FLUSH PRIVILEGES;");
             return true;
         } else {
             $msg->log("mysql", "add_db", "Error: ".$dbn);
             $msg->raise("ERROR", "mysql", _("An error occured. The database could not be created"));
             return false;
         }
     }

References $c, $cuid, $db, $len, $msg, $passwd_classcount, $password, add_user(), create_pass(), grant(), and variable_get().

◆ add_user()

m_mysql::add_user	(	$usern,
		$password,
		$passconf
	)

Create a new user in MySQL rights tables.

Parameters

	$usern	the username (we will add _[alternc-account] to it)
string	$password	The password for this username
string	$passconf	The password confirmation

Returns: boolean if the user has been created in MySQL or FALSE if an error occurred

Definition at line 655 of file m_mysql.php.

                                                     {
         global $db, $msg, $mem, $cuid, $admin;
         $msg->log("mysql", "add_user", $usern);
  
         $usern = trim($usern);
         $login = $mem->user["login"];
         if ($login != $usern) {
             $user = $login . "_" . $usern;
         } else {
             $user = $usern;
         }
         if (!$usern) {
             $msg->raise("ALERT", "mysql", _("The username is mandatory"));
             return false;
         }
         if (!$password) {
             $msg->raise("ALERT", "mysql", _("The password is mandatory"));
             return false;
         }
         if (!preg_match("#^[0-9a-z]#", $usern)) {
             $msg->raise("ERROR", "mysql", _("The username can contain only letters and numbers"));
             return false;
         }
  
         // We check the length of the COMPLETE username, not only the part after _
         $len=variable_get("sql_max_username_length", 16);
         if (strlen($user) > $len) {
             $msg->raise("ERROR", "mysql", _("MySQL username cannot exceed %d characters"), $len);
             return false;
         }
         $db->query("SELECT * FROM dbusers WHERE name= ? ;", array($user));
         if ($db->num_rows()) {
             $msg->raise("ERROR", "mysql", _("The database user already exists"));
             return false;
         }
         if ($password != $passconf || !$password) {
             $msg->raise("ERROR", "mysql", _("The passwords do not match"));
             return false;
         }
  
         // Check this password against the password policy using common API : 
         if (is_callable(array($admin, "checkPolicy"))) {
             if (!$admin->checkPolicy("mysql", $user, $password)) {
                 return false; // The error has been raised by checkPolicy()
             }
         }
  
         // We add him to the user table 
         $db->query("INSERT INTO dbusers (uid,name,password,enable) VALUES( ?, ?, ?, 'ACTIVATED');", array($cuid, $user, $password));
  
         $this->grant("*", $user, "USAGE", $password);
         return true;
     }

References $cuid, $db, $len, $login, $mem, $msg, $password, $user, grant(), and variable_get().

Referenced by add_db().

◆ alternc_add_member()

m_mysql::alternc_add_member ( )

Hook function called when a user is created.

AlternC's standard function that create a member @access private

Definition at line 957 of file m_mysql.php.

                                   {
         global $db, $msg, $cuid, $mem;
         $msg->log("mysql", "alternc_add_member");
         // checking for the phpmyadmin user
         $db->query("SELECT name,password FROM dbusers WHERE uid= ? AND enable='ADMIN';", array($cuid));
         if ($db->num_rows()) {
             $myadm = $db->f("name");
             $password = $db->f("password");
         } else {
             $myadm = $cuid . "_myadm";
             $password = create_pass();
         }
  
         $db->query("INSERT INTO dbusers (uid,name,password,enable) VALUES (?, ?, ?, 'ADMIN');", array($cuid, $myadm, $password));
  
         return true;
     }

References $cuid, $db, $mem, $msg, $password, and create_pass().

◆ alternc_del_member()

m_mysql::alternc_del_member ( )

Hook function called when a user is deleted.

AlternC's standard function that delete a member @access private

Definition at line 981 of file m_mysql.php.

                                   {
         global $msg;
         $msg->log("mysql", "alternc_del_member");
         $c = $this->get_dblist();
         if (is_array($c)) {
             for ($i = 0; $i < count($c); $i++) {
                 $this->del_db($c[$i]["name"]);
             }
         }
         $d = $this->get_userslist(1);
         if (!empty($d)) {
             for ($i = 0; $i < count($d); $i++) {
                 $this->del_user($d[$i]["name"], 1,true);
             }
         }
         return true;
     }

References $c, $d, $i, $msg, del_db(), del_user(), get_dblist(), and get_userslist().

◆ alternc_del_session()

m_mysql::alternc_del_session ( )

Hook function called when a user is logged out.

We just remove the cookie created in admin/sql_admin.php a @access private

Definition at line 1005 of file m_mysql.php.

                                    {
         $_SESSION['PMA_single_signon_user'] = '';
         $_SESSION['PMA_single_signon_password'] = '';
         $_SESSION['PMA_single_signon_host'] = '';
     }

◆ alternc_export_conf()

m_mysql::alternc_export_conf ( )

Exports all the mysql information of an account @access private EXPERIMENTAL 'sid' function ;)

Definition at line 1017 of file m_mysql.php.

                                    {
         // TODO don't work with separated sql server for dbusers
         global $db, $msg, $cuid;
         $msg->log("mysql", "export");
         $db->query("SELECT login, pass, db, bck_mode, bck_dir, bck_history, bck_gzip FROM db WHERE uid= ? ;", array($cuid));
         $str = "";
         if ($db->next_record()) {
             $str.=" <sql>\n";
             $str.="   <login>" . $db->Record["login"] . "</login>\n";
             $str.="   <pass>" . $db->Record["pass"] . "</pass>\n";
             do {
                 $filename = $tmpdir . "/mysql." . $db->Record["db"] . ".sql.gz"; // FIXME not used
                 $str.="   <database>" . ($db->Record["db"]) . "</database>\n";
                 $str.="   <password>" . ($db->Record["pass"]) . "</password>\n";
                 if ($s["bck_mode"] != 0) { // FIXME what is $s ?
                     $str.="   <backup-mode>" . ($db->Record["bck_mode"]) . "</backup-mode>\n";
                     $str.="   <backup-dir>" . ($db->Record["bck_dir"]) . "</backup-dir>\n";
                     $str.="   <backup-history>" . ($db->Record["bck_history"]) . "</backup-history>\n";
                     $str.="   <backup-gzip>" . ($db->Record["bck_gzip"]) . "</backup-gzip>\n";
                 }
             } while ($db->next_record());
             $str.=" </sql>\n";
         }
         return $str;
     }

References $cuid, $db, and $msg.

◆ alternc_export_data()

m_mysql::alternc_export_data ( $dir )

Exports all the mysql databases a of give account to $dir directory @access private EXPERIMENTAL 'sid' function ;)

Definition at line 1049 of file m_mysql.php.

                                        {
         global $db, $msg, $cuid;
         $msg->log("mysql", "export_data");
         $db->query("SELECT db.login, db.pass, db.db, dbusers.name FROM db,dbusers WHERE db.uid= ?  AND dbusers.uid=db.uid;", array($cuid));
         $dir.="sql/";
         if (!is_dir($dir)) {
             if (!mkdir($dir)) {
                 $msg->raise("ERROR", 'mysql', _("The directory could not be created"));
             }
         }
         // on exporte toutes les bases utilisateur.
         while ($db->next_record()) {
             $filename = $dir . "mysql." . $db->Record["db"] . "." . date("H:i:s") . ".sql.gz";
             exec("/usr/bin/mysqldump --defaults-file=/etc/alternc/my.cnf --add-drop-table --allow-keywords -Q -f -q -a -e " . escapeshellarg($db->Record["db"]) . " |/bin/gzip >" . escapeshellarg($filename));
         }
     }

References $cuid, $db, and $msg.

◆ alternc_password_policy()

m_mysql::alternc_password_policy ( )

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

Definition at line 126 of file m_mysql.php.

                                        {
         return array("mysql" => "MySQL users");
     }

◆ available_sql_rights()

m_mysql::available_sql_rights ( )

list of all possible SQL rights

Definition at line 910 of file m_mysql.php.

                                     {
         return Array('select', 'insert', 'update', 'delete', 'create', 'drop', 'references', 'index', 'alter', 'create_tmp', 'lock', 'create_view', 'show_view', 'create_routine', 'alter_routine', 'execute', 'event', 'trigger');
     }

◆ change_user_password()

m_mysql::change_user_password	(	$usern,
		$password,
		$passconf
	)

Change a user's MySQL password.

Parameters

$usern	the username
$password	The password for this username
$passconf	The password confirmation

Returns: boolean if the password has been changed in MySQL or FALSE if an error occurred

Definition at line 717 of file m_mysql.php.

                                                                 {
         global $db, $msg, $cuid, $admin;
         $msg->log("mysql", "change_user_pass", $usern);
  
         $usern = trim($usern);
         if ($password != $passconf || !$password) {
             $msg->raise("ERROR", "mysql", _("The passwords do not match"));
             return false;
         }
  
         // Check this password against the password policy using common API : 
         if (is_callable(array($admin, "checkPolicy"))) {
             if (!$admin->checkPolicy("mysql", $usern, $password)) {
                 return false; // The error has been raised by checkPolicy()
             }
         }
         $this->dbus->query("SET PASSWORD FOR " . $db->quote($usern) . "@" . $db->quote($this->dbus->Client) . " = PASSWORD(?);", array($password));
         $db->query("UPDATE dbusers set password= ? where name= ? and uid= ? ;", array($password, $usern, $cuid));
         return true;
     }

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

◆ del_db()

m_mysql::del_db ( $dbname )

Delete a database for the current user.

Parameters

$dbname string Name of the database to delete. The db name is $user_$dbn

Returns: boolean if the database $user_$db has been successfully deleted, or FALSE if an error occured, such as db does not exist.

Definition at line 318 of file m_mysql.php.

                              {
         global $db, $msg, $cuid;
         $msg->log("mysql", "del_db", $dbname);
         $db->query("SELECT uid FROM db WHERE db= ?;", array($dbname));
         if (!$db->next_record()) {
             $msg->raise("ERROR", "mysql", _("The database was not found. I can't delete it"));
             return false;
         }
  
         // Ok, database exists and dbname is compliant. Let's proceed
         $db->query("DELETE FROM size_db WHERE db= ?;", array($dbname));
         $db->query("DELETE FROM db WHERE uid= ? AND db= ? ;", array($cuid, $dbname));
         $this->dbus->query("DROP DATABASE $dbname;");
  
         $db_esc = str_replace('_', '\_', $dbname);
         $this->dbus->query("DELETE FROM mysql.db WHERE Db= ? ;",    array($db_esc));
  
         // We test if the user created with the database is associated with more than 1 database.
         $this->dbus->query("select User from mysql.db where User= ? ;", array($dbname));
         if (($this->dbus->num_rows()) == 0) {
             // If not we can delete it.
             $this->del_user($dbname, false, true );
         }
         return true;
     }

References $cuid, $db, $msg, and del_user().

Referenced by alternc_del_member().

◆ del_user()

m_mysql::del_user	(	$user,
		$all = `false`,
		$caller_is_deldb = `false`
	)

Delete a user in MySQL rights tables.

Parameters

	$user	the username (we will add "[alternc-account]_" to it) to delete
integer	$all

Returns: boolean if the user has been deleted in MySQL or FALSE if an error occurred

Definition at line 745 of file m_mysql.php.

                                                                      {
         global $db, $msg, $cuid;
         $msg->log("mysql", "del_user", $user);
         if (!preg_match("#^[0-9a-z]#", $user)) {
             $msg->raise("ERROR", "mysql", _("The username can contain only letters and numbers"));
             return false;
         }
         if (!$all) {
             $db->query("SELECT name FROM dbusers WHERE name= ? and enable not in ('ADMIN','HIDDEN');", array($user));
         } else {
             $db->query("SELECT name FROM dbusers WHERE uid= ? ;", array($cuid));
         }
  
         if (!$db->num_rows()) {
             if (! $caller_is_deldb )
                 $msg->raise("ERROR", "mysql", _("The username was not found"));
  
             return false;
         }
         $db->next_record();
         $login = $db->f("name");
  
         // Ok, database exists and dbname is compliant. Let's proceed
         $this->dbus->query("REVOKE ALL PRIVILEGES ON *.* FROM " . $db->quote($user) . "@" . $db->quote($this->dbus->Client) . ";");
         $this->dbus->query("DELETE FROM mysql.db WHERE User= ? AND Host= ? ;", array($user, $this->dbus->Client));
         $this->dbus->query("DELETE FROM mysql.user WHERE User= ? AND Host= ? ;", array($user, $this->dbus->Client));
         $this->dbus->query("FLUSH PRIVILEGES");
  
         $db->query("DELETE FROM dbusers WHERE uid= ? AND name= ? ;", array($cuid, $user));
  
         if ( $caller_is_deldb )
             $msg->raise("INFO", "mysql", _("The user '%s' has been successfully deleted"), $user);
         
         return true;
     }

References $cuid, $db, $login, $msg, and $user.

Referenced by alternc_del_member(), and del_db().

◆ get_db_size()

m_mysql::get_db_size ( $dbname )

Get the size of a database.

Parameters

$dbname name of the database

Returns: integer database size @access private

Definition at line 555 of file m_mysql.php.

                                   {
         $this->dbus->query("SHOW TABLE STATUS FROM $dbname;");
         $size = 0;
         while ($this->dbus->next_record()) {
             $size += $this->dbus->f('Data_length') + $this->dbus->f('Index_length');
             if ($this->dbus->f('Engine') != 'InnoDB') {
                 $size += $this->dbus->f('Data_free');
             }
         }
         return $size;
     }

Referenced by get_mysql_details().

◆ get_dblist()

m_mysql::get_dblist ( )

Get the list of the database for the current user.

Returns: array returns an associative array as follow :
"db" => database name "bck" => backup mode for this db "dir" => Backup folder. Returns an array (empty) if no databases

Definition at line 138 of file m_mysql.php.

                           {
         global $db, $msg, $bro, $cuid;
         $msg->debug("mysql", "get_dblist");
         $db->free();
         $db->query("SELECT login,pass,db, bck_mode, bck_dir FROM db WHERE uid= ? ORDER BY db;", array($cuid));
         $c = array();
         while ($db->next_record()) {
             list($dbu, $dbn) = split_mysql_database_name($db->f("db"));
             $c[] = array("db" => $db->f("db"), "name" => $db->f('db'), "bck" => $db->f("bck_mode"), "dir" => $db->f("bck_dir"), "login" => $db->f("login"), "pass" => $db->f("pass"));
         }
         return $c;
     }

References $bro, $c, $cuid, $db, $msg, and split_mysql_database_name().

Referenced by alternc_del_member(), get_user_dblist(), and hook_quota_get().

◆ get_dbus_size()

m_mysql::get_dbus_size	(	$db_name,
		$db_host,
		$db_login,
		$db_password,
		$db_client
	)

Return the size of each databases in a SQL Host given in parameter.

Parameters

$db_name	the human name of the host
$db_host	the host hosting the SQL databases
$db_login	the login to access the SQL db
$db_password	the password to access the SQL db
$db_client	the client to access the SQL db

Returns: an array associating the name of the databases to their sizes : array(dbname=>size)

Definition at line 1076 of file m_mysql.php.

                                                                                     {
         global $msg;
         $msg->debug("mysql", "get_dbus_size", $db_host);
  
         $this->dbus = new DB_Sql("mysql",$db_host,$db_login,$db_password);
  
         $this->dbus->query("SHOW DATABASES;");
         $alldb=array();
         while ($this->dbus->next_record()) {
             $alldb[] = $this->dbus->f("Database");
         }
  
         $res = array();
         foreach($alldb as $dbname) {
             $c = $this->dbus->query("SHOW TABLE STATUS FROM $dbname;");
             $size = 0;
             while ($this->dbus->next_record()) {
                 $size+=$this->dbus->f("Data_length") + $this->dbus->f("Index_length");
             }
             $res["$dbname"] = "$size";
         }
         return $res;
     }

References $c, $msg, and $res.

◆ get_defaultsparam()

m_mysql::get_defaultsparam ( $dbn )

Definition at line 594 of file m_mysql.php.

                                      {
         global $db, $msg, $cuid;
         $msg->debug("mysql", "getdefaults");
  
         $dbu = $dbn;
         $r = array();
         $dbn = str_replace('_', '\_', $dbn);
         $this->dbus->query("Select * from mysql.db where Db= ? and User!= ? ;", array($dbn, $cuid."_myadm"));
  
         if (!$this->dbus->num_rows()) {
             $msg->raise("ERROR", "mysql",_("Database not found"));
             return false;
         }
  
         $listRights = array('Select', 'Insert', 'Update', 'Delete', 'Create', 'Drop', 'References', 'Index', 'Alter', 'Create_tmp_table', 'Lock_tables', 'Create_view', 'Show_view', 'Create_routine', 'Alter_routine', 'Execute', 'Event', 'Trigger');
         while ($this->dbus->next_record()) {
             // rTmp is the array where we put the informations from each loop, added to array $r
             $rTmp = array();
             $variable = $this->dbus->Record;
             
             $dbu = $variable['User'];
             
             $rTmp['Host'] = $this->dbus->f('Host');
             $rTmp['Rights']='All';
             
             foreach ($listRights as $v) {
                 $right = $v."_priv";
                 if ($this->dbus->f($right) !== "Y") {
                     $rTmp['Rights'] = 'NotAll';
                     break;
                 }
             }
             
             if (!$db->query("SELECT name,password from dbusers where name= ? ;", array($dbu))) {
                 $msg->raise("ERROR", "mysql",_("Database not found")." (3)");
                 return false;
             }
             
             if (!$db->num_rows()) {
                 $msg->raise("ERROR", "mysql",_("Database not found")." (4)");
                 return false;
             }
             
             $db->next_record();
             $rTmp['user'] = $db->f('name');
             $rTmp['password'] = $db->f('password');
             
             $r[] = $rTmp;
             
         } // endwhile
         return $r;
     }

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

◆ get_mysql_details()

m_mysql::get_mysql_details ( $dbn )

Returns the details of a user's database.

$dbn is the name of the database (after the _) or nothing for the database "$user"

Returns: string returns an associative array as follow : "db" => Name of the database "bck" => Current bckup mode "dir" => Backup directory "size" => Size of the database (in bytes) "pass" => Password of the user "history" => Number of backup we keep "gzip" => Does we compress the dumps ? Returns FALSE if the user has no database of if the database does not exist.

Definition at line 194 of file m_mysql.php.

                                      {
         global $db, $msg, $cuid;
         $root = getuserpath();
         $msg->debug("mysql", "get_mysql_details");
         $pos = strpos($dbn, '_');
         if ($pos === false) {
             $dbname = $dbn;
         } else {
             $dbncomp = explode('_', $dbn);
             $dbname = $dbn;
             $dbn = $dbncomp[1];
         }
         $size = $this->get_db_size($dbname);
         $db->query("SELECT login,pass,db, bck_mode, bck_gzip, bck_dir, bck_history FROM db WHERE uid= ? AND db= ?;", array($cuid, $dbname));
         if (!$db->num_rows()) {
             $msg->raise("ERROR", "mysql", _("Database %s not found"), $dbn);
             return array("enabled" => false);
         }
         $db->next_record();
         list($dbu, $dbn) = split_mysql_database_name($db->f("db"));
         return array("enabled" => true, "login" => $db->f("login"), "db" => $db->f("db"), "name" => $dbn, "bck" => $db->f("bck_mode"), "dir" => substr($db->f("bck_dir"), strlen($root)), "size" => $size, "pass" => $db->f("pass"), "history" => $db->f("bck_history"), "gzip" => $db->f("bck_gzip"));
     }

References $cuid, $db, $msg, $root, get_db_size(), getuserpath(), and split_mysql_database_name().

Referenced by restore().

◆ get_user_dblist()

m_mysql::get_user_dblist ( $user )

Return the list of the database rights of user $user.

Parameters

$user the username

Returns: array An array of database name and rights

Definition at line 787 of file m_mysql.php.

                                     {
         global $db, $msg;
  
         $this->dbus->query("SELECT * FROM mysql.user WHERE User= ? AND Host= ? ;", array($user, $this->dbus->Client));
         if (!$this->dbus->next_record()) {
             $msg->raise("ERROR", 'mysql', _("This user does not exist in the MySQL/User database"));
             return false;
         }
  
         $r = array();
         $db->free();
         $dblist = $this->get_dblist();
         foreach ($dblist as $tab) {
             $dbname = str_replace('_', '\_', $tab["db"]);
             $this->dbus->query("SELECT * FROM mysql.db WHERE User= ? AND Host= ? AND Db= ? ;", array($user, $this->dbus->Client, $dbname));
             if ($this->dbus->next_record()) {
                 $r[] = array("db" => $tab["db"], "select" => $this->dbus->f("Select_priv"), "insert" => $this->dbus->f("Insert_priv"), "update" => $this->dbus->f("Update_priv"), "delete" => $this->dbus->f("Delete_priv"), "create" => $this->dbus->f("Create_priv"), "drop" => $this->dbus->f("Drop_priv"), "references" => $this->dbus->f("References_priv"), "index" => $this->dbus->f("Index_priv"), "alter" => $this->dbus->f("Alter_priv"), "create_tmp" => $this->dbus->f("Create_tmp_table_priv"), "lock" => $this->dbus->f("Lock_tables_priv"),
                 "create_view" => $this->dbus->f("Create_view_priv"),
                 "show_view" => $this->dbus->f("Show_view_priv"),
                 "create_routine" => $this->dbus->f("Create_routine_priv"),
                 "alter_routine" => $this->dbus->f("Alter_routine_priv"),
                 "execute" => $this->dbus->f("Execute_priv"),
                 "event" => $this->dbus->f("Event_priv"),
                 "trigger" => $this->dbus->f("Trigger_priv")
                 );
             } else {
                 $r[] = array("db" => $tab['db'], "select" => "N", "insert" => "N", "update" => "N", "delete" => "N", "create" => "N", "drop" => "N", "references" => "N", "index" => "N", "alter" => "N", "create_tmp" => "N", "lock" => "N", "create_view" => "N", "show_view" => "N", "create_routine" => "N", "alter_routine" => "N", "execute" => "N", "event" => "N", "trigger" => "N");
             }
         }
         return $r;
     }

References $db, $msg, $r, $tab, $user, and get_dblist().

◆ get_userslist()

m_mysql::get_userslist ( $all = null )

Returns the list of database users of an account.

Definition at line 571 of file m_mysql.php.

                                         {
         global $db, $msg, $cuid;
         $msg->debug("mysql", "get_userslist");
         $c = array();
         if (!$all) {
             $db->query("SELECT name FROM dbusers WHERE uid= ? and enable not in ('ADMIN','HIDDEN') ORDER BY name;", array($cuid));
         } else {
             $db->query("SELECT name FROM dbusers WHERE uid= ? ORDER BY name;", array($cuid));
         }
         while ($db->next_record()) {
             $pos = strpos($db->f("name"), "_");
             if ($pos === false) {
                 $c[] = array("name" => ($db->f("name")));
             } else {
                 $c[] = array("name" => ($db->f("name")));
                 //$c[]=array("name"=>substr($db->f("name"),strpos($db->f("name"),"_")+1));
             }
         }
  
         return $c;
     }

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

Referenced by alternc_del_member().

◆ grant()

m_mysql::grant	(	$base,
		$user,
		$rights = `null`,
		$pass = `null`,
		$table = `'*'`
	)

Function used to grant SQL rights to users: @base :database @user : database user @rights : rights to apply ( optional, every rights apply given if missing @pass : user password ( optional, if not given the pass stays the same, else it takes the new value ) @table : sql tables to apply rights.

Definition at line 453 of file m_mysql.php.

                                                                              {
         global $msg, $db;
         $msg->log("mysql", "grant", $base . "-" . $rights . "-" . $user);
  
         if (!preg_match("#^[0-9a-z_\\*\\\\]*$#", $base)) {
             $msg->raise("ERROR", "mysql", _("Database name can contain only letters and numbers"));
             return false;
         } elseif (!$this->dbus->query("select db from db where db= ?;", array($base))) {
             $msg->raise("ERROR", "mysql", _("Database not found"));
             return false;
         }
  
         if ($rights == null) {
             $rights = 'ALL PRIVILEGES';
         } elseif (!preg_match("#^[a-zA-Z,\s]*$#", $rights)) {
             $msg->raise("ERROR", "mysql", _("Databases rights are not correct"));
             return false;
         }
  
         if (!preg_match("#^[0-9a-z]#", $user)) {
             $msg->raise("ERROR", "mysql", _("The username can contain only letters and numbers."));
             return false;
         }
         $db->query("select name from dbusers where name= ? ;", array($user));
  
         if (!$db->num_rows()) {
             $msg->raise("ERROR", "mysql", _("Database user not found"));
             return false;
         }
  
         $grant = "grant " . $rights . " on `" . $base . "`." . $table . " to " . $db->quote($user) . "@" . $db->quote($this->dbus->Client);
  
         if ($pass) {
             $grant .= " identified by " . $db->quote($pass) . ";";
         } else {
             $grant .= ";";
         }
  
         if (!$this->dbus->query($grant)) {
             $msg->raise("ERROR", "mysql", _("Could not grant rights"));
             return false;
         }
         return true;
     }

References $db, $msg, $user, and elseif.

Referenced by add_db(), add_user(), and set_user_rights().

◆ hook_lxc_params()

m_mysql::hook_lxc_params ( $params )

Hook function called by the lxc class to set mysql_host and port parameters @access private.

Definition at line 920 of file m_mysql.php.

                                       {
         global $msg;
         $msg->log("mysql", "alternc_get_quota");
         $p = array();
         if (isset($this->dbus["Host"]) && $this->dbus["Host"] != "") {
             $p["mysql_host"] = $this->dbus["Host"];
             $p["mysql_port"] = 3306;
         }
         return $p;
     }

References $msg, and $p.

◆ hook_menu()

m_mysql::hook_menu ( )

Definition at line 92 of file m_mysql.php.

                          {
         global $quota;
         $q = $quota->getquota("mysql");
  
         $obj = array(
             'title' => _("MySQL"),
             'ico' => 'images/mysql.png',
             'link' => 'toggle',
             'pos' => 100,
             'links' => array(),
         );
  
         $obj['links'][] = array(
             'txt' => _("Databases"),
             'url' => "sql_list.php",
         );
         $obj['links'][] = array(
             'txt' => _("MySQL Users"),
             'url' => "sql_users_list.php",
         );
         if ($q["u"] > 0) {
             $obj['links'][] = array(
                 'txt' => _("PhpMyAdmin"),
                 'url' => "sql_pma_sso.php",
                 'target' => '_blank',
             );
         }
         return $obj;
     }

References $q.

◆ hook_quota_get()

m_mysql::hook_quota_get ( )

Hook function called by the quota class to compute user used quota 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 939 of file m_mysql.php.

                               {
         global $msg, $mem, $quota;
         $msg->debug("mysql", "alternc_get_quota");
         $q = Array("name" => "mysql", "description" => _("MySQL Databases"), "used" => 0);
         $c = $this->get_dblist();
         if (is_array($c)) {
             $q['used'] = count($c);
             $q['sizeondisk'] = $quota->get_size_db_sum_user($mem->user["login"])/1024;
         }
         return $q;
     }

References $c, $mem, $msg, $q, and get_dblist().

◆ list_db_servers()

m_mysql::list_db_servers ( )

Definition at line 81 of file m_mysql.php.

                                {
         global $db;
         $db->query("select d.*, IFNULL(count(m.uid),0) as nb_users from db_servers d left join membres m on  d.id = m.db_server_id group by d.id,m.db_server_id order by d.name,d.id;");
         $c = array();
         while ($db->next_record()) {
             $c[] = $db->Record;
         }
         return $c;
     }

References $c, and $db.

◆ php_myadmin_connect()

m_mysql::php_myadmin_connect ( )

Get the login and password of the special user able to connect to phpmyadmin.

Returns: array returns an associative array with login and password Returns FALSE if error

Definition at line 157 of file m_mysql.php.

                                    {
         global $db, $cuid, $msg;
         $msg->log("mysql", "php_myadmin_connect");
         $db->query("SELECT count(0) as count from db where uid = ?;", array($cuid));
         $db->next_record();
         if ($db->f('count') == 0) {
             $msg->raise("ERROR", "mysql", _("Cannot connect to PhpMyAdmin, no databases for user {$cuid}"));
             return false;
         }
         $db->query("SELECT dbu.name,dbu.password, dbs.host FROM dbusers dbu, db_servers dbs, membres m WHERE dbu.uid= ? and enable='ADMIN' and dbs.id=m.db_server_id and m.uid= ? ;", array($cuid, $cuid));
         if (!$db->num_rows()) {
             $msg->raise("ERROR", "mysql", _("Cannot connect to PhpMyAdmin, no admin user for uid {$cuid}"));
             return false;
         }
         $db->next_record();
         $info = array(
             "login" => $db->f("name"),
             "pass" => $db->f("password"),
             "host" => $db->f("host")
         );
         return $info;
     }

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

◆ put_mysql_backup()

m_mysql::put_mysql_backup	(	$dbn,
		$bck_mode,
		$bck_history,
		$bck_gzip,
		$bck_dir
	)

Set the backup parameters for the database $db.

Parameters

$dbn	string database name
$bck_mode	integer Backup mode (0 = none 1 = daily 2 = weekly)
$bck_history	integer How many backup should we keep ?
$bck_gzip	boolean shall we compress the backup ?
$bck_dir	string Directory relative to the user account where the backup will be stored

Returns: boolean true if the backup parameters has been successfully changed, false if not.

Definition at line 354 of file m_mysql.php.

                                                                                   {
         global $db, $msg, $bro, $cuid;
         $msg->log("mysql", "put_mysql_backup");
  
         if (!variable_get('sql_allow_users_backups')) {
             $msg->raise("ERROR", "mysql", _("User aren't allowed to configure their backups"));
             return false;
         }
  
         $pos = strpos($dbn, '_');
         if ($pos === false) {
             $dbname = $dbn;
         } else {
             $dbncomp = explode('_', $dbn);
             $dbname = $dbn;
             $dbn = $dbncomp[1];
         }
         if (!preg_match("#^[0-9a-z]*$#", $dbn)) {
             $msg->raise("ERROR", "mysql", _("Database name can contain only letters and numbers"));
             return false;
         }
         $db->query("SELECT * FROM db WHERE uid= ? AND db= ? ;", array($cuid, $dbname));
         if (!$db->num_rows()) {
             $msg->raise("ERROR", "mysql", _("Database %s not found"), $dbn);
             return false;
         }
         $db->next_record();
         $bck_mode = intval($bck_mode);
         $bck_history = intval($bck_history);
         if ($bck_gzip) {
             $bck_gzip = "1";
         } else {
             $bck_gzip = "0";
         }
         if (!$bck_mode) {
             $bck_mode = "0";
         }
         if (!$bck_history) {
             $msg->raise("ALERT", "mysql", _("You have to choose how many backups you want to keep"));
             return false;
         }
         if (($bck_dir = $bro->convertabsolute($bck_dir, 0)) === false) { // return a full path or FALSE
             $msg->raise("ERROR", "mysql", _("Directory does not exist"));
             return false;
         }
         $db->query("UPDATE db SET bck_mode= ? , bck_history= ?, bck_gzip= ?, bck_dir= ? WHERE uid= ? AND db= ? ;", array($bck_mode, $bck_history, $bck_gzip, $bck_dir, $cuid, $dbname));
         return true;
     }

References $bro, $cuid, $db, $msg, and variable_get().

◆ put_mysql_details()

m_mysql::put_mysql_details ( $password )

Change the password of the user in MySQL.

Parameters

$password string new password (cleartext)

Returns: boolean TRUE if the password has been successfully changed, FALSE else.

Definition at line 409 of file m_mysql.php.

                                           {
         global $db, $msg, $cuid, $admin;
         $msg->log("mysql", "put_mysql_details");
         $db->query("SELECT * FROM db WHERE uid= ?;", array($cuid));
         if (!$db->num_rows()) {
             $msg->raise("ERROR", "mysql", _("Database not found"));
             return false;
         }
         $db->next_record();
         $login = $db->f("login");
  
         if (!$password) {
             $msg->raise("ERROR", "mysql", _("The password is mandatory"));
             return false;
         }
  
         $len=variable_get("sql_max_username_length", 16);
         if (strlen($password) > $len) {
             $msg->raise("ERROR", "mysql", _("MySQL password cannot exceed %d characters"), $len);
             return false;
         }
  
         // Check this password against the password policy using common API : 
         if (is_callable(array($admin, "checkPolicy"))) {
             if (!$admin->checkPolicy("mysql", $login, $password)) {
                 return false; // The error has been raised by checkPolicy()
             }
         }
  
         // Update all the "pass" fields for this user : 
         $db->query("UPDATE db SET pass= ? WHERE uid= ?;", array($password, $cuid));
         $this->dbus->query("SET PASSWORD FOR " .$login . "@" . $this->dbus->Client . "  = PASSWORD(?);", array($password));
         return true;
     }

References $cuid, $db, $len, $login, $msg, $password, and variable_get().

◆ reload_dbus()

m_mysql::reload_dbus ( )

Definition at line 76 of file m_mysql.php.

                            {
         $this->dbus = new DB_users();
     }

◆ restore()

m_mysql::restore	(	$file,
		$stdout,
		$id
	)

Restore a sql database.

Parameters

$file	string The filename, relative to the user root dir, which contains a sql dump
$stdout	boolean shall-we dump the error to stdout ?
$id	integer The ID of the database to dump to.

Returns: boolean TRUE if the database has been restored, or FALSE if an error occurred

Definition at line 506 of file m_mysql.php.

                                           {
         global $msg, $bro;
         if (empty($file)) {
             $msg->raise("ERROR", "mysql", _("No file specified"));
             return false;
         }
         if (!$r = $this->get_mysql_details($id)) {
             return false;
         }
         if (!($fi = $bro->convertabsolute($file, 0))) {
             $msg->raise("ERROR", "mysql", _("File not found"));
             return false;
         }
         if (!file_exists($fi)) {
             $msg->raise("ERROR", "mysql", _("File not found"));
             return false;
         }
  
         if (substr($fi, -3) == ".gz") {
             $exe = "/bin/gzip -d -c <" . escapeshellarg($fi) . " | /usr/bin/mysql -h" . escapeshellarg($this->dbus->Host) . " -u" . escapeshellarg($r["login"]) . " -p" . escapeshellarg($r["pass"]) . " " . escapeshellarg($r["db"]);
         } elseif (substr($fi, -4) == ".bz2") {
             $exe = "/usr/bin/bunzip2 -d -c <" . escapeshellarg($fi) . " | /usr/bin/mysql -h" . escapeshellarg($this->dbus->Host) . " -u" . escapeshellarg($r["login"]) . " -p" . escapeshellarg($r["pass"]) . " " . escapeshellarg($r["db"]);
         } else {
             $exe = "/usr/bin/mysql -h" . escapeshellarg($this->dbus->Host) . " -u" . escapeshellarg($r["login"]) . " -p" . escapeshellarg($r["pass"]) . " " . escapeshellarg($r["db"]) . " <" . escapeshellarg($fi);
         }
         $exe .= " 2>&1";
  
         echo "<code><pre>";
         $ret = 0;
         if ($stdout) {
             passthru($exe, $ret);
         } else {
             exec($exe, $ret);
         }
         echo "</pre></code>";
         if ($ret != 0) {
             return false;
         } else {
             return true;
         }
     }

References $bro, $id, $msg, $r, elseif, and get_mysql_details().

◆ set_user_rights()

m_mysql::set_user_rights	(	$user,
		$dbn,
		$rights
	)

Set the access rights of user $user to database $dbn to be rights $rights.

Parameters

$user	the username to give rights to
$dbn	The database to give rights to
$rights	The rights as an array of MySQL keywords (insert, select ...)

Returns: boolean TRUE if the rights has been applied or FALSE if an error occurred

Definition at line 827 of file m_mysql.php.

                                                    {
         global $msg;
         $msg->log("mysql", "set_user_rights");
  
         // We generate the rights array depending on the rights list:
         $strrights = "";
         for ($i = 0; $i < count($rights); $i++) {
             switch ($rights[$i]) {
             case "select":
                 $strrights.="SELECT,";
                 break;
             case "insert":
                 $strrights.="INSERT,";
                 break;
             case "update":
                 $strrights.="UPDATE,";
                 break;
             case "delete":
                 $strrights.="DELETE,";
                 break;
             case "create":
                 $strrights.="CREATE,";
                 break;
             case "drop":
                 $strrights.="DROP,";
                 break;
             case "references":
                 $strrights.="REFERENCES,";
                 break;
             case "index":
                 $strrights.="INDEX,";
                 break;
             case "alter":
                 $strrights.="ALTER,";
                 break;
             case "create_tmp":
                 $strrights.="CREATE TEMPORARY TABLES,";
                 break;
             case "lock":
                 $strrights.="LOCK TABLES,";
                 break;
             case "create_view":
                 $strrights.="CREATE VIEW,";
                 break;
             case "show_view":
                 $strrights.="SHOW VIEW,";
                 break;
             case "create_routine":
                 $strrights.="CREATE ROUTINE,";
                 break;
             case "alter_routine":
                 $strrights.="ALTER ROUTINE,";
                 break;
             case "execute":
                 $strrights.="EXECUTE,";
                 break;
             case "event":
                 $strrights.="EVENT,";
                 break;
             case "trigger":
                 $strrights.="TRIGGER,";
                 break;
             }
         }
  
         // We reset all user rights on this DB : 
         $dbname = str_replace('_', '\_', $dbn);
         $this->dbus->query("SELECT * FROM mysql.db WHERE User = ? AND Db = ?;", array($user, $dbname));
  
         if ($this->dbus->num_rows()) {
             $this->dbus->query("REVOKE ALL PRIVILEGES ON `".$dbname."`.* FROM ".$this->dbus->quote($user)."@" . $this->dbus->quote($this->dbus->Client) . ";");
         }
         if ($strrights) {
             $strrights = substr($strrights, 0, strlen($strrights) - 1);
             $this->grant($dbname, $user, $strrights);
         }
         $this->dbus->query("FLUSH PRIVILEGES");
         return TRUE;
     }

References $i, $msg, $user, and grant().

Member Data Documentation

◆ $dbus

m_mysql::$dbus

Definition at line 60 of file m_mysql.php.

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

bureau/class/m_mysql.php

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add_db()

◆ add_user()

◆ alternc_add_member()

◆ alternc_del_member()

◆ alternc_del_session()

◆ alternc_export_conf()

◆ alternc_export_data()

◆ alternc_password_policy()

◆ available_sql_rights()

◆ change_user_password()

◆ del_db()

◆ del_user()

◆ get_db_size()

◆ get_dblist()

◆ get_dbus_size()

◆ get_defaultsparam()

◆ get_mysql_details()

◆ get_user_dblist()

◆ get_userslist()

◆ grant()

◆ hook_lxc_params()

◆ hook_menu()

◆ hook_quota_get()

◆ list_db_servers()

◆ php_myadmin_connect()

◆ put_mysql_backup()

◆ put_mysql_details()

◆ reload_dbus()

◆ restore()

◆ set_user_rights()

Member Data Documentation

◆ $dbus