sysPass/inc/common.class.php

<?php
/**
 * sysPass
 *
 * @author nuxsmin
 * @link http://syspass.org
 * @copyright 2012-2014 Rubén Domínguez nuxsmin@syspass.org
 *
 * This file is part of sysPass.
 *
 * sysPass is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * sysPass is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

defined('APP_ROOT') || die(_('No es posible acceder directamente a este archivo'));

/**
 * Esta clase es encargada de ejecutar acciones comunes para las funciones
 */
class SP_Common
{
    /**
     * @brief Enviar un email
     * @param array $message con el nombre de la accióm y el texto del mensaje
     * @param string $mailTo con el destinatario
     * @param bool $isEvent para indicar si es um
     * @return bool
     */
    public static function sendEmail($message, $mailTo = '', $isEvent = true)
    {
        if (!SP_Util::mailIsEnabled()) {
            return false;
        }

        if (!is_array($message)) {
            return false;
        }

        $mail = self::getEmailObject($mailTo, $message['action']);

        if (!is_object($mail)) {
            return false;
        }

        $mail->isHTML();
        $newline = '<br>';

        if ($isEvent === true) {
            $performer = (isset($_SESSION["ulogin"])) ? $_SESSION["ulogin"] : _('N/D');
            $body[] = SP_Html::strongText(_('Acción') . ": ") . $message['action'];
            $body[] = SP_Html::strongText(_('Realizado por') . ": ") . $performer . ' (' . $_SERVER['REMOTE_ADDR'] . ')';

            $mail->addCC(SP_Config::getValue('mail_from'));
        }

        $body[] = (is_array($message['text'])) ? implode($newline, $message['text']) : '';
        $body[] = '';
        $body[] = '--';
        $body[] = SP_Html::getAppInfo('appname') . ' - ' . SP_Html::getAppInfo('appdesc');
        $body[] = SP_Html::anchorText(SP_Init::$WEBURI);


        $mail->Body = implode($newline, $body);

        $sendMail = $mail->send();

        // Enviar correo
        if ($sendMail) {
            $log['text'][] = _('Correo enviado');
        } else {
            $log['text'][] = _('Error al enviar correo');
            $log['text'][] = 'ERROR: ' . $mail->ErrorInfo;
        }

        $log['text'][] = '';
        $log['text'][] = _('Destinatario') . ": $mailTo";
        $log['text'][] = ($isEvent === true) ? _('CC') . ": " . SP_Config::getValue('mail_from') : '';

        $log['action'] = _('Enviar Email');

        SP_Log::wrLogInfo($log);
        return $sendMail;
    }

    /**
     * @brief Inicializar la clase PHPMailer
     * @param string $mailTo con la dirección del destinatario
     * @param string $action con la acción realizada
     * @return object
     */
    public static function getEmailObject($mailTo, $action)
    {
        $appName = SP_Html::getAppInfo('appname');
        $mailFrom = SP_Config::getValue('mail_from');
        $mailServer = SP_Config::getValue('mail_server');
        $mailPort = SP_Config::getValue('mail_port', 25);
        $mailAuth = SP_Config::getValue('mail_authenabled', FALSE);

        if ($mailAuth){
            $mailUser = SP_Config::getValue('mail_user');
            $mailPass = SP_Config::getValue('mail_pass');
        }

        if (!$mailServer) {
            return false;
        }

        if (empty($mailTo)) {
            $mailTo = $mailFrom;
        }

        $phpmailerPath = EXTENSIONS_DIR . DIRECTORY_SEPARATOR . 'phpmailer';
        require_once $phpmailerPath . DIRECTORY_SEPARATOR . 'class.phpmailer.php';
        require_once $phpmailerPath . DIRECTORY_SEPARATOR . 'class.smtp.php';

        $mail = new PHPMailer();

        $mail->isSMTP();
        $mail->CharSet = 'utf-8';
        $mail->SMTPAuth = $mailAuth;
        $mail->Host = $mailServer;
        $mail->Port = $mailPort;
        $mail->Username = $mailUser;
        $mail->Password = $mailPass;
        $mail->SMTPSecure = strtolower(SP_Config::getValue('mail_security'));
        //$mail->SMTPDebug = 2;
        //$mail->Debugoutput = 'error_log';

        $mail->setFrom($mailFrom, $appName);
        $mail->addAddress($mailTo);
        $mail->addReplyTo($mailFrom, $appName);
        $mail->WordWrap = 100;
        $mail->Subject = $appName . ' (' . _('Aviso') . ') - ' . $action;

        return $mail;
    }

