ilDAVFile Class Reference

Inheritance diagram for ilDAVFile:

Collaboration diagram for ilDAVFile:

Public Member Functions
	__construct (protected ilObjFile $obj, protected ilWebDAVRepositoryHelper $repo_helper, Services $resource_storage, protected RequestInterface $request, protected ilWebDAVObjFactory $dav_factory, protected bool $versioning_enabled)
	put ($data, ?string $name=null)
	get ()
	getName ()
	getContentType ()
	getETag ()
	getSize ()
	noSizeCheckNeeded ()
	setName ($name)
	delete ()
	getLastModified ()

Protected Member Functions
	clearLocks ()

Protected Attributes
Manager	$resource_manager
Consumers	$resource_consumer
bool	$needs_size_check = true
int	$temporary_size = null

Detailed Description

Author

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

Definition at line 32 of file class.ilDAVFile.php.

Constructor & Destructor Documentation

__construct()

ilDAVFile::__construct	(	protected ilObjFile	$obj,
		protected ilWebDAVRepositoryHelper	$repo_helper,
		Services	$resource_storage,
		protected RequestInterface	$request,
		protected ilWebDAVObjFactory	$dav_factory,
		protected bool	$versioning_enabled
	)

Definition at line 46 of file class.ilDAVFile.php.

References ILIAS\ResourceStorage\Services\consume(), and ILIAS\ResourceStorage\Services\manage().

      {
        $this->resource_manager = $resource_storage->manage();
        $this->resource_consumer = $resource_storage->consume();
    }

Here is the call graph for this function:

Member Function Documentation

clearLocks()

ilDAVFile::clearLocks ( )

protected

Definition at line 58 of file class.ilDAVFile.php.

References null.

Referenced by put().

                                   : void
    {
        $this->repo_helper->locks()->purgeExpiredLocksFromDB();
        $lock = $this->repo_helper->locks()->getLockObjectWithObjIdFromDB($this->obj->getId());
        if ($lock !== null) {
            $this->repo_helper->locks()->removeLockWithTokenFromDB($lock->getToken());
        }
    }

Here is the caller graph for this function:

delete()

ilDAVFile::delete

(

)

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

                            : void
    {
        $this->repo_helper->deleteObject($this->obj->getRefId());
    }

get()

ilDAVFile::get

(

)

Returns

string|resource

Definition at line 136 of file class.ilDAVFile.php.

    {
        if (!$this->repo_helper->checkAccess("read", $this->obj->getRefId())) {
            throw new Forbidden("Permission denied. No read access for this file");
        }

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

getContentType()

ilDAVFile::getContentType

(

)

Definition at line 164 of file class.ilDAVFile.php.

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

getETag()

ilDAVFile::getETag

(

)

Definition at line 169 of file class.ilDAVFile.php.

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

Referenced by put().

                             : ?string
    {
        if ($this->getSize() > 0) {
            return '"'
                . sha1(
                    (string) $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:

getLastModified()

ilDAVFile::getLastModified

(

)

Definition at line 218 of file class.ilDAVFile.php.

                                     : ?int
    {
        return $this->retrieveLastModifiedAsIntFromObjectLastUpdateString($this->obj->getLastUpdateDate());
    }

getName()

ilDAVFile::getName

(

)

Definition at line 149 of file class.ilDAVFile.php.

References ensureSuffix(), and extractSuffixFromFilename().

Referenced by getETag(), and put().

                             : string
    {
        $title = $this->obj->getTitle();
        $suffix = empty($this->obj->getFileExtension())
            ? $this->extractSuffixFromFilename($title)
            : $this->obj->getFileExtension();

        $return_title = $this->ensureSuffix(
            $title,
            $suffix
        );

        return $return_title;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSize()

ilDAVFile::getSize

(

)

Definition at line 184 of file class.ilDAVFile.php.

Referenced by getETag(), and put().

                             : int
    {
        try {
            return $this->obj->getFileSize();
        } catch (Throwable) {
            return -1;
        }
    }

Here is the caller graph for this function:

noSizeCheckNeeded()

ilDAVFile::noSizeCheckNeeded

(

)

Definition at line 193 of file class.ilDAVFile.php.

                                       : void
    {
        $this->needs_size_check = false;
    }

put()

ilDAVFile::put	(		$data,
		?string	$name = null
	)

Parameters

string | resource

$data

Definition at line 70 of file class.ilDAVFile.php.

References $data, $version, clearLocks(), ensureSuffix(), extractSuffixFromFilename(), getETag(), getName(), ilFileUtils\getPhpUploadSizeLimitInBytes(), getSize(), ILIAS\Repository\int(), and null.

                                                    : ?string
    {
        if (!$this->repo_helper->checkAccess('write', $this->obj->getRefId())) {
            throw new Forbidden("Permission denied. No write access for this file");
        }
        if ($name === null) {
            $name = $this->getName();
        }
        $size = 0;
        $name ??= $this->getName();
        $name = $this->ensureSuffix($name, $this->extractSuffixFromFilename($name));

        $stream = is_resource($data) ? Streams::ofResource($data) : Streams::ofString($data);
        $stream_size = $stream->getSize();

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

        if ($size > ilFileUtils::getPhpUploadSizeLimitInBytes()) {
            // remove already created file?
            throw new Forbidden('File is too big');
        }

        if ($this->needs_size_check && $this->getSize() === 0) {
            $parent_ref_id = $this->repo_helper->getParentOfRefId($this->obj->getRefId());
            $file_dav = $this->dav_factory->createDAVObject($this->obj, $parent_ref_id);
            $file_dav->noSizeCheckNeeded();

            return $file_dav->put($data);
        }

        $resource = $stream->detach();
        if ($resource === null) {
            return null;
        }
        $stream = Streams::ofResource($resource);

        if ($this->versioning_enabled) {
            $version = $this->obj->getVersion(true);
            if (($stream_content = (string) $stream) !== '') {
                $version = $this->obj->appendStream(
                    Streams::ofString($stream_content),
                    $name
                );
            }
        } else {
            $version = $this->obj->replaceWithStream($stream, $name);
        }

        $stream->close();
        $this->clearLocks();

        if ($version > 0) {
            // $this->obj->publish();
            return $this->getETag();
        }
        return null;
    }

Here is the call graph for this function:

setName()

ilDAVFile::setName

(

$name

)

Definition at line 198 of file class.ilDAVFile.php.

References ensureSuffix(), extractSuffixFromFilename(), and ilWebDAVNotDavableException\OBJECT_TITLE_NOT_DAVABLE.

                                  : void
    {
        if (!$this->repo_helper->checkAccess("write", $this->obj->getRefId())) {
            throw new Forbidden('Permission denied');
        }

        if ($this->isDAVableObjTitle($name) &&
            $name === $this->obj->checkFileExtension($this->getName(), $name)) {
            $this->obj->setTitle($this->ensureSuffix($name, $this->extractSuffixFromFilename($name)));
            $this->obj->update();
        } else {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_TITLE_NOT_DAVABLE);
        }
    }

Here is the call graph for this function:

Field Documentation

$needs_size_check

bool ilDAVFile::$needs_size_check = true

protected

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

$resource_consumer

Consumers ilDAVFile::$resource_consumer

protected

Definition at line 40 of file class.ilDAVFile.php.

$resource_manager

Manager ilDAVFile::$resource_manager

protected

Definition at line 39 of file class.ilDAVFile.php.

$temporary_size

int ilDAVFile::$temporary_size = null

protected

Definition at line 44 of file class.ilDAVFile.php.

---

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

• components/ILIAS/WebDAV/classes/dav/class.ilDAVFile.php