angrybeanie_wagtail/env/lib/python3.12/site-packages/wagtail/snippets/models.py

from functools import lru_cache

from django.apps import apps as global_apps
from django.contrib.admin.utils import quote
from django.contrib.auth import get_permission_codename
from django.contrib.auth.models import Permission
from django.contrib.contenttypes.models import ContentType
from django.db import DEFAULT_DB_ALIAS, models, router
from django.urls import reverse
from django.utils.module_loading import import_string

from wagtail.admin.viewsets import viewsets
from wagtail.hooks import search_for_hooks
from wagtail.models import DraftStateMixin, LockableMixin, WorkflowMixin

SNIPPET_MODELS = []


# register_snippet will often be called before models are fully loaded, which may cause
# issues with constructing viewsets (https://github.com/wagtail/wagtail/issues/9586).
# We therefore initially set a DEFER_REGISTRATION flag to indicate that registration
# should not be processed immediately, but added to the DEFERRED_REGISTRATIONS list to be
# handled later. This is initiated from WagtailSnippetsAppConfig.ready(), at which point
# we can be sure that models are fully loaded.
DEFER_REGISTRATION = True
DEFERRED_REGISTRATIONS = []


def get_snippet_models():
    # Snippets can be registered in wagtail_hooks.py by calling register_snippet
    # as a function instead of a decorator. Make sure we search for hooks before
    # returning the list of snippet models.
    search_for_hooks()
    return SNIPPET_MODELS


@lru_cache(maxsize=None)
def get_workflow_enabled_models():
    return [model for model in get_snippet_models() if issubclass(model, WorkflowMixin)]


def get_editable_models(user):
    from wagtail.snippets.permissions import get_permission_name

    return [
        model
        for model in get_snippet_models()
        if user.has_perm(get_permission_name("change", model))
    ]


class SnippetAdminURLFinder:
    # subclasses should define a 'model' attribute
    def __init__(self, user=None):
        if user:
            from wagtail.snippets.permissions import get_permission_name

            self.user_can_edit = user.has_perm(
                get_permission_name("change", self.model)
            )
        else:
            # skip permission checks
            self.user_can_edit = True

    def get_edit_url(self, instance):
        if self.user_can_edit:
            return reverse(
                instance.snippet_viewset.get_url_name("edit"),
                args=[quote(instance.pk)],
            )


def register_snippet(registerable, viewset=None):
    if DEFER_REGISTRATION:
        # Models may not have been fully loaded yet, so defer registration until they are -
        # add it to the list of registrations to be processed by register_deferred_snippets
        DEFERRED_REGISTRATIONS.append((registerable, viewset))
    else:
        _register_snippet_immediately(registerable, viewset)

    return registerable


def _register_snippet_immediately(registerable, viewset=None):
    # Register the viewset and formfield for this snippet model,
    # skipping the check for whether models are loaded
    from wagtail.snippets.views.snippets import SnippetViewSet

    if isinstance(registerable, str):
        registerable = import_string(registerable)
    if isinstance(viewset, str):
        viewset = import_string(viewset)

    if isinstance(registerable, type) and issubclass(registerable, models.Model):
        # Legacy-style registration, using a model class as the `registerable`
        # register_snippet(SnippetModel, viewset=CustomViewSet) or
        # register_snippet(SnippetModel) or
        # @register_snippet on class SnippetModel
        if viewset is None:
            viewset = SnippetViewSet
        registerable = viewset(model=registerable)

    if callable(registerable):
        # The registerable is likely a ViewSet/ViewSetGroup class with all the
        # options configured on the class, but it may also be a function that
        # returns a ViewSet/ViewSetGroup instance.
        registerable = registerable()

    # Registerable has been resolved to a ViewSet/ViewSetGroup instance
    viewsets.register(registerable)


def register_deferred_snippets():
    """
    Called from WagtailSnippetsAppConfig.ready(), at which point we can be sure all models
    have been loaded and register_snippet can safely construct viewsets.
    """
    global DEFER_REGISTRATION
    DEFER_REGISTRATION = False
    for registerable, viewset in DEFERRED_REGISTRATIONS:
        _register_snippet_immediately(registerable, viewset)


def create_extra_permissions(
    app_config, *args, using=DEFAULT_DB_ALIAS, apps=global_apps, **kwargs
):
    app_label = app_config.label
    try:
        app_config = apps.get_app_config(app_label)
        apps.get_model("contenttypes", "ContentType")
        apps.get_model("auth", "Permission")
    except LookupError:
        return

    if not router.allow_migrate_model(using, Permission):
        return

    model_cts = ContentType.objects.db_manager(using).get_for_models(
        *get_snippet_models(), for_concrete_models=False
    )

    all_perms = set(
        Permission.objects.using(using)
        .filter(content_type__in=model_cts.values())
        .values_list("content_type", "codename")
    )

    permissions = []

    def add_permission(model, content_type, name):
        codename = get_permission_codename(name, model._meta)
        if (content_type.pk, codename) in all_perms:
            return

        permissions.append(
            Permission(
                content_type=content_type,
                codename=codename,
                name=f"Can {name} {model._meta.verbose_name_raw}",
            )
        )

    for model, ct in model_cts.items():
        if issubclass(model, DraftStateMixin):
            add_permission(model, ct, "publish")
        if issubclass(model, LockableMixin):
            add_permission(model, ct, "lock")
            add_permission(model, ct, "unlock")

    Permission.objects.using(using).bulk_create(permissions)