ilObjFileDAV Class Reference

Class ilObjFileDAV. More...

Inheritance diagram for ilObjFileDAV:

Collaboration diagram for ilObjFileDAV:

Public Member Functions
	__construct (ilObjFile $a_obj, ilWebDAVRepositoryHelper $repo_helper, ilWebDAVObjDAVHelper $dav_helper)
	ilObjFileDAV represents the WebDAV-Interface to an ILIAS-Object More...
	put ($data)
	Replaces the contents of the file. More...
	get ()
	Returns the data. More...
	getName ()
	Returns title of file object. More...
	getContentType ()
	Returns the mime-type for a file. More...
	getETag ()
	Returns the ETag for a file. More...
	getSize ()
	Returns the size of the node, in bytes. More...
	setName ($a_name)
	handleFileUpload ($a_data, $a_file_action)
	Handle uploaded file. More...
Public Member Functions inherited from ilObjectDAV
	__construct (ilObject $a_obj, ilWebDAVRepositoryHelper $repo_helper, ilWebDAVObjDAVHelper $dav_helper)
	Constructor for DAV Object. More...
	getRefId ()
	Returns the ref id of this object. More...
	getObjectId ()
	Returns the object id of this object. More...
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...
	delete ()
	Deletes the current node. More...
	setName ($a_name)
	Renames the node. More...
	getName ()
	SabreDAV interface function . More...
	getObject ()
	Returns ILIAS Object. More...

Protected Member Functions
	getPathToDirectory ()
	getPathToFile ()
	This method only exists for legacy reasons. More...
	checkForVirus (string $file_dest_path)
	createHistoryAndNotificationForObjUpdate ($a_action)
	Create history entry and a news notification for file object update. More...
	deleteObjOrVersion ()
	Delete an object if there is no other version in it otherwise delete version. More...

Protected Attributes
	$resource_manager
	$resource_consumer
	$request
	$versioning_enabled
Protected Attributes inherited from ilObjectDAV
	$ref_id
	$obj
	$request
	$repo_helper
	$dav_helper

Detailed Description

Class ilObjFileDAV.

Implementation for ILIAS File Objects represented as WebDAV File Objects

Author

Raphael Heer rapha.nosp@m.el.h.nosp@m.eer@h.nosp@m.slu..nosp@m.ch $Id$

Definition at line 19 of file class.ilObjFileDAV.php.

Constructor & Destructor Documentation

__construct()

ilObjFileDAV::__construct	(	ilObjFile	$a_obj,
		ilWebDAVRepositoryHelper	$repo_helper,
		ilWebDAVObjDAVHelper	$dav_helper
	)

ilObjFileDAV represents the WebDAV-Interface to an ILIAS-Object

So an ILIAS is needed in the constructor. Otherwise this object would be useless.

Parameters

ilObjFile	$a_obj
ilWebDAVRepositoryHelper	$repo_helper
ilWebDAVObjDAVHelper	$dav_helper

Definition at line 42 of file class.ilObjFileDAV.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;
        $settings = new ilSetting('webdav');
        $this->resource_manager = $DIC->resourceStorage()->manage();
        $this->resource_consumer = $DIC->resourceStorage()->consume();
        $this->versioning_enabled = (bool) $settings->get('webdav_versioning_enabled', true);
        parent::__construct($a_obj, $repo_helper, $dav_helper);
    }

Here is the call graph for this function:

Member Function Documentation

checkForVirus()

ilObjFileDAV::checkForVirus ( string  $file_dest_path )

protected

Definition at line 285 of file class.ilObjFileDAV.php.

References ilLoggerFactory\getLogger(), and ilUtil\virusHandling().

    {
        $vrs = ilUtil::virusHandling($file_dest_path, '', true);
        // If vrs[0] == false -> virus found
        if ($vrs[0] == false) {
            ilLoggerFactory::getLogger('WebDAV')->error(get_class($this) . ' ' . $this->obj->getTitle() . " -> virus found on '$file_dest_path'!");
            throw new Exception\Forbidden('Virus found!');
        }
    }

Here is the call graph for this function:

createHistoryAndNotificationForObjUpdate()

ilObjFileDAV::createHistoryAndNotificationForObjUpdate (   $a_action )

protected

Create history entry and a news notification for file object update.

Parameters

$a_action

Definition at line 300 of file class.ilObjFileDAV.php.

References ilHistory\_createEntry().