    /**
     * @brief Devuelve una respuesta en formato XML con el estado y el mensaje
     * @param string $description mensaje a devolver
     * @param int $status devuelve el estado
     * @return string documento XML
     */
    public static function printXML($description, $status = 1)
    {
        if (!is_string($description)) {
            return false;
        }

        $arrStrFrom = array("&", "<", ">", "\"", "\'");
        $arrStrTo = array("&amp;", "&lt;", "&gt;", "&quot;", "&apos;");

        $cleanDescription = str_replace($arrStrFrom, $arrStrTo, $description);

        $xml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
        $xml .= "<root>\n<status>" . $status . "</status>\n <description>" . $cleanDescription . "</description>\n</root>";

        header("Content-Type: application/xml");
        exit($xml);
    }

    /**
     * @brief Devuelve una respuesta en formato JSON con el estado y el mensaje
     * @param string $description mensaje a devolver
     * @param int $status devuelve el estado
     * @param string $action con la accion a realizar
     * @return string respuesta JSON
     */
    public static function printJSON($description, $status = 1, $action = '')
    {
        if (!is_string($description)) {
            return false;
        }

        $arrStrFrom = array("\\", '"', "'");
        $arrStrTo = array("\\", '\"', "\'");

        $cleanDescription = str_replace($arrStrFrom, $arrStrTo, $description);

        $json = array('status' => $status, 'description' => $cleanDescription, 'action' => $action);

        header('Content-type: application/json');
        exit(json_encode($json));
    }

    /**
     * @brief Devuelve un icono de ayuda con el mensaje
     * @param int $type tipo de mensaje
     * @param int $id id del mensaje
     * @return string con la etiqueta html <img>
     */
    public static function printHelpButton($type, $id)
    {
        $msgHelp[0] = _('Indicar el usuario de conexión a la base de datos de phpPMS');
        $msgHelp[1] = _('Indicar el nombre de la base de datos de phpPMS');
        $msgHelp[2] = _('Indicar el servidor de la base de datos de phpPMS');
        $msgHelp[3] = _('Habilita el nombre de la cuenta de la búsqueda, como enlace a los detalles de la cuenta');
        $msgHelp[4] = _('Número de resultados por página a mostrar, al realizar una búsqueda');
        $msgHelp[5] = _('Habilita la subida/descarga de archivos para las cuentas');
        $msgHelp[6] = _('Establece el tamaño máximo para subir archivos') . "<br><br>" . _('El máximo absuluto es de 16MB');
        $msgHelp[7] = _('Habilita la opción de añadir un enlace a Wiki externa para los resultados de la búsqueda');
        $msgHelp[8] = _('URL que utiliza la wiki para realizar una búsqueda de una página en esta') . "<br><br>" . _('Como parámetro se utiliza el nombre del cliente') . "<br><br>" . _('Ejemplo') . ":<br><br>https://wiki.cygnux.org/search.php?phrase=";
        $msgHelp[9] = _('URL que utiliza la wiki para acceder a los detalles de una página de ésta') . "<br><br>" . _('El nombre de la cuenta se utiliza como parámetro de la variable de búsqueda de la Wiki') . "<br><br>" . _('Ejemplo') . ":<br><br>https://wiki.cygnux.org/show.php?name=";
        $msgHelp[10] = _('Prefijo para determinar qué cuentas tienen un enlace a una página de la Wiki') . "<br><br>" . _('Ejemplos') . ": serv- | srv- | vm-";
        $msgHelp[11] = _('Habilita de autentificación mediante servidor LDAP') . "<br><br>" . _('Este método utilizará MySQL en caso de fallo');
        $msgHelp[12] = _('Usuario para conectar con el servicio de LDAP') . "<br><br>" . _('Ejemplo') . ":<br><br>cn=syspass,ou=Users,dc=cygnux,o=org";
        $msgHelp[13] = _('Base en la que realizar la búsqueda de usuarios de LDAP') . "<br><br>" . _('Ejemplo') . ":<br><br>dc=cygnux,o=org";
        $msgHelp[14] = _('Grupo de LDAP al que debe de pertenecer el usuario para permitir el acceso') . "<br><br>" . _('Ejemplo') . ":<br><br>cn=GRP_SPUSERS,ou=USERS | GRP_SPUSERS";
        $msgHelp[15] = _('Nombre o dirección IP del servidor de LDAP');
        $msgHelp[16] = _('Establece una nueva clave maestra sin re-encriptar las cuentas');
        $msgHelp[17] = _('Clave del usuario de conexión a LDAP');
        $msgHelp[18] = _('En este modo no se puede acceder a la aplicación. Para deshabilitarlo es necesario modificar el archivo de configuración');
        $msgHelp[19] = _('Muestra información relativa a la configuración de la aplicación y rendimiento');
        $msgHelp[20] = _('Guarda las acciones realizadas en la aplicación');
        $msgHelp[21] = _('Comprobar actualizaciones de la aplicación (sólo para los usuarios administradores)');
        $msgHelp[22] = _('Extensiones de máximo 4 caracteres.') . "<br><br>" . _('Escribir extensión y pulsar intro para añadir.');
        $msgHelp[23] = _('Importar desde KeePass o KeePassX. El nombre del cliente será igual a KeePass o KeePassX')."<br><br>"._('Importar desde un archivo CSV con el formato') . ":<br><br>" . _('nombre_de_cuenta;cliente;categoría;url;usuario;clave;notas') . "<br><br>" . _('Si el cliente o la categoría no están creados, se crean automáticamente.');
        $msgHelp[24] = _('Permite que las cuentas sin acceso sean visibles sólo para las búsquedas.');
        $msgHelp[25] = _('Muestra los resultados de búsqueda de cuentas en formato tarjeta.');

        if (array_key_exists($id, $msgHelp)) {
            echo '<img src="imgs/help.png" title="' . $msgHelp[$id] . '" class="inputImgMini" />';
        }
    }

