Update documentation

Author: fsbraun

README.rst

@@ -21,8 +21,8 @@ Key features
   rebuild you site's plugin tree if css framework is changed in the
   future, e.g. from Bootstrap 5 to a future version.
 
-- **New link plugin** allowing to link to internal pages provided by
-  other applications, such as `djangocms-blog
+- Leverage of new **djangocms-link features** allowing to link to internal pages
+  provided by other applications, such as `djangocms-blog
   <https://github.com/nephila/djangocms-blog>`_.
 
 - **Nice and well-arranged admin frontend** of `djangocms-bootstrap4

djangocms_frontend/contrib/link/cms_plugins.py

@@ -1,7 +1,6 @@
 from cms.plugin_pool import plugin_pool
 from django.apps import apps
 from django.conf import settings as django_settings
-from django.urls import path
 from django.utils.translation import gettext_lazy as _
 
 from djangocms_frontend.helpers import get_plugin_template, insert_fields
@@ -10,7 +9,7 @@
 from ...cms_plugins import CMSUIPlugin
 from ...common import AttributesMixin, SpacingMixin
 from .. import link
-from . import forms, models, views
+from . import forms, models
 from .constants import USE_LINK_ICONS
 from .helpers import GetLinkMixin
 
@@ -99,11 +98,6 @@ class TextLinkPlugin(mixin_factory("Link"), AttributesMixin, SpacingMixin, LinkP
     def get_render_template(self, context, instance, placeholder):
         return get_plugin_template(instance, "link", "link", settings.LINK_TEMPLATE_CHOICES)
 
-    def get_plugin_urls(self):
-        return [
-            path("autocomplete/", views.AutocompleteJsonView.as_view(), name="link_link_autocomplete"),
-        ]
-
 
 if "djangocms_frontend.contrib.link" in django_settings.INSTALLED_APPS:
     #  Only register plugin if in INSTALLED_APPS

djangocms_frontend/contrib/link/forms.py

@@ -5,10 +5,7 @@
 from django import apps, forms
 from django.conf import settings as django_settings
 from django.contrib.admin.widgets import SELECT2_TRANSLATIONS, AutocompleteMixin
-from django.contrib.contenttypes.models import ContentType
 from django.contrib.sites.models import Site
-from django.core.exceptions import ObjectDoesNotExist
-from django.db import models
 from django.utils.translation import get_language
 from django.utils.translation import gettext as _
 from djangocms_link.fields import LinkFormField
@@ -29,7 +26,6 @@
 from ...models import FrontendUIItem
 from .. import link
 from .constants import LINK_CHOICES, LINK_SIZE_CHOICES, TARGET_CHOICES
-from .helpers import get_object_for_value
 
 mixin_factory = settings.get_forms(link)
 
@@ -112,30 +108,6 @@ def optgroups(self, name, value, attr=None):
         return groups
 
 
-class SmartLinkField(forms.ChoiceField):
-    widget = Select2jqWidget
-
-    def prepare_value(self, value):
-        if value:
-            if isinstance(value, dict):  # Entangled dictionary?
-                try:
-                    app_label, model = value["model"].rsplit(".", 1)
-                    content_type = ContentType.objects.get(app_label=app_label, model=model)
-                    return f"{content_type.id}-{value['pk']}"
-                except (TypeError, ValueError, KeyError, ObjectDoesNotExist):
-                    pass
-            elif isinstance(value, models.Model):
-                content_type = ContentType.objects.get_for_model(value)
-                return f"{content_type.id}-{value.id}"
-        return ""
-
-    def clean(self, value):
-        obj = get_object_for_value(value)
-        if obj is not None:
-            return obj
-        return super().clean(value)
-
-
 if apps.apps.is_installed("djangocms_url_manager"):
     from djangocms_url_manager.forms import (
         HtmlLinkSiteSelectWidget,

djangocms_frontend/contrib/link/helpers.py

@@ -1,53 +1,10 @@
-from importlib import import_module
-
-from cms.forms.utils import get_page_choices
-from cms.models import Page
 from django.apps import apps
-from django.conf import settings as django_settings
-from django.contrib.admin import site
 from django.contrib.contenttypes.models import ContentType
 from django.contrib.sites.models import Site
-from django.core.exceptions import FieldError, ObjectDoesNotExist
-from django.utils.encoding import force_str
+from django.core.exceptions import ObjectDoesNotExist
 
 from djangocms_frontend.helpers import get_related_object
 
-LINK_MODELS = getattr(django_settings, "DJANGOCMS_FRONTEND_LINK_MODELS", [])
-
-
-def create_querysets(link_models):
-    querysets = []
-    for item in link_models:
-        if item["class_path"] != "cms.models.Page":
-            # CMS pages are collected using a cms function to preserve hierarchy
-            section = item["type"]
-            parts = item["class_path"].rsplit(".", 1)
-            cls = getattr(import_module(parts[0]), parts[1])
-            queryset = cls.objects
-
-            if "manager_method" in item:
-                queryset = getattr(queryset, item["manager_method"])()
-
-            if "filter" in item:
-                for k, v in item["filter"].items():
-                    try:
-                        # Attempt to execute any callables in the filter dict.
-                        item["filter"][k] = v()
-                    except TypeError:
-                        # OK, it wasn't a callable, so, leave it be
-                        pass
-                queryset = queryset.filter(**item["filter"])
-            else:
-                if "manager_method" not in item:
-                    queryset = queryset.all()
-            if "order_by" in item:
-                queryset = queryset.order_by(item["order_by"])
-            querysets.append((section, queryset, item.get("search", None), cls))
-    return querysets
-
-
-_querysets = create_querysets(LINK_MODELS)
-
 
 def get_object_for_value(value):
     if isinstance(value, str) and "-" in value:
@@ -63,81 +20,6 @@ def get_object_for_value(value):
     return None
 
 
-def unescape(text, nbsp):
-    return (
-        text.replace(" ", nbsp)
-        .replace("&", "&")
-        .replace("&lt;", "<")
-        .replace("&gt;", ">")
-        .replace("&quot;", '"')
-        .replace("&#x27;", "'")
-    )
-
-
-def get_link_choices(request, term="", lang=None, nbsp=None):
-    global _querysets
-
-    if nbsp is None:
-        nbsp = "" if term else "\u2000"
-    available_objects = []
-    # Now create our list of cms pages
-    type_id = ContentType.objects.get_for_model(Page).id
-    for value, descr in get_page_choices(lang):
-        if isinstance(descr, list):
-            available_objects.append(
-                {
-                    "text": value,
-                    "children": [
-                        dict(
-                            id=f"{type_id}-{page}",
-                            # django admin's autocomplete view requires unescaped strings
-                            # get_page_choices escapes strings, so we undo the escape
-                            text=unescape(name, nbsp),
-                        )
-                        for page, name in descr
-                        if not isinstance(term, str) or term.upper() in name.upper()
-                    ],
-                }
-            )
-        elif value and isinstance(value, int):
-            available_objects.append(dict(id=f"{type_id}-{value}"))
-
-    # Add list of additional non-cms pages
-    for section, qs, search, cls in _querysets:
-        objects = None
-        model_admin = site._registry.get(cls, None)
-        if search:
-            try:
-                objects = qs.filter(**{search + "__icontains": term})
-            except FieldError:
-                pass
-        if objects is None:
-            objects = [item for item in qs.all() if (not isinstance(term, str)) or term.upper() in str(item).upper()]
-        if objects:
-            type_class = ContentType.objects.get_for_model(objects[0].__class__)
-            available_objects.append(
-                {
-                    "text": force_str(section),
-                    "children": [
-                        dict(id=f"{type_class.id}-{obj.id}", text=str(obj))
-                        for obj in objects
-                        if request is None or model_admin and model_admin.has_view_permission(request, obj=obj)
-                    ],
-                }
-            )
-    return available_objects
-
-
-def get_choices(request, term="", lang=None) -> list:
-    def to_choices(json):
-        return list(
-            (elem["text"], to_choices(elem["children"])) if "children" in elem else (elem["id"], elem["text"])
-            for elem in json
-        )
-
-    return to_choices(get_link_choices(request, term, lang, "&nbsp;"))
-
-
 class GetLinkMixin:
     def get_link(self) -> str:
         if "url_grouper" in self.config and self.config["url_grouper"] and apps.is_installed("djangocms_url_manager"):

djangocms_frontend/contrib/link/views.py

@@ -342,29 +342,8 @@ to a CMS page or pages of other Django applications. They are dynamic, i.e. if
 the page's url changes (e.g. because it is moved in the page tree) all links
 pointing to the page change accordingly.
 
-.. note::
-
-    **djangocms-frontend** uses django-cms' function ``get_page_choices(lang)``
-    to get the list of available pages in the current language.
-
-The developer can extend the list of available internal link targets to pages
-outside the CMS page tree using the
-``DJANGOCMS_FRONTEND_LINK_MODELS`` setting in the project's ``.settings`` file.
-The link/button
-component can point to any page controlled by a Django model if the model class
-implements the ``get_absolute_url`` method. A typical use case would, e.g.,
-blog entries of `djangocms-blog <https://github.com/nephila/djangocms-blog>`_.
-(This approach was inspired by mkoisten's `djangocms-styledlink
-<https://github.com/mkoistinen/djangocms-styledlink>`_.)
-
-For more information, see
-:ref:`How to add internal link targets outside of the CMS`
-
-.. note::
+If targets are deleted the link will fallback to regular text.
 
-    Only those destinations (outside the CMS) are shown for which a model admin
-    is registered and the logged in user has view permissions: A user will only
-    see a destination if they can view it in the admin site.
 
 Re-usable component example
 ===========================

docs/source/components.rst

@@ -29,6 +29,7 @@ by adding an option:
     djangocms-frontend[djangocms-icon]  # Installs djangocms-icon for icons support in links
     djangocms-frontend[static-ace]  # Installs djangocms-static-ace to include the ace code editor in static files
     djangocms-frontend[static-ace, djangocms-icon]  # comma-separate multiple dependencies
+    djangocms-frontend[djangocms-link]  # Installs djangocms-link for link support
 
 ``djangocms-frontend[static-ace]`` is useful if your project cannot or should not
 access a CDN to load the `ace code editor <https://ace.c9.io>`_ for the code plugin.
@@ -44,6 +45,7 @@ Add the following entries to your ``INSTALLED_APPS``:
 
       "djangocms_icon",  # optional
       "easy_thumbnails",
+      "djangocms_link",  # Needed for link support
       "djangocms_frontend",
       "djangocms_frontend.contrib.accordion",
       "djangocms_frontend.contrib.alert",