Referenced by handleFileUpload().

    {
        // Add history entry and notification for new file version (stolen from ilObjFile->addFileVersion)
        switch ($a_action) {
            case "new_version":
            case "replace":
                ilHistory::_createEntry($this->obj->getId(), $a_action, $this->obj->getTitle() . "," . $this->obj->getVersion() . "," . $this->obj->getMaxVersion());
                break;
        }

        $this->obj->notifyUpdate($this->obj->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteObjOrVersion()

ilObjFileDAV::deleteObjOrVersion ( )

protected

Delete an object if there is no other version in it otherwise delete version.

Definition at line 316 of file class.ilObjFileDAV.php.

References ilUtil\delDir().

    {
        if ($this->obj->getVersion() > 1) {
            $version_dir = $this->obj->getDirectory($this->obj->getVersion());
            ilUtil::delDir($version_dir);
        } else {
            $this->obj->deleteVersions();
            $this->obj->delete();
        }
    }

Here is the call graph for this function:

get()

ilObjFileDAV::get

(

)

Returns the data.

This method may either return a string or a readable stream resource

Returns

mixed

Exceptions

Forbidden

We need this to satisfy the create process on MacOS. MacOS first posts a 0 size file and then reads it again, before then going on to post the real file.

Definition at line 95 of file class.ilObjFileDAV.php.

References getPathToFile(), and getSize().

    {
        if ($this->repo_helper->checkAccess("read", $this->obj->getRefId())) {
            if ($this->getSize() === 0) {
                return "";
            }

            if (($r_id = $this->obj->getResourceId()) &&
                ($identification = $this->resource_manager->find($r_id))) {
                return $this->resource_consumer->stream($identification)->getStream()->getContents();
            }

            /*
             * @todo: This is legacy and should be removed with ILIAS 8
             */
            if (file_exists($file = $this->getPathToFile())) {
                return fopen($file, 'r');
            }

            throw new Exception\NotFound("File not found");
        }

        throw new Exception\Forbidden("Permission denied. No read access for this file");
    }

Here is the call graph for this function:

getContentType()

ilObjFileDAV::getContentType

(

)

Returns the mime-type for a file.

If null is returned, we'll assume application/octet-stream

Returns

string|null

Definition at line 141 of file class.ilObjFileDAV.php.

    {
        return  $this->obj->getFileType();
    }

getETag()

ilObjFileDAV::getETag

(

)

Returns the ETag for a file.

An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change.

Return null if the ETag can not effectively be determined.

The ETag must be surrounded by double-quotes, so something like this would make a valid ETag:

return '"someetag"';

Returns

string|null

Definition at line 160 of file class.ilObjFileDAV.php.

References getName(), getPathToFile(), and getSize().

Referenced by handleFileUpload().

    {
        if (file_exists($path = $this->getPathToFile())) {
            return '"' . sha1(
                fileinode($path) .
                filesize($path) .
                filemtime($path)
            ) . '"';
        }

        if ($this->getSize() > 0) {
            return '"' . sha1(
                $this->getSize() .
                $this->getName() .
                $this->obj->getCreateDate()
            ) . '"';
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getName()

ilObjFileDAV::getName

(

)

Returns title of file object.

If it has a forbidden file extension -> ".sec" will be added

Returns

string

Definition at line 129 of file class.ilObjFileDAV.php.

References ilFileUtils\getValidFilename().

Referenced by getETag().

    {
        return ilFileUtils::getValidFilename($this->obj->getTitle());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPathToDirectory()

ilObjFileDAV::getPathToDirectory ( )

protected

Definition at line 262 of file class.ilObjFileDAV.php.

Referenced by getPathToFile().

    {
        return $this->obj->getDirectory($this->obj->getVersion());
    }

Here is the caller graph for this function:

getPathToFile()

ilObjFileDAV::getPathToFile ( )

protected

This method only exists for legacy reasons.

Deprecated:

Exceptions

ilFileUtilsException

Returns

string

Definition at line 275 of file class.ilObjFileDAV.php.

References getPathToDirectory(), and ilFileUtils\getValidFilename().

Referenced by get(), getETag(), and handleFileUpload().

    {
        // ilObjFile delivers the filename like it was on the upload. But if the file-extension is forbidden, the file
        // will be safed as .sec-file. In this case ->getFileName returns the wrong file name
        $path = $this->getPathToDirectory() . "/" . $this->obj->getFileName();

        // For the case of forbidden file-extensions, ::getValidFilename($path) returns the path with the .sec extension
        return ilFileUtils::getValidFilename($path);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSize()

ilObjFileDAV::getSize

(

)

Returns the size of the node, in bytes.

Returns

int

Definition at line 186 of file class.ilObjFileDAV.php.

Referenced by get(), getETag(), and put().

                              : int
    {
        return $this->obj->getFileSize();
    }

Here is the caller graph for this function:

handleFileUpload()

ilObjFileDAV::handleFileUpload	(		$a_data,
			$a_file_action
	)

Handle uploaded file.

Either it is a new file upload to a directory or it is an upload to replace an existing file.

Given data can be a resource or data (given from the sabreDAV library)

Parameters

string  |  resource

$a_data

Exceptions

Forbidden

These are temporary shenanigans for ILIAS 7. Will be removed with ILIAS 8 as it will be expected that migration was run.

Todo:

: Remove with ILIAS 8

Definition at line 213 of file class.ilObjFileDAV.php.

References $DIC, $size, CLIENT_DATA_DIR, createHistoryAndNotificationForObjUpdate(), ilPreview\createPreview(), getETag(), getPathToFile(), ilUtil\getUploadSizeLimitBytes(), and ilFileObjectToStorageMigrationRunner\migrate().

Referenced by put().

    {
        if ($a_file_action != 'create' && file_exists($this->getPathToFile())) {
            global $DIC;
            $migration = new ilFileObjectToStorageMigrationRunner(
                $DIC->fileSystem()->storage(),
                $DIC->database(),
                rtrim(CLIENT_DATA_DIR, "/") . '/ilFile/migration_log.csv'
            );
            $migration->migrate(new ilFileObjectToStorageDirectory($this->obj->getId(), $this->obj->getDirectory()));
        }

        $size = (int) $this->request->getHeader('Content-Length')[0];

        if ($size === 0 && $this->request->hasHeader('X-Expected-Entity-Length')) {
            $size = $this->request->getHeader('X-Expected-Entity-Length')[0];
        }

        if ($size > ilUtil::getUploadSizeLimitBytes()) {
            throw new Exception\Forbidden('File is too big');
        }

        $stream = Streams::ofResource($a_data);

        if ($a_file_action === 'replace') {
            $this->obj->replaceWithStream($stream, $this->obj->getTitle());
        } else {
            $this->obj->appendStream($stream, $this->obj->getTitle());
        }

        $stream->close();

        // TODO filename is "input" and metadata etc.

        if ($this->obj->update()) {
            $this->createHistoryAndNotificationForObjUpdate($a_file_action);
            ilPreview::createPreview($this->obj, true);
        }

        return $this->getETag();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

put()

ilObjFileDAV::put

(

$data

)

Replaces the contents of the file.

The data argument is a readable stream resource.

After a successful put operation, you may choose to return an ETag. The etag must always be surrounded by double-quotes. These quotes must appear in the actual string you're returning.

Clients may use the ETag from a PUT request to later on make sure that when they update the file, the contents haven't changed in the mean time.

If you don't plan to store the file byte-by-byte, and you return a different object on a subsequent GET you are strongly recommended to not return an ETag, and just return null.

Parameters

resource | string

$data

Returns

string|null

Exceptions

Forbidden

Definition at line 73 of file class.ilObjFileDAV.php.

References $data, getSize(), and handleFileUpload().

    {
        if ($this->repo_helper->checkAccess('write', $this->getRefId())) {
            if ($this->versioning_enabled === true ||
                $this->obj->getVersion() === '1' && $this->getSize() === 0) {
                // Stolen from ilObjFile->addFileVersion
                return $this->handleFileUpload($data, 'new_version');
            } else {
                return $this->handleFileUpload($data, 'replace');
            }
        }
        throw new Exception\Forbidden("Permission denied. No write access for this file");
    }

Here is the call graph for this function:

setName()

ilObjFileDAV::setName

(

$a_name

)

Parameters

string

$a_name

Exceptions

Forbidden

Definition at line 195 of file class.ilObjFileDAV.php.

    {
        if ($this->dav_helper->isValidFileNameWithValidFileExtension($a_name)) {
            parent::setName($a_name);
        } else {
            throw new Exception\Forbidden("Invalid file extension");
        }
    }

Field Documentation

$request

ilObjFileDAV::$request

protected

Definition at line 23 of file class.ilObjFileDAV.php.

$resource_consumer

ilObjFileDAV::$resource_consumer

protected

Definition at line 22 of file class.ilObjFileDAV.php.

$resource_manager

ilObjFileDAV::$resource_manager

protected

Definition at line 21 of file class.ilObjFileDAV.php.

$versioning_enabled

ilObjFileDAV::$versioning_enabled

protected

Definition at line 30 of file class.ilObjFileDAV.php.

---

The documentation for this class was generated from the following file:

• Services/WebDAV/classes/dav/class.ilObjFileDAV.php