capwelton / libapp

programs/Ctrl/AppCtrlSSE.php

<?php

// -------------------------------------------------------------------------
// OVIDENTIA http://www.ovidentia.org
// Ovidentia 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 2, or (at your option)
// any later version.
//
// 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.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
// USA.
// -------------------------------------------------------------------------
/**
 * @license http://opensource.org/licenses/gpl-license.php GNU General Public License (GPL)
 * @copyright Copyright (c) 2022 by SI4YOU ({@link https://www.siforyou.com})
 */
namespace Capwelton\LibApp\Ctrl;

/**
 * This controller manages actions that can be performed on notifications
 *
 * @method Func_App App()
 * @method self proxy()
 */
class AppCtrlSSE extends AppController
{
    
    private $currentUser;
    
    private $refreshFrequency;
    
    public function server()
    {
        session_write_close();
        
        header("Content-Type: text/event-stream");
        header('Cache-Control: no-cache');
        header('Connection: keep-alive');
        header('X-Accel-Buffering: no');
        
        $refreshFrequency = $this->getRefreshFrequency();
        
        while (1){
            if(connection_aborted()){
                exit();

Using exit here is not recommended.

            }
            $data = $this->getSSEData();
            if($data != '{}'){
                echo "event: ping\n";
                echo "\n\n";
                echo 'data: ' . $this->getSSEData() . "\n\n";
            }
            ob_end_flush();
            flush();
            sleep($refreshFrequency);
        }
    }
    
    public function dummy()
    {
        $App = $this->App();
        $notifSet = $App->NotificationSet();
        $dummy = $notifSet->newRecord();
        
        $dummy->title = 'Dummy title';
        $dummy->description = 'Lorem ipsum dolor sit amet, consectetur adisciping elit';
        $dummy->user = bab_getUserId();
        $dummy->save();
        
        $dummy->createSSENotification();
    }
    
    private function getRefreshFrequency()
    {
        if(! isset($this->refreshFrequency)){
            $registry = app_getRegistry();
            $registry->changeDirectory('configuration');
            $registry->changeDirectory('SSE');
            $this->refreshFrequency = $registry->getValue('refreshFrequency', 3);
        }
        return $this->refreshFrequency;
    }
    
    private function getSSEData()
    {
        $SSESet = $this->getSSERecordSet();
        $currentUser = $this->getCurrentUser();
        
        return $SSESet->getSSEData($currentUser, true);
    }
    
    private function getCurrentUser()
    {
        if(isset($this->currentUser)){
            return $this->currentUser;
        }
        
        $App = $this->App();
        $this->currentUser = $App->getCurrentUser();
        return $this->currentUser;
    }
}