class.fsAccessWrapper.php

<?php
/*
 * Copyright 2007-2013 Charles du Jeu - Abstrium SAS <team (at) pyd.io>
 * This file is part of Pydio.
 *
 * Pydio is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Pydio 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Pydio.  If not, see <http://www.gnu.org/licenses/>.
 *
 * The latest code can be found at <http://pyd.io/>.
 *
 */
defined('AJXP_EXEC') or die( 'Access not allowed');

/**
 * Wrapper for a local filesystem
 * @package AjaXplorer_Plugins
 * @subpackage Access
 */
class fsAccessWrapper implements AjxpWrapper
{
    /**
     * FileHandle resource
     *
     * @var resource
     */
    protected $fp;
    /**
     * DirHandle resource
     *
     * @var resource
     */
    protected $dH;

    /**
     * If dH is not used but an array containing the listing
     * instead. dH == -1 in that case.
     *
     * @var array()
     */
    protected static $currentListing;
    protected static $currentListingKeys;
    protected static $currentListingIndex;
    protected static $currentFileKey;
    protected static $crtZip;
    protected $realPath;
    protected static $lastRealSize;

    /**
     * Initialize the stream from the given path.
     *
     * @param string $path
     * @return mixed Real path or -1 if currentListing contains the listing : original path converted to real path
     */
    protected static function initPath($path, $streamType, $storeOpenContext = false, $skipZip = false)
    {
        $path = self::unPatchPathForBaseDir($path);
        $url = parse_url($path);
        $repoId = $url["host"];
        $test = trim($url["path"], "/");
        $atRoot = empty($test);
        if (isSet($url["fragment"]) && strlen($url["fragment"]) > 0) {
            $url["path"] .= "#".$url["fragment"];
        }
        $repoObject = ConfService::getRepositoryById($repoId);
        if(!isSet($repoObject)) throw new Exception("Cannot find repository with id ".$repoId);
        $split = UserSelection::detectZip($url["path"]);
        $insideZip = false;
        if($split && $streamType == "file" && $split[1] != "/") $insideZip = true;
        if($split && $streamType == "dir") $insideZip = true;
        if($skipZip) $insideZip = false;

        $resolveUser = null;
        if(isSet($url["user"]) && AuthService::usersEnabled()){
            $resolveUser = ConfService::getConfStorageImpl()->createUserObject($url["user"]);
        }
        $resolvedPath = realpath(SystemTextEncoding::toStorageEncoding($repoObject->getOption("PATH", false, $resolveUser)));

        //var_dump($path);
        //var_dump($skipZip);
        // Inside a zip : copy the file to a tmp file and return a reference to it
        if ($insideZip) {
            $zipPath = $split[0];
            $localPath = $split[1];
            require_once(AJXP_BIN_FOLDER."/pclzip.lib.php");
            //print($streamType.$path);
               if ($streamType == "file") {
                   if (self::$crtZip == null ||  !is_array(self::$currentListingKeys)) {
                       $tmpDir = AJXP_Utils::getAjxpTmpDir() . DIRECTORY_SEPARATOR . md5(time()-rand());
                       mkdir($tmpDir);
                       $tmpFileName = $tmpDir.DIRECTORY_SEPARATOR.basename($localPath);
                       AJXP_Logger::debug(__CLASS__,__FUNCTION__,"Tmp file $tmpFileName");
                       register_shutdown_function(array("fsAccessWrapper", "removeTmpFile"), $tmpDir, $tmpFileName);
                    $crtZip = new PclZip(AJXP_Utils::securePath($resolvedPath.$repoObject->resolveVirtualRoots($zipPath)));
                    $content = $crtZip->listContent();
                    if(is_array($content)){
                        foreach ($content as $item) {
                            $fName = AJXP_Utils::securePath($item["stored_filename"]);
                            if ($fName == $localPath || "/".$fName == $localPath) {
                                $localPath = $fName;
                                break;
                            }
                        }
                    }
                    $res = $crtZip->extract(PCLZIP_OPT_BY_NAME, $localPath, PCLZIP_OPT_PATH, $tmpDir, PCLZIP_OPT_REMOVE_ALL_PATH);
                    AJXP_Logger::debug(__CLASS__,__FUNCTION__,"Extracted ".$path." to ".dirname($localPath));
                    if($storeOpenContext) self::$crtZip = $crtZip;
                    return $tmpFileName;
                   } else {
                       $key = basename($localPath);
                       if (array_key_exists($key, self::$currentListing)) {
                           self::$currentFileKey = $key;
                           return -1;
                       } else {
                           throw new AJXP_Exception("Cannot find key");
                       }
                   }
               } else {
                $crtZip = new PclZip(AJXP_Utils::securePath($resolvedPath.$repoObject->resolveVirtualRoots($zipPath)));
                $liste = $crtZip->listContent();
                   if(!is_array($liste)) $liste = array();
                if($storeOpenContext) self::$crtZip = $crtZip;
                $folders = array(); $files = array();$builtFolders = array();
                if($localPath[strlen($localPath)-1] != "/") $localPath.="/";
                foreach ($liste as $item) {
                    $stored = $item["stored_filename"];
                    if($stored[0] != "/") $stored = "/".$stored;
                    $pathPos = strpos($stored, $localPath);
                    if ($pathPos !== false) {
                        $afterPath = substr($stored, $pathPos+strlen($localPath));
                        if ($afterPath != "" && substr_count($afterPath, "/") < 2) {
                            $statValue = array();
                            if (substr_count($afterPath, "/") == 0) {
                                $statValue[2] = $statValue["mode"] = ($item["folder"]?"00040000":"0100000");
                                $statValue[7] = $statValue["size"] = $item["size"];
                                $statValue[8] = $statValue["atime"] = $item["mtime"];
                                $statValue[9] = $statValue["mtime"] = $item["mtime"];
                                $statValue[10] = $statValue["ctime"] = $item["mtime"];
                                if (strpos($afterPath, "/") == strlen($afterPath)-1) {
                                    $afterPath = substr($afterPath, 0, strlen($afterPath)-1);
                                }
                                //$statValue["filename"] = $zipPath.$localPath.$afterPath;
                                if ($item["folder"]) {
                                    $folders[$afterPath] = $statValue;
                                } else {
                                    $files[$afterPath] = $statValue;
                                }
                            } else {
                                $arr = explode("/", $afterPath);
                                $afterPath = array_shift($arr);
                                if(isSet($folders[$afterPath]) || isSet($builtFolders[$afterPath])) continue;
                                $statValue[2] = $statValue["mode"] = "00040000";
                                $statValue[7] = $statValue["size"] = 0;
                                $statValue[8] = $statValue["atime"] = $item["mtime"];
                                $statValue[9] = $statValue["mtime"] = $item["mtime"];
                                $statValue[10] = $statValue["ctime"] = $item["mtime"];
                                $builtFolders[$afterPath] = $statValue;
                            }
                        }
                    }
                }
                self::$currentListing = array_merge($folders, $builtFolders, $files);
                self::$currentListingKeys = array_keys(self::$currentListing);
                self::$currentListingIndex = 0;
                return -1;
               }
        } else {
            if ($atRoot) {
                $virtual = $repoObject->listVirtualRoots();
                if (count($virtual)) {
                    self::$currentListing = array();
                    foreach ($virtual as $rootKey => $rootValue) {
                        $statValue = array();
                        $statValue[2] = $statValue["mode"] = 00040000;//($rootValue["right"] == "rw" ? "00040000" : "00070000");
                        self::$currentListing[$rootKey] = $statValue;
                    }
                    self::$currentListingKeys = array_keys(self::$currentListing);
                    self::$currentListingIndex = 0;
                    return -1;
                }
            }
            return $resolvedPath.$repoObject->resolveVirtualRoots($url["path"]);
        }
    }

