SP\Util\Util

Complexity

Total Complexity

52

Size/Duplication

Total Lines	315
Duplicated Lines	0 %

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getTempDir()	0	25	6
C	randomPassword()	0	62	15
A	logout()	0	3	1
B	boolval()	0	16	7
A	getMaxUpload()	0	7	1
A	generateRandomBytes()	0	3	1
A	getAppLock()	0	9	4
A	getETA()	0	10	3
A	itemsIdAdapter()	0	5	1
A	castToClass()	0	7	2
A	lockApp()	0	5	1
A	unlockApp()	0	3	1
B	unserialize()	0	38	9

<?php
/**
 * sysPass
 *
 * @author    nuxsmin
 * @link      https://syspass.org
 * @copyright 2012-2018, 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/>.
 */

namespace SP\Util;

use Defuse\Crypto\Core;
use Defuse\Crypto\Encoding;

defined('APP_ROOT') || die();

/**
 * Clase con utilizades para la aplicación
 */
final class Util
{
    /**
     * Generar una clave aleatoria
     *
     * @param int  $length     Longitud de la clave
     * @param bool $useNumbers Usar números
     * @param bool $useSpecial Usar carácteres especiales
     * @param bool $checKStrength
     *
     * @return string
     */
    public static function randomPassword($length = 16, $useNumbers = true, $useSpecial = true, $checKStrength = true)
    {
        $charsLower = 'abcdefghijklmnopqrstuwxyz';
        $charsUpper = 'ABCDEFGHIJKLMNOPQRSTUWXYZ';

        $alphabet = $charsLower . $charsUpper;

        if ($useSpecial === true) {
            $charsSpecial = '@$%&/()!_:.;{}^';
            $alphabet .= $charsSpecial;
        }

        if ($useNumbers === true) {
            $charsNumbers = '0123456789';
            $alphabet .= $charsNumbers;
        }

        /**
         * @return array
         */
        $passGen = function () use ($alphabet, $length) {
            $pass = [];
            $alphaLength = strlen($alphabet) - 1; //put the length -1 in cache

            for ($i = 0; $i < $length; $i++) {
                $n = mt_rand(0, $alphaLength);
                $pass[] = $alphabet[$n];
            }

            return $pass;
        };

        if ($checKStrength === true) {
            do {
                $pass = $passGen();
                $strength = ['lower' => 0, 'upper' => 0, 'special' => 0, 'number' => 0];

                foreach ($pass as $char) {
                    if (strpos($charsLower, $char) !== false) {
                        $strength['lower']++;
                    } elseif (strpos($charsUpper, $char) !== false) {
                        $strength['upper']++;
                    } elseif ($useSpecial === true && strpos($charsSpecial, $char) !== false) {

The variable $charsSpecial does not seem to be defined for all execution paths leading up to this point.

                        $strength['special']++;
                    } elseif ($useNumbers === true && strpos($charsNumbers, $char) !== false) {

The variable $charsNumbers does not seem to be defined for all execution paths leading up to this point.

                        $strength['number']++;
                    }
                }

                if ($useSpecial === false) {
                    unset($strength['special']);
                }

                if ($useNumbers === false) {
                    unset($strength['number']);
                }
            } while (in_array(0, $strength, true));

            return implode($pass);
        }

        return implode($passGen());
    }

    /**
     * Generar una cadena aleatoria usuando criptografía.
     *
     * @param int $length opcional, con la longitud de la cadena
     *
     * @return string
     * @throws \Defuse\Crypto\Exception\EnvironmentIsBrokenException
     */
    public static function generateRandomBytes($length = 30)
    {
        return Encoding::binToHex(Core::secureRandom($length));
    }

    /**
     * Comprueba y devuelve un directorio temporal válido
     *
     * @return bool|string
     */
    public static function getTempDir()
    {
        $sysTmp = sys_get_temp_dir();
        $appTmp = APP_PATH . DIRECTORY_SEPARATOR . 'temp';
        $file = 'syspass.test';

        $checkDir = function ($dir) use ($file) {
            if (file_exists($dir . DIRECTORY_SEPARATOR . $file)) {
                return $dir;
            }

            if (is_dir($dir) || @mkdir($dir)) {
                if (touch($dir . DIRECTORY_SEPARATOR . $file)) {
                    return $dir;
                }
            }

            return false;
        };

        if ($checkDir($appTmp)) {
            return $appTmp;
        }

        return $checkDir($sysTmp);
    }

    /**
     * Realiza el proceso de logout.
     *
     * FIXME
     */
    public static function logout()
    {
        exit('<script>sysPassApp.actions.main.logout();</script>');

Using exit here is not recommended.

    }

    /**
     * Obtener el tamaño máximo de subida de PHP.
     */
    public static function getMaxUpload()
    {
        $max_upload = (int)ini_get('upload_max_filesize');
        $max_post = (int)ini_get('post_max_size');
        $memory_limit = (int)ini_get('memory_limit');

        return min($max_upload, $max_post, $memory_limit);
    }

