* Bacula(R) - The Network Backup Solution
* Baculum - Bacula web interface
*
- * Copyright (C) 2013-2015 Marcin Haba
+ * Copyright (C) 2013-2016 Kern Sibbald
*
* The main author of Baculum is Marcin Haba.
* The original author of Bacula is Kern Sibbald, with contributions
Prado::using('Application.Class.Miscellaneous');
+/**
+ * Manage application configuration.
+ * Module is responsible for get/set application config data like:
+ * read/write application config and usersfiles, get application language
+ * and others.
+ *
+ * @author Marcin Haba <marcin.haba@bacula.pl>
+ */
class ConfigurationManager extends TModule
{
/**
- * Location o application configuration file.
+ * Application config file path
*/
const CONFIG_FILE = 'Application.Data.settings';
const USERS_FILE = 'Application.Data.baculum';
/**
- * PostgreSQL default params.
+ * User name allowed characters pattern
+ */
+ const USER_PATTERN = '[a-zA-Z0-9]+';
+
+ /**
+ * PostgreSQL default params
*/
const PGSQL = 'pgsql';
const PGSQL_NAME = 'PostgreSQL';
const PGSQL_PORT = 5432;
/**
- * MySQL default params.
+ * MySQL default params
*/
const MYSQL = 'mysql';
const MYSQL_NAME = 'MySQL';
const MYSQL_PORT = 3306;
/**
- * SQLite default params.
+ * SQLite default params
*/
const SQLITE = 'sqlite';
const SQLITE_NAME = 'SQLite';
const SQLITE_PORT = null;
/**
- * Default language for application.
+ * Default application language
*/
const DEFAULT_LANGUAGE = 'en';
+ /**
+ * Get database name by database type (short name).
+ *
+ * @access public
+ * @param string $type database type ('pgsql', 'mysql' ...)
+ * @return mixed database name or null if database name not found
+ */
public function getDbNameByType($type) {
+ $type = (string) $type;
switch($type) {
- case self::PGSQL: $dbName = self::PGSQL_NAME; break;
- case self::MYSQL: $dbName = self::MYSQL_NAME; break;
- case self::SQLITE: $dbName = self::SQLITE_NAME; break;
- default: $dbName = null; break;
+ case self::PGSQL: $db_name = self::PGSQL_NAME; break;
+ case self::MYSQL: $db_name = self::MYSQL_NAME; break;
+ case self::SQLITE: $db_name = self::SQLITE_NAME; break;
+ default: $db_name = null; break;
}
- return $dbName;
- }
-
- public function getPostgreSQLType() {
- return self::PGSQL;
- }
-
- public function getMySQLType() {
- return self::MYSQL;
- }
-
- public function getSQLiteType() {
- return self::SQLITE;
+ return $db_name;
}
+ /**
+ * Check if given database type is PostgreSQL type.
+ *
+ * @access public
+ * @param string $type database type ('pgsql', 'mysql' ...)
+ * @return boolean true if database type is PostgreSQL, otherwise false
+ */
public function isPostgreSQLType($type) {
return ($type === self::PGSQL);
}
+ /**
+ * Check if given database type is MySQL type.
+ *
+ * @access public
+ * @param string $type database type ('pgsql', 'mysql' ...)
+ * @return boolean true if database type is MySQL, otherwise false
+ */
public function isMySQLType($type) {
return ($type === self::MYSQL);
}
+ /**
+ * Check if given database type is SQLite type.
+ *
+ * @access public
+ * @param string $type database type ('sqlite', 'mysql' ...)
+ * @return boolean true if database type is SQLite, otherwise false
+ */
public function isSQLiteType($type) {
return ($type === self::SQLITE);
}
+ /**
+ * Get currently set application language short name.
+ * If no language set then default language is taken.
+ *
+ * @access public
+ * @return string lanuage short name
+ */
public function getLanguage() {
$language = self::DEFAULT_LANGUAGE;
if ($this->isApplicationConfig() === true) {
- $config = $this->getApplicationConfig();
+ $config = self::getApplicationConfig();
if (array_key_exists('lang', $config['baculum'])) {
$language = $config['baculum']['lang'];
}
return $language;
}
- public function setLanguage($language) {
-
- }
-
/**
- * Saving application configuration.
- *
+ * Save application configuration.
+ *
* @access public
* @param array $config structure of config file params
* @return boolean true if config save is successfully, false if config save is failure
*/
public function setApplicationConfig(array $config) {
- $cfgFile = Prado::getPathOfNamespace(self::CONFIG_FILE, '.conf');
- return ($this->Application->getModule('misc')->writeINIFile($cfgFile, $config) != false);
+ $cfg_file = Prado::getPathOfNamespace(self::CONFIG_FILE, '.conf');
+ return ($this->Application->getModule('misc')->writeINIFile($cfg_file, $config) != false);
}
/**
- * Getting application configuration.
- *
+ * Get application configuration.
+ *
* @access public
* @return array application configuration
*/
public static function getApplicationConfig() {
- $cfgFile = Prado::getPathOfNamespace(self::CONFIG_FILE, '.conf');
- return Miscellaneous::parseINIFile($cfgFile);
+ $cfg_file = Prado::getPathOfNamespace(self::CONFIG_FILE, '.conf');
+ return Miscellaneous::parseINIFile($cfg_file);
}
/**
- * Checking if application configuration file exists.
- *
+ * Check if application configuration file exists.
+ *
* @access public
* @return boolean true if file exists, otherwise false
*/
return file_exists(Prado::getPathOfNamespace(self::CONFIG_FILE, '.conf'));
}
+ /**
+ * Get user name allowed characters pattern
+ *
+ * @access public
+ * @return string user name pattern
+ */
+ public function getUserPattern() {
+ return self::USER_PATTERN;
+ }
+
+ /**
+ * Get encrypted password to use in HTTP Basic auth.
+ *
+ * @access public
+ * @param string $password plain text password
+ * @return string encrypted password
+ */
public function getCryptedPassword($password) {
$enc_pwd = crypt($password, base64_encode($password));
return $enc_pwd;
}
/**
- * Saving user to users configuration file.
- *
- * NOTE!
- * So far by webGUI is possible to set one user.
- * For more users and restricted consoles, there is need to modify
- * users and passwords file.
- *
- * TODO: Support for more than one user setting on webGUI.
+ * Save user to users configuration file.
*
* @access public
* @param string $user username
* @param string $password user's password
- * @param boolean $firstUsage determine if it is first saved user during first Baculum run
- * @param mixed $oldUser previous username before change
+ * @param boolean $first_usage determine if it is first saved user during first Baculum run
+ * @param mixed $old_user previous username before change
* @return boolean true if user saved successfully, otherwise false
*/
- public function setUsersConfig($user, $password, $firstUsage = false, $oldUser = null) {
- $allUsers = $this->getAllUsers();
- $password = $this->getCryptedPassword($password);
-
- if($firstUsage === true) {
+ public function setUsersConfig($user, $password, $first_usage = false, $old_user = null) {
+ if ($first_usage === true) {
$this->clearUsersConfig();
}
- $userExists = array_key_exists($user, $allUsers);
+ $all_users = $this->getAllUsers();
+ $password = $this->getCryptedPassword($password);
+
+ $userExists = array_key_exists($user, $all_users);
if ($userExists === true) {
// update user password;
- $allUsers[$user] = $password;
+ $all_users[$user] = $password;
}
- if(!is_null($oldUser) && $oldUser !== $user) {
+ if (!is_null($old_user) && $old_user !== $user) {
// delete old username with password from configuration file
- if(array_key_exists($oldUser, $allUsers)) {
- unset($allUsers[$oldUser]);
+ if (array_key_exists($old_user, $all_users)) {
+ unset($all_users[$old_user]);
}
}
// add new user if does not exist
- if($userExists === false) {
- $allUsers[$user] = $password;
+ if ($userExists === false) {
+ $all_users[$user] = $password;
}
- $result = $this->saveUserConfig($allUsers);
+ $result = $this->saveUserConfig($all_users);
return $result;
}
+ /**
+ * Read all users from HTTP Basic users file.
+ * Returned value is associative array with usernames as keys
+ * and encrypted passwords as values.
+ *
+ * @access public
+ * @return array users/passwords list
+ */
public function getAllUsers() {
- $allUsers = array();
+ $all_users = array();
if ($this->isUsersConfig() === true) {
- $usersFile = Prado::getPathOfNamespace(self::USERS_FILE, '.users');
- $users = file($usersFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+ $users_file = Prado::getPathOfNamespace(self::USERS_FILE, '.users');
+ $users = file($users_file, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
for($i = 0; $i < count($users); $i++) {
- if(preg_match("/^(?P<user>\S+)\:(?P<hash>\S+)$/", $users[$i], $match) === 1) {
- $allUsers[$match['user']] = $match['hash'];
+ if (preg_match("/^(?P<user>\S+)\:(?P<hash>\S+)$/", $users[$i], $match) === 1) {
+ $all_users[$match['user']] = $match['hash'];
}
}
}
- return $allUsers;
+ return $all_users;
}
- public function saveUserConfig($allUsers) {
+ /**
+ * Save HTTP Basic users file.
+ * Given parameter is associative array with usernames as keys
+ * and encrypted passwords as values.
+ *
+ * @access public
+ * @param array $all_users users/passwords list
+ * @return boolean true if users file saved successfully, otherwise false
+ */
+ public function saveUserConfig($all_users) {
$users = array();
- foreach ($allUsers as $user => $pwd) {
+ foreach ($all_users as $user => $pwd) {
$users[] = "$user:$pwd";
}
- $usersFile = Prado::getPathOfNamespace(self::USERS_FILE, '.users');
+ $users_file = Prado::getPathOfNamespace(self::USERS_FILE, '.users');
$usersToFile = implode("\n", $users);
$old_umask = umask(0);
umask(0077);
- $result = file_put_contents($usersFile, $usersToFile) !== false;
+ $result = file_put_contents($users_file, $usersToFile) !== false;
umask($old_umask);
return $result;
}
+ /**
+ * Remove single user from HTTP Basic users file.
+ * Note, this method saves config file if username was existed
+ * before removing.
+ *
+ * @access public
+ * @param string $username user name to remove
+ * @return boolean true if users file saved successfully, otherwise false
+ */
public function removeUser($username) {
$result = false;
- $allUsers = $this->getAllUsers();
- if (array_key_exists($username, $allUsers)) {
- unset($allUsers[$username]);
- $result = $this->saveUserConfig($allUsers);
+ $all_users = $this->getAllUsers();
+ if (array_key_exists($username, $all_users)) {
+ unset($all_users[$username]);
+ $result = $this->saveUserConfig($all_users);
}
return $result;
}
/**
- * Checking if users configuration file exists.
+ * Check if users configuration file exists.
*
* @access public
* @return boolean true if file exists, otherwise false
/**
* Clear all content of users file.
*
- * @access private
+ * @access public
* @return boolean true if file cleared successfully, otherwise false
*/
- private function clearUsersConfig() {
- $usersFile = Prado::getPathOfNamespace(self::USERS_FILE, '.users');
- $result = file_put_contents($usersFile, '') !== false;
+ public function clearUsersConfig() {
+ $users_file = Prado::getPathOfNamespace(self::USERS_FILE, '.users');
+ $result = file_put_contents($users_file, '') !== false;
return $result;
}
+ /**
+ * Log in as specific user.
+ *
+ * Note, usually after this method call there required is using exit() just
+ * after method execution. Otherwise the HTTP redirection may be canceled on some
+ * web servers.
+ *
+ * @access public
+ * @param string $http_protocol 'http' or 'https' value
+ * @param string $host hostname without port, for example: my.own.host or localhost
+ * @param integer $port port number on which listens web server
+ * @param string $user user name to log in
+ * @param string $string plain text user's password
+ * @return none
+ */
public function switchToUser($http_protocol, $host, $port, $user, $password) {
- $urlPrefix = $this->Application->getModule('friendly-url')->getUrlPrefix();
- $location = sprintf("%s://%s:%s@%s:%d%s", $http_protocol, $user, $password, $host, $port, $urlPrefix);
+ $url_prefix = $this->Application->getModule('friendly-url')->getUrlPrefix();
+ $location = sprintf("%s://%s:%s@%s:%d%s", $http_protocol, $user, $password, $host, $port, $url_prefix);
+ $refresh_url = sprintf("%s://%s:%d%s", $http_protocol, $host, $port, $url_prefix);
+
+ /**
+ * Refresh page is required due to lack of auth data in $_SERVER superglobal array
+ * after re-login by URI.
+ */
+ $_SESSION['refresh_page'] = $refresh_url;
+
+ // Log in by header
header("Location: $location");
}
+ /**
+ * Get (pseudo)random string.
+ *
+ * Useful for log out user from HTTP Basic auth by providing random password.
+ *
+ * @access public
+ * @return string random 62 characters string from range [a-zA-Z0-9]
+ */
public function getRandomString() {
$characters = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
$rand_string = str_shuffle($characters);
projects / bacula / bacula / blobdiff