XetaIO / Xeta

src/Controller/Component/SessionsActivityComponent.php

<?php
namespace App\Controller\Component;

use App\Model\Entity\User;
use Cake\Controller\Component;
use Cake\Event\Event;
use Cake\I18n\Time;
use Cake\ORM\Entity;
use Cake\ORM\TableRegistry;

class SessionsActivityComponent extends Component
{

    /**
     * Request object
     *
     * @var \Cake\Network\Request
     */
    protected $_request;

    /**
     * Instance of the Session object
     *
     * @return void
     */
    protected $_session;

    /**
     * Initialize properties.
     *
     * @param array $config The config data.
     *
     * @return void
     */
    public function initialize(array $config)
    {
        $controller = $this->_registry->getController();
        $this->_request = $controller->request;
        $this->_session = $controller->request->session();
    }

    /**
     * Startup event to trace the user on the website.
     *
     * @param Event $event The event that was fired.
     *
     * @return void
     */
    public function startup(Event $event)

The parameter $event is not used and could be removed.

    {
        if (empty($this->_session->id())) {
            $this->_session->start();

            return;
        }
        $sessions = TableRegistry::get('Sessions');

        $prefix = isset($this->_request['prefix']) ? $this->_request['prefix'] . '/' : '';
        $controller = $prefix . $this->_request['controller'];
        $action = $this->_request['action'];
        $params = serialize($this->_request->pass);
        $expires = time() + ini_get('session.gc_maxlifetime');

        //@codingStandardsIgnoreStart
        $user_id = $this->_session->read('Auth.User.id');
        $user_agent = $this->_request->env('HTTP_USER_AGENT');
        $user_ip = $this->_request->clientIp();
        $full_url = $this->_request->url;
        //@codingStandardIgnoreEnd

        $modified = new Time();

        $record = compact('controller', 'action', 'params', 'expires', 'user_id', 'user_agent', 'user_ip', 'full_url', 'modified');

        $record[$sessions->primaryKey()] = $this->_session->id();
        $sessions->save(new Entity($record));
    }

    /**
     * Get the list of the users online.
     *
     * @return array
     */
    public function getOnlineUsers()
    {
        $sessions = TableRegistry::get('Sessions');

        $output = [
            'guests' => 0,
            'members' => 0,
        ];

        $records = $sessions
            ->find('expires')
            ->contain([
                'Users' => function ($q) {
                    return $q->select([
                        'id',
                        'username'
                    ]);
                },
                'Users.Groups' => function ($q) {
                    return $q->select(['css', 'is_member']);
                },
            ])
            ->select(['Sessions.user_id', 'Sessions.expires'])
            ->group('Sessions.user_id')
            ->toArray();

        foreach ($records as $key => $record) {
            if (is_null($record->user_id)) {
                $output['guests']++;

                unset($records[$key]);
                continue;
            } else {
                $output['members']++;
            }
        }

        //Total visitors.
        $output['total'] = $output['guests'] + $output['members'];

        //Visitor records.
        $output['records'] = $records;

        return $output;
    }

    /**
     * Determine if the given user is online or offline.
     *
     * @param \App\Model\Entity\User $user The user to check.
     *
     * @return bool
     */
    public function getOnlineStatus(User $user)
    {
        $sessions = TableRegistry::get('Sessions');
        $online = $sessions
            ->find('expires')
            ->select(['Sessions.expires', 'Sessions.user_id'])
            ->where([
                'Sessions.user_id' => $user->id
            ])
            ->first();

        if (!empty($online)) {
            return true;
        }

        return false;
    }

    /**
     * Get all the sessions online for the given user.
     *
     * @param int $user The user id.
     *
     * @return false|array
     */
    public function getOnlineSessionsForUser($user)
    {
        if (empty($user) || is_null($user)) {
            return false;
        }

        $this->Sessions = TableRegistry::get('Sessions');

        $sessions = $this->Sessions
            ->find('expires')
            ->where([
                'Sessions.user_id' => $user
            ])
            ->toArray();

        return $sessions;
    }

}