File metadata manager
This module provides a service to extract and manage metadata from various file types, including image EXIF data and font information. It uses a pluggable system, allowing developers to add support for new metadata formats, and caches this information to improve performance.
A module that provides a file metadata manager service and API. Allows to get, via an unified API, information stored in files like EXIF photo information, TrueType font information, etc.
Metadata protocols are pluggable. Developers can implement a plugin and use the service framework to get the metadata required.
The following plugins are provided by the module:
- exif - Uses the PHP Exif Library to read/write EXIF information to image files, bypassing the limitations of the standard PHP Exif extensions which only provides read capabilities. Enable the File metadata - EXIF submodule to enable this plugin.
- font - Uses the PHP Font Lib to read font information from TTF/OTF/WOFF font files. Enable the File metadata - Font submodule to enable this plugin.
- getimagesize - Caches calls to the PHP
getimagesize()function.
Plugins provided by other modules:
- pdf - provided by the File metadata manager - PDF module. Uses the PDF parser library to read metadata from PDF files.
Features:
- Load from, and save to, file embedded metadata directly from the files.
- Metadata for a file is statically cached during a request's lifetime. This avoids different modules all repeat I/O on the same file.
- Metadata can be cached in a Drupal cache bin to avoid repeating I/O on the files in successive requests.
- Metadata standards (EXIF, TTF, etc.) are implemented as plugins. The service loads the metadata plugin needed based on the calling code request.
- Manages copying to/from local temporary storage files stored in remote file systems, to allow PHP functions that do not support remote stream wrappers access the file locally.
This module is inspired by discussions at #2630242: Provide methods to retrieve EXIF image information via the Image object.
Installation
The module MUST be installed using Composer.
Configuration:
- Go to Manage > Configuration > System > File Metadata Manager and specify
the cache retention requirements, in general and/or per each metadata plugin.