Wrapper.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred\Stream;

/**
 *  Stream wrapper.
 *  @see http://www.php.net/manual/en/class.streamwrapper.php
 */
class Wrapper extends \Rsi\Thing{

  public $context = null;

  protected $_fred = null;
  protected $_handlers = [];
  protected $_filename = null;
  protected $_params = [];
  protected $_dir = null;
  protected $_readOnly = false;
  protected $_modified = false;
  protected $_position = 0;
  protected $_data = null;

  /**
   * Split the path in protocol, handlers, filename and optional parameters (all stored in properties).
   * @param string $path  Path of the form fred://handler1/handler2/file.ext?key1=value1&key2=value2 (where 'fred' is the name
   *   of the global var with the framework handle).
   * @return bool  True when successful.
   */
  protected function splitPath($path){
    if($result = preg_match('/^(\\w+):\\/\\/((\\w+\\/)+)([\\w\\-\\.]+)(?:\\?(.*))?$/',$path,$matches)){
      if(!$this->_fred){
        if(array_key_exists($key = $matches[1],$GLOBALS)) $this->_fred = $GLOBALS[$key];
        else foreach($GLOBALS as $value) if($value instanceof \Rsi\Fred) $this->_fred = $value;
      }
      $result = $this->_fred->stream->handlersExist($this->_handlers = explode('/',substr($matches[2],0,-1)));
      $this->_filename = $matches[4];
      parse_str(count($matches) < 6 ? null : $matches[5],$this->_params);
    }
    return $result;
  }

  public function dir_closedir(){
    $this->_dir = null;
    return true;
  }

  public function dir_opendir($path,$options){
    if(!$this->splitPath(\Rsi\File::addDirSeparator($path) . '.')) return false;
    $this->_dir = $this->_fred->stream->search($this->_handlers);
    return true;
  }

  public function dir_readdir(){
    $name = current($this->_dir);
    next($this->_dir);
    return $name;
  }

  public function dir_rewinddir(){
    reset($this->_dir);
    return true;
  }

  public function mkdir($path,$mode,$options){
    return true;
  }

  public function rename($path_from,$path_to){
    if($this->splitPath($path_from) && ($this->data !== false) && $this->splitPath($path_to)){
      $this->_modified = true;
      $this->stream_flush();
      return $this->unlink($path_from);
    }
    return false;
  }

  public function rmdir($path,$options){
    return $this->splitPath(\Rsi\File::addDirSeparator($path) . '.') && !$this->_fred->stream->search($this->_handlers);
  }

//TODO: public function stream_cast($cast_as)

  public function stream_close(){
  }

  public function stream_eof(){
    return $this->_position >= strlen($this->data);
  }

  public function stream_flush(){
    if($this->_modified) $this->_fred->stream->save($this->_handlers,$this->_filename,$this->_params,$this->_data);
  }

//TODO: public function stream_lock($operation)

  public function stream_metadata($path,$option,$value){
    switch($option){
      case STREAM_META_TOUCH:
        if(!$this->_data) $this->_data = '';
        break;
      default:
        return false;
    }
    return true;
  }

  public function stream_open($path,$mode,$options,&$opened_path){
    $this->_position = 0;
    if(!$this->splitPath($path)) return false;
    $this->_data = null;
    $this->_readOnly = $this->_modified = $exclusive = false;
    switch(substr($mode,0,1)){
      case 'r':
        if(substr($mode,-1) != '+') $this->_readOnly = true;
        break;
      case 'x':
        $exclusive = true;
      case 'a':
        if($this->data !== false){
          if($exclusive) return false;
          $this->_position = strlen($this->_data);
          break;
        }
      case 'w':
        $this->_data = null;
      case 'c':
        $this->_modified = true;
        break;
    }
    return true;
  }

  public function stream_read($count){
    $data = substr($this->data,$this->_position,$count);
    $this->_position += strlen($data);
    return $data;
  }

  public function stream_seek($offset,$whence){
    switch($whence){
      case SEEK_SET:
        if(($offset < 0) || ($offset >= strlen($this->data))) return false;
        $this->_position = $offset;
        break;
      case SEEK_CUR:
        if($offset < 0) return false;
        $this->_position += $offset;
        break;
      case SEEK_END:
        if(($length = strlen($this->data)) + $offset < 0) return false;
        $this->_position = $length + $offset;
        break;
      default:
        return false;
    }
    return true;
  }

  public function stream_set_option($option,$arg1,$arg2){
    return false;
  }

  public function stream_stat(){
    return [
      'dev' => 0,
      'ino' => 0,
      'mode' => 0777 | 0100000,
      'nlink' => 0,
      'uid' => 0,
      'gid' => 0,
      'rdev' => 0,
      'size' => strlen($this->data),
      'atime' => 0,
      'mtime' => 0,
      'ctime' => 0,
      'blksize' => -1,
      'blocks' => -1
    ];
  }

  public function stream_tell(){
    return $this->_position;
  }

  public function stream_truncate($new_size){
    $this->_data = substr($this->data,0,$new_size);
  }

  public function stream_write($data){
    if($this->_readOnly) return false;
    if($length = strlen($data)){
      $this->_data = substr($this->data,0,$this->_position) . $data . substr($this->data,$this->_position += $length);
      $this->_modified = true;
    }
    return $length;
  }

  public function unlink($path){
    return $this->splitPath($path) ? $this->_fred->stream->delete($this->_handlers,$this->_filename,$this->_params) : false;
  }

  public function url_stat($path,$flags){
    return $this->splitPath($path) && $this->_fred->stream->exists($this->_handlers,$this->_filename,$this->_params)
      ? [
          'dev' => 0,
          'ino' => 0,
          'mode' => 0100777,
          'nlink' => 0,
          'uid' => 0,
          'gid' => 0,
          'rdev' => 0,
          'size' => strlen($this->data),
          'atime' => 0,
          'mtime' => $this->_fred->stream->time($this->_handlers,$this->_filename,$this->_params),
          'ctime' => 0,
          'blksize' => -1,
          'blocks' => -1
        ]
      : false;
  }

  protected function getData(){
    if($this->_data === null) $this->_data = $this->_fred->stream->read($this->_handlers,$this->_filename,$this->_params);
    return $this->_data;
  }

}