';
+ return '';
}
}
/**
- * @brief Devuelve un hash para verificación de formularios
+ * Devuelve un hash para verificación de formularios.
+ * Esta función genera un hash que permite verificar la autenticidad de un formulario
+ *
* @param bool $new si es necesrio regenerar el hash
* @return string con el hash de verificación
- *
- * Esta función genera un hash que permite verificar la autenticidad de un formulario
*/
public static function getSessionKey($new = false)
{
$hash = sha1(time());
+ // Generamos un nuevo hash si es necesario y lo guardamos en la sesión
if (!isset($_SESSION["sk"]) || $new === true) {
$_SESSION["sk"] = $hash;
return $hash;
@@ -257,7 +263,8 @@ class SP_Common
}
/**
- * @brief Comprobar el hash de verificación de formularios
+ * Comprobar el hash de verificación de formularios.
+ *
* @param string $key con el hash a comprobar
* @return bool|string si no es correcto el hash devuelve bool. Si lo es, devuelve el hash actual.
*/
@@ -271,7 +278,9 @@ class SP_Common
}
/**
- * @brief Obtener los valores de peticiones GET o POST y devolver limpios
+ * Obtener los valores de variables $_GET, $_POST, $_REQUEST o $_SESSION
+ * y devolverlos limpios con el tipo correcto o esperado.
+ *
* @param string $method con el método a utilizar
* @param string $param con el parámetro a consultar
* @param mixed $default opcional, valor por defecto a devolver
@@ -333,4 +342,4 @@ class SP_Common
return $out;
}
}
-}
+}
\ No newline at end of file
diff --git a/inc/config.class.php b/inc/config.class.php
index 7d7ef5b2..614afeba 100644
--- a/inc/config.class.php
+++ b/inc/config.class.php
@@ -4,7 +4,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -49,11 +49,10 @@ class SP_Config
private static $init = false; // La caché está llena??
/**
- * @brief Obtiene un valor desde la configuración en la BBDD
- * @param string $param con el parámetro de configuración
- * @return string con el valor
+ * Obtiene un valor desde la configuración en la BBDD.
*
- * Obtener el valor de un parámetro almacenado en la BBDD
+ * @param string $param con el parámetro de configuración
+ * @return false|string con el valor
*/
public static function getConfigValue($param)
{
@@ -70,9 +69,9 @@ class SP_Config
}
/**
- * @brief Obtener array con la configuración
+ * Obtener un array con la configuración almacenada en la BBDD.
*
- * Obtener un array con la configuración almacenada en la BBDD
+ * @return bool
*/
public static function getConfig()
{
@@ -89,16 +88,14 @@ class SP_Config
$strKey = $config->config_parameter;
$strValue = $config->config_value;
self::$arrConfigValue[$strKey] = $strValue;
-
}
}
/**
- * @brief Guardar la configuración
+ * Guardar la configuración en la BBDD.
+ *
* @param bool $mkInsert realizar un 'insert'?
* @return bool
- *
- * Guardar la configuración en la BBDD
*/
public static function writeConfig($mkInsert = false)
{
@@ -131,7 +128,8 @@ class SP_Config
}
/**
- * @brief Guardar un parámetro de configuración
+ * Guardar un parámetro de configuración en la BBDD.
+ *
* @param string $param con el parámetro a guardar
* @param string $value con el calor a guardar
* @return bool
@@ -159,11 +157,10 @@ class SP_Config
}
/**
- * @brief Cargar la configuración desde la BBDD
+ * Cargar la configuración desde la BBDD a variable global $CFG.
+ *
* @param bool $force reescribir la variable global $CFG?
* @return bool
- *
- * Cargar la configuración desde la BBDD y guardarla en una variable global $CFG
*/
public static function getDBConfig($force = false)
{
@@ -197,13 +194,11 @@ class SP_Config
}
/**
- * @brief Obtiene un valor desde config.php
+ * Obtiene un valor de configuración desde el archivo config.php
+ *
* @param string $key clave
* @param string $default = null valor por defecto
* @return string el valor o $default
- *
- * Esta función obtiene un valor desde config.php. Si no existe,
- * $default será defuelto.
*/
public static function getValue($key, $default = null)
{
@@ -215,10 +210,9 @@ class SP_Config
}
/**
- * @brief Carga el archivo de configuración
- * @return bool
+ * Carga el archivo de configuración y lo guarda en caché.
*
- * Lee el archivo de configuración y lo guarda en caché
+ * @return bool
*/
private static function readData()
{
@@ -246,11 +240,10 @@ class SP_Config
}
/**
- * @brief Lista todas las claves de configuración
+ * Lista todas las claves de configuración guardadas en config.php.
+ *
* @param bool $full obtener todas las claves y sus valores
* @return array con nombres de claves
- *
- * Esta función devuelve todas las claves guardadas en config.php.
*/
public static function getKeys($full = false)
{
@@ -264,12 +257,12 @@ class SP_Config
}
/**
- * @brief Elimina una clave de la configuración
- * @param string $key clave
- * @return bool
- *
+ * Elimina una clave de la configuración.
* Esta función elimina una clave de config.php. Si no tiene permiso
* de escritura en config.php, devolverá false.
+ *
+ * @param string $key clave
+ * @return bool
*/
public static function deleteKey($key)
{
@@ -287,7 +280,8 @@ class SP_Config
}
/**
- * @brief Escribe en archivo de configuración
+ * Escribe en archivo de configuración.
+ *
* @return bool
*/
public static function writeData()
@@ -323,8 +317,7 @@ class SP_Config
}
/**
- * @brief Establece los valores de configuración por defecto en config.php
- * @return none
+ * Establece los valores de configuración por defecto en config.php
*/
public static function setDefaultValues()
{
@@ -354,13 +347,13 @@ class SP_Config
}
/**
- * @brief Establece un valor
+ * Establece un valor en el archivo de configuración.
+ * Esta función establece el valor y reescribe config.php. Si el archivo
+ * no se puede escribir, devolverá false.
+ *
* @param string $key clave
* @param string $value valor
* @return bool
- *
- * Esta función establece el valor y reescribe config.php. Si el archivo
- * no se puede escribir, devolverá false.
*/
public static function setValue($key, $value)
{
diff --git a/inc/crypt.class.php b/inc/crypt.class.php
index b7386f81..6774f51b 100644
--- a/inc/crypt.class.php
+++ b/inc/crypt.class.php
@@ -4,7 +4,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -30,39 +30,35 @@ defined('APP_ROOT') || die(_('No es posible acceder directamente a este archivo'
*/
class SP_Crypt
{
-
- public $strInitialVector;
+ public static $strInitialVector;
/**
- * @brief Comprobar si el módulo de encriptación está disponible
+ * Comprobar si el módulo de encriptación está disponible.
+ *
* @return bool
*/
public static function checkCryptModule()
{
- $resEncDes = mcrypt_module_open('rijndael-256', '', 'cbc', '');
-
- if ($resEncDes == false) {
- return false;
- } else {
- return true;
- }
+ return mcrypt_module_self_test(MCRYPT_RIJNDAEL_256);
}
/**
- * @brief Generar un hash de una clave utilizando un salt
+ * Generar un hash de una clave utilizando un salt.
+ *
* @param string $pwd con la clave a 'hashear'
* @return string con el hash de la clave
*/
public static function mkHashPassword($pwd)
{
- $salt = bin2hex(mcrypt_create_iv(32, MCRYPT_DEV_URANDOM)); // Obtenemos 256 bits aleatorios en hexadecimal
+ $salt = bin2hex(self::getIV()); // Obtenemos 256 bits aleatorios en hexadecimal
$hash = hash("sha256", $salt . $pwd); // Añadimos el salt a la clave y rehacemos el hash
$hashPwd = $salt . $hash;
return $hashPwd;
}
/**
- * @brief Comprobar el hash de una clave
+ * Comprobar el hash de una clave.
+ *
* @param string $pwd con la clave a comprobar
* @param string $correctHash con el hash a comprobar
* @return bool
@@ -86,165 +82,129 @@ class SP_Crypt
}
/**
- * @brief Crear un salt
+ * Crear un salt utilizando mcrypt.
+ *
* @return string con el salt creado
*/
public static function makeHashSalt()
{
- do {
- $cryptIV = self::createIV();
- $blnCheckIv = self::checkIV($cryptIV);
- } while ($blnCheckIv == false);
-
- return $cryptIV;
+ return self::getIV();
}
/**
- * @brief Generar una clave encriptada
+ * Generar una clave encriptada.
+ * Esta función llama a los métodos privados para encriptar datos.
+ *
* @param string $pwd con la clave a encriptar
* @param string $masterPwd con la clave maestra
* @return bool
- *
- * Esta función llama a los métodos privados para encriptar datos.
*/
- public function mkEncrypt($pwd, $masterPwd = "")
+ public static function mkEncrypt($pwd, $masterPwd = "")
{
- $masterPwd = (!$masterPwd) ? $this->getSessionMasterPass() : $masterPwd;
+ $masterPwd = (!$masterPwd) ? self::getSessionMasterPass() : $masterPwd;
- do {
- do {
- $cryptIV = SP_Crypt::createIV();
- $blnCheckIv = SP_Crypt::checkIV($cryptIV);
- } while ($blnCheckIv == false);
-
- $this->strInitialVector = $cryptIV;
-
- $cryptValue = $this->encrypt($pwd, $masterPwd, $cryptIV);
- $blnCheckEncrypted = $this->checkEncryptedPass($cryptValue);
- } while ($blnCheckEncrypted == false);
+ self::$strInitialVector = self::getIV();
+ $cryptValue = self::encrypt($pwd, $masterPwd, self::$strInitialVector);
return $cryptValue;
}
/**
- * @brief Desencriptar la clave maestra de la sesión
+ * Desencriptar la clave maestra de la sesión.
+ *
* @return string con la clave maestra
*/
- public function getSessionMasterPass()
+ public static function getSessionMasterPass()
{
- return $this->decrypt($_SESSION["mPass"], $_SESSION['mPassPwd'], $_SESSION['mPassIV']);
+ return self::getDecrypt($_SESSION["mPass"], $_SESSION['mPassPwd'], $_SESSION['mPassIV']);
}
/**
- * @brief Desencriptar datos con la clave maestra
+ * Desencriptar datos con la clave maestra.
+ *
* @param string $strEncrypted con los datos a desencriptar
* @param string $strPassword con la clave maestra
* @param string $cryptIV con el IV
* @return string con los datos desencriptados
*/
- public function decrypt($strEncrypted, $strPassword, $cryptIV)
+ public static function getDecrypt($strEncrypted, $strPassword, $cryptIV)
{
- $resEncDes = mcrypt_module_open('rijndael-256', '', 'cbc', '');
- mcrypt_generic_init($resEncDes, $strPassword, $cryptIV);
- $strDecrypted = trim(mdecrypt_generic($resEncDes, $strEncrypted));
+ $mcryptRes = self::getMcryptResource();
+ mcrypt_generic_init($mcryptRes, $strPassword, $cryptIV);
+ $strDecrypted = trim(mdecrypt_generic($mcryptRes, $strEncrypted));
- mcrypt_generic_deinit($resEncDes);
- mcrypt_module_close($resEncDes);
+ mcrypt_generic_deinit($mcryptRes);
+ mcrypt_module_close($mcryptRes);
return $strDecrypted;
}
/**
- * @brief Crear el vector de inicialización
+ * Crear el vector de inicialización.
+ *
* @return string con el IV
*/
- private static function createIV()
+ private static function getIV()
{
- $resEncDes = mcrypt_module_open('rijndael-256', '', 'cbc', '');
+ $source = MCRYPT_DEV_URANDOM;
+ $mcryptRes = self::getMcryptResource();
+
if (SP_Util::runningOnWindows() && (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 50300)) {
- $cryptIV = mcrypt_create_iv(mcrypt_enc_get_iv_size($resEncDes), MCRYPT_RAND);
- } else {
- $cryptIV = mcrypt_create_iv(mcrypt_enc_get_iv_size($resEncDes), MCRYPT_DEV_URANDOM);
+ $source = MCRYPT_RAND;
}
- mcrypt_module_close($resEncDes);
+
+ // Crear el IV y asegurar que tiene una longitud de 32 bytes
+ do {
+ $cryptIV = mcrypt_create_iv(mcrypt_enc_get_iv_size($mcryptRes), $source);
+ } while (strlen($cryptIV) < 32);
+
+ mcrypt_module_close($mcryptRes);
return $cryptIV;
}
/**
- * @brief Comprobar si el vector de inicialización tiene la longitud correcta
- * @param string $cryptIV con el IV
- * @return bool
- */
- private static function checkIV($cryptIV)
- {
- $strEscapeInitialVector = DB::escape($cryptIV);
-
- if (strlen($strEscapeInitialVector) != 32) {
- return false;
- } else {
- return true;
- }
- }
-
- /**
- * @brief Encriptar datos con la clave maestra
+ * Encriptar datos con la clave maestra.
+ *
* @param string $strValue con los datos a encriptar
* @param string $strPassword con la clave maestra
* @param string $cryptIV con el IV
* @return string con los datos encriptados
*/
- private function encrypt($strValue, $strPassword, $cryptIV)
+ private static function encrypt($strValue, $strPassword, $cryptIV)
{
- $resEncDes = mcrypt_module_open('rijndael-256', '', 'cbc', '');
- mcrypt_generic_init($resEncDes, $strPassword, $cryptIV);
- $strEncrypted = mcrypt_generic($resEncDes, $strValue);
- mcrypt_generic_deinit($resEncDes);
+ $mcryptRes = self::getMcryptResource();
+
+ mcrypt_generic_init($mcryptRes, $strPassword, $cryptIV);
+ $strEncrypted = mcrypt_generic($mcryptRes, $strValue);
+ mcrypt_generic_deinit($mcryptRes);
return $strEncrypted;
}
/**
- * @brief Comprobar datos encriptados
- * @param string $strEncryptedPass con los datos encriptados
- * @return bool
+ * Generar la clave maestra encriptada con la clave del usuario.
*
- * Esta función comprueba la longitud de los datos encriptados despues de
- * escaparlos con mysqli
- */
- private function checkEncryptedPass($strEncryptedPass)
- {
- $strEscapedEncryptedPass = DB::escape($strEncryptedPass);
-
- if (strlen($strEscapedEncryptedPass) != strlen($strEncryptedPass)) {
- return false;
- } else {
- return true;
- }
- }
-
- /**
- * @brief Generar la clave maestra encriptada con la clave del usuario
* @param string $customPwd con la clave a encriptar
* @param string $masterPwd con la clave maestra
* @return string con la clave encriptada
- *
- * Esta función llama a los métodos privados para encriptar datos.
*/
- public function mkCustomMPassEncrypt($customPwd, $masterPwd)
+ public static function mkCustomMPassEncrypt($customPwd, $masterPwd)
{
- do {
- do {
- $cryptIV = SP_Crypt::createIV();
- $blnCheckIv = SP_Crypt::CheckIV($cryptIV);
- } while ($blnCheckIv == false);
-
- $cryptValue = $this->encrypt($masterPwd, $customPwd, $cryptIV);
- $blnCheckEncrypted = $this->checkEncryptedPass($cryptValue);
- } while ($blnCheckEncrypted == false);
-
+ $cryptIV = self::getIV();
+ $cryptValue = self::encrypt($masterPwd, $customPwd, $cryptIV);
$dataCrypt = array($cryptValue, $cryptIV);
return $dataCrypt;
}
+
+ /**
+ * Método para obtener un recurso del módulo mcrypt.
+ * Se utiliza el algoritmo RIJNDAEL_256 en modo CBC
+ *
+ * @return resource
+ */
+ private static function getMcryptResource(){
+ return mcrypt_module_open(MCRYPT_RIJNDAEL_256, '', MCRYPT_MODE_CBC, '');
+ }
}
\ No newline at end of file
diff --git a/inc/customer.class.php b/inc/customer.class.php
index 087e64d2..0d9e774a 100644
--- a/inc/customer.class.php
+++ b/inc/customer.class.php
@@ -5,7 +5,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -38,7 +38,8 @@ class SP_Customer
public static $customerHash;
/**
- * @brief Crear un nuevo cliente en la BBDD
+ * Crear un nuevo cliente en la BBDD.
+ *
* @return bool
*/
public static function addCustomer()
@@ -63,17 +64,17 @@ class SP_Customer
}
/**
- * @brief Crear un hash con el nombre del cliente
- * @return string con el hash generado
- *
+ * Crear un hash con el nombre del cliente.
* Esta función crear un hash para detectar clientes duplicados mediante
* la eliminación de carácteres especiales y capitalización
+ *
+ * @return string con el hash generado
*/
private static function mkCustomerHash()
{
$charsSrc = array(
- ".", " ", "_", ", ", "-", ";
- ", "'", "\"", ":", "(", ")", "|", "/");
+ ".", " ", "_", ", ", "-", ";",
+ "'", "\"", ":", "(", ")", "|", "/");
$newValue = strtolower(str_replace($charsSrc, '', DB::escape(self::$customerName)));
$hashValue = md5($newValue);
@@ -81,7 +82,8 @@ class SP_Customer
}
/**
- * @brief Actualizar un cliente en la BBDD
+ * Actualizar un cliente en la BBDD.
+ *
* @param int $id con el Id del cliente
* @return bool
*/
@@ -109,7 +111,8 @@ class SP_Customer
}
/**
- * @brief Eliminar un cliente de la BBDD
+ * Eliminar un cliente de la BBDD.
+ *
* @param int $id con el Id del cliente a eliminar
* @return bool
*/
@@ -134,9 +137,10 @@ class SP_Customer
}
/**
- * @brief Obtener el Nombre de un cliente por su Id
+ * Obtener el Nombre de un cliente por su Id.
+ *
* @param int $id con el Id del cliente
- * @return string con el nombre del cliente
+ * @return false|string con el nombre del cliente
*/
public static function getCustomerById($id)
{
@@ -153,7 +157,8 @@ class SP_Customer
}
/**
- * @brief Comprobar si existe un cliente duplicado comprobando el hash
+ * Comprobar si existe un cliente duplicado comprobando el hash.
+ *
* @param int $id opcional con el Id del cliente
* @return bool
*/
@@ -181,8 +186,9 @@ class SP_Customer
}
/**
- * @brief Obtener el Id de un cliente por su nombre
- * @return int con el Id del cliente
+ * Obtener el Id de un cliente por su nombre
+ *
+ * @return false|int Con el Id del cliente
*/
public static function getCustomerByName()
{
@@ -199,7 +205,8 @@ class SP_Customer
}
/**
- * @brief Obtener los datos de un cliente
+ * Obtener los datos de un cliente.
+ *
* @param int $id con el Id del cliente a consultar
* @return array con el nombre de la columna como clave y los datos como valor
*/
@@ -225,7 +232,8 @@ class SP_Customer
}
/**
- * @brief Obtener el listado de clientes
+ * Obtener el listado de clientes.
+ *
* @param int $customerId con el Id del cliente
* @param bool $retAssocArray para devolver un array asociativo
* @return array con el id de cliente como clave y el nombre como valor
@@ -263,11 +271,11 @@ class SP_Customer
}
/**
- * @brief Comprobar si un cliente está en uso
- * @param int $id con el Id del cliente a consultar
- * @return bool
- *
+ * Comprobar si un cliente está en uso.
* Esta función comprueba si un cliente está en uso por cuentas.
+ *
+ * @param int $id con el Id del cliente a consultar
+ * @return int Con el número de cuentas
*/
public static function checkCustomerInUse($id)
{
@@ -276,9 +284,10 @@ class SP_Customer
}
/**
- * @brief Obtener el número de cuentas que usan un cliente
+ * Obtener el número de cuentas que usan un cliente.
+ *
* @param int $id con el Id del cliente a consultar
- * @return integer con el número total de cuentas
+ * @return false|int con el número total de cuentas
*/
private static function getCustomerInAccounts($id)
{
diff --git a/inc/db.class.php b/inc/db.class.php
index 6d3b2e38..468db306 100644
--- a/inc/db.class.php
+++ b/inc/db.class.php
@@ -5,7 +5,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -41,7 +41,8 @@ class DB
private static $_db;
/**
- * @brief Comprobar que la base de datos existe
+ * Comprobar que la base de datos existe.
+ *
* @return bool
*/
public static function checkDatabaseExist()
@@ -69,11 +70,11 @@ class DB
}
/**
- * @brief Realizar la conexión con la BBDD
- * @return bool
- *
+ * Realizar la conexión con la BBDD.
* Esta función utiliza mysqli para conectar con la base de datos.
* Guarda el objeto creado en la variable $_db de la clase
+ *
+ * @return bool
*/
private static function connection()
{
@@ -118,13 +119,14 @@ class DB
}
/**
- * @brief Obtener los datos para generar un select
+ * Obtener los datos para generar un select.
+ *
* @param string $tblName con el nombre de la tabla a cunsultar
* @param string $tblColId con el nombre de la columna del tipo Id a mostrar
* @param string $tblColName con el nombre de la columna del tipo Name a mostrar
* @param array $arrFilter con las columnas a filtrar
* @param array $arrOrder con el orden de las columnas
- * @return array con los valores del select con el Id como clave y el nombre como valor
+ * @return false|array con los valores del select con el Id como clave y el nombre como valor
*/
public static function getValuesForSelect($tblName, $tblColId, $tblColName, $arrFilter = NULL, $arrOrder = NULL)
{
@@ -152,7 +154,8 @@ class DB
}
/**
- * @brief Obtener los resultados de una consulta
+ * Obtener los resultados de una consulta.
+ *
* @param string $query con la consulta a realizar
* @param string $querySource con el nombre de la función que realiza la consulta
* @param bool $retArray devolver un array si la consulta tiene esultados
@@ -181,11 +184,12 @@ class DB
}
/**
- * @brief Realizar una consulta a la BBDD
+ * Realizar una consulta a la BBDD.
+ *
* @param string $query con la consulta a realizar
* @param string $querySource con el nombre de la función que realiza la consulta
* @param bool $unbuffered realizar la consulta para obtener registro a registro
- * @return bool|int devuelve bool si hay un error. Devuelve int con el número de registros
+ * @return false|int devuelve bool si hay un error. Devuelve int con el número de registros
*/
public static function doQuery($query, $querySource, $unbuffered = false)
{
@@ -249,11 +253,10 @@ class DB
}
/**
- * @brief Escapar una cadena de texto
+ * Escapar una cadena de texto con funciones de mysqli.
+ *
* @param string $str con la cadena a escapar
* @return string con la cadena escapada
- *
- * Esta función utiliza mysqli para escapar cadenas de texto.
*/
public static function escape($str)
{
diff --git a/inc/files.class.php b/inc/files.class.php
index 429b9972..3c35bad6 100644
--- a/inc/files.class.php
+++ b/inc/files.class.php
@@ -5,7 +5,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -32,7 +32,8 @@ defined('APP_ROOT') || die(_('No es posible acceder directamente a este archivo'
class SP_Files
{
/**
- * @brief Guardar un archivo en la BBDD
+ * Guardar un archivo en la BBDD.
+ *
* @param int $accountId
* @param array $fileData con los datos y el contenido del archivo
* @return bool
@@ -64,11 +65,11 @@ class SP_Files
}
/**
- * @brief Obtener un archivo desde la BBDD
- * @param int $fileId con el Id del archivo
- * @return object con los datos del archivo
- *
+ * Obtener un archivo desde la BBDD.
* Función para obtener un archivo y pasarlo al navegador como descarga o imagen en línea
+ *
+ * @param int $fileId con el Id del archivo
+ * @return false|object con los datos del archivo
*/
public static function fileDownload($fileId)
{
@@ -89,7 +90,8 @@ class SP_Files
}
/**
- * @brief Eliminar un archivo de la BBDD
+ * Eliminar un archivo de la BBDD.
+ *
* @param int $fileId con el Id del archivo
* @return bool
*/
@@ -119,9 +121,10 @@ class SP_Files
}
/**
- * @brief Obtener información de un archivo almacenado en la BBDD
+ * Obtener información de un archivo almacenado en la BBDD.
+ *
* @param int $fileId con el Id del archivo
- * @return object con el resultado de la consulta
+ * @return false|object con el resultado de la consulta
*/
public static function getFileInfo($fileId)
{
@@ -145,9 +148,10 @@ class SP_Files
}
/**
- * @brief Obtener el listado de archivos de una cuenta
+ * Obtener el listado de archivos de una cuenta.
+ *
* @param int $accountId con el Id de la cuenta
- * @return array con los archivos de la cuenta.
+ * @return false|array con los archivos de la cuenta.
*/
public static function getFileList($accountId)
{
@@ -176,9 +180,10 @@ class SP_Files
}
/**
- * @brief Obtener el número de archivo de una cuenta
+ * Obtener el número de archivo de una cuenta.
+ *
* @param int $accountId con el Id de la cuenta
- * @return int con el número de archivos
+ * @return false|int con el número de archivos
*/
public static function countFiles($accountId)
{
@@ -196,7 +201,8 @@ class SP_Files
/**
- * @brief Elimina los archivos de una cuenta en la BBDD
+ * Elimina los archivos de una cuenta en la BBDD.
+ *
* @param int $accountId con el Id de la cuenta
* @return bool
*/
diff --git a/inc/groups.class.php b/inc/groups.class.php
index 9b655af1..d2ccd473 100644
--- a/inc/groups.class.php
+++ b/inc/groups.class.php
@@ -5,7 +5,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -38,7 +38,8 @@ class SP_Groups
static $queryLastId;
/**
- * @brief Obtener los datos de un grupo
+ * Obtener los datos de un grupo.
+ *
* @param int $id con el Id del grupo a consultar
* @return array con el nombre de la columna como clave y los datos como valor
*/
@@ -64,10 +65,11 @@ class SP_Groups
}
/**
- * @brief Obtener los grupos de usuarios
+ * Obtener los grupos de usuarios.
+ *
* @param int $groupId opcional, con el Id del grupo a consultar
* @param bool $returnArray opcional, si se debe de devolver un array asociativo
- * @return array con la lista de grupos
+ * @return false|array con la lista de grupos
*/
public static function getGroups($groupId = NULL, $returnArray = false)
{
@@ -101,7 +103,8 @@ class SP_Groups
}
/**
- * @brief Comprobar si un grupo existe en la BBDD
+ * Comprobar si un grupo existe en la BBDD.
+ *
* @return bool
*/
public static function checkGroupExist()
@@ -132,7 +135,8 @@ class SP_Groups
}
/**
- * @brief Añadir un nuevo grupo
+ * Añadir un nuevo grupo.
+ *
* @return bool
*/
public static function addGroup()
@@ -157,7 +161,8 @@ class SP_Groups
}
/**
- * @brief Modificar un grupo
+ * Modificar un grupo.
+ *
* @return bool
*/
public static function updateGroup()
@@ -185,7 +190,8 @@ class SP_Groups
}
/**
- * @brief Eliminar un grupo
+ * Eliminar un grupo.
+ *
* @return bool
*/
public static function deleteGroup()
@@ -211,10 +217,9 @@ class SP_Groups
}
/**
- * @brief Comprobar si un grupo está en uso
- * @return array con el número de usuarios/cuentas que usan el grupo
+ * Comprobar si un grupo está en uso por usuarios o cuentas.
*
- * Esta función comprueba si un grupo está en uso por usuarios o cuentas.
+ * @return array con el número de usuarios/cuentas que usan el grupo
*/
public static function checkGroupInUse()
{
@@ -224,8 +229,9 @@ class SP_Groups
}
/**
- * @brief Obtener el número de usuarios que usan un grupo
- * @return int con el número total de cuentas
+ * Obtener el número de usuarios que usan un grupo.
+ *
+ * @return false|int con el número total de cuentas
*/
private static function getGroupInUsers()
{
@@ -243,8 +249,9 @@ class SP_Groups
}
/**
- * @brief Obtener el número de cuentas que usan un grupo como primario
- * @return integer con el número total de cuentas
+ * Obtener el número de cuentas que usan un grupo como primario.
+ *
+ * @return false|int con el número total de cuentas
*/
private static function getGroupInAccounts()
{
@@ -262,8 +269,9 @@ class SP_Groups
}
/**
- * @brief Obtener el número de cuentas que usan un grupo como secundario
- * @return integer con el número total de cuentas
+ * Obtener el número de cuentas que usan un grupo como secundario.
+ *
+ * @return false|int con el número total de cuentas
*/
private static function getGroupInAccountsSec()
{
@@ -281,9 +289,10 @@ class SP_Groups
}
/**
- * @brief Obtener el nombre de un grupo por a partir del Id
+ * Obtener el nombre de un grupo por a partir del Id.
+ *
* @param int $id con el Id del grupo
- * @return string con el nombre del grupo
+ * @return false|string con el nombre del grupo
*/
public static function getGroupNameById($id)
{
@@ -301,9 +310,10 @@ class SP_Groups
}
/**
- * @brief Obtiene el listado con el nombre de los grupos de una cuenta
+ * Obtiene el listado con el nombre de los grupos de una cuenta.
+ *
* @param int $accountId con el Id de la cuenta
- * @return array con los nombres de los grupos ordenados
+ * @return false|array con los nombres de los grupos ordenados
*/
public static function getGroupsNameForAccount($accountId)
{
@@ -329,7 +339,8 @@ class SP_Groups
}
/**
- * @brief Actualizar la asociación de grupos con cuentas
+ * Actualizar la asociación de grupos con cuentas.
+ *
* @param int $accountId con el Id de la cuenta
* @param array $groupsId con los grupos de la cuenta
* @return bool
@@ -344,7 +355,8 @@ class SP_Groups
}
/**
- * @brief Eliminar la asociación de grupos con cuentas
+ * Eliminar la asociación de grupos con cuentas.
+ *
* @param int $accountId con el Id de la cuenta
* @param array $groupsId opcional con los grupos de la cuenta
* @return bool
@@ -371,7 +383,8 @@ class SP_Groups
}
/**
- * @brief Crear asociación de grupos con cuentas
+ * Crear asociación de grupos con cuentas.
+ *
* @param int $accountId con el Id de la cuenta
* @param array $groupsId con los grupos de la cuenta
* @return bool
@@ -413,9 +426,10 @@ class SP_Groups
}
/**
- * @brief Obtiene el listado de grupos de una cuenta
+ * Obtiene el listado de grupos de una cuenta.
+ *
* @param int $accountId con el Id de la cuenta
- * @return array con el Id de grupo
+ * @return false|array con el Id de grupo
*/
public static function getGroupsForAccount($accountId)
{
diff --git a/inc/html.class.php b/inc/html.class.php
index a0cf95a7..feb455dd 100644
--- a/inc/html.class.php
+++ b/inc/html.class.php
@@ -5,7 +5,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -35,13 +35,13 @@ class SP_Html
private static $htmlPage = array();
/**
- * @brief Crear un elemento del tipo SELECT
+ * Crear un elemento del tipo SELECT.
+ * Esta función genera un elemento SELECT con las propiedades y valores pasados.
+ *
* @param array $arrValues con los valores del select
* @param array $arrSelectProp con las propiedades del select
* @param bool $useValue para usar el Id como valor
* @return none
- *
- * Esta función genera un elemento SELECT con las propiedades y valores pasados.
*/
public static function printSelect($arrValues, $arrSelectProp, $useValue = true)
{
@@ -84,12 +84,12 @@ class SP_Html
}
/**
- * @brief Mostrar la página HTML
+ * Mostrar la página HTML.
+ * Esta función es la encargada de devolver el código HTML al navegador.
+ *
* @param string $page opcional con la página a mostar
* @param array $err con los errores generados
* @return none
- *
- * Esta función es la encargada de devolver el código HTML al navegador.
*/
public static function render($page = "main", $err = NULL)
{
@@ -125,10 +125,10 @@ class SP_Html
}
/**
- * @brief Crear el header en HTML
- * @return none
- *
+ * Crear el header en HTML.
* Esta función crea la cabecera de una página HTML
+ *
+ * @return none
*/
private static function makeHeader()
{
@@ -144,7 +144,8 @@ class SP_Html
}
/**
- * @brief Devuelve información sobre la aplicación
+ * Devuelve información sobre la aplicación.
+ *
* @param string $index con la key a devolver
* @return array con las propiedades de la aplicación
*/
@@ -168,7 +169,8 @@ class SP_Html
}
/**
- * @brief Establece los enlaces CSS de la página HTML
+ * Establece los enlaces CSS de la página HTML.
+ *
* @return none
*/
public static function setCss()
@@ -180,7 +182,8 @@ class SP_Html
}
/**
- * @brief Establece los enlaces JAVASCRIPT de la página HTML
+ * Establece los enlaces JAVASCRIPT de la página HTML.
+ *
* @return none
*/
public static function setJs()
@@ -191,11 +194,11 @@ class SP_Html
}
/**
- * @brief Crear el body en HTML
+ * Crear el body en HTML.
+ * Esta función crea el cuerpo de una página HTML
+ *
* @param string $page con la página a cargar
* @return none
- *
- * Esta función crea el cuerpo de una página HTML
*/
private static function makeBody($page)
{
@@ -213,11 +216,10 @@ class SP_Html
}
/**
- * @brief Crear el pie de la página HTML
+ * Crear el pie de la página HTML.
+ *
* @param string $page opcional con la paǵina a mostrar
* @return none
- *
- * Esta función crea el pie de página en HTML
*/
public static function makeFooter($page = "main")
{
@@ -235,7 +237,8 @@ class SP_Html
}
/**
- * @brief Cargar un archivo de plantilla
+ * Cargar un archivo de plantilla.
+ *
* @param string $template con el nombre de la plantilla
* @param array $tplvars con los datos a pasar a la plantilla
* @return none
@@ -252,7 +255,8 @@ class SP_Html
}
/**
- * @brief Crea la barra de navegación para búsqueda de cuentas
+ * Crea la barra de navegación para búsqueda de cuentas.
+ *
* @param int $intSortKey con el número de campo del filro
* @param int $intCur con el número de página actual
* @param int $intTotal con el número total de páginas
@@ -293,7 +297,8 @@ class SP_Html
}
/**
- * @brief Crea la barra de navegación para el registro de eventos
+ * Crea la barra de navegación para el registro de eventos.
+ *
* @param int $intCur con el número de página actual
* @param int $intTotal con el número total de páginas
* @param int $intTime con el tiempo de carga de los resultados
@@ -326,9 +331,10 @@ class SP_Html
}
/**
- * @brief Limpia los datos recibidos de un formulario
+ * Limpia los datos recibidos de un formulario.
+ *
* @param string $data con los datos a limpiar
- * @return string con los datos limpiados
+ * @return false|string con los datos limpiados
*/
public static function sanitize(&$data)
{
@@ -373,7 +379,8 @@ class SP_Html
}
/**
- * @brief Muestra una barra de información con los registros y tiempo de la consulta
+ * Muestra una barra de información con los registros y tiempo de la consulta.
+ *
* @param int $intTotal con el total de registros devueltos
* @param int $startTime con el tiempo de inicio de la consulta
* @return none
@@ -389,7 +396,8 @@ class SP_Html
}
/**
- * @brief Truncar un texto a una determinada longitud
+ * Truncar un texto a una determinada longitud.
+ *
* @param string $str con la cadena a truncar
* @param int $len con la longitud máxima de la cadena
* @return string con el texto truncado
@@ -404,11 +412,11 @@ class SP_Html
}
/**
- * @brief Devolver errores comunes
+ * Devolver errores comunes.
+ * Esta función muestra la página de error con el error indicado.
+ *
* @param string $code con el código de error a mostrar
* @return none
- *
- * Esta función muestra la página de error con el error indicado.
*/
public static function showCommonError($code)
{
@@ -429,11 +437,11 @@ class SP_Html
}
/**
- * @brief Convertir un color RGB a HEX
+ * Convertir un color RGB a HEX
+ * From: http://bavotasan.com/2011/convert-hex-color-to-rgb-using-php/
+ *
* @param array $rgb con color en RGB
* @return string
- *
- * From: http://bavotasan.com/2011/convert-hex-color-to-rgb-using-php/
*/
public static function rgb2hex($rgb)
{
@@ -446,7 +454,8 @@ class SP_Html
}
/**
- * @brief Devolver una tabla con el resultado de una consulta y acciones
+ * Devolver una tabla con el resultado de una consulta y acciones.
+ *
* @param array $arrTableProp con las propiedades de la tabla
* @param array $queryItems con los resultados de la consulta
* @return none
@@ -542,7 +551,8 @@ class SP_Html
}
/**
- * @brief Devolver una cadena con el tag HTML strong
+ * Devolver una cadena con el tag HTML strong.
+ *
* @param string $text con la cadena de texto
* @return string
*/
@@ -552,7 +562,8 @@ class SP_Html
}
/**
- * @brief Devolver un link HTML
+ * Devolver un link HTML.
+ *
* @param string $text con la cadena de texto
* @param string $link con el destino del enlace
* @param string $title con el título del enlace
@@ -568,18 +579,4 @@ class SP_Html
return $anchor;
}
-
- private static function minifier($files)
- {
- if (!is_array($files)) {
- return false;
- }
-
- foreach ($files as $file) {
- //$output_min .= file_get_contents($file['src']);
- include_once SP_Init::$SERVERROOT . DIRECTORY_SEPARATOR . $file['src'];
- }
-
- //return $output_min;
- }
}
diff --git a/inc/import.class.php b/inc/import.class.php
index 14cfa154..e889b808 100644
--- a/inc/import.class.php
+++ b/inc/import.class.php
@@ -5,7 +5,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -68,7 +68,8 @@ class SP_Import
private static $tmpFile;
/**
- * @brief Iniciar la importación de cuentas
+ * Iniciar la importación de cuentas.
+ *
* @param array $fileData con los datos del archivo
* @return array resultado del proceso
*/
@@ -92,7 +93,8 @@ class SP_Import
}
/**
- * @brief Leer los datos del archivo
+ * Leer los datos del archivo.
+ *
* @param array $fileData con los datos del archivo
* @throws ImportException
* @return bool
@@ -143,7 +145,8 @@ class SP_Import
}
/**
- * @brief Leer los datos importados y formatearlos
+ * Leer los datos importados y formatearlos.
+ *
* @throws ImportException
* @return bool
*/
@@ -169,7 +172,8 @@ class SP_Import
}
/**
- * @brief Crear una cuenta con los datos obtenidos
+ * Crear una cuenta con los datos obtenidos.
+ *
* @param array $data con los datos de la cuenta
* @throws ImportException
* @return bool
@@ -219,7 +223,8 @@ class SP_Import
}
/**
- * @brief Encriptar la clave de una cuenta
+ * Encriptar la clave de una cuenta.
+ *
* @param string $password con la clave de la cuenta
* @throws ImportException
* @return array con la clave y el IV
@@ -230,29 +235,28 @@ class SP_Import
return array('pass' => '', 'IV' => '');
}
- $crypt = new SP_Crypt;
-
// Comprobar el módulo de encriptación
if (!SP_Crypt::checkCryptModule()) {
throw new ImportException('critical', _('Error interno'), _('No se puede usar el módulo de encriptación'));
}
// Encriptar clave
- $data['pass'] = $crypt->mkEncrypt($password);
+ $data['pass'] = SP_Crypt::mkEncrypt($password);
if (!empty($password) && ($data['pass'] === false || is_null($data['pass']))) {
throw new ImportException('critical', _('Error interno'), _('Error al generar datos cifrados'));
}
- $data['IV'] = $crypt->strInitialVector;
+ $data['IV'] = SP_Crypt::$strInitialVector;
return $data;
}
/**
- * @brief Leer el archivo de KeePass a un objeto XML
+ * Leer el archivo de KeePass a un objeto XML.
+ *
* @throws ImportException
- * @return bool
+ * @return object Con los datos del archivo XML
*/
private static function readXMLFile()
{
@@ -264,9 +268,10 @@ class SP_Import
}
/**
- * @brief Detectar la aplicación que generó el XML
+ * Detectar la aplicación que generó el XML.
+ *
* @throws ImportException
- * @return bool
+ * @return none
*/
private static function detectXMLFormat()
{
@@ -291,7 +296,8 @@ class SP_Import
}
/**
- * @brief Leer la cabecera del archivo XML y obtener patrones de aplicaciones conocidas
+ * Leer la cabecera del archivo XML y obtener patrones de aplicaciones conocidas.
+ *
* @return bool
*/
private static function parseFileHeader()
diff --git a/inc/init.php b/inc/init.php
index 543b781b..05283950 100644
--- a/inc/init.php
+++ b/inc/init.php
@@ -4,7 +4,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -38,11 +38,11 @@ class SP_Init
private static $SUBURI = '';
/**
- * @brief Inicializar la aplicación
- * @return none
- *
+ * Inicializar la aplicación.
* Esta función inicializa las variables de la aplicación y muestra la página
* según el estado en el que se encuentre.
+ *
+ * @return none
*/
public static function init()
{
@@ -197,7 +197,8 @@ class SP_Init
}
/**
- * SPL autoload
+ * SPL autoload.
+ * Cargador de clases
*/
public static function sysPassAutoload($classname)
{
@@ -212,11 +213,11 @@ class SP_Init
}
/**
- * @brief Establecer las rutas de la aplicación
- * @return none
- *
- * Esta función establece las rutasdel sistema de archivos y web de la aplicación.
+ * Establecer las rutas de la aplicación.
+ * Esta función establece las rutas del sistema de archivos y web de la aplicación.
* La variables de clase definidas son $SERVERROOT, $WEBROOT y $SUBURI
+
+ * @return none
*/
private static function setPaths()
{
@@ -260,10 +261,10 @@ class SP_Init
}
/**
- * @brief Establece el lenguaje de la aplicación
- * @returns none
+ * Establece el lenguaje de la aplicación.
+ * Esta función establece el lenguaje según esté definido en la configuración o en el navegador.
*
- * Esta función establece el lenguaje según esté definidi en la configuración o en el navegador.
+ * @returns none
*/
private static function selectLang()
{
@@ -292,7 +293,8 @@ class SP_Init
}
/**
- * @brief Comprobar el archivo que realiza el include necesita inicialización
+ * Comprobar el archivo que realiza el include necesita inicialización.
+ *
* @returns bool
*/
private static function checkInitSourceInclude()
@@ -304,10 +306,10 @@ class SP_Init
}
/**
- * @brief Comprobar el archivo de configuración.
- * @return none
- *
+ * Comprobar el archivo de configuración.
* Esta función comprueba que el archivo de configuración exista y los permisos sean correctos.
+ *
+ * @return none
*/
private static function checkConfig()
{
@@ -331,7 +333,8 @@ class SP_Init
}
/**
- * @brief Devuelve un eror utilizando la plantilla de rror
+ * Devuelve un eror utilizando la plantilla de rror.
+ *
* @param string $str con la descripción del error
* @param string $hint opcional, con una ayuda sobre el error
* @returns none
@@ -348,10 +351,10 @@ class SP_Init
}
/**
- * @brief Comprueba que la aplicación esté instalada
- * @return none
- *
+ * Comprueba que la aplicación esté instalada
* Esta función comprueba si la aplicación está instalada. Si no lo está, redirige al instalador.
+ *
+ * @return none
*/
private static function checkInstalled()
{
@@ -370,12 +373,12 @@ class SP_Init
}
/**
- * @brief Comprobar si el modo mantenimeinto está activado
- * @param bool $check sólo comprobar si está activado el modo
- * @return bool
- *
+ * Comprobar si el modo mantenimeinto está activado
* Esta función comprueba si el modo mantenimiento está activado.
* Devuelve un error 503 y un reintento de 120s al cliente.
+ *
+ * @param bool $check sólo comprobar si está activado el modo
+ * @return bool
*/
public static function checkMaintenanceMode($check = false)
{
@@ -399,7 +402,8 @@ class SP_Init
}
/**
- * @brief Comrpueba y actualiza la versión de la aplicación
+ * Comrpueba y actualiza la versión de la aplicación.
+ *
* @returns none
*/
private static function checkVersion()
@@ -464,7 +468,8 @@ class SP_Init
}
/**
- * @brief Inicialiar la sesión de usuario
+ * Inicialiar la sesión de usuario
+ *
* @return none
*/
private static function initSession()
@@ -518,8 +523,9 @@ class SP_Init
}
/**
- * @brief Obtener el timeout de sesión desde la configuración
- * @returns int con el tiempo en segundos
+ * Obtener el timeout de sesión desde la configuración.
+ *
+ * @return int con el tiempo en segundos
*/
private static function getSessionLifeTime()
{
@@ -533,7 +539,8 @@ class SP_Init
}
/**
- * @brief Escribir la información de logout en el registro de eventos
+ * Escribir la información de logout en el registro de eventos.
+ *
* @return none
*/
private static function wrLogoutInfo()
@@ -551,8 +558,9 @@ class SP_Init
}
/**
- * @brief Comprobar si hay que ejecutar acciones de URL
- * @return bool
+ * Comprobar si hay que ejecutar acciones de URL.
+ *
+ * @return bool|none
*/
public static function checkRequestActions()
{
@@ -574,7 +582,8 @@ class SP_Init
}
/**
- * @brief Deslogar el usuario actual y eliminar la información de sesión
+ * Deslogar el usuario actual y eliminar la información de sesión.
+ *
* @return none
*/
private static function logout()
@@ -586,7 +595,8 @@ class SP_Init
}
/**
- * @brief Comprobar si el usuario está logado
+ * Comprobar si el usuario está logado.
+ *
* @returns bool
*/
public static function isLoggedIn()
@@ -599,10 +609,10 @@ class SP_Init
}
/**
- * @brief Devuelve el tiempo actual en coma flotante
- * @returns float con el tiempo actual
- *
+ * Devuelve el tiempo actual en coma flotante.
* Esta función se utiliza para calcular el tiempo de renderizado con coma flotante
+ *
+ * @returns float con el tiempo actual
*/
public static function microtime_float()
{
diff --git a/inc/installer.class.php b/inc/installer.class.php
index 4f12ded4..97cda201 100644
--- a/inc/installer.class.php
+++ b/inc/installer.class.php
@@ -5,7 +5,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -75,7 +75,8 @@ class SP_Installer
private static $isHostingMode;
/**
- * @brief Iniciar instalación
+ * Iniciar instalación.
+ *
* @param array $options datos de instalación
* @return array resultado del proceso
*/
@@ -183,15 +184,15 @@ class SP_Installer
}
/**
- * @brief Comprobar la conexión con la BBDD.
+ * Comprobar la conexión con la BBDD.
+ * Comprobar si la conexión con la base de datos para sysPass es posible con
+ * los datos facilitados.
+ *
* @param string $dbhost host de conexión
* @param string $dbadmin usuario de conexión
* @param string $dbpass clave de conexión
* @throws InstallerException
* @return none
- *
- * Comprobar si la conexión con la base de datos para sysPass es posible con
- * los datos facilitados.
*/
private static function checkDatabaseAdmin($dbhost, $dbadmin, $dbpass)
{
@@ -205,11 +206,11 @@ class SP_Installer
}
/**
- * @brief Configurar la base de datos
+ * Configurar la base de datos.
+ * Esta función crea la base de datos y el usuario necesario para sysPass.
+ *
* @throws InstallerException
* @return none
- *
- * Esta función crea la base de datos y el usuario necesario para sysPass.
*/
private static function setupMySQLDatabase()
{
@@ -253,13 +254,13 @@ class SP_Installer
}
/**
- * @brief Crear el usuario para conectar con la base de datos.
+ * Crear el usuario para conectar con la base de datos.
+ * Esta función crea el usuario para conectar con la base de datos.
+ * Si se marca en modo hosting, no se crea el usuario.
+ *
* @param string $dbpassword clave del usuario de sysPass
* @throws InstallerException
* @return none
- *
- * Esta función crea el usuario para conectar con la base de datos.
- * Si se marca en modo hosting, no se crea el usuario.
*/
private static function createDBUser($dbpassword)
{
@@ -277,13 +278,11 @@ class SP_Installer
}
/**
- * @brief Crear la base de datos
+ * Crear la base de datos.
+ *
* @param string $dbpassword clave del usuario de sysPass
* @throws InstallerException
* @return none
- *
- * Esta función crea la base de datos y asigna los permisos para el usuario de sysPass.
- * Si se marca el modo hosting, no se establecen los permisos.
*/
private static function createMySQLDatabase($dbpassword)
{
@@ -309,7 +308,8 @@ class SP_Installer
}
/**
- * @brief Comprobar si la base de datos indicada existe
+ * Comprobar si la base de datos indicada existe.
+ *
* @return bool
*/
private static function checkDatabaseExist()
@@ -333,11 +333,11 @@ class SP_Installer
}
/**
- * @brief Crear la estructura de la base de datos
+ * Crear la estructura de la base de datos.
+ * Esta función crea la estructura de la base de datos a partir del archivo dbsctructure.sql.
+ *
* @throws InstallerException
* @return none
- *
- * Esta función crea la estructura de la base de datos a partir del archivo dbsctructure.sql.
*/
private static function createDBStructure()
{
@@ -376,11 +376,11 @@ class SP_Installer
}
/**
- * @brief Crear el usuario admin de sysPass.
+ * Crear el usuario admin de sysPass.
+ * Esta función crea el grupo, perfil y usuario 'admin' para utilizar sysPass.
+ *
* @throws InstallerException
* @return none
- *
- * Esta función crea el grupo, perfil y usuario 'admin' para utilizar sysPass.
*/
private static function createAdminAccount()
{
@@ -419,7 +419,6 @@ class SP_Installer
"pProfiles" => 1,
"pEventlog" => 1);
-
SP_Profiles::$profileName = 'Admin';
if (!SP_Profiles::addProfile($profileProp)) {
@@ -465,10 +464,10 @@ class SP_Installer
}
/**
- * @brief Deshacer la instalación en caso de fallo
- * @return none
- *
+ * Deshacer la instalación en caso de fallo.
* Esta función elimina la base de datos y el usuario de sysPass
+ *
+ * @return none
*/
private static function rollback()
{
@@ -479,4 +478,4 @@ class SP_Installer
SP_Config::deleteKey('dbpass');
}
-}
+}
\ No newline at end of file
diff --git a/inc/keepassimport.class.php b/inc/keepassimport.class.php
index 85f3cedc..34856aac 100644
--- a/inc/keepassimport.class.php
+++ b/inc/keepassimport.class.php
@@ -5,7 +5,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -33,9 +33,9 @@ class SP_KeePassImport
{
/**
- * @brief Iniciar la importación desde KeePass
+ * Iniciar la importación desde KeePass
* @param object $xml
- * @return bool
+ * @return none
*/
public static function addKeepassAccounts($xml)
{
@@ -43,11 +43,12 @@ class SP_KeePassImport
}
/**
- * @brief Obtener los datos de las entradas de KeePass
+ * Obtener los datos de las entradas de KeePass.
+ *
* @param object $entries con el objeto XML con las entradas
* @param string $groupName con nombre del grupo a procesar
* @throws ImportException
- * @return bool
+ * @return none
*/
private static function getEntryData($entries, $groupName)
{
@@ -79,10 +80,11 @@ class SP_KeePassImport
}
/**
- * @brief Obtener los grupos y procesar lan entradas de KeePass
+ * Obtener los grupos y procesar lan entradas de KeePass.
+ *
* @param object $xml con objeto XML del archivo de KeePass
* @throws ImportException
- * @return bool
+ * @return none
*/
private static function getGroups($xml)
{
diff --git a/inc/keepassximport.class.php b/inc/keepassximport.class.php
index 62174c3b..7b3d5273 100644
--- a/inc/keepassximport.class.php
+++ b/inc/keepassximport.class.php
@@ -5,7 +5,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -33,9 +33,10 @@ class SP_KeePassXImport
{
/**
- * @brief Iniciar la importación desde KeePass
+ * Iniciar la importación desde KeePass.
+ *
* @param object $xml
- * @return bool
+ * @return none
*/
public static function addKeepassXAccounts($xml)
{
@@ -43,11 +44,12 @@ class SP_KeePassXImport
}
/**
- * @brief Obtener los datos de las entradas de KeePass
+ * Obtener los datos de las entradas de KeePass.
+ *
* @param object $entries con el objeto XML con las entradas
* @param string $groupName con nombre del grupo a procesar
* @throws ImportException
- * @return bool
+ * @return none
*/
private static function getEntryData($entries, $groupName)
{
@@ -64,10 +66,11 @@ class SP_KeePassXImport
}
/**
- * @brief Obtener los grupos y procesar lan entradas de KeePass
+ * Obtener los grupos y procesar lan entradas de KeePass.
+ *
* @param object $xml con objeto XML del archivo de KeePass
* @throws ImportException
- * @return bool
+ * @return none
*/
private static function getGroups($xml)
{
diff --git a/inc/ldap.class.php b/inc/ldap.class.php
index 6f4a07b7..a03ae5f7 100644
--- a/inc/ldap.class.php
+++ b/inc/ldap.class.php
@@ -5,7 +5,7 @@
*
* @author nuxsmin
* @link http://syspass.org
- * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
+ * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
*
* This file is part of sysPass.
*
@@ -45,7 +45,8 @@ class SP_LDAP
private static $ldapGroup;
/**
- * @brief Obtener el recurso de conexión a LDAP
+ * Obtener el recurso de conexión a LDAP.
+ *
* @return resource
*/
public static function getConn()
@@ -56,13 +57,14 @@ class SP_LDAP
}
/**
- * @brief Comprobar la conexión al servidor de LDAP
+ * Comprobar la conexión al servidor de LDAP.
+ *
* @param string $ldapServer con la dirección del servidor
* @param string $bindDN con el usuario de conexión
* @param string $bindPass con la clave del usuario de conexión
* @param string $searchBase con la base para las búsquedas
* @param string $ldapGroup con el grupo con los usuarios de acceso
- * @return bool
+ * @return false|int Con el número de entradas encontradas
*/
public static function checkLDAPConn($ldapServer, $bindDN, $bindPass, $searchBase, $ldapGroup)
{
@@ -84,7 +86,8 @@ class SP_LDAP
}
/**
- * @brief Realizar la conexión al servidor de LDAP
+ * Realizar la conexión al servidor de LDAP.
+ *
* @throws Exception
* @return bool
*/
@@ -109,7 +112,8 @@ class SP_LDAP
}
/**
- * @brief Realizar la autentificación con el servidor de LDAP
+ * Realizar la autentificación con el servidor de LDAP.
+ *
* @param string $userDN con el DN del usuario
* @param string $userPass con la clave del usuario
* @throws Exception
@@ -136,7 +140,8 @@ class SP_LDAP
}
/**
- * @brief Realizar una búsqueda de objetos en la ruta indicada
+ * Realizar una búsqueda de objetos en la ruta indicada.
+ *
* @throws Exception
* @return int con el número de resultados
*/
@@ -164,7 +169,8 @@ class SP_LDAP
}
/**
- * @brief Obtener el RDN del grupo
+ * Obtener el RDN del grupo.
+ *
* @throws Exception
* @return string con el RDN del grupo
*/
@@ -222,7 +228,8 @@ class SP_LDAP
}
/**
- * @brief Comprobar si los parámetros necesario de LDAP están establecidos
+ * Comprobar si los parámetros necesario de LDAP están establecidos.
+ *
* @return bool
*/
public static function checkLDAPParams()
@@ -247,7 +254,8 @@ class SP_LDAP
}
/**
- * @brief Obtener el RDN del usuario que realiza el login
+ * Obtener el RDN del usuario que realiza el login.
+ *
* @param string $userLogin con el login del usuario
* @throws Exception
* @return none
@@ -298,7 +306,8 @@ class SP_LDAP
}
/**
- * @brief Realizar la desconexión del servidor de LDAP
+ * Realizar la desconexión del servidor de LDAP.
+ *
* @return none
*/
public static function unbind()
@@ -307,7 +316,8 @@ class SP_LDAP
}
/**
- * @brief Obtener los atributos del usuario
+ * Obtener los atributos del usuario.
+ *
* @param array $attribs con los atributos a obtener
* @return array con los atributos disponibles y sus valores
*/
@@ -337,7 +347,8 @@ class SP_LDAP
}
/**
- * @brief Buscar al usuario en un grupo
+ * Buscar al usuario en un grupo.
+ *
* @param string $userDN con el RDN del usuario
* @throws Exception
* @return bool
@@ -389,7 +400,8 @@ class SP_LDAP
}
/**
- * @brief Escapar carácteres especiales en el RDN de LDAP
+ * Escapar carácteres especiales en el RDN de LDAP.
+ *
* @param string $dn con el RDN del usuario
* @return string
*/
diff --git a/inc/locales/de_DE/LC_MESSAGES/messages.mo b/inc/locales/de_DE/LC_MESSAGES/messages.mo
index d85209a1..7086122e 100644
Binary files a/inc/locales/de_DE/LC_MESSAGES/messages.mo and b/inc/locales/de_DE/LC_MESSAGES/messages.mo differ
diff --git a/inc/locales/de_DE/LC_MESSAGES/messages.po b/inc/locales/de_DE/LC_MESSAGES/messages.po
index 7dfd133e..1c79b6cb 100644
--- a/inc/locales/de_DE/LC_MESSAGES/messages.po
+++ b/inc/locales/de_DE/LC_MESSAGES/messages.po
@@ -8,8 +8,8 @@ msgid ""
msgstr ""
"Project-Id-Version: sysPass\n"
"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2015-01-23 22:33+0100\n"
-"PO-Revision-Date: 2015-01-23 22:34+0100\n"
+"POT-Creation-Date: 2015-01-25 15:35+0100\n"
+"PO-Revision-Date: 2015-01-25 16:00+0100\n"
"Last-Translator: nuxsmin