Alive.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred;

class Alive extends Component{

  public $maxSessionTime = null; //!< Maximum duration of a session (minutes; empty = infinite).
  public $maxInactiveTime = null; //!< Maximum period of inactivity (minutes; empty = infinite).

  public $journalPath = null; //!< Path for journal files (empty = do not save).
  public $journalExt = '.log';
  public $journalFormat = 'H:i:s';
  public $journalMaxSize = 10240; //!< Max filesize in bytes.
  public $journalTimout = 3600; //!< Max idle time in seconds.
  public $journalGarbageChance = 100;

  protected $_lastAlive = null;
  protected $_journalFilename = null;

  public function clientConfig(){
    return array_merge(parent::clientConfig(),['interval' => $this->interval]);
  }

  protected function init(){
    parent::init();
    if(!$this->session->start){
      $this->session->start = time();
      $this->journal('Session start from remote address ' . $this->component('security')->remoteAddr);
    }
    $this->_lastAlive = $this->session->alive;
    $this->session->alive = time();
  }
  /**
   * Register a component to be pinged.
   * @param string $name  Name of the component.
   */
  public function register($name){
    if(!in_array($name,$ping = $this->session->ping ?: [])) $ping[] = $name;
    $this->session->ping = $ping;
  }
  /**
   * Ping the session to see its status.
   * @return string  URL to navigate to (empty = no action required).
   */
  public function ping(){
    $this->session->alive = $this->_lastAlive; //restore - ignore this call
    if(
      (!$this->maxSessionTime || (time() - $this->session->start <= $this->maxSessionTime * 60)) &&
      (!$this->maxInactiveTime || (time() - $this->session->alive <= $this->maxInactiveTime * 60))
    ){
      if($ping = $this->session->ping) foreach($ping as $name) $this->_fred->component($name)->ping();
      $this->journalGarbage();
      return null;
    }
    $this->component('user')->invalidate();
    $this->session->start = false;
    return $this->router->reverse($this->front->defaultControllerName);
  }
  /**
   * Add a message to the journal.
   * @param string $message  Message to add.
   */
  public function journal($message){
    if($filename = $this->journalFilename) try{
      return \Rsi\File::write($filename,date($this->journalFormat) . ": $message\n",0666,true);
    }
    catch(\Exception $e){
      $this->component('log')->error($e);
    }
  }
  /**
   * Clean-up the journals.
   * @param bool $force  Set to true to force a clean-up (otherwise the journalGarbageChance is used).
   * @return int  Number of active journals (null if not cleaned).
   */
  public function journalGarbage($force = false){
    $count = null;
    if($this->journalPath && ($force || !rand(0,$this->journalGarbageChance))) try{
      $log = $this->component('log');
      $time = time() - $this->journalTimout;
      foreach((new \GlobIterator($this->journalPath . '*' . $this->journalExt)) as $filename => $file) try{
        if(($file->getMTime() < $time) || ($file->getSize() > $this->journalMaxSize)) unlink($filename);
        else $count++;
      }
      catch(\Exception $e){
        $log->info($e);
        error_clear_last();
      }
    }
    catch(\Exception $e){
      $log->error($e);
    }
    return $count;
  }
  /**
   * List all active journals.
   * @param string $filter  Only journals with this string in one of the messages.
   * @param string $order  Order the journals by one of the properties.
   * @return array  Array with 'name','time', and 'size'.
   */
  public function journals($filter = null,$order = null){
    $journals = [];
    if($this->journalPath){
      $this->journalGarbage(true);
      foreach((new \GlobIterator($this->journalPath . '*' . $this->journalExt)) as $filename => $file)
        if(!$filter || (stripos(\Rsi\File::read($filename),$filter) !== false))
          $journals[] = ['name' => $file->getFilename(),'time' => $file->getMTime(),'size' => $file->getSize()];
      if($order && $journals && array_key_exists($order,$journals[0]))
        usort($journals,function($a,$b) use ($order){ return strnatcmp($a[$order],$b[$order]); });
    }
    return $journals;
  }
  /**
   * All messages from a journal.
   * @param string $name  Journal name.
   * @return array  Message lines.
   */
  public function journalMessages($name){
    return $this->journalPath && !preg_match('/(\\/|\\\\|\\.\\.)/',$name) && \Rsi\Str::endsWith($name,$this->journalExt)
      ? explode("\n",trim(\Rsi\File::read($this->journalPath . $name)))
      : false;
  }

  protected function getInterval(){
    $interval = ini_get('session.gc_maxlifetime') / 90; //seconds -> minutes, and 2/3 of that
    if($this->maxSessionTime) $interval = min($interval,$this->maxSessionTime / 10);
    if($this->maxInactiveTime) $interval = min($interval,$this->maxInactiveTime / 10);
    return max(1,$interval);
  }

  protected function getJournalFilename(){
    if(!$this->journalPath) return false;
    if(!$this->_journalFilename) $this->_journalFilename = $this->journalPath . session_id() . $this->journalExt;
    return $this->_journalFilename;
  }

}