Skip to content

refactor(ui): support custom file display name resolver #3274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zubeydecivelek wants to merge 1 commit into
base: master
Choose a base branch
from
Open

refactor(ui): support custom file display name resolver #3274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions invenio_app_rdm/records_ui/templates/semantic-ui/invenio_app_rdm/records/detail.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@
<section id="record-files" class="rel-mt-2 rel-mb-3"
aria-label="{{ _('Files') }}">
{%- if permissions.can_read_files -%}
{%- block record_files_readable -%}
{# record has files AND user can see files #}
{%- set files = files | order_entries | selectattr("status", "==", "completed") | list %}
{%- if files|length > 0 -%}
Expand All @@ -297,6 +298,7 @@ <h2 id="files-heading">{{ _('Files') }}</h2>
{%- endif -%}
{{ file_list_box(files, record_ui["id"], is_preview, include_deleted, record, permissions) }}
Copy link
Member

@zzacharo zzacharo Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ file_list_box(files, record_ui["id"], is_preview, include_deleted, record, permissions) }}
{%- block record_files_container -%}
{{ file_list_box(files, record_ui["id"], is_preview, include_deleted, record, permissions) }}
{%- endblock record_files_container -%}

{% endif %}
{%- endblock record_files_readable -%}
{% else %}
{# record has files BUT user does not have permission to see files #}
<div
Expand Down
27 changes: 19 additions & 8 deletions invenio_app_rdm/records_ui/templates/semantic-ui/invenio_app_rdm/records/macros/files.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,13 @@
{%- endmacro %}


{% macro preview_file_box(file, pid, is_preview, record, include_deleted) %}
{% macro preview_file_box(file, pid, is_preview, record, include_deleted, resolve_display_name=None) %}
{%- set is_remote_file = file.transfer.type == transfer_types.REMOTE %}
{%- if resolve_display_name %}
{%- set display_name = resolve_display_name(file) or file.key %}
{%- else %}
{%- set display_name = file.key %}
{%- endif %}
<div class="ui accordion panel mb-10 {{record.ui.access_status.id}}" href="#files-preview-accordion-panel">
<h3 class="active title panel-heading {{ record.ui.access_status.id }} m-0">
<div
Expand All @@ -44,7 +49,7 @@ <h3 class="active title panel-heading {{ record.ui.access_status.id }} m-0">
class="trigger"
aria-label="{{ _('File preview') }}"
>
<span id="preview-file-title">{{ file.key }}</span>
<span id="preview-file-title">{{ display_name }}</span>
<i class="angle right icon" aria-hidden="true"></i>
</div>
</h3>
Expand Down Expand Up @@ -82,7 +87,8 @@ <h3 class="active title panel-heading {{ record.ui.access_status.id }} m-0">
download_endpoint='invenio_app_rdm_records.record_file_download',
preview_endpoint='invenio_app_rdm_records.record_file_preview',
is_media=false,
permissions=None
permissions=None,
resolve_display_name=None
) %}
<table class="ui striped table files fluid {{record.ui.access_status.id}}">
<thead>
Expand All @@ -108,6 +114,11 @@ <h3 class="active title panel-heading {{ record.ui.access_status.id }} m-0">
{% for file in files %}
{% if not file.access.hidden %}
{%- set is_remote_file = file.transfer.type == transfer_types.REMOTE %}
{%- if resolve_display_name %}
{%- set display_name = resolve_display_name(file) or file.key %}
Copy link
Member

@zzacharo zzacharo Dec 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{%- set display_name = resolve_display_name(file) or file.key %}
{%- set human_readable_file_name = display_name(file) or file.key %}

{%- else %}
{%- set display_name = file.key %}
{%- endif %}
{% if is_preview %}
{%- set file_url_download = url_for(download_endpoint, pid_value=pid, filename=file.key, download=1, preview=1) %}
{%- set file_url_preview = url_for(preview_endpoint, pid_value=pid, filename=file.key, preview=1, include_deleted=include_deleted_value) %}
Expand All @@ -120,7 +131,7 @@ <h3 class="active title panel-heading {{ record.ui.access_status.id }} m-0">
<tr>
<td class="ten wide">
<div>
<a href="{{ file_url_download }}">{{ file.key }}</a>
<a href="{{ file_url_download }}">{{ display_name }}</a>
</div>
{%- if not is_remote_file %}
<small class="ui text-muted font-tiny">{{ file.checksum or _("Checksum not yet calculated.") }}
Expand Down Expand Up @@ -151,7 +162,7 @@ <h3 class="active title panel-heading {{ record.ui.access_status.id }} m-0">
{%- endmacro %}


{% macro file_list_box(files, pid, is_preview, include_deleted, record, permissions) %}
{% macro file_list_box(files, pid, is_preview, include_deleted, record, permissions, resolve_display_name=None) %}
{%- set binary_sizes = not config.APP_RDM_DISPLAY_DECIMAL_FILE_SIZES %}
<div class="ui accordion panel mb-10 {{ record.ui.access_status.id }}" href="#files-list-accordion-panel">
<h3 class="active title panel-heading {{ record.ui.access_status.id }} m-0">
Expand All @@ -174,13 +185,13 @@ <h4 class="inline">{{ record.ui.access_status.title_l10n }}</h4>
</div>
{% endif %}
<div>
{{ file_list(files, pid, is_preview, include_deleted, record=record,download_endpoint="invenio_app_rdm_records.record_file_download", permissions=permissions) }}
{{ file_list(files, pid, is_preview, include_deleted, record=record,download_endpoint="invenio_app_rdm_records.record_file_download", permissions=permissions, resolve_display_name=resolve_display_name) }}
</div>
</div>
</div>
{%- endmacro %}

{% macro media_file_list_box(files, pid, is_preview, include_deleted, record, permissions) %}
{% macro media_file_list_box(files, pid, is_preview, include_deleted, record, permissions, resolve_display_name=None) %}
{%- set binary_sizes = not config.APP_RDM_DISPLAY_DECIMAL_FILE_SIZES %}
<div class="ui accordion panel mb-10 {{ record.access.record }}" href="#media-files-preview-accordion-panel">
<h3 class="active title panel-heading {{ record.access.record }} m-0">
Expand All @@ -204,7 +215,7 @@ <h4 class="inline">{{ record.ui.access_status.title_l10n }}</h4>
</div>
{% endif %}
<div>
{{ file_list(files, pid, is_preview, include_deleted, record=record, with_preview=false, download_endpoint="invenio_app_rdm_records.record_media_file_download", is_media=true, permissions=permissions) }}
{{ file_list(files, pid, is_preview, include_deleted, record=record, with_preview=false, download_endpoint="invenio_app_rdm_records.record_media_file_download", is_media=true, permissions=permissions, resolve_display_name=resolve_display_name) }}
</div>
</div>
</div>
Expand Down
Loading