Backend Module 

The extension adds some fields to the sys_file_storage database table to store quota configuration per storage. After the extension has been successfully installed, access to a new backend module FAL Quota in the FILE section [1] may be enabled for Backend Users and Groups via TYPO3 module configuration:

The module provides an overview for all storages currently sorted by UID and their configured quota settings [2].

Enabling Quota for a Storage 

To enable Quotas for a storage, you must set up a quota [1], a hard limit [2] and optionally a threshold (defaults to 75 %) [3] and email recipient(s). Multiple recipient addresses are separated by comma (,) [4].

The example above defines a soft quota of 10 MB [1] and a hard limit of 15 MB [2]. Hard limit values must be equal to or greater than the soft quota values. The notification threshold value [3] defines the limit where the utilization check starts sending email notifications (if recipients have been specified and the Scheduler task has been configured. See Configuration for details).

Additional recipients can optionally provided by a PSR event listener.

Example Configuration/Services.yaml:

services:
  MyVendor\MyProject\EventListener\AddAdditionalRecipients:
    public: true
    tags:
      - name: event.listener
        identifier: 'MyVendor-MyProject-AddAdditionalRecipients'
        event: MyVendor\MyProject\Event\AddAdditionalRecipientsEvent

Example Classes/EventListener/AddAdditionalRecipients.php:

<?php

namespace MyVendor\MyProject\EventListener;

use Mehrwert\FalQuota\Event\AddAdditionalRecipientsEvent;

readonly class AddAdditionalRecipients
{
    private const array ADDITIONAL_RECIPIENTS = [
        1 => [
          'person-for-storage-1@example.org',
        ],
        2 => [
          'person-for-storage-2@example.org',
          'another-person-for-storage-2@example.org',
        ],
    ];

    public function __invoke(AddAdditionalRecipientsEvent $event): void
    {
        $storageId = $event->getStorage()->getUid();
        $event->setAdditionalRecipients(
            self::ADDITIONAL_RECIPIENTS[$storageId] ?? []
        );
    }
}

Overview of Storage with Quota 

If quota limits have been configured for some of your storages, the backend module of FAL Quota shows those quota settings in the list view but without the Scheduler task (or a manual update via CLI) without the current storage utilization [1]:

As soon as you run the CLI task/Scheduler task the utilization will be updated and Current Storage taken [1] will show the space in use. Storage record rows ar marked with a yellow background if the threshold is reached or with a red background if the quota limit has been reached/exceeded.

Scheduler Tasks for FAL Quota 

As of 1.7.0 workflows for statictics update and email notification have been split in two tasks. Since 1.7.0 it is possible to perform frequent updates of usage statictis and send notifications only once in a while.

Scheduler Task to update Quota Statistics 

To create a task for a recurring update of the quota statistics and to automatically send notification mails go to SYSTEM > Scheduler > Scheduled tasks and click on the plus sign to add a task. Choose Execute console commands from the Class list [1]. Click on the option list for Schedulable Command. Save and reopen to define command arguments and select the Symfony command fal_quota:quota:update: Update Quota Statistics for storages from the list [2].

Manually update Quota Statistics 

The task can also be manually executed on the command line using the TYPO3 CLI:

./public/typo3/sysext/core/bin/typo3 fal_quota:quota:update

You can optionally specify the UID of a storage to update a single storage record:

./public/typo3/sysext/core/bin/typo3 fal_quota:quota:update 1

Scheduler Task for Email Notifications 

The email notifications is currently very basic and just sends an informal mail about the storage reaching quota limits.

The scheduler task for notifications can be configured in cron style (in this example (0 10 * * */5): Every friday at 10 a.m.).

Backend Integration and Warnings 

Warnings are issued as flash messages and shown in the FILE > Filelist module [1]:

Supported Platforms 

FAL Quota uses TYPO3 standard Hooks and Singals/Slots to do the checks and thus should run on all supported platforms with storages using a Local driver. However it has not yet been tested on Windows installations where the disk_free_space() method could have issues. Feedback welcome!