From 7e52851407931f74c01a5a0ffe8ccee7c59101bf Mon Sep 17 00:00:00 2001
From: MizukiTemma <temma@integreat-app.de>
Date: Fri, 5 Jul 2024 22:36:04 +0200
Subject: [PATCH] Add centralised link list in the network management

---
 integreat_cms/cms/templates/_base.html        |  7 +++
 .../templates/linkcheck/link_list_row.html    |  6 +-
 .../templates/linkcheck/links_by_filter.html  | 21 ++++---
 .../cms/templatetags/linkcheck_filters.py     | 19 ++++++
 integreat_cms/cms/urls/protected.py           | 34 ++++++++++
 integreat_cms/cms/utils/linkcheck_utils.py    | 13 +++-
 .../cms/views/linkcheck/link_replace_view.py  | 10 ++-
 .../views/linkcheck/linkcheck_list_view.py    | 62 ++++++++++---------
 integreat_cms/locale/de/LC_MESSAGES/django.po |  8 ++-
 .../release_notes/current/unreleased/1443.yml |  2 +
 10 files changed, 132 insertions(+), 50 deletions(-)
 create mode 100644 integreat_cms/release_notes/current/unreleased/1443.yml

diff --git a/integreat_cms/cms/templates/_base.html b/integreat_cms/cms/templates/_base.html
index 9ab85522f7..e13a869710 100644
--- a/integreat_cms/cms/templates/_base.html
+++ b/integreat_cms/cms/templates/_base.html
@@ -269,6 +269,13 @@
                     <i icon-name="layout-grid"></i>
                     {% translate "Admin Dashboard" %}
                 </a>
+                {% if perms.cms.view_broken_links %}
+                    <a href="{% url 'linkcheck_landing' %}"
+                       class="{% if current_menu_item == 'linkcheck' %} active{% endif %}">
+                        <i icon-name="link"></i>
+                        {% translate "Broken Links" %}
+                    </a>
+                {% endif %}
                 {% if perms.cms.view_region %}
                     <a href="{% url 'regions' %}"
                        class="{% if current_menu_item == 'regions' %} active{% endif %}">
diff --git a/integreat_cms/cms/templates/linkcheck/link_list_row.html b/integreat_cms/cms/templates/linkcheck/link_list_row.html
index 256038cf54..a40d8e6faa 100644
--- a/integreat_cms/cms/templates/linkcheck/link_list_row.html
+++ b/integreat_cms/cms/templates/linkcheck/link_list_row.html
@@ -100,8 +100,8 @@
             {{ url.region_links|length }}
         </td>
         <td class="text-right pr-4">
-            <a title="{% translate "Replace URL globally" %}"
-               href="{% url 'edit_url' url_id=url.id url_filter=view.kwargs.url_filter region_slug=request.region.slug %}{{ pagination_params }}#replace-url"
+            <a title="{% if request.region %}{% translate "Replace URL centrally in the current region" %}{% else %}{% translate "Replace URL globally in all the regions" %}{% endif %}"
+               href="{% linkcheck_url 'edit_url' request url_id=url.id url_filter=view.kwargs.url_filter %}{{ pagination_params }}#replace-url"
                class="btn-icon">
                 <i icon-name="pen-square"></i>
             </a>
@@ -112,7 +112,7 @@
             <td colspan="10">
                 <div class="flex gap-2 p-2">
                     {% render_field edit_url_form.url|add_error_class:"border-red-500" type="url" form="edit-url-form" %}
-                    <a href="{% url 'linkcheck' url_filter=view.kwargs.url_filter region_slug=request.region.slug %}{{ pagination_params }}"
+                    <a href="{% linkcheck_url 'linkcheck' request url_filter=view.kwargs.url_filter %}{{ pagination_params }}"
                        class="btn btn-red">{% translate "Cancel" %}</a>
                     <button type="submit" form="edit-url-form" class="btn">
                         {% translate "Save" %}
diff --git a/integreat_cms/cms/templates/linkcheck/links_by_filter.html b/integreat_cms/cms/templates/linkcheck/links_by_filter.html
index b629206d74..dd12c95a93 100644
--- a/integreat_cms/cms/templates/linkcheck/links_by_filter.html
+++ b/integreat_cms/cms/templates/linkcheck/links_by_filter.html
@@ -1,6 +1,7 @@
 {% extends "_base.html" %}
 {% load i18n %}
 {% load static %}
