sysPass/lib/SP/Util/Util.php

<?php
/*
 * sysPass
 *
 * @author nuxsmin
 * @link https://syspass.org
 * @copyright 2012-2024, 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 JetBrains\PhpStorm\NoReturn;
use JsonException;
use SP\Infrastructure\File\FileException;
use SP\Infrastructure\File\FileHandler;

use function SP\logger;

/**
 * Clase con utilizades para la aplicación
 */
final class Util
{
    /**
     * Realiza el proceso de logout.
     *
     * FIXME
     */
    #[NoReturn] public static function logout(): void
    {
        exit('<script>sysPassApp.actions.main.logout();</script>');
    }

    /**
     * Obtener el tamaño máximo de subida de PHP.
     */
    public static function getMaxUpload(): int
    {
        return min(
            self::convertShortUnit(ini_get('upload_max_filesize')),
            self::convertShortUnit(ini_get('post_max_size')),
            self::convertShortUnit(ini_get('memory_limit'))
        );
    }

    public static function convertShortUnit(string $value): int
    {
        if (preg_match('/(\d+)(\w+)/', $value, $match)) {
            switch (strtoupper($match[2])) {
                case 'K':
                    return (int)$match[1] * 1024;
                case 'M':
                    return (int)$match[1] * (1024 ** 2);
                case 'G':
                    return (int)$match[1] * (1024 ** 3);
            }
        }

        return (int)$value;
    }

    /**
     * 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.
     *
     * @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)
     * @author Samuel Levy <sam+nospam@samuellevy.com>
     *
     */
    public static function boolval(mixed $in, bool $strict = false): bool
    {
        $in = is_string($in) ? strtolower($in) : $in;

        // if not strict, we only have to check if something is false
        if (!$in
            || in_array($in, ['false', 'no', 'n', '0', 'off', false, 0], true)
        ) {
            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 (bool)$in;
    }

    /**
     * Bloquear la aplicación
     *
     * @throws JsonException
     * @throws FileException
     */
    public static function lockApp(int $userId, string $subject): void
    {
        $data = ['time' => time(), 'userId' => $userId, 'subject' => $subject];

        $file = new FileHandler(LOCK_FILE);
        $file->save(json_encode($data, JSON_THROW_ON_ERROR));

        logger('Application locked out');
    }

    /**
     * Desbloquear la aplicación
     */
    public static function unlockApp(): bool
    {
        logger('Application unlocked');

        return @unlink(LOCK_FILE);
    }

    /**
     * Comprueba si la aplicación está bloqueada
     *
     * @return bool|string
     * @throws JsonException
     */
    public static function getAppLock(): bool|string
    {
        try {
            $file = new FileHandler(LOCK_FILE);

            return json_decode(
                $file->readToString(),
                false,
                512,
                JSON_THROW_ON_ERROR
            );
        } catch (FileException) {
            return false;
        }
    }

    /**
     * Devolver el tiempo aproximado en segundos de una operación
     *
     * @return array Con el tiempo estimado y los elementos por segundo
     */
    public static function getETA(int $startTime, int $numItems, int $totalItems): array
    {
        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
     */
    public static function itemsIdAdapter(string $itemsId, string $delimiter = ','): array
    {
        return array_map(
            static function ($value) {
                return (int)$value;
            },
            explode($delimiter, $itemsId)
        );
    }

    public static function getMaxDownloadChunk(): int
    {
        return self::convertShortUnit(ini_get('memory_limit')) / FileHandler::CHUNK_FACTOR;
    }
}