    /**
     * Checks a variable to see if it should be considered a boolean true or false.
     * Also takes into account some text-based representations of true of false,
     * such as 'false','N','yes','on','off', etc.
     *
     * @author Samuel Levy <sam+nospam@samuellevy.com>
     *
     * @param mixed $in     The variable to check
     * @param bool  $strict If set to false, consider everything that is not false to
     *                      be true.
     *
     * @return bool The boolean equivalent or null (if strict, and no exact equivalent)
     */
    public static function boolval($in, $strict = false)
    {
        $in = is_string($in) ? strtolower($in) : $in;

        // if not strict, we only have to check if something is false
        if (in_array($in, ['false', 'no', 'n', '0', 'off', false, 0], true) || !$in) {
            return false;
        }

        if ($strict && in_array($in, ['true', 'yes', 'y', '1', 'on', true, 1], true)) {
            return true;
        }

        // not strict? let the regular php bool check figure it out (will
        // largely default to true)
        return ($in ? true : false);
    }

    /**
     * Cast an object to another class, keeping the properties, but changing the methods
     *
     * @param string        $dstClass Destination class name
     * @param string|object $serialized
     * @param string        $srcClass Old class name for removing from private methods
     *
     * @return mixed
     */
    public static function unserialize($dstClass, $serialized, $srcClass = null)
    {
        if (!is_object($serialized)) {
            $match = preg_match_all('/O:\d+:"(?P<class>[^"]++)"/', $serialized, $matches);

            $process = false;

            if ($match) {
                foreach ($matches['class'] as $class) {
                    if (!class_exists($class)
                        || $class !== $dstClass
                    ) {
                        $process = true;
                    }
                }

                if ($process === false) {
                    return unserialize($serialized);
                }
            }

            // Serialized data needs to be processed to change the class name
            if ($process === true) {
                // If source class is set, it will try to clean up the class name from private methods
                if ($srcClass !== null) {
                    $serialized = preg_replace_callback(
                        '/:\d+:"\x00' . preg_quote($srcClass, '/') . '\x00(\w+)"/',
                        function ($matches) {
                            return ':' . strlen($matches[1]) . ':"' . $matches[1] . '"';
                        },
                        $serialized);
                }

                return self::castToClass($serialized, $dstClass);
            }
        }

        return $serialized;
    }

    /**
     * Cast an object to another class
     *
     * @param $cast
     * @param $class
     *
     * @return mixed
     */
    public static function castToClass($cast, $class)
    {
        // TODO: should avoid '__PHP_Incomplete_Class'?

        $cast = is_object($cast) ? serialize($cast) : $cast;

        return unserialize(preg_replace('/O:\d+:"[^"]++"/', 'O:' . strlen($class) . ':"' . $class . '"', $cast));
    }

    /**
     * Bloquear la aplicación
     *
     * @param int    $userId
     * @param string $subject
     *
     * @return bool
     */
    public static function lockApp($userId, $subject)
    {
        $data = ['time' => time(), 'userId' => (int)$userId, 'subject' => $subject];

        return file_put_contents(LOCK_FILE, json_encode($data));

The expression return file_put_contents(SP\Util\LOCK_FILE, json_encode($data)) returns the type integer which is incompatible with the documented return type boolean.

    }

    /**
     * Desbloquear la aplicación
     *
     * @return bool
     */
    public static function unlockApp()
    {
        return @unlink(LOCK_FILE);
    }

    /**
     * Comprueba si la aplicación está bloqueada
     *
     * @return int
     */
    public static function getAppLock()
    {
        if (file_exists(LOCK_FILE)
            && ($data = file_get_contents(LOCK_FILE)) !== false
        ) {
            return json_decode($data) ?: false;

The expression return json_decode($data) ?: false could also return false which is incompatible with the documented return type integer. Did you maybe forget to handle an error condition?

        }

        return false;

The expression return false returns the type false which is incompatible with the documented return type integer.

    }

    /**
     * Devolver el tiempo aproximado en segundos de una operación
     *
     * @param $startTime
     * @param $numItems
     * @param $totalItems
     *
     * @return array Con el tiempo estimado y los elementos por segundo
     */
    public static function getETA($startTime, $numItems, $totalItems)
    {
        if ($numItems > 0 && $totalItems > 0) {
            $runtime = time() - $startTime;
            $eta = (int)((($totalItems * $runtime) / $numItems) - $runtime);

            return [$eta, $numItems / $runtime];
        }

        return [0, 0];
    }

    /**
     * Adaptador para convertir una cadena de IDs a un array
     *
     * @param string $itemsId
     * @param string $delimiter
     *
     * @return array
     */
    public static function itemsIdAdapter(string $itemsId, $delimiter = ','): array
    {
        return array_map(function ($value) {
            return intval($value);
        }, explode($delimiter, $itemsId));
    }
}