+{% load linkcheck_filters %}
 {% block content %}
     <div class="flex flex-wrap justify-between gap-4">
         <h1 class="heading">
@@ -21,34 +22,34 @@ <h1 class="heading">
             {% endif %}
         </h1>
         {% if request.user.expert_mode %}
-            <a href="{% url 'search_and_replace_link' region_slug=request.region.slug %}"
+            <a href="{% linkcheck_url 'search_and_replace_link' request %}"
                class="font-bold text-sm text-gray-800 flex items-center gap-1 mb-2 hover:underline">
                 <span><i icon-name="replace" class="align-top h-5"></i> {% translate "Search & replace" %}</span>
             </a>
         {% endif %}
     </div>
-    <a href="{% if view.kwargs.url_filter == 'valid' %}#{% else %}{% url 'linkcheck' region_slug=request.region.slug url_filter='valid' %}{% if request.GET.size %}?size={{ request.GET.size }}{% endif %}{% endif %}"
+    <a href="{% if view.kwargs.url_filter == 'valid' %} # {% else %} {% linkcheck_url 'linkcheck' request url_filter='valid' %}{{ pagination_params }} {% endif %}"
        class="pr-2 {% if view.kwargs.url_filter == 'valid' %}text-black font-bold cursor-default{% else %}bg-transparent hover:underline text-blue-500 hover:text-blue-600 cursor-pointer{% endif %}">
         {% translate "Valid" %}
         <span class="{% if view.kwargs.url_filter == 'valid' %}text-gray-500 font-normal{% endif %}">
             ({{ number_valid_urls }})
         </span>
     </a>
-    <a href="{% if view.kwargs.url_filter == 'invalid' %}#{% else %}{% url 'linkcheck' region_slug=request.region.slug url_filter='invalid' %}{% if request.GET.size %}?size={{ request.GET.size }}{% endif %}{% endif %}"
+    <a href="{% if view.kwargs.url_filter == 'invalid' %} # {% else %} {% linkcheck_url 'linkcheck' request url_filter='invalid' %}{{ pagination_params }} {% endif %}"
        class="px-2 border-l-2 border-gray-500 {% if view.kwargs.url_filter == 'invalid' %}text-black font-bold cursor-default{% else %}bg-transparent hover:underline text-blue-500 hover:text-blue-600 cursor-pointer{% endif %}">
         {% translate "Invalid" %}
         <span class="{% if view.kwargs.url_filter == 'invalid' %}text-gray-500 font-normal{% endif %}">
             ({{ number_invalid_urls }})
         </span>
     </a>
-    <a href="{% if view.kwargs.url_filter == 'unchecked' %}#{% else %}{% url 'linkcheck' region_slug=request.region.slug url_filter='unchecked' %}{% if request.GET.size %}?size={{ request.GET.size }}{% endif %}{% endif %}"
+    <a href="{% if view.kwargs.url_filter == 'unchecked' %} # {% else %} {% linkcheck_url 'linkcheck' request url_filter='unchecked' %}{{ pagination_params }} {% endif %}"
        class="px-2 border-l-2 border-gray-500 {% if view.kwargs.url_filter == 'unchecked' %}text-black font-bold cursor-default{% else %}bg-transparent hover:underline text-blue-500 hover:text-blue-600 cursor-pointer{% endif %}">
         {% translate "Unchecked" %}
         <span class="{% if view.kwargs.url_filter == 'unchecked' %}text-gray-500 font-normal{% endif %}">
             ({{ number_unchecked_urls }})
         </span>
     </a>
-    <a href="{% if view.kwargs.url_filter == 'ignored' %}#{% else %}{% url 'linkcheck' region_slug=request.region.slug url_filter='ignored' %}{% if request.GET.size %}?size={{ request.GET.size }}{% endif %}{% endif %}"
+    <a href="{% if view.kwargs.url_filter == 'ignored' %} # {% else %} {% linkcheck_url 'linkcheck' request url_filter='ignored' %}{{ pagination_params }} {% endif %}"
        class="px-2 border-l-2 border-gray-500 {% if view.kwargs.url_filter == 'ignored' %}text-black font-bold cursor-default{% else %}bg-transparent hover:underline text-blue-500 hover:text-blue-600 cursor-pointer{% endif %}">
         {% translate "Ignored" %}
         <span class="{% if view.kwargs.url_filter == 'ignored' %}text-gray-500 font-normal{% endif %}">
@@ -57,7 +58,7 @@ <h1 class="heading">
     </a>
     {% if request.user.expert_mode %}
         {% if LINKCHECK_EMAIL_ENABLED %}
