SessionUser.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program 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.
*/

namespace Xoops\Core\Session;

use Xoops\Core\HttpRequest;
use Xoops\Core\Request;

class SessionUser
{

    protected $session;

    protected $xoops = null;

    public function __construct(Manager $session)
    {
        $this->session = $session;
        $this->xoops = \Xoops::getInstance();
    }


    public function establish()
    {
        $session = $this->session;

        // is user already set in session?
        if ($session->has('xoopsUserId')) {
            $this->addUserToSession($session->get('xoopsUserId'));
            return;
        }

        // is the usercookie available?
        $remember = new RememberMe;
        $userId = $remember->recall();
        if (false !== $userId) {
            $this->setNeedsConfirmed();
            $this->addUserToSession($userId);
        }
    }


    public function recordUserLogin($userId, $rememberMe = false)
    {
        $this->setConfirmed();
        $this->addUserToSession($userId);
        if ($rememberMe) {
            $remember = new RememberMe;
            $remember->createUserCookie($userId);
        }
    }

    public function recordUserLogout()
    {
        $remember = new RememberMe;
        $remember->forget();
        $this->session->clearSession();
    }

    public function addUserToSession($userId)
    {
        $session = $this->session;
        $memberHandler = $this->xoops->getHandlerMember();
        $user = $memberHandler->getUser($userId);
        if ($user instanceof \XoopsUser) {
            if ($user->isActive()) {
                // make sure all primary user data is consistent
                $session->set('xoopsUserId', $user->getVar('uid'));
                $session->set('xoopsUserGroups', $user->getGroups());
                if (!$session->has('SESSION_AUTHSTATUS')) {
                    $this->setNeedsConfirmed();
                }
                // all is good, leave the existing info
                return;
            }
        }
        // invalid user - clear everything
        $session->clearSession();
        return;
    }

    public function setNeedsConfirmed()
    {
        $this->session->set('SESSION_AUTHSTATUS', 'confirm');
    }

    public function setConfirmed()
    {
        $this->session->set('SESSION_AUTHSTATUS', 'ok');
    }

    public function checkConfirmed()
    {
        return $this->session->has('xoopsUserId') &&
                ('ok' == $this->session->get('SESSION_AUTHSTATUS', 'failed'));
    }
}