itzbund / gsb-metadata-cleaner
Metadata cleaning and optimization for Government Site Builder (GSB) 11. This is part of the Government Site Builder (GSB) 11. The GSB 11 is a measure of the Dienstekonsolidierung Bund (DKB) of the Federal Ministry of the Interior and for Homeland (BMI) and is carried out on behalf of the Informatio
Maintainers
Details
gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_metadata_cleaner.git
Installs: 1 543
Dependents: 1
Suggesters: 1
Security: 0
Type:typo3-cms-extension
pkg:composer/itzbund/gsb-metadata-cleaner
Requires
- php: ^8.3
- typo3/cms-backend: ^13.4
Requires (Dev)
- ergebnis/composer-normalize: ^2.47.0
- helmich/typo3-typoscript-lint: ^3.3.0
- phpmd/phpmd: ^2.13
- ssch/typo3-rector: ^3.5
- typo3/coding-standards: ^0.8
- typo3/testing-framework: ^8.2
- 12.x-dev
- v2.0.0-rc.4
- v2.0.0-rc.3
- v2.0.0-rc.2
- v2.0.0-rc.1
- v2.0.0-beta.38
- v2.0.0-beta.37
- v2.0.0-beta.36
- v2.0.0-beta.35
- v2.0.0-beta.34
- v2.0.0-beta.33
- v2.0.0-beta.32
- v2.0.0-beta.31
- v2.0.0-beta.30
- v2.0.0-beta.29
- v2.0.0-beta.28
- v2.0.0-beta.27
- v2.0.0-beta.26
- v2.0.0-beta.25
- v2.0.0-beta.24
- v2.0.0-beta.23
- v2.0.0-beta.22
- v2.0.0-beta.21
- v2.0.0-beta.20
- v2.0.0-beta.19
- v2.0.0-beta.18
- v2.0.0-beta.17
- v2.0.0-beta.16
- v2.0.0-beta.15
- v2.0.0-beta.14
- v2.0.0-beta.13
- v2.0.0-beta.12
- v2.0.0-beta.11
- v2.0.0-beta.10
- v2.0.0-beta.9
- v2.0.0-beta.8
- v2.0.0-beta.7
- v2.0.0-beta.6
- v2.0.0-beta.5
- v2.0.0-beta.4
- v2.0.0-beta.3
- v2.0.0-beta.2
- v2.0.0-beta.1
- dev-main / 1.x-dev
- v1.3.34
- v1.3.33
- v1.3.33-rc.1
- v1.3.32
- v1.3.31
- v1.3.30
- v1.3.29
- v1.3.28
- v1.3.27
- v1.3.26
- v1.3.25
- v1.3.25-rc.2
- v1.3.25-rc.1
- v1.3.24
- v1.3.23
- v1.3.23-rc.1
- v1.3.22
- v1.3.21
- v1.3.21-rc.1
- v1.3.20
- v1.3.19
- v1.3.19-rc.1
- v1.3.18
- v1.3.17
- v1.3.16
- v1.3.15
- v1.3.14
- v1.3.13
- v1.3.12
- v1.3.11
- v1.3.11-rc.1
- v1.3.10
- v1.3.9
- v1.3.8
- v1.3.8-rc.1
- v1.3.7
- v1.3.6
- v1.3.5
- v1.3.5-rc.1
- v1.3.4
- v1.3.4-rc.1
- v1.3.3
- v1.3.3-rc.1
- v1.3.2
- v1.3.1
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.1
- v1.0.0
- dev-release
- dev-t3v13
This package is auto-updated.
Last update: 2025-10-09 18:22:49 UTC
README
GSB 11 Extension gsb_metadata_cleaner
About
The extension gsb_metadata_cleaner
helps the reduce the amount of data - especially personal information - in metadata of files. It uses exiftool to delete everything except for "copyright" data and tags which can be configured per storage. This applies to pdfs and images.
It is part of the Government Side Builder 11.
Installation
The best way to install this extension is to start with the GSB Sitepackage Kickstarter extension.
Quick installation without GSB Sitepackage Kickstarter
In a composer-based TYPO3 installation you can install the extension EXT:gsb_metadata_cleaner via composer:
composer config -g gitlab-domains gitlab.opencode.de && \
composer config -g repositories.gsb-metadata-cleaner vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_metadata_cleaner
composer require itzbund/gsb-metadata-cleaner
In TYPO3 installations above version 11.5 the extension will be automatically installed. You do not have to activate it manually.
Configuration
For each file storage you can configure (TCA/TSconfig
) which fields (except for copyright
/Xmp-dc:Rights
, which are always kept) are preserved.
Extension Settings
The paths to the exiftool
and qpdf
binary can be configured. Note that you cannot configure the binary name itself, just the path to the binaries.
You can disable qpdf
if it breaks you pdfs.
Feature Flags
This document explains how to use feature flags. We separate between two different kinds of feature flags:
Feature
Feature flags allow you to enable or disable specific features in your installation. \ This is of particular importance to disable features that have not passed the approval process.
Optional
Optional flags allow you to (de-)activate specific features for your installation. \ A practical use for these is the (de-)activation of an extension.
For more information about feature flags in TYPO3, please refer to the official TYPO3 Documentation on Feature Flags.
Feature Flag Configuration
Feature and Optional flags are configured in the .env
or the local-dev/.ddev/docker-compose.environment.yaml
file on ddev machine. To add a feature flag, use the following syntax:
# FEATURE FLAG
- TYPO3__SYS__features__GSB11_FEATURE_123_NEW_FEATURE=%const(bool:true)%
# OPTIONAL FLAG
- TYPO3__SYS__features__GSB11_OPTION_123_ENABLE_EXTENSION=%const(bool:true)%
In this example, both feature flags, GSB11_FEATURE_123_NEW_FEATURE
and GSB11_OPTION_123_ENABLE_EXTENSION
,
are set to true
. To disable the feature, change the value to false
or delete the setting.
Feature Flag Truth Table
This table illustrates the behavior of feature flags in various states.
Feature Flag State | Evaluated Value | Description |
---|---|---|
featureFlag = true | true | The feature is explicitly enabled. |
featureFlag = false | false | The feature is explicitly disabled. |
featureFlag = '' | false | An empty value is treated as false . |
featureFlag not exist | false | A non-existent flag defaults to false . |
Usage in PHP Code
To use a feature flag in your PHP code, you can check the flag's value with the isFeatureEnabled()
method of the Features
class:
if (GeneralUtility::makeInstance(Features::class)->isFeatureEnabled('GSB11_FEATURE_123_NEW_FEATURE')) {
echo 'Feature is enabled';
// Feature-specific code
...
}
Usage in Fluid Templates
Feature flags can also be checked in your Fluid templates with TYPO3's Feature ViewHelper.
Basic usage
<f:feature name="GSB11_FEATURE_123_NEW_FEATURE">
This is being shown if the flag is enabled
</f:feature>
Feature > then > else
<f:feature name="GSB11_OPTION_123_ENABLE_EXTENSION">
<f:then>
Flag is enabled
</f:then>
<f:else>
Flag is undefined or not enabled
</f:else>
</f:feature>
Current feature flags of gsb_metadata_cleaner
Feature flag | Description |
---|---|
currently none | - |
Usage
Nothing to do. Just include the extension and your file's metadata gets a cleanup 🧹 on upload.
Contribute
As with TYPO3, we encourage you to join the project by submitting changes. Development of the GSB 11 happens mainly in the GSB 11 TYPO3 extension repositories.
To get started, have a look at our detailed contribution walkthrough.