-            <a href="{% if view.kwargs.url_filter == 'email' %}#{% else %}{% url 'linkcheck' region_slug=request.region.slug url_filter='email' %}{% if request.GET.size %}?size={{ request.GET.size }}{% endif %}{% endif %}"
+            <a href="{% if view.kwargs.url_filter == 'email' %} # {% else %} {% linkcheck_url 'linkcheck' request url_filter='email' %}{{ pagination_params }} {% endif %}"
                class="px-2 border-l-2 border-gray-500 {% if view.kwargs.url_filter == 'email' %}text-black font-bold cursor-default{% else %}bg-transparent hover:underline text-blue-500 hover:text-blue-600 cursor-pointer{% endif %}">
                 {% translate "Email links" %}
                 <span class="{% if view.kwargs.url_filter == 'email' %}text-gray-500 font-normal{% endif %}">
@@ -66,7 +67,7 @@ <h1 class="heading">
             </a>
         {% endif %}
         {% if LINKCHECK_PHONE_ENABLED %}
-            <a href="{% if view.kwargs.url_filter == 'phone' %}#{% else %}{% url 'linkcheck' region_slug=request.region.slug url_filter='phone' %}{% if request.GET.size %}?size={{ request.GET.size }}{% endif %}{% endif %}"
+            <a href="{% if view.kwargs.url_filter == 'phone' %} # {% else %} {% linkcheck_url 'linkcheck' request url_filter='phone' %}{{ pagination_params }} {% endif %}"
                class="px-2 border-l-2 border-gray-500 {% if view.kwargs.url_filter == 'phone' %}text-black font-bold cursor-default{% else %}bg-transparent hover:underline text-blue-500 hover:text-blue-600 cursor-pointer{% endif %}">
                 {% translate "Phone links" %}
                 <span class="{% if view.kwargs.url_filter == 'phone' %}text-gray-500 font-normal{% endif %}">
@@ -170,16 +171,16 @@ <h1 class="heading">
                 </option>
                 {% if view.kwargs.url_filter == 'ignored' %}
                     <option value="unignore"
-                            data-bulk-action="{% url 'linkcheck' region_slug=request.region.slug url_filter=view.kwargs.url_filter %}{{ pagination_params }}">
+                            data-bulk-action="{% linkcheck_url 'linkcheck' request url_filter=view.kwargs.url_filter %} {{ pagination_params }}">
                         {% translate "Unignore" %}
                     </option>
                 {% else %}
                     <option value="recheck"
-                            data-bulk-action="{% url 'linkcheck' region_slug=request.region.slug url_filter=view.kwargs.url_filter %}{{ pagination_params }}">
+                            data-bulk-action="{% linkcheck_url 'linkcheck' request url_filter=view.kwargs.url_filter %} {{ pagination_params }}">
                         {% translate "Recheck" %}
                     </option>
                     <option value="ignore"
-                            data-bulk-action="{% url 'linkcheck' region_slug=request.region.slug url_filter=view.kwargs.url_filter %}{{ pagination_params }}">
+                            data-bulk-action="{% linkcheck_url 'linkcheck' request url_filter=view.kwargs.url_filter %} {{ pagination_params }}">
                         {% translate "Ignore" %}
                     </option>
                 {% endif %}
diff --git a/integreat_cms/cms/templatetags/linkcheck_filters.py b/integreat_cms/cms/templatetags/linkcheck_filters.py
index 68e5958460..312a76c009 100644
--- a/integreat_cms/cms/templatetags/linkcheck_filters.py
+++ b/integreat_cms/cms/templatetags/linkcheck_filters.py
@@ -3,9 +3,13 @@
 from typing import TYPE_CHECKING
 
 from django import template
+from django.urls import reverse
 from django.utils.safestring import mark_safe
 
 if TYPE_CHECKING:
+    from typing import Any
+
+    from django.http import HttpRequest
     from linkcheck.models import Url
 
 register = template.Library()
@@ -49,3 +53,18 @@ def url_anchor_icon(url: Url) -> str:
     if url.anchor_status is False:
         return '<i icon-name="x" class="text-red-500"></i>'
     return '<i icon-name="check" class="text-green-500"></i>'
