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)
	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 Returns the name of the node.This is used to generate the url. Returns string . More...
	getObject ()
	Returns ILIAS Object. More...
Public Member Functions inherited from Sabre\DAV\Node
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...
	delete ()
	Deletes the current node. More...
	setName ($name)
	Renames the node. More...

Protected Member Functions
	fileUploadWithStream ($a_data, string $file_dest_path)
	Write given data (as Resource) to the given file. More...
	fileUploadWithString (string $a_data, string $file_dest_path)
	Write given data (as string) to the given file. More...
	getPathToDirectory ()
	getPathToFile ()
	This method is called in 2 use cases: More...
	checkForVirus (string $file_dest_path)
	setObjValuesForNewFileVersion ()
	Set object values for a new file version. More...
	createHistoryAndNotificationForObjUpdate ()
	Create history entry and a news notification for file object update. More...

Protected Attributes
	$obj
Protected Attributes inherited from ilObjectDAV
	$ref_id
	$obj
	$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 38 of file class.ilObjFileDAV.php.

    {
        parent::__construct($a_obj, $repo_helper, $dav_helper);
    }

Member Function Documentation

checkForVirus()

ilObjFileDAV::checkForVirus ( string  $file_dest_path )

protected

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

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

Referenced by handleFileUpload().

    {
        $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'!");
            unlink($file_dest_path);
            $this->obj->delete();
            throw new Exception\Forbidden('Virus found!');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createHistoryAndNotificationForObjUpdate()

ilObjFileDAV::createHistoryAndNotificationForObjUpdate ( )

protected

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

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

References ilHistory\_createEntry().

Referenced by handleFileUpload().

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

Here is the call graph for this function:

Here is the caller graph for this function:

fileUploadWithStream()

ilObjFileDAV::fileUploadWithStream (   $a_data, string  $file_dest_path  )

protected

Write given data (as Resource) to the given file.

Parameters

Resource	$a_data
string	$file_dest_path

Exceptions

Exception

Returns

number

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

References ilLoggerFactory\getLogger().

Referenced by handleFileUpload().

    {
        try {
            $written_length = 0;
            $write_stream = fopen($file_dest_path, 'w');
            while (!feof($a_data)) {
                if (false === ($written = fwrite($write_stream, fread($a_data, 4096)))) {
                    fclose($write_stream);
                    throw new Exception\Forbidden('Forbidden to write file');
                }
                $written_length += $written;
            }
        } catch (Exception $e) {
            ilLoggerFactory::getLogger('WebDAV')->error("Error on uploading {$this->obj->getTitle()} to path $file_dest_path with message: " . $e->getMessage());
            throw new Exception();
        } finally {
            fclose($write_stream);
        }
        
        return $written_length;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fileUploadWithString()

ilObjFileDAV::fileUploadWithString ( string  $a_data, string  $file_dest_path  )

protected

Write given data (as string) to the given file.

Parameters

string	$a_data
string	$file_dest_path

Exceptions

Forbidden

Returns

number $written_length

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

Referenced by handleFileUpload().

    {
        $write_stream = fopen($file_dest_path, 'w');
        $written_length = fwrite($write_stream, $a_data);
        fclose($write_stream);
        if ($written_length === false && strlen($a_data) > 0) {
            throw new Exception\Forbidden('Forbidden to write file');
        }
        return $written_length;
    }

Here is the caller 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

Implements Sabre\DAV\IFile.

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

References getPathToFile().

    {
        if ($this->repo_helper->checkAccess("read", $this->obj->getRefId())) {
            $file = $this->getPathToFile();
            if (file_exists($file)) {
                return fopen($file, 'r');
            } else {
                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

Implements Sabre\DAV\IFile.

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

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

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

Implements Sabre\DAV\IFile.

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

References $path, and getPathToFile().

Referenced by put().

    {
        if (file_exists($path = $this->getPathToFile())) {
            return '"' . sha1(
                fileinode($path) .
                filesize($path) .
                filemtime($path)
            ) . '"';
        }
        
        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

Implements Sabre\DAV\INode.

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

References ilFileUtils\getValidFilename().

Referenced by handleFileUpload().

    {
        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 266 of file class.ilObjFileDAV.php.

Referenced by getPathToFile(), and handleFileUpload().

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

Here is the caller graph for this function:

getPathToFile()

ilObjFileDAV::getPathToFile ( )

protected

This method is called in 2 use cases:

Use case 1: Get the path to an already existing file to download it -> read operation Use case 2: Get the path to save a new file into or overwrite an existing one -> write operation

Exceptions

ilFileUtilsException

Returns

string

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

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

Referenced by get(), getETag(), getSize(), 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

Implements Sabre\DAV\IFile.

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

References getPathToFile().

    {
        if (file_exists($this->getPathToFile())) {
            return $this->obj->getFileSize();
        }
        return 0;
    }

Here is the call graph for this function:

handleFileUpload()

ilObjFileDAV::handleFileUpload

(

$a_data

)

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

BadRequest
Forbidden

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

References checkForVirus(), createHistoryAndNotificationForObjUpdate(), fileUploadWithStream(), fileUploadWithString(), ilLoggerFactory\getLogger(), getName(), getPathToDirectory(), getPathToFile(), ilMimeTypeUtil\lookupMimeType(), and ilUtil\makeDirParents().

Referenced by put().

    {
        // Set name for uploaded file because due to the versioning, the title can change for different versions. This setter-call here
        // ensures that the uploaded file is saved with the title of the object. This obj->setFileName() has to be called
        // before $this->getPathToFile(). Otherwise, the file could be saved under the wrong filename.
        $this->obj->setFileName($this->getName());
        $file_dest_path = $this->getPathToFile();

        // If dir does not exist yet -> create it
        if (!file_exists($file_dest_path)) {
            ilUtil::makeDirParents($this->getPathToDirectory());
        }
        
        // File upload
        if (is_resource($a_data)) {
            $written_length = $this->fileUploadWithStream($a_data, $file_dest_path);
        } elseif (is_string($a_data)) {
            $written_length = $this->fileUploadWithString($a_data, $file_dest_path);
        } else {
            ilLoggerFactory::getLogger('WebDAV')->warning(get_class($this) . ' ' . $this->obj->getTitle() . " -> invalid upload data sent");
            throw new Exception\BadRequest('Invalid put data sent');
        }
        
        // Security checks
        $this->checkForVirus($file_dest_path);

        // Set last meta data
        include_once("./Services/Utilities/classes/class.ilMimeTypeUtil.php");
        $this->obj->setFileType(ilMimeTypeUtil::lookupMimeType($file_dest_path));
        $this->obj->setFileSize($written_length);
        if ($this->obj->update() && $this->obj->getMaxVersion() > 1) {
            $this->createHistoryAndNotificationForObjUpdate();
        }
    }

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

BadRequest
Forbidden

Implements Sabre\DAV\IFile.

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

References $data, getETag(), handleFileUpload(), and setObjValuesForNewFileVersion().

    {
        if ($this->repo_helper->checkAccess('write', $this->getRefId())) {
            $this->setObjValuesForNewFileVersion();
            $this->handleFileUpload($data);
            return $this->getETag();
        }
        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

Implements Sabre\DAV\INode.

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

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

setObjValuesForNewFileVersion()

ilObjFileDAV::setObjValuesForNewFileVersion ( )

protected

Set object values for a new file version.

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

Referenced by put().

    {
        // This is necessary for windows explorer. Because windows explorer makes always 2 PUT requests. One with a 0 Byte
        // file to test, if the user has write permissions and the second one to upload the original file.
        if ($this->obj->getFileSize() > 0) {
            // Stolen from ilObjFile->addFileVersion
            $this->obj->setVersion($this->obj->getMaxVersion() + 1);
            $this->obj->setMaxVersion($this->obj->getMaxVersion() + 1);
        }
    }

Here is the caller graph for this function:

Field Documentation

$obj

ilObjFileDAV::$obj

protected

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

---

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

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