Resource Storage Service ======================== # Overview The Resource Storage Service should be the central place where components and plugins should manage their user uploaded files and resources. Historically ILIAS uses the file system directly in its components to manage files. There are some conventions but within the structure of a component files can be stored freely. Additional features such as versioning of files is always the responsibility of the component or the plugin. ILIAS 7 offers the Resource Storage Service for all components and plug-ins. In summary, the service allows to exchange a user upload (UploadResult from the Upload-Service) for a unique resource ID. During this exchange, the service takes care of the correct storage of the data (file as well as metadatan to the file). There is no direct access of the component to the FileSystem, neither by native PHP functions nor by the FileSystem service. As soon as the UserUpload is needed again, e.g. to display or download it, the Resource-ID can be exchanged for a corresponding delivery method. This process also does not directly access the file system by the component. ``` Component +-+ Resource | | Storage +----------+ | | Service | UPLOAD +--------------> | +----------+ | | | | | | +----------+ | | | ID <--------------+ | +----------+ | | | | | | +---------------------------------+ | | | | +----------+ | | | ID +--------------> | +----------+ | | | | | | +----------+ | | | CONSUMER <--------------+ | +----------+ | | | | | | +-+ ``` ## Terms ``` +---------------------------------------------------------------------+ | RESOURCE | +---------------------------------------------------------------------+ | | | +--------------------+ | | | IDENTIFICATION | | | +--------------------+ | | | | +-------------------+ +-------------------+ +-------------------+ | | | REVISION | | REVISION | | REVISION | | | +-------------------+ +-------------------+ +-------------------+ | | | | | | | | | | | +---------------+ | | +---------------+ | | +---------------+ | | | | | INFORMATION | | | | INFORMATION | | | | INFORMATION | | | | | +---------------+ | | +---------------+ | | +---------------+ | | | | | "FILE" | | | | "FILE" | | | | "FILE" | | | | | +---------------+ | | +---------------+ | | +---------------+ | | | | | | | | | | | +-------------------+ +-------------------+ +-------------------+ | | | +---------------------------------------------------------------------+ ``` ### Resource A Resource is the abstract term for a "thing" uploaded by a user and passed to the Resource Storage Service for management. The Resource is the combination of - Identification - Revisions - Information about the revisions - File or its contents (of the respective revisions) - Stakeholders ### Identification The identification represents the unique information about which resource is involved. This information is stored by the component itself to be able to retrieve a resource later. ### Revision Revisions contain the file together with metadata (information) and a version number. This means that a resource can have multiple revisions. The management of these revisions is the responsibility of the Service. Revisions can be added, changed or deleted from outside by the components. ### Information Information holds general metadata about a revision, such as MimeType, size, title, ... . This information is stored by the service. ### Consumer Consumers allow to "consume" a resource. This is the interface closest to the FileSystem that is allowed to start an action with the file of a revision, such as - Download - Get Stream - Retrieve content - Get the absolute Path of the file (only for legagy purposes) - ... A set of Comsumers is already part of the service. ### Stakeholder Although resources are uploaded to ILIAS by users, these users are not only responsible for a resource but also for the component in which the file has been uploaded. The service must be able to retrieve information from the component in order to decide whether a resource is needed at all or not, e.g. during cleanup processes. Or, if a resource is removed by the service for security reasons, the component must be informed about it, in order to carry out further cleanup steps. ### StorageHandler (internal) In order to be equipped for the future, the Storage Service internally uses so-called StorageHandlers to store files. In the first step this is of course a FileSystem-based storage handler. However, the way is open here to expand this at a later point in time. # Usage The use of the service should be as easy as possible from the point of view of the components and Plugins. The components should only communicate with the service according to the principle shown above, i.e. exchange uploads for identifications or exchange an identification for a consumer. # Examples In most cases most of the work is already done by the UI inputs and as a form developer you get the identification directly from the service which can then be stored in your component. In case you want to exchange an upload for an identification yourself, proceed as follows in your component: ```php getResults()['my_uploaded_file']; $stakeholder = new ilMyComponentResourceStakeholder(); $identification = $DIC['resource_storage']->manage()->upload($upload_result, $stakeholder); // then store the $identification whereever I need it in my component ``` Suppose we already have a file stored in the Storage Service and would download it in our component. We had stored the identification, with which a corresponding consumer can now be obtained to download the file. ```php getMyResourceIDasString(); // we get the stored ID of the resource $identification = $DIC['resource_storage']->manage()->find($rid_string); if (null !== $identification) { $DIC['resource_storage']->consume()->download($identification)->run(); } else { // there is no such resource in the storage service } ``` Adding a new revision is as simple as that: ```php getMyResourceIDasString(); // we get the stored ID of the resource $identification = $DIC['resource_storage']->manage()->find($rid_string); $upload_result = $DIC['upload']->getResults()['my_uploaded_file']; $stakeholder = new ilMyComponentResourceStakeholder(); if (null !== $identification) { $DIC['resource_storage']->manage()->appendNewRevision($identification, $upload_result, $stakeholder); } else { // there is no such resource in the storage service } ``` # Drafts Revisions are published by default. However, a maximum of one revision can be added to a resource in the status DRAFT on top. Cosumers continue to receive the latest revision that has been published. As long as a DRAFT revision exists, no new revisions can be created, but the current DRAFT revision will be updated until the one published via `Manager::publish`. ## Example ```php // Create new Resource from Upload use ILIAS\ResourceStorage\Services; global $DIC; /** @var Services $irss */ $irss = $DIC['resource_storage']; $upload_result = $DIC['upload']->getResults()['my_uploaded_file']; $stakeholder = new ilMyComponentResourceStakeholder(); $rid = $irss->manage()->upload($upload_result, $stakeholder); // later, add a draft: $new_upload_result = $DIC['upload']->getResults()['my_uploaded_file']; $revision = $irss->manage()->appendNewRevision($rid, $upload_result, $stakeholder, null, true); // $revision->getStatus() is RevisionStatus::DRAFT $latest_published_revision = $irss->manage()->getCurrentRevision($rid); // First upload $latest_draft_revision = $irss->manage()->getCurrentRevisionIncludingDraft($rid); // Second Upload $irss->manage()->publish($rid); // Publish the latest draft revision $latest_published_revision = $irss->manage()->getCurrentRevision($rid); // Second File $latest_published_revision = $irss->manage()->getCurrentRevisionIncludingDraft($rid); // Second File // im some cases you want to unpublish the latest revision again $irss->manage()->unpublish($rid); $latest_published_revision = $irss->manage()->getCurrentRevision($rid); // First upload $latest_draft_revision = $irss->manage()->getCurrentRevisionIncludingDraft($rid); // Second Upload ``` # Collections In many cases a component does not only need a single resource to be stored, but wants to be able to use a collection of resources (e.g. in an exercise unit several files can be delivered per person). For this purpose `Collections` can be used in IRSS. A collection always contains a collection of ResourceIdentifications in a defined order. The management of collections is done via: ```php $DIC['resource_storage']->collection(); ``` To use a collection, a new collection-id can be created: ```php $rcid = $DIC['resource_storage']->collection()->id(); ``` Or an existing collection-id can be called: ```php $rcid = $DIC['resource_storage']->collection()->id("f0e564e2-5d48-4d33-a8e6-bdc2646900d7"); ``` Retrieving the collection itself is done via: ```php // $rcid see example above $collection = $DIC['resource_storage']->collection()->get($rcid); ``` ResourceIdentifications can now be added to such a collection, e.g. after the upload. The collection must be saved afterwards: ```php $irss = $DIC['resource_storage']; $rcid = $irss->collection()->id("f0e564e2-5d48-4d33-a8e6-bdc2646900d7"); $collection = $irss->collection()->get($rcid); $this->upload->process(); $result = array_values($this->upload->getResults())[0]; if ($result->isOK()) { $id = $irss->manage()->upload($result, $this->stakeholder); $collection->add($id); // adding a resource to the collection } $irss->collection()->store($collection); // saving the collection ``` Collections can be explicitly assigned to a user ID, and such collections can later be retrieved and modified only on the basis of this user ID: ```php // create new collection for user 6 $rcid = $DIC['resource_storage']->collection()->id(null, 6); // return a collection with e.g. ID "f0e564e2-5d48-4d33-a8e6-bdc2646900d7" // ... accessing the same collection with another user-id results in an exception $rcid = $DIC['resource_storage']->collection()->id("f0e564e2-5d48-4d33-a8e6-bdc2646900d7", 13); ``` To get the ResourceIdentifications assigned to a collection, they can be accessed as follows: ```php $rcid = $DIC['resource_storage']->collection()->id("f0e564e2-5d48-4d33-a8e6-bdc2646900d7"); $collection = $irss->collection()->get($rcid); foreach ($collection->->getResourceIdentifications() as $rid) { // do something with the resource $file_stream = $DIC['resource_storage']->consume()->stream($rid)->getStream(); } ``` Collections can also be easily downloaded as a ZIP file. ```php $rcid = $DIC['resource_storage']->collection()->id("f0e564e2-5d48-4d33-a8e6-bdc2646900d7"); $DIC['resource_storage']->consume()->downloadCollection($rcid)->run(); ``` Besides storing collections (`store`) there are also `clone` and `remove`. ## Sorting and Ranges of Collections A collection can be sorted for display, various options are available for this: ```php use ILIAS\ResourceStorage\Collection\Collections; /** @var Collections $collection_services */ $collection_services = $DIC['resource_storage']->collection(); $rcid = $collection_services ->id("f0e564e2-5d48-4d33-a8e6-bdc2646900d7"); $collection = $irss->collection()->get($rcid); // By Title $collection_sorted_by_title_asc = $collection_services->sort($collection)->asc()->byTitle(); $collection_sorted_by_title_desc = $collection_services->sort($collection)->desc()->byTitle(); // By Creation Date $collection_sorted_by_creation_date_asc = $collection_services->sort($collection)->asc()->byCreationDate(); $collection_sorted_by_creation_date_desc = $collection_services->sort($collection)->desc()->byCreationDate(); // By File-Size $collection_sorted_by_filesize_asc = $collection_services->sort($collection)->asc()->bySize(); $collection_sorted_by_filesize_desc = $collection_services->sort($collection)->desc()->bySize(); ``` These are in-memory sorts. But if you want to store the sort permanently, you can do this as follows: ```php $collection_services->sort($collection)->asc()->andSave()->bySize(); ``` To display only a part of a collection, you can obtain a range of a collection. In this case you get the `ResourceIdentification` directly either as `array` or as `\Generator`: ```php use ILIAS\ResourceStorage\Collection\Collections; /** @var Collections $collection_services */ $collection_services = $DIC['resource_storage']->collection(); $rcid = $collection_services ->id("f0e564e2-5d48-4d33-a8e6-bdc2646900d7"); $collection = $irss->collection()->get($rcid); // Get only a range of the collection $range_generator = $collection_services->rangeAsGenerator($collection, 10, 200); $range_array = $collection_services->rangeAsArray($collection, 10, 200); ``` # Resource Flavours Flavours are derivatives of resources that can be created, managed and used alongside the original resource. A simple example are different resolutions of images: If a person uploads e.g. a profile picture with 20MB size, the IRSS can generate several flavours from it, e.g. a 500x500px flavour in an adapted quality, which can be used for the representation in a member gallery, without the full resolution with 20MB having to be loaded and displayed in the browser. Similar approaches exist in ILIAS in many places, but always the components themselves must ensure that the desired " derivatives" are available, stored and can be retrieved. With the Flavours the IRSS offers this centrally. ## Structure of Flavours For the creation of Flavours technically 3 things are needed: - Definition - Machine - Engine `Definition`: The consoments of the flavours use in most cases a definition, which kind of flavour they would like to get from the IRSS. For many cases the IRSS already offers possible definitions that can be configured. One definition is for example "A preview image with max. 500x500px". `Machine`: A machine can process such a definition and create the desired flavors. For a definition, there must always be a machine that can process this definition. For the definitions provided by the IRSS there are also corresponding machines. `Engine`: A machine sometimes needs an engine to be able to create the desired flavours. Such engines are e.g. packages like `Imagick` or `GD`. Some machines also get along with a simple `NoEngin`. ## How to use Flavours Let's take the example of file objects: Already in older versions of ILIAS preview files could be created for file objects, different file types were supported. In the case of PDFs, for example, the first 5 pages are generated as a preview image. The file object can now request this process from the IRSS via a definition. The IRSS knows two methods for the creation or retrieval of flavors: ```php global $DIC; $irss = $DIC->resourceStorage(); $irss->flavours()->ensure(...); $irss->flavours()->get(...); ``` `ensure` can be used to trigger the creation of the flavours, e.g. after an upload of a new file. `get` creates them as well, but you also get the result directly and can display the flavors. With the following setup we generate max. 10 thumbnails for a resource. The IRSS takes all file types and generates up to 10 thumbnails, if the file type of the resource is supported by the `Engine`. So in case of PDF you get 10 thumbnails, in case of JPG only one. Other file types do not result in any preview image. ```php global $DIC; $irss = $DIC->resourceStorage(); // the ResourceIdentification we want to get the flavours for $rid = $irss->manage()->find('53ed29e0-7c13-49f0-a077-bcb5f87fa50c'); $definition = new PagesToExtract( true, // persistent, Flavours are stored in FileSystem, otherwise it's in-memory 280, // max size (w/h) of the preview image 10 // max number of pages to extract ); $flavour = $irss->flavours()->get($rid, $definition); ``` The result is a `Flavour` object. These contain some meta data about the flavour and with `getTokens` you can access alls `Tokens` for StreamAccess (see below). Normally, you would now want displayable URLs for these FlavourStreams. The `Consumer` service of the IRSS supports this accordingly (which uses those `Tokens` inside): ```php $flavour = $irss->flavours()->get($rid, $definition); $urls_of_flavour_streams = $irss->consume()->flavourUrls($flavour); // create UI Images for each flavour stream $images = array_map(function (string $url): Image { return $this->ui->factory()->image()->standard($url, 'Flavour'); }, $urls_of_flavour_streams); ``` The `flavourUrls` consumer already supports the `WebAccessChecker` and the URLS are signed accordingly. ## Tokens for StreamAccess The `Flavour` object contains a list of `Tokens` for the `StreamAccess` service. These tokens can be used to access the Stream of a Flavour or of a Revision, but you hopefully won't ever need to do this directly. The `Consumer` service of the IRSS supports this accordingly (which uses those `Tokens` inside). Tokens are a mechanism to manage write (and later read) access to streams from the IRSS. In a first step, the WebAccessChecker also uses these tokens to know which revision or flavor exactly should be delivered. As I said, if you are a consumer of the IRSS, you use the Consumers approach anyway. # Other (involved) Services - UploadService, see [here](../FileUpload/README.md) - FileSystem-Service, see [here](../Filesystem/README.md) # Migration - Migration will need at least the feature ["Migrate Command"](https://docu.ilias.de/goto_docu_wiki_wpage_6399_1357.html) - A documentation how you can migrate your component is [here](../../components/ILIAS/ResourceStorage_/MIGRATIONS.md). # Roadmap Please see the roapmap of the service in [README.md](ROADMAP.md) # Events The IRSS offers an interface for events, which follows the general observer pattern. To be informed about events, a separate class is implemented with the interface `\ILIAS\ResourceStorage\Events\Observer`. This can be registered via the IRSS service: ```php global $DIC; $observer = new MyObserver(); // implements \ILIAS\ResourceStorage\Events\Observer $DIC->resourceStorage()->events()->attach( $observer, \ILIAS\ResourceStorage\Events\Event::COLLECTION_RESOURCE_ADDED ); ``` For the example of the event `\ILIAS\ResourceStorage\Events\Event::COLLECTION_RESOURCE_ADDED`, the data obtained is the class `\ILIAS\ResourceStorage\Events\CollectionData` with the ResourceIdentification and the ResourceCollectionIdentification each as a string. As soon as further events are available, these are described in the enum `\ILIAS\ResourceStorage\Events\Event` and here in the README.