    public static function patchPathForBaseDir($dirPath)
    {
        if(!ini_get("open_basedir") || !preg_match('/\.zip/i', $dirPath)) return $dirPath;
        return str_replace(".zip", "__ZIP_EXTENSION__", $dirPath);

    }

    public static function unPatchPathForBaseDir($dirPath)
    {
        if(!ini_get("open_basedir")) return $dirPath;
        return str_replace("__ZIP_EXTENSION__", ".zip", $dirPath);
    }

    public static function removeTmpFile($tmpDir, $tmpFile)
    {
        if(is_file($tmpFile)) unlink($tmpFile);
        if(is_dir($tmpDir)) rmdir($tmpDir);
    }

    protected static function closeWrapper()
    {
        if (self::$crtZip != null) {
            self::$crtZip = null;
            self::$currentListing  = null;
            self::$currentListingKeys = null;
            self::$currentListingIndex = null;
            self::$currentFileKey = null;
        }
    }

    public static function getRealFSReference($path, $persistent = false)
    {
        $contextOpened =false;
        if (self::$crtZip != null) {
            $contextOpened = true;
            $crtZip = self::$crtZip;
            self::$crtZip = null;
        }
        $realPath = self::initPath($path, "file");
        if (!$contextOpened) {
            self::closeWrapper();
        } else {
            self::$crtZip = $crtZip;
        }
        return $realPath;
    }