    /**
     * @brief Devuelve un hash para verificación de formularios
     * @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());

        if (!isset($_SESSION["sk"]) || $new === true) {
            $_SESSION["sk"] = $hash;
            return $hash;
        }

        return $_SESSION["sk"];
    }

    /**
     * @brief 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.
     */
    public static function checkSessionKey($key)
    {
        if (!isset($_SESSION["sk"]) || $_SESSION["sk"] == "" || !$key) {
            return false;
        }

        return ($_SESSION["sk"] == $key);
    }

    /**
     * @brief Obtener los valores de peticiones GET o POST y devolver limpios
     * @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
     * @param bool $onlyCHeck opcional, comprobar si el parámetro está presente
     * @param mixed $force opcional, valor devuelto si el parámeto está definido
     * @param bool $sanitize opcional, escapar/eliminar carácteres especiales
     * @return bool|string si está presente el parámeto en la petición devuelve bool. Si lo está, devuelve el valor.
     */
    public static function parseParams($method, $param, $default = '', $onlyCHeck = false, $force = false, $sanitize = true)
    {
        $out = '';

        switch ($method) {
            case 'g':
                if (!isset($_GET[$param])) {
                    return $default;
                }
                $out = $_GET[$param];
                break;
            case 'p':
                if (!isset($_POST[$param])) {
                    return $default;
                }
                $out = $_POST[$param];
                break;
            case 's':
                if (!isset($_SESSION[$param])) {
                    return $default;
                }
                $out = $_SESSION[$param];
                break;
            default :
                return false;
        }

        if ($onlyCHeck) {
            return true;
        }

        if ($force) {
            return $force;
        }

        if (is_numeric($out) && is_numeric($default)) {
            return (int)$out;
        }

        if (is_string($out)) {
            return ($method != 's' && $sanitize === true) ? SP_Html::sanitize($out) : $out;
        }

        if (is_array($out)) {
            return $out;
        }
    }
}