Merge pull request openlibhums#5027 from openlibhums/al-text-manager

Alt Text Management

Author: mauromsl

.gitignore

@@ -150,3 +150,5 @@ src/utils/management/commands/test_command.py
 /src/static/admin/hypothesis/**
 jenkins/test-results
 jenkins/test_results
+
+src/file_editor

docs/source/manager/journal/index.rst

@@ -108,6 +108,22 @@ Favicon
 Default Profile Image
     The default image used when editorial team groups have "Display profile images" enabled. The image is also used on the public profile page when a user has enabled it.
 
+Alt Text
+--------
+Most images in the Images settings page have an **Edit alt text** button. Clicking it opens a popup where you can enter descriptive alt text for that image. Alt text is saved immediately when you click **Save alt text** — there is no need to submit the main form afterwards.
+
+Alt text is available for images that appear in page content and can be described meaningfully:
+
+- Header image
+- Default large image
+- Default cover image
+- Default thumbnail
+- Default profile image (only when a custom image is uploaded; the built-in fallback image has its own alt text)
+- Press override image (only when an override image is uploaded; the press logo is used by default)
+- Issue cover images and large images
+
+The **Favicon** does not have an alt text option. Favicons appear in the browser tab, not in the page content, so they do not support alt text.
+
 Styling
 -------
 This page displays some general settings for controlling the styling of your journal.
@@ -148,3 +164,4 @@ Setting values can be accessed inside templates using **{{ journal_settings.grou
 In Django they can be accessed with **get_setting**::
 
     request.journal.get_setting('group_name', 'setting_name')
+

src/comms/models.py

@@ -7,11 +7,12 @@
 from django.http import Http404
 from django.utils.translation import gettext as _
 from django.templatetags.static import static
-from simple_history.models import HistoricalRecords
 from django.utils.html import mark_safe
+from django.utils.html import strip_tags
 
 from core import files
 from core.model_utils import JanewayBleachField, JanewayBleachCharField
+from core.templatetags import alt_text
 
 __copyright__ = "Copyright 2017 Birkbeck, University of London"
 __author__ = "Martin Paul Eve & Andy Byers"
@@ -182,6 +183,32 @@ def best_large_image_url(self):
         """
         return self.best_image_url
 
+    def best_large_image_alt_text(self):
+        default_text = strip_tags(self.title)
+        if self.large_image_file:
+            return alt_text.get_alt_text(
+                obj=self.large_image_file,
+                default=default_text,
+            )
+        elif self.content_type.name == "press" and self.object.default_carousel_image:
+            return alt_text.get_alt_text(
+                file_path=self.object.default_carousel_image.url,
+                default=default_text,
+            )
+        elif self.content_type.name == "journal":
+            if self.object.default_large_image:
+                return alt_text.get_alt_text(
+                    file_path=self.object.default_large_image.url,
+                    default=default_text,
+                )
+            elif self.object.press.default_carousel_image:
+                return alt_text.get_alt_text(
+                    file_path=self.object.press.default_carousel_image.url,
+                    default=default_text,
+                )
+
+        return default_text
+
     def __str__(self):
         if self.posted_by:
             return "{0} posted by {1} on {2}".format(

src/core/admin.py

@@ -737,6 +737,22 @@ def _person(self, obj):
             return ""
 
 
+class AltTextAdmin(admin.ModelAdmin):
+    list_display = (
+        "content_type",
+        "object_id",
+        "file_path",
+        "alt_text",
+        "created",
+        "updated",
+    )
+    search_fields = (
+        "alt_text",
+        "file_path",
+    )
+    list_filter = ("content_type",)
+
+
 admin_list = [
     (models.AccountRole, AccountRoleAdmin),
     (models.Account, AccountAdmin),
@@ -773,6 +789,7 @@ def _person(self, obj):
     (models.OrganizationName, OrganizationNameAdmin),
     (models.Location, LocationAdmin),
     (models.ControlledAffiliation, ControlledAffiliationAdmin),
+    (models.AltText, AltTextAdmin),
 ]
 
 [admin.site.register(*t) for t in admin_list]

src/core/forms/__init__.py

@@ -22,6 +22,7 @@
     JournalAttributeForm,
     JournalContactForm,
     JournalImageForm,
+    JournalSingleImageForm,
     JournalStylingForm,
     JournalSubmissionForm,
     LoginForm,
@@ -37,4 +38,5 @@
     SimpleTinyMCEForm,
     UserCreationFormExtended,
     XSLFileForm,
+    AltTextForm,
 )

src/core/forms/forms.py

@@ -10,7 +10,6 @@
 from django import forms
 from django.db.models import Q
 from django.utils.datastructures import MultiValueDict
-from django.forms.fields import Field
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 from django.contrib.auth.forms import UserCreationForm
@@ -513,6 +512,12 @@ class Meta:
             "default_profile_image",
         )
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        for field in self.fields.values():
+            if isinstance(field.widget, forms.ClearableFileInput):
+                field.widget = forms.FileInput()
+
     def save(self, commit=True):
         instance = super().save(commit=True)
         try:
@@ -526,6 +531,41 @@ def save(self, commit=True):
         return instance
 
 
+class JournalSingleImageForm(forms.ModelForm):
+    """Single-field form for uploading one journal image field at a time."""
+
+    class Meta:
+        model = journal_models.Journal
+        fields = (
+            "header_image",
+            "default_cover_image",
+            "default_large_image",
+            "favicon",
+            "press_image_override",
+            "default_profile_image",
+        )
+
+    def __init__(self, *args, field_name, **kwargs):
+        super().__init__(*args, **kwargs)
+        for name in list(self.fields):
+            if name != field_name:
+                del self.fields[name]
+        if field_name in self.fields:
+            self.fields[field_name].widget = forms.FileInput()
+
+    def save(self, commit=True):
+        instance = super().save(commit=True)
+        if "default_large_image" in self.fields and instance.default_large_image:
+            try:
+                resize_and_crop(
+                    instance.default_large_image.path,
+                    field_name="Default large image",
+                )
+            except ValueError:
+                pass
+        return instance
+
+
 class JournalStylingForm(forms.ModelForm):
     class Meta:
         model = journal_models.Journal
@@ -775,7 +815,7 @@ def __init__(self, *args, **kwargs):
                             except:
                                 result = None
 
-                    if result != None:
+                    if result is not None:
                         values_list.append(result)
                     elif result == None and "default" in facet:
                         values_list.append(facet["default"])
@@ -1152,3 +1192,87 @@ class ConfirmDeleteForm(forms.Form):
     """
 
     pass
+
+
+class AltTextForm(forms.ModelForm):
+    class Meta:
+        model = models.AltText
+        fields = [
+            "alt_text",
+        ]
+        widgets = {
+            "alt_text": forms.Textarea(
+                attrs={"rows": 5},
+            ),
+        }
+
+    def __init__(
+        self,
+        *args,
+        content_type=None,
+        object_id=None,
+        file_path=None,
+        **kwargs,
+    ):
+        if "initial" not in kwargs:
+            kwargs["initial"] = {}
+
+        # Populate initial to help form rendering
+        if content_type and object_id:
+            kwargs["initial"].update(
+                {
+                    "content_type": content_type,
+                    "object_id": object_id,
+                }
+            )
+        elif file_path:
+            kwargs["initial"].update(
+                {
+                    "file_path": file_path,
+                }
+            )
+
+        super().__init__(*args, **kwargs)
+
+        # Set these on the form so we can assign them to the instance in save()
+        self.content_type = content_type
+        self.object_id = object_id
+        self.file_path = file_path
+
+    def clean(self):
+        cleaned_data = super().clean()
+        self.instance.content_type = self.content_type
+        self.instance.object_id = self.object_id
+        self.instance.file_path = self.file_path
+        return cleaned_data
+
+    def save(self, commit=True):
+        # Attempt to find an existing instance to update
+        existing = None
+
+        if self.content_type and self.object_id:
+            existing = models.AltText.objects.filter(
+                content_type=self.content_type,
+                object_id=self.object_id,
+            ).first()
+
+        elif self.file_path:
+            existing = models.AltText.objects.filter(
+                file_path=self.file_path,
+            ).first()
+
+        # If existing, update its fields
+        if existing:
+            existing.alt_text = self.cleaned_data["alt_text"]
+            instance = existing
+        else:
+            instance = super().save(commit=False)
+            instance.content_type = self.content_type
+            instance.object_id = self.object_id
+            instance.file_path = self.file_path
+
+        if commit:
+            instance.full_clean()
+            instance.save()
+
+        return instance

src/core/include_urls.py

@@ -11,7 +11,7 @@
 from django.views.decorators.cache import cache_page
 
 from journal import urls as journal_urls
-from core import views as core_views, plugin_loader
+from core import views as core_views, plugin_loader, partial_views
 from utils import notify
 from press import views as press_views
 from cms import views as cms_views
@@ -431,6 +431,19 @@
         core_views.manage_access_requests,
         name="manage_access_requests",
     ),
+    # Partial views used for HTMX
+    path("alt-text/form/", partial_views.alt_text_form, name="alt_text_form"),
+    path("alt-text/submit/", partial_views.alt_text_submit, name="alt_text_submit"),
+    path(
+        "manager/settings/images/upload/<str:field_name>/",
+        partial_views.journal_image_upload,
+        name="journal_image_upload",
+    ),
+    path(
+        "manager/settings/images/remove/<str:field_name>/",
+        partial_views.journal_image_remove,
+        name="journal_image_remove",
+    ),
 ]
 
 # Journal homepage block loading

src/core/janeway_global_settings.py

@@ -165,6 +165,7 @@
             ],
             "builtins": [
                 "core.templatetags.fqdn",
+                "core.templatetags.alt_text",
                 "security.templatetags.securitytags",
                 "django.templatetags.i18n",
             ],

src/core/logic.py

@@ -11,18 +11,19 @@
 import operator
 import re
 from functools import reduce
-from urllib.parse import unquote, urlparse
 
 from django.conf import settings
 from django.contrib.auth import logout
 from django.contrib import messages
 from django.template.loader import get_template
 from django.db.models import Q
-from django.http import JsonResponse, QueryDict
+from django.http import JsonResponse
 from django.forms.models import model_to_dict
 from django.shortcuts import reverse
 from django.utils import timezone
 from django.utils.translation import get_language, gettext_lazy as _
+from django.contrib.contenttypes.models import ContentType
+from django.core.exceptions import ValidationError
 
 from core import forms, models, files, plugin_installed_apps
 from utils.function_cache import cache
@@ -1263,3 +1264,39 @@ def create_organization_name(request):
             % {"organization": organization_name},
         )
         return organization_name
+
+
+def resolve_alt_text_target(request):
+    """
+    Resolve the content_type, object_id, file_path, and object instance
+    from the request data (POST or GET). Expects 'model', 'pk', and/or 'file_path'.
+
+    Returns:
+        (content_type, object_id, file_path, obj)
+
+    Raises:
+        ValidationError if model or pk is invalid.
+    """
+    data = request.POST or request.GET
+
+    model = data.get("model")
+    pk = data.get("pk")
+    file_path = data.get("file_path")
+
+    content_type = None
+    object_id = None
+    obj = None
+
+    if model and pk:
+        if "." not in model:
+            raise ValidationError("Model should be in the form 'app_label.model_name'.")
+
+        app_label, model_name = model.split(".")
+        content_type = ContentType.objects.get(
+            app_label=app_label,
+            model=model_name,
+        )
+        object_id = int(pk)
+        obj = content_type.get_object_for_this_type(pk=object_id)
+
+    return content_type, object_id, file_path, obj