+
+
+@register.simple_tag
+@mark_safe
+def linkcheck_url(target: str, request: HttpRequest, **kwargs: Any) -> str:
+    """
+    Return the url matching the target url name, region and other supplied slugs
+
+    :param target: The name of target url
+    :param request: The current request, used to check whether a region is given or not
+    :param kwargs: Other slugs passed as the keyword argument
+    """
+    if request.region:
+        kwargs["region_slug"] = request.region.slug
+    return reverse(target, kwargs=kwargs)
diff --git a/integreat_cms/cms/urls/protected.py b/integreat_cms/cms/urls/protected.py
index a3f9cad2c5..48580e38d2 100644
--- a/integreat_cms/cms/urls/protected.py
+++ b/integreat_cms/cms/urls/protected.py
@@ -235,6 +235,40 @@
         dashboard.AdminDashboardView.as_view(),
         name="admin_dashboard",
     ),
+    path(
+        "linkcheck/",
+        include(
+            [
+                path(
+                    "",
+                    linkcheck.LinkcheckRedirectView.as_view(),
+                    name="linkcheck_landing",
+                ),
+                path(
+                    "<slug:url_filter>/",
+                    include(
+                        [
+                            path(
+                                "",
+                                linkcheck.LinkcheckListView.as_view(),
+                                name="linkcheck",
+                            ),
+                            path(
+                                "<int:url_id>/",
+                                linkcheck.LinkcheckListView.as_view(),
+                                name="edit_url",
+                            ),
+                        ]
+                    ),
+                ),
+                path(
+                    "search_and_replace_link",
+                    linkcheck.LinkReplaceView.as_view(),
+                    name="search_and_replace_link",
+                ),
+            ]
+        ),
+    ),
     path(
         "regions/",
         include(
diff --git a/integreat_cms/cms/utils/linkcheck_utils.py b/integreat_cms/cms/utils/linkcheck_utils.py
index 4a99b48692..22b718ea8b 100644
--- a/integreat_cms/cms/utils/linkcheck_utils.py
+++ b/integreat_cms/cms/utils/linkcheck_utils.py
@@ -6,7 +6,7 @@
 from typing import DefaultDict, TYPE_CHECKING
 
 from django.conf import settings
-from django.db.models import Prefetch, Q, QuerySet, Subquery
+from django.db.models import Count, Prefetch, Q, QuerySet, Subquery
 from linkcheck import update_lock
 from linkcheck.listeners import tasks_queue
 from linkcheck.models import Link, Url
@@ -60,6 +60,12 @@ def get_urls(
             )
         )
 
+    # Annotate with number of links that are not ignored.
+    # If there is any link that is not ignored, the url is also not ignored.
+    urls = urls.annotate(
+        non_ignored_links=Count("links", filter=Q(links__ignore=False))
+    )
+
     # Filter out ignored URL types
     if settings.LINKCHECK_IGNORED_URL_TYPES:
         return [
@@ -138,8 +144,9 @@ def filter_urls(
         [] for _ in range(6)
     )
     for url in urls:
-        links = url.region_links if region_slug else url.links.all()
-        if all(link.ignore for link in links):
+        if region_slug is None:
+            url.region_links = url.links.all()
+        if not url.non_ignored_links:
             ignored_urls.append(url)
         elif url.status:
             valid_urls.append(url)
diff --git a/integreat_cms/cms/views/linkcheck/link_replace_view.py b/integreat_cms/cms/views/linkcheck/link_replace_view.py
index b8fdcf1720..b359d7d9cd 100644
--- a/integreat_cms/cms/views/linkcheck/link_replace_view.py
+++ b/integreat_cms/cms/views/linkcheck/link_replace_view.py
@@ -83,9 +83,13 @@ def post(self, request: HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse:
             _("Links were replaced successfully."),
         )
 
+        if request.region:
+            return redirect(
+                "linkcheck_landing",
+                **{
+                    "region_slug": request.region.slug,
+                },
+            )
         return redirect(
             "linkcheck_landing",
-            **{
-                "region_slug": request.region.slug,
-            },
         )
diff --git a/integreat_cms/cms/views/linkcheck/linkcheck_list_view.py b/integreat_cms/cms/views/linkcheck/linkcheck_list_view.py
index d52770ad01..e3592d9337 100644
--- a/integreat_cms/cms/views/linkcheck/linkcheck_list_view.py
+++ b/integreat_cms/cms/views/linkcheck/linkcheck_list_view.py
@@ -100,10 +100,9 @@ def dispatch(self, request: HttpRequest, *args: Any, **kwargs: Any) -> HttpRespo
         Dispatch the view to either get() or post()
         """
         if edit_url_id := kwargs.pop("url_id", None):
+            region = request.region.slug if request.region else None
             try:
-                self.instance = get_urls(
-                    region_slug=request.region.slug, url_ids=[edit_url_id]
-                )[0]
+                self.instance = get_urls(region, url_ids=[edit_url_id])[0]
             except IndexError as e:
                 raise Http404("This URL does not exist") from e
             if request.POST:
@@ -155,9 +154,12 @@ def post(self, request: HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse:
                     assert self.instance
                 new_url = self.form.cleaned_data["url"]
                 # Get all current translations with the same url
-                translations = {
-                    link.content_object for link in self.instance.region_links
-                }
+                links = (
+                    self.instance.region_links
+                    if request.region
+                    else self.instance.links.all()
+                )
+                translations = {link.content_object for link in links}
                 # Replace the old urls with the new urls in the content
                 for translation in translations:
                     translation.replace_urls(
@@ -184,30 +186,32 @@ def post(self, request: HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse:
                 # If the form is invalid, render the invalid form
                 return super().get(request, *args, **kwargs)
 
-        action = request.POST.get("action")
-        selected_urls = get_urls(
-            region_slug=request.region.slug,
-            url_ids=request.POST.getlist("selected_ids[]"),
-        )
+        if action := request.POST.get("action"):
+            region_slug = request.region.slug if request.region else None
+            selected_urls = get_urls(
+                region_slug=region_slug,
+                url_ids=request.POST.getlist("selected_ids[]"),
+            )
+
+            if action == "ignore":
+                for url in selected_urls:
+                    Link.objects.filter(
+                        id__in=[link.id for link in url.region_links]
+                    ).update(ignore=True)
+                messages.success(request, _("Links were successfully ignored"))
+            elif action == "unignore":
+                for url in selected_urls:
+                    Link.objects.filter(
+                        id__in=[link.id for link in url.region_links]
+                    ).update(ignore=False)
+                messages.success(request, _("Links were successfully unignored"))
+            elif action == "recheck":
+                for url in selected_urls:
+                    url.check_url(external_recheck_interval=0)
+                messages.success(request, _("Links were successfully checked"))
+                # Add short delay to allow rechecking to be finished when page reloads
+                time.sleep(1)
 
-        if action == "ignore":
-            for url in selected_urls:
-                Link.objects.filter(
-                    id__in=[link.id for link in url.region_links]
-                ).update(ignore=True)
-            messages.success(request, _("Links were successfully ignored"))
-        elif action == "unignore":
-            for url in selected_urls:
-                Link.objects.filter(
-                    id__in=[link.id for link in url.region_links]
-                ).update(ignore=False)
-            messages.success(request, _("Links were successfully unignored"))
-        elif action == "recheck":
-            for url in selected_urls:
-                url.check_url(external_recheck_interval=0)
-            messages.success(request, _("Links were successfully checked"))
-            # Add short delay to allow rechecking to be finished when page reloads
-            time.sleep(1)
         invalidate_model(Link)
         invalidate_model(Url)
         linkcheck_url = reverse("linkcheck", kwargs=kwargs)
diff --git a/integreat_cms/locale/de/LC_MESSAGES/django.po b/integreat_cms/locale/de/LC_MESSAGES/django.po
index de68a1216c..e882a6a117 100644
--- a/integreat_cms/locale/de/LC_MESSAGES/django.po
+++ b/integreat_cms/locale/de/LC_MESSAGES/django.po
@@ -6491,8 +6491,12 @@ msgid "Go to source"
 msgstr "Inhalt aufrufen"
 
 #: cms/templates/linkcheck/link_list_row.html
-msgid "Replace URL globally"
-msgstr "URL zentral ersetzen"
+msgid "Replace URL centrally in the current region"
+msgstr "URL zentral in der aktuellen Region ersetzen"
+
+#: cms/templates/linkcheck/link_list_row.html
+msgid "Replace URL globally in all the regions"
+msgstr "URL global in allen Regionen ersetzen"
 
 #: cms/templates/linkcheck/links_by_filter.html
 msgid "All links"
diff --git a/integreat_cms/release_notes/current/unreleased/1443.yml b/integreat_cms/release_notes/current/unreleased/1443.yml
new file mode 100644
index 0000000000..3753568f06
--- /dev/null
+++ b/integreat_cms/release_notes/current/unreleased/1443.yml
@@ -0,0 +1,2 @@
+en: Add centralized link list in the network management
+de: Füge die zentralisierte Linklist in die Netzwerkverwaltung hinzu