ElggFile.php

Go to the documentation of this file.

<?php

class ElggFile extends \ElggObject {
    private $filestore;

    private $handle;

    protected function initializeAttributes() {
        parent::initializeAttributes();

        $this->attributes['subtype'] = "file";
    }

    public function __construct($row = null) {
        parent::__construct($row);

        // Set default filestore
        $this->filestore = $this->getFilestore();
    }

    public function setFilename($name) {
        $this->filename = $name;
    }

    public function getFilename() {
        return $this->filename;
    }

    public function getFilenameOnFilestore() {
        return $this->filestore->getFilenameOnFilestore($this);
    }

    public function getFilestoreSize($prefix = '', $container_guid = 0) {
        if (!$container_guid) {
            $container_guid = $this->container_guid;
        }
        $fs = $this->getFilestore();
        // @todo add getSize() to \ElggFilestore
        return $fs->getSize($prefix, $container_guid);
    }

    public function getMimeType() {
        if ($this->mimetype) {
            return $this->mimetype;
        }

        // @todo Guess mimetype if not here
    }

    public function setMimeType($mimetype) {
        return $this->mimetype = $mimetype;
    }

    public function detectMimeType($file = null, $default = null) {
        $class = __CLASS__;
        if (!$file && isset($this) && $this instanceof $class) {
            $file = $this->getFilenameOnFilestore();
        }

        if (!is_readable($file)) {
            return false;
        }

        $mime = $default;

        // for PHP5 folks.
        if (function_exists('finfo_file') && defined('FILEINFO_MIME_TYPE')) {
            $resource = finfo_open(FILEINFO_MIME_TYPE);
            if ($resource) {
                $mime = finfo_file($resource, $file);
            }
        }

        // for everyone else.
        if (!$mime && function_exists('mime_content_type')) {
            $mime = mime_content_type($file);
        }

        $original_filename = isset($this) && $this instanceof $class ? $this->originalfilename : basename($file);
        $params = array(
            'filename' => $file,
            'original_filename' => $original_filename, // @see file upload action
            'default' => $default,
        );
        return _elgg_services()->hooks->trigger('mime_type', 'file', $params, $mime);
    }

    public function setDescription($description) {
        $this->description = $description;
    }

    public function open($mode) {
        if (!$this->getFilename()) {
            throw new \IOException("You must specify a name before opening a file.");
        }

        // See if file has already been saved
        // seek on datastore, parameters and name?

        // Sanity check
        if (
            ($mode != "read") &&
            ($mode != "write") &&
            ($mode != "append")
        ) {
            $msg = "Unrecognized file mode '" . $mode . "'";
            throw new \InvalidParameterException($msg);
        }

        // Get the filestore
        $fs = $this->getFilestore();

        // Ensure that we save the file details to object store
        //$this->save();

        // Open the file handle
        $this->handle = $fs->open($this, $mode);

        return $this->handle;
    }

    public function write($data) {
        $fs = $this->getFilestore();

        return $fs->write($this->handle, $data);
    }

    public function read($length, $offset = 0) {
        $fs = $this->getFilestore();

        return $fs->read($this->handle, $length, $offset);
    }

    public function grabFile() {
        $fs = $this->getFilestore();
        return $fs->grabFile($this);
    }

    public function close() {
        $fs = $this->getFilestore();

        if ($fs->close($this->handle)) {
            $this->handle = null;

            return true;
        }

        return false;
    }

    public function delete() {
        $fs = $this->getFilestore();
        
        $result = $fs->delete($this);
        
        if ($this->getGUID() && $result) {
            $result = parent::delete();
        }
        
        return $result;
    }

    public function seek($position) {
        $fs = $this->getFilestore();

        // @todo add seek() to \ElggFilestore
        return $fs->seek($this->handle, $position);
    }

    public function tell() {
        $fs = $this->getFilestore();

        return $fs->tell($this->handle);
    }

    public function getSize() {
        return $this->filestore->getFileSize($this);
    }

    public function size() {
        elgg_deprecated_notice("Use \ElggFile::getSize() instead of \ElggFile::size()", 1.9);
        return $this->getSize();
    }

    public function eof() {
        $fs = $this->getFilestore();

        return $fs->eof($this->handle);
    }

    public function exists() {
        $fs = $this->getFilestore();

        return $fs->exists($this);
    }

    public function setFilestore(\ElggFilestore $filestore) {
        $this->filestore = $filestore;
    }

    protected function getFilestore() {
        // Short circuit if already set.
        if ($this->filestore) {
            return $this->filestore;
        }

        // ask for entity specific filestore
        // saved as filestore::className in metadata.
        // need to get all filestore::* metadata because the rest are "parameters" that
        // get passed to filestore::setParameters()
        if ($this->guid) {
            $options = array(
                'guid' => $this->guid,
                'where' => array("n.string LIKE 'filestore::%'"),
            );

            $mds = elgg_get_metadata($options);

            $parameters = array();
            foreach ($mds as $md) {
                list( , $name) = explode("::", $md->name);
                if ($name == 'filestore') {
                    $filestore = $md->value;
                }
                $parameters[$name] = $md->value;
            }
        }

        // need to check if filestore is set because this entity is loaded in save()
        // before the filestore metadata is saved.
        if (isset($filestore)) {
            if (!class_exists($filestore)) {
                $msg = "Unable to load filestore class " . $filestore . " for file " . $this->guid;
                throw new \ClassNotFoundException($msg);
            }

            $this->filestore = new $filestore();
            $this->filestore->setParameters($parameters);
            // @todo explain why $parameters will always be set here (PhpStorm complains)
        }

        // this means the entity hasn't been saved so fallback to default
        if (!$this->filestore) {
            $this->filestore = get_default_filestore();
        }

        return $this->filestore;
    }

    public function save() {
        if (!parent::save()) {
            return false;
        }

        // Save datastore metadata
        $params = $this->filestore->getParameters();
        foreach ($params as $k => $v) {
            $this->setMetadata("filestore::$k", $v);
        }

        // Now make a note of the filestore class
        $this->setMetadata("filestore::filestore", get_class($this->filestore));

        return true;
    }

    public function __sleep() {
        return array_diff(array_keys(get_object_vars($this)), array(
            // Don't persist filestore, which contains CONFIG
            // https://github.com/Elgg/Elgg/issues/9081#issuecomment-152859856
            'filestore',

            // a resource
            'handle',
        ));
    }

    public function __wakeup() {
        $this->getFilestore();
    }
}