Sophron

Sophron of Syracuse (Greek: Σώφρων ὁ Συρακούσιος, fl. 430 BC) was a writer of mimes (Wikipedia).

Sophron of Drupal is a module to enhance MIME type management, based on the FileEye/MimeMap library.

Features

• Enhances Drupal's MIME type detection based on file extension to recognise 1200+ MIME types from 1600+ file extensions (vs Drupal's 360 MIME types and 475 file extensions).
• Provides an extensive MIME type management API through FileEye/MimeMap.
• Optionally replaces Drupal's core MIME type extension-based guesser.

Installation

• Install the required module packages with Composer. From the Drupal installation root directory, type

$ composer require drupal/sophron

This will download both the module and any dependency. Composer will automatically download the module's release that is most appropriate for the version of Drupal currently installed.

• Enable the module. Navigate to Manage > Extend. Check the box next to the module and then click the 'Install' button at the bottom.

Override Drupal core MIME type guessing

The Sophron module by itself just provides a service and an API for MIME type management. You can enable the complimentary Sophron guesser module to let Sophron manage the MIME type guessing, overriding Drupal core's guesser.

NOTE: The Sophron guesser module does not invoke the hook_file_mimetype_mapping_alter hook to allow altering the mapping of MIME types to file extensions. If you need to modify mappings, use the Sophron configuration UI (see below) to replicate any mapping changes. Alternatively, modules can implement event subscribers that react to a Drupal\sophron\Event\MapEvent::INIT event that is fired when a map is initialised, and make the necessary changes to the mappings.

Configuration

• Go to Administration » Configuration » System » MIME Types.

• In the 'Mapping' tab, select the most appropriate map for your needs. In the 'Mapping commands' textbox you can add additional mapping commands (see format below) that will be executed at runtime when the selected map is initialised (i.e. before any MIME type guessing is performed). If there are mapping errors or gaps between Drupal core mappings and the selected map mappings, specific reports are provided.

• The 'MIME types' tab contains a report of all supported MIME types, with their associated file extensions, descriptions, and aliases.

• The 'File extension' tab contains a report of all supported file extensions, with their associated MIME types and MIME type descriptions.

Mapping commands

Mapping commands should be entered in the following format, one command per line:

- {method: foo, arguments: [arg1, arg2, ...]}

Where foo is a method from the FileEye\MimeMap\Map\AbstractMap class, and the argN are the method's arguments.

Most useful commands:

• {method: addTypeExtensionMapping, arguments: [type, extension]} adds a type-to-extension mapping. Example: - {method: addTypeExtensionMapping, arguments: [application/dsptype, tsp]}

• {method: addTypeAlias, arguments: [type, alias]} adds an alias of a MIME type. Example: - {method: addTypeAlias, arguments: [application/atom+xml, application/atom]}

• {method: setExtensionDefaultType, arguments: [extension, type]} changes the default extension for a MIME type. Example: - {method: setExtensionDefaultType, arguments: [asc, text/plain]}

• {method: removeType, arguments: [type]} removes the entire mapping of a type. Example: - {method: removeType, arguments: [text/plain]}

Updating Sophron map

Sophron uses a MIME type map that is built from FileEye/MimeMap default map, with the adjustments needed to make it fully compatible with Drupal's core MIME type mapping. This map is in the stored in the Drupal\sophron\Map\DrupalMap PHP class.

MimeMap provides an utility to update the code of the PHP map classes. Sophron's map class can be updated starting from upstream's default one by running

$ cd [project_directory]
$ vendor/bin/fileeye-mimemap update --class=\\Drupal\\sophron\\Map\\DrupalMap --script=modules/contrib/sophron/resources/drupal_map_build.yml

The drupal_map_build.yml script instructs the utility to start the map update from the FileEye\MimeMap\Map\DefaultMap class with the command

# We use the default MimeMap map as a starting point.
-
    - 'Starting from MimeMap default map'
    - selectBaseMap
    - [\FileEye\MimeMap\Map\DefaultMap]

then run the adjustments required to make the map compatible with Drupal core with the command

# Then apply Drupal specific overrides.
-
    - 'Applying Drupal overrides'
    - applyOverrides
    -
        -
            - [addTypeExtensionMapping, [application/atomserv+xml, atomsrv]]
            - [addTypeExtensionMapping, [application/dsptype, tsp]]
            - [addTypeExtensionMapping, [application/hta, hta]]
            - ...

Creating custom MIME type to extension maps

The fileeye-mimemap update utility can also be used to add new maps by copy/pasting an existing class, renaming it, and running the utility with a custom script that makes the required changes. The custom map can then be set as the one to be used by Sophron's in the module configuration.