Files.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred\User;

class Files extends \Rsi\Fred\Component{

  public $quota = 16; //!< Maximum total user files size (per user; in mega bytes).

  protected $_user = null;
  protected $_root = null; //!< Root directory for the user files.

  /**
   * Get full filename for a file.
   * @param string $filename  User filename, including optional directories.
   * @return string  Full filename (including root). False if root not set, no user ID, or incorrect filename.
   */
  protected function filename($filename){
    return $this->_root && $this->_user->id && preg_match('/^(\\w+\\/)*\\w+(\\.\\w+)?$/',$filename)
      ? $this->_root . $this->_user->id . '/' . $filename
      : false;
  }
  /**
   * List files.
   * @param string|array $types  Allowed types (regex or array with extensions).
   * @return array  Key = full name, value = info.
   */
  public function list($types = null){
    $result = [];
    $filters = [\Rsi\File::FIND_FILTER_SIZE . '>' => 0,\Rsi\File::FIND_FILTER_TIME . '>' => 0];
    if($types) $filters[\Rsi\File::FIND_FILTER_NAME . '//'] = is_array($types) ? '/\\.(' . implode('|',$types) . ')$/i' : $types;
    if($this->_root && $this->_user->id && ($files = \Rsi\File::find($root = $this->_root . $this->_user->id,$filters,true))){
      $root = strlen($root) + 1;
      foreach($files as $filename => $info) $result[str_replace(DIRECTORY_SEPARATOR,'/',substr($filename,$root))] = $info;
    }
    return $result;
  }
  /**
   * Total size used (in bytes).
   * @return int
   */
  public function total(){
    $total = 0;
    foreach($this->list() as $info) $total += $info['size'];
    return $total;
  }
  /**
   * Save a file.
   * @param string $filename  User filename, including optional directories.
   * @param mixed $data  Data to save.
   * @return int  Number of bytes written or false on error.
   */
  public function save($filename,$data){
    if(($filename = $this->filename($filename)) && (($this->total() + (is_file($filename) ? 0 : strlen($data))) <= $this->quota * 1048576)){
      \Rsi\File::mkdir(dirname($filename));
      return file_put_contents($filename,$data);
    }
    return false;
  }
  /**
   * Read a file.
   * @param string $filename  User filename, including optional directories.
   * @return mixed  Data. False on error or null if file does not exist.
   */
  public function fetch($filename){
    return ($filename = $this->filename($filename)) ? \Rsi\File::read($filename,null) : false;
  }
  /**
   * Delete a file.
   * @param string $filename  User filename, including optional directories.
   * @return bool  True on success.
   */
  public function delete($filename){
    if(($filename = $this->filename($filename)) && \Rsi\File::unlink($filename)){
      $root = strlen($this->_root);
      while((strlen($filename = dirname($filename)) > $root) && !(new \FilesystemIterator($filename))->valid()) rmdir($filename);
      return true;
    }
    return false;
  }
  /**
   * Delete all files.
   */
  public function clear(){
    foreach($this->list() as $filename => $info) $this->delete($filename);
  }

}