CoreFiles by mySites.guru
KeepaliveAssetItem.php63 lines, 2,017 bytes, from Joomla_6.0.2-Stable-Full_Package.zip
Raw History Compare with 6.0.1
md5
12f2ae4fc8d000bbdca8cd797d5e2e26
sha1
abc356067967c5d05c8b490b6cf697317d5ac9b7
sha256
5142553dd6934f9a0c1c77ceda1835c19a47c6fb103e48be06abe99a596da1d5
<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2019 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\WebAsset\AssetItem;

use Joomla\CMS\Document\Document;
use Joomla\CMS\Factory;
use Joomla\CMS\Router\Route;
use Joomla\CMS\WebAsset\WebAssetAttachBehaviorInterface;
use Joomla\CMS\WebAsset\WebAssetItem;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Web Asset Item class for Keepalive asset
 *
 * @since  4.0.0
 */
class KeepaliveAssetItem extends WebAssetItem implements WebAssetAttachBehaviorInterface
{
    /**
     * Method called when asset attached to the Document.
     * Useful for Asset to add a Script options.
     *
     * @param   Document  $doc  Active document
     *
     * @return void
     *
     * @since   4.0.0
     */
    public function onAttachCallback(Document $doc)
    {
        $app            = Factory::getApplication();
        $sessionHandler = $app->get('session_handler', 'database');

        // If the handler is not 'Database', we set a fixed, small refresh value (here: 5 min)
        $refreshTime = 300;

        if ($sessionHandler === 'database') {
            $lifeTime    = $app->getSession()->getExpire();
            $refreshTime = $lifeTime <= 60 ? 45 : $lifeTime - 60;

            // The longest refresh period is one hour to prevent integer overflow.
            if ($refreshTime > 3600 || $refreshTime <= 0) {
                $refreshTime = 3600;
            }
        }

        // If we are in the frontend or logged in as a user, we can use the ajax component to reduce the load
        $uri = 'index.php' . ($app->isClient('site') || !Factory::getUser()->guest ? '?option=com_ajax&format=json' : '');

        // Add keepalive script options.
        $doc->addScriptOptions('system.keepalive', ['interval' => $refreshTime * 1000, 'uri' => Route::_($uri)]);
    }
}

The same content is in 155 releases, Joomla 5.0.0-alpha1 to 6.2.1-rc1. See them all, or every version of this file.