GetFileInfoResponse.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\WOPI\Handler;
 
use ILIAS\ResourceStorage\Revision\Revision;
use ILIAS\Data\URI;
 
class GetFileInfoResponse extends Response
{
    public function __construct(
        Revision $revision,
        int $current_user_id,
        bool $editable = false,
        ?bool $user_can_write = null
    ) {
        $user_can_write ??= $editable;
        $URI = new URI(ILIAS_HTTP_PATH);
        $origin = $URI->getSchema() . '://' . $URI->getHost();
        $lookup_name = \ilObjUser::_lookupName($current_user_id);
 
        $title = preg_replace('/\.[^.]*$/', '', $revision->getTitle())
            . '.' . $revision->getInformation()->getSuffix();
 
        parent::__construct([
            self::BASE_FILE_NAME => $title,
            self::VERSION => (string) $revision->getVersionNumber(),
            // the WOPI specification asks for strings
            self::OWNER_ID => (string) $revision->getOwnerId(),
            self::USER_ID => (string) $current_user_id,
            self::SIZE => $revision->getInformation()->getSize(),
            self::SUPPORTS_CONTAINERS => false,
            self::SUPPORTS_DELETE_FILE => false,
            self::SUPPORTS_UPDATE => $editable,
            self::READ_ONLY => !$editable,
            self::USER_CAN_WRITE => $user_can_write,
            self::USER_FRIENDLY_NAME => $lookup_name['firstname'] . ' ' . $lookup_name['lastname'],
            self::LAST_MODIFIED_TIME => $revision->getInformation()->getCreationDate()->format(DATE_ATOM),
            self::USER_CAN_NOT_WRITE_RELATIVE => true,
            self::POST_MESSAGE_ORIGIN => $origin,
            self::CLOSE_BUTTON_CLOSES_WINDOW => false,
            // ILIAS has no handler for the UI_Edit message, so it must not announce one:
            // clients offer a way into edit mode when EditModePostMessage is true, and
            // that button would do nothing here.
            self::EDIT_MODE_POST_MESSAGE => false,
            self::EDIT_NOTIFICATION_POST_MESSAGE => true,
            // ILIAS closes the client itself (mode info of the editor page, the modal of the
            // preview) and has no handler for the UI_Close message. Without CloseUrl and
            // ClosePostMessage clients do not show a close button of their own.
            self::CLOSE_POST_MESSAGE => false,
            self::SUPPORTS_LOCKS => true,
            self::SUPPORTS_GET_LOCK => true,
            self::SUPPORTS_EXTENDED_LOCK_LENGTH => true,
            self::USER_CAN_RENAME => false
        ]);
    }
}