lepton_session.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
class LEPTON_session
{
    use LEPTON_singleton;
 
    public static $instance;
 
    // Default constructor of the class
    final public function __construct()
    {
        // return the class instance
        //return self::getInstance();
    }
 
    public static function set_cookie (
        string $name,
        string|int $value,
        array $options = [],
        bool $mustExists = false,
        bool $mergeDefault = true
    ): bool
    {
        // check if name exists in $_COOKIE
        if ((true === $mustExists ) && (false === isset($_COOKIE[ $name ])))
        {
            return false;
        }
 
        // clear options, remove empty settings
        $temp = $options;
        $options = [];
        foreach( $temp as $optkey => $optvalue )
        {
            if ($optvalue != "")
            {
                $options[$optkey] = $optvalue;
            }
        }
 
        // merge options array with defaults
        if (true === $mergeDefault )
        {
            $defaults = self::get_cookie_defaults();
            $options = array_merge($defaults, $options);
        }
 
        //  Update cookie settings, see: https://www.php.net/manual/de/function.setcookie.php
        $cookie = setcookie($name, $value, $options);
        
        return $cookie;
    }
 
    public static function deleteCookieSession(string $name, string|int $value = "", array $options = []): bool
    {
        // check if name exists in $_COOKIE
        if (false === isset($_COOKIE[$name]))
        {
            return false;    // not exists means also cookie not exists
        }
 
        // overwrite session array
        $_SESSION = [];
 
        // set/overwrite expire option
        $options["expires"] = 1;    // 01.01.1970 00:00:01
 
        // delete session cookie if set
        $returnVal = self::set_cookie($name, $value, $options);
 
        // overwrite session array again
        $_SESSION = [];
 
        // delete the session itself
        session_destroy();
 
        return $returnVal;
    }
 
    public static function get_cookie_defaults(): array
    {
        $iniValues = self::getConfigValuesFromIni();
        
        // return the defaults
        return [
            "expires" => time() + ($iniValues['lifetime'] ?? (3 * 3600)), // three hours
 
            "path" => "/",
 
            "domain" => "",
 
            "secure" => (isset($_SERVER['HTTPS'])
                    ? (strtolower( $_SERVER['HTTPS'] )  == "on") // bool
                    : false
            ),
 
            "httponly" => $iniValues['httponly'] ?? true,
 
            "samesite" => $iniValues['samesite'] ?? "Lax"
        ];
    }
 
 
    public static function getConfigValuesFromIni(): array
    {
        $vals = [
            'samesite' => ['type' => 'string', 'default' => 'Lax', 'range' => ['none', 'lax', 'strict']],
            'httponly' => ['type' => 'bool', 'default' => true],
            'lifetime' => ['type' => 'integer_eval', 'default' => (3*3600)],
            'domain'   => ['type' => 'string', 'default' => '/']
        ];
        $returnValues = [];
        $ini_file_name = LEPTON_PATH . "/config/lepton.ini.php";
        if (true === file_exists($ini_file_name))
        {
            $config = parse_ini_string(";" . file_get_contents($ini_file_name), true);
            if (isset($config['lepton_cookie']))
            {
                foreach($config['lepton_cookie'] as $key => $value)
                {
                    $returnValues[$key] = $value;
                }
            }
        }
 
        $oREQUEST = LEPTON_request::getInstance();
        
        foreach ($returnValues as $key => &$val)
        {
            if (isset($vals[$key]))
            {
                $val = $oREQUEST->filterValue(
                    $val,
                    $vals[$key]['type'],
                    $vals[$key]['default'],
                    $vals[$key]['range'] ?? ''
                );
            }
        }
        return $returnValues;
    }
}