    public static function isRemote()
    {
        return false;
    }

    public static function copyFileInStream($path, $stream)
    {
        $fp = fopen(self::getRealFSReference($path), "rb");
        if(!is_resource($fp)) return;
        while (!feof($fp)) {
            if(!ini_get("safe_mode")) @set_time_limit(60);
             $data = fread($fp, 4096);
             fwrite($stream, $data, strlen($data));
        }
        fclose($fp);
    }

    public static function changeMode($path, $chmodValue)
    {
        $realPath = self::initPath($path, "file");
        @chmod($realPath, $chmodValue);
    }

    /**
     * Opens the strem
     *
     * @param String $path Maybe in the form "ajxp.fs://repositoryId/pathToFile"
     * @param String $mode
     * @param unknown_type $options
     * @param unknown_type $context
     * @return unknown
     */
    public function stream_open($path, $mode, $options, &$context)
    {
        try {
            $this->realPath = AJXP_Utils::securePath(self::initPath($path, "file"));
        } catch (Exception $e) {
            AJXP_Logger::error(__CLASS__,"stream_open", "Error while opening stream $path (".$e->getMessage().")");
            return false;
        }
        if ($this->realPath == -1) {
            $this->fp = -1;
            return true;
        } else {
            $this->fp = fopen($this->realPath, $mode, $options);
            return ($this->fp !== false);
        }
    }

    public function stream_seek($offset , $whence = SEEK_SET)
    {
        fseek($this->fp, $offset, $whence);
    }

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

    public function stream_stat()
    {
        $PROBE_REAL_SIZE = ConfService::getConf("PROBE_REAL_SIZE");
        if (is_resource($this->fp)) {
            $statValue = fstat($this->fp);
            fsAccessWrapper::$lastRealSize = false;
            if ($statValue[2] > 0 && $PROBE_REAL_SIZE && !ini_get("safe_mode")) {
                fsAccessWrapper::$lastRealSize = floatval(trim($this->getTrueSizeOnFileSystem($this->realPath)));
            }
            return $statValue;
        }
        if (is_resource($this->dH)) {
            return fstat($this->dH);
        }
        if ($this->fp == -1) {
            return self::$currentListing[self::$currentFileKey];
        }
        return null;
    }

    public function url_stat($path, $flags)
    {
        // File and zip case
        $patchedPath = self::patchPathForBaseDir($path);
        if (ini_get("open_basedir") && preg_match('/__ZIP_EXTENSION__/', $patchedPath)) {
            // Zip Folder case
            self::$lastRealSize = false;
            $search = basename($path);
            $realBase = $this->initPath(dirname($path), "dir");
            if ($realBase == -1) {
                if (array_key_exists($search, self::$currentListing)) {
                    return self::$currentListing[$search];
                }
            }
        }
        if ($fp = @fopen($path, "r")) {
            $stat = fstat($fp);
            fclose($fp);
            return $stat;
        }
        // Folder case
        $real = $this->initPath($path, "dir", false, true);
        if ($real!=-1 && is_dir($real)) {
            return stat($real);
        }
        // Zip Folder case
        $search = basename($path);
        $realBase = $this->initPath(dirname($path), "dir");
        if ($realBase == -1) {
            if (array_key_exists($search, self::$currentListing)) {
                return self::$currentListing[$search];
            }
        }
        // 000 permission file
        if ($real != -1 && is_file($real)) {
            return stat($real);
        }
        // Handle symlinks!
        if ($real != -1 && is_link($real)) {
               $realFile = @readlink($real);
               if (is_file($realFile) || is_dir($realFile)) {
                   return stat($realFile);
               } else {
                // symlink is broken, delete it.
                   @unlink($real);
                   return null;
               }
           }

        // Non existing file
           return null;
    }

    public function rename($from, $to)
    {
        return rename($this->initPath($from, "file", false, true), $this->initPath($to, "file", false, true));
    }

    public function stream_read($count)
    {
        return fread($this->fp, $count);
    }

    public function stream_write($data)
    {
        fwrite($this->fp, $data, strlen($data));
        return strlen($data);
    }

    public function stream_eof()
    {
        return feof($this->fp);
    }

    public function stream_close()
    {
        if (isSet($this->fp) && $this->fp!=-1 && $this->fp!==false) {
            fclose($this->fp);
        }
    }

    public function stream_flush()
    {
        if (isSet($this->fp) && $this->fp!=-1 && $this->fp!==false) {
            fflush($this->fp);
        }
    }

    public function unlink($path)
    {
        $this->realPath = $this->initPath($path, "file", false, true);
        return unlink($this->realPath);
    }

    public function rmdir($path, $options)
    {
        $this->realPath = $this->initPath($path, "file", false, true);
        return rmdir($this->realPath);
    }

    public function mkdir($path, $mode, $options)
    {
        return mkdir($this->initPath($path, "file"), $mode);
    }

    /**
     * Readdir functions
     *
     * @param string $path
     * @param int $options
     */
    public function dir_opendir ($path , $options )
    {
        $this->realPath = $this->initPath($path, "dir", true);
        if (is_string($this->realPath)) {
            $this->dH = @opendir($this->realPath);
        } else if ($this->realPath == -1) {
            $this->dH = -1;
        }
        return $this->dH !== false;
    }
    public function dir_closedir  ()
    {
        $this->closeWrapper();
        if ($this->dH == -1) {
            return true;
        } else {
            return closedir($this->dH);
        }
    }
    public function dir_readdir ()
    {
        if ($this->dH == -1) {
            if (isSet(self::$currentListingKeys[self::$currentListingIndex])) {
                self::$currentListingIndex ++;
                return self::$currentListingKeys[self::$currentListingIndex-1];
            } else {
                return false;
            }
        } else {
            return readdir($this->dH);
        }
    }
    public function dir_rewinddir ()
    {
        if ($this->dH == -1) {
            self::$currentListingIndex = 0;
        } else {
            return rewinddir($this->dH);
        }
    }

    public static function getLastRealSize()
    {
        return self::$lastRealSize;
    }

    protected function getTrueSizeOnFileSystem($file)
    {
        if (!(strtoupper(substr(PHP_OS, 0, 3)) == 'WIN')) {
            $cmd = "stat -L -c%s ".escapeshellarg($file);
            $val = trim(`$cmd`);
            if (strlen($val) == 0 || floatval($val) == 0) {
                // No stat on system
                $cmd = "ls -1s --block-size=1 ".escapeshellarg($file);
                $val = trim(`$cmd`);
            }
            if (strlen($val) == 0 || floatval($val) == 0) {
                // No block-size on system (probably busybox), try long output
                $cmd = "ls -l ".escapeshellarg($file)."";

                $arr = explode("/[\s]+/", `$cmd`);
                $val = trim($arr[4]);
            }
            if (strlen($val) == 0 || floatval($val) == 0) {
                // Still not working, get a value at least, not 0...
                $val = sprintf("%u", filesize($file));
            }
            return floatval($val);
        } else if (class_exists("COM")) {
            $fsobj = new COM("Scripting.FileSystemObject");
            $f = $fsobj->GetFile($file);
            return floatval($f->Size);
        } else if (is_file($file)) {
            return exec('FOR %A IN ("'.$file.'") DO @ECHO %~zA');
        } else return sprintf("%u", filesize($file));
    }

}