Add support for File entities and full Views integration

Created on 13 October 2022, about 2 years ago

Updated 15 March 2024, 9 months ago

Problem/Motivation

The current file_usage counter implementation in Drupal core is a little limited since it doesn't provide the ability to track the file usage in a consistent manner e.g. by specific revisions, or provide an API for rebuilding the usage count itself for contrib modules which reference files in a different way e.g. inside non-standard formats like JSON objects like:

https://www.drupal.org/project/editorjs →
https://www.drupal.org/project/gutenberg → (example usage tracker for media entities, but no file tracking at the moment)

With the aim being to provide a similar behaviour to the existing /admin/content/files/usage/{fid} view, it also makes sense to improve Views integration as part of this issue in particular:

Adding the ability to interact with all the entity_usage database fields.
Supporting revisions - #3125347: Allow revision based views to use the existing Entity Usage views field. →
Supporting viewing entity_usage based on the sources (if so desired) - #3138083: Add views relation for source entity →
Introducing views plugins to provide feature parity with the current ListUsageController - #3138083: Add views relation for source entity →

With the advantage being that the entity usage lists can be easily customized to suit different use cases, while leveraging most of Views' perfomant/caching capabilities (see 🐛 Entity usage list does not scale Needs review ).

Steps to reproduce

The module explicitly disables support for file and user entities at the moment presumably because it doesn't provide a canonical by default.

Proposed resolution

Add special handling for File entities just as we do for Paragraphs.

Add views integration providing the ability to replicate the existing controller view (and can be used to replace core's existing /admin/content/files/usage/{fid} view).

Remaining tasks

Provide issue fork.

User interface changes

Form settings will include a new option to determine if the entity should include the "Entity usage" link as an operation.

This is useful for entities such as File which might not have a standalone canonical but still want to support entity usage tracking.

API changes

TBD.

Data model changes

N/A.

📌 Task

Status

Needs work

Version

2.0

Component

Code

Created by

codebymikey

Live updates comments and jobs are added and updated live.

Needs tests
The change is currently missing an automated test that fails when run with the original code, and succeeds when the bug has been fixed.

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Open in Jenkins → Open on Drupal.org →
Core: 10.1.x + Environment: PHP 8.1 & MySQL 8
last update over 1 year ago
Composer require-dev failure
Comment over 1 year ago →
codebymikey
Use the appropriate field definition label for some simpler base field definitions.
Comment over 1 year ago →
codebymikey
Following the #2955078: Track file/image fields → issue being merged, the newly introduced File field plugin will need addressing so that it doesn't include duplicate entity usage references. It'd still be nice to include the ability to exclude "Thumbnails" from being referenced when the "Track referencing base fields" is enabled.
Comment 9 months ago →
solideogloria
Would this also make it so that files will be marked temporary when the Entity Usage module says that there are no more uses? That's what I think should happen if the site has $config['file.settings']['make_unused_managed_files_temporary'] = TRUE;

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024