File.php

Go to the documentation of this file.

<?php
 
namespace Rsi\Fred;
 
/**
 *  File storage and archiving.
 */
class File extends Component{
 
  const EVENT_ARCHIVE = 'file:archive';
  const EVENT_SAVE = 'file:save';
  const EVENT_DELETE = 'file:delete';
 
  public $mode = null; //!< File mode (not set if empty).
 
  protected $_indexBase = 1; //!< Index starting value.
  protected $_indexSize = 0; //!< Minimum index length (prefixed with zeros when smaller).
  protected $_types = []; //!< Key = type name, value = array with 'format' and optional 'archive' format. An asterisk is
    // replaced with the ID. A quotation mark is replaced with the index. Placeholder "(x,y)" indicates a part of the ID,
    // starting on offset "x" (negative denotes from end) and with length "y" (optionally left padded when the ID is actually
    // smaller than the length). Placeholder "[z]" will be replaced with the corresponding date tag for "z".
 
  protected function format($format,$id,$index = null,$time = null){
    return \Rsi\Str::replaceDate(strtr(preg_replace_callback('/\\((-?\\d+),(\\d+)\\)/',function($match) use ($id){
      return \Rsi\Str::pad(substr($id,$match[1],$match[2]),$match[2]);
    },$format),['*' => $id,'?' => $index === null ? null : \Rsi\Str::pad($index,$this->_indexSize)]),$time);
  }
  /**
   * Filename for a file.
   * @param string $type  File type.
   * @param string $id  File ID.
   * @return string  Filename.
   */
  public function name($type,$id){
    return $this->format($this->_types[$type]['format'],$id);
  }
  /**
   * Check if a file exists.
   * @param string $type  File type.
   * @param string $id  File ID.
   * @return bool  True if the file exists.
   */
  public function exists($type,$id){
    return is_file($this->name($type,$id));
  }
  /**
   * Archive a file (if it exists).
   * @param string $type  File type.
   * @param string $id  File ID.
   * @param string $filename  Filename for the current file.
   * @return string  Archive filename (null if archive not set; false if no current file or error).
   */
  protected function archive($type,$id,&$filename = null){
    $filename = $this->name($type,$id);
    if($format = $this->_types[$type]['archive'] ?? null){
      if(!is_file($filename)) return false;
      $index = strpos($format,'?') === null ? null : $this->_indexBase;
      do $archive = $this->format($format,$id,$index === null ? null : $index++);
      while(($index !== null) && is_file($archive));
      \Rsi\File::mkdir(dirname($archive));
      if($result = \Rsi\File::rename($filename,$archive))
        $this->component('event')->trigger(self::EVENT_ARCHIVE,$this,$type,$id,$filename,$archive);
      return $result ? $archive : false;
    }
    return null;
  }
  /**
   * Save date into a file (archive existing file first).
   * @param string $type  File type.
   * @param string $id  File ID.
   * @param string $data  Data to save.
   * @return int  Number of bytes written or false on error.
   */
  public function save($type,$id,$data){
    $this->archive($type,$id,$filename);
    \Rsi\File::mkdir(dirname($filename));
    if(($result = \Rsi\File::write($filename,$data,$this->mode)) !== false)
      $this->component('event')->trigger(self::EVENT_SAVE,$this,$type,$id,$filename);
    return $result;
  }
  /**
   * Delete a file (archive first).
   * @param string $type  File type.
   * @param string $id  File ID.
   * @return bool  True if file does not exist afterwards.
   */
  public function delete($type,$id){
    $this->archive($type,$id,$filename);
    if($result = \Rsi\File::unlink($filename)) $this->component('event')->trigger(self::EVENT_DELETE,$this,$type,$id);
    return $result;
  }
  /**
   * Find archive files in a directory.
   * @param string $dir  Directory to scan.
   * @param array $dirs  Directory filters for sub-directories.
   * @param int $time  Only select files older than this timestamp (empty = no filter).
   * @return array  Key = full name, value = info
   */
  protected function find($dir,$dirs,$time = null){
    $archives = [];
    if($filter = array_shift($dirs)){
      $filter = [\Rsi\File::FIND_FILTER_NAME . '//' => $filter];
      if(!$dirs) $archives += \Rsi\File::find($dir,
        [\Rsi\File::FIND_FILTER_TYPE => \Rsi\File::FIND_TYPE_FILE] +
        $filter +
        ($time ? [\Rsi\File::FIND_FILTER_TIME . '<' => $time] : [])
      );
      elseif($subs = \Rsi\File::find($dir,[\Rsi\File::FIND_FILTER_TYPE => \Rsi\File::FIND_TYPE_DIR] + $filter))
        foreach($subs as $sub => $info) $archives += $this->find($sub,$dirs,$time);
    }
    return $archives;
  }
  /**
   * Find archive files.
   * @param string $type  File type.
   * @param string $id  File ID.
   * @param int $time  Only select files older than this timestamp (empty = no filter).
   * @return array  Archive files found (null if archive not set).
   */
  public function archives($type,$id,$time = null){
    if($format = $this->_types[$type]['archive'] ?? null){
      $root = $dirs = [];
      foreach(preg_split('/[\\/\\\\]/',str_replace('*',$id ?: '*',$format)) as $dir){
        if(!$dirs && !preg_match('/[\\(\\[\\?\\*]/',$dir)) $root[] = $dir;
        else{
          $dir = preg_quote($dir,'/');
          $dir = preg_replace('/\\\\\\(.*?,(\\d+)\\\\\\)/','.{$1}',$dir);
          $dir = preg_replace('/\\\\\\[.*?\\\\\\]/','\\w+?',$dir);
          $dir = strtr($dir,['\\?' => '\\d+','\\*' => '.*?']);
          $dirs[] = '/^' . $dir . '$/';
        }
      }
      return array_keys($this->find(implode('/',$root),$dirs,$time));
    }
    return null;
  }
  /**
   * Purge the archive.
   * @param string $type  File type.
   * @param int $time  Purge files older than this timestamp.
   * @return int  Number if files purged (null if archive not set).
   */
  public function purge($type,$time){
    if(($archives = $this->archives($type,null,$time)) === null) return null;
    $count = 0;
    foreach($archives as $archive) if(\Rsi\File::unlink($archive)) $count++;
    return $count;
  }
  /**
   * Purge archive for all types with an optional "purge" parameter.
   * @return int  Number if files purged.
   */
  public function purgeAll(){
    $count = 0;
    foreach($this->_types as $type => $config) if($time = $config['purge'] ?? null) $count += $this->purge($type,$time);
    return $count;
  }
 
}