admin.py

"""Django admin interface for `~builds.models.Build` and related models."""

from django.contrib import admin, messages
from polymorphic.admin import PolymorphicChildModelAdmin, PolymorphicParentModelAdmin

from readthedocs.builds.models import (
    Build,
    BuildCommandResult,
    RegexAutomationRule,
    Version,
    VersionAutomationRule,
)
from readthedocs.core.utils import trigger_build
from readthedocs.core.utils.admin import pretty_json_field
from readthedocs.projects.models import HTMLFile
from readthedocs.search.utils import _indexing_helper


class BuildCommandResultInline(admin.TabularInline):
    model = BuildCommandResult
    fields = ("command", "exit_code", "output")


class BuildAdmin(admin.ModelAdmin):
    fields = (
        "project",
        "version",
        "type",
        "state",
        "error",
        "success",
        "cold_storage",
        "date",
        "builder",
        "length",
        "build_config_file",
        "pretty_config",
    )
    readonly_fields = (
        "date",  # required to be read-only because it's a @property
        "pretty_config",  # required to be read-only because it's a @property
        "builder",
        "length",
    )
    list_display = (
        "id",
        "project_slug",
        "version_slug",
        "success",
        "type",
        "state",
        "date",
        "builder",
        "length",
    )
    list_filter = ("type", "state", "success")
    list_select_related = ("project", "version")
    raw_id_fields = ("project", "version")
    inlines = (BuildCommandResultInline,)
    search_fields = ("project__slug", "version__slug")

    def project_slug(self, obj):
        return obj.project.slug

    def version_slug(self, obj):
        return obj.version.slug

    def pretty_config(self, instance):
        return pretty_json_field(instance, "config")

    pretty_config.short_description = "Config File"


class VersionAdmin(admin.ModelAdmin):

    list_display = (
        "slug",
        "project_slug",
        "type",
        "privacy_level",
        "active",
        "built",
    )
    readonly_fields = (
        "pretty_config",  # required to be read-only because it's a @property
    )
    list_filter = ("type", "privacy_level", "active", "built")
    search_fields = ("slug", "project__slug")
    raw_id_fields = ("project",)
    actions = ["build_version", "reindex_version", "wipe_version_indexes"]

    def project_slug(self, obj):
        return obj.project.slug

    def pretty_config(self, instance):
        return pretty_json_field(instance, "config")

    pretty_config.short_description = "Config File"

    def build_version(self, request, queryset):
        """Trigger a build for the project version."""
        total = 0
        for version in queryset:
            trigger_build(
                project=version.project,
                version=version,
            )
            total += 1
        messages.add_message(
            request,
            messages.INFO,
            "Triggered builds for {} version(s).".format(total),
        )

    build_version.short_description = "Build version"

    def reindex_version(self, request, queryset):
        """Reindexes all selected versions to ES."""
        html_objs_qs = []
        for version in queryset.iterator():
            html_objs = HTMLFile.objects.filter(
                project=version.project, version=version
            )

            if html_objs.exists():
                html_objs_qs.append(html_objs)

        if html_objs_qs:
            _indexing_helper(html_objs_qs, wipe=False)

        self.message_user(request, "Task initiated successfully.", messages.SUCCESS)

    reindex_version.short_description = "Reindex version to ES"

    def wipe_version_indexes(self, request, queryset):
        """Wipe selected versions from ES."""
        html_objs_qs = []
        for version in queryset.iterator():
            html_objs = HTMLFile.objects.filter(
                project=version.project, version=version
            )

            if html_objs.exists():
                html_objs_qs.append(html_objs)

        if html_objs_qs:
            _indexing_helper(html_objs_qs, wipe=True)

        self.message_user(
            request,
            "Task initiated successfully",
            messages.SUCCESS,
        )

    wipe_version_indexes.short_description = "Wipe version from ES"


@admin.register(RegexAutomationRule)
class RegexAutomationRuleAdmin(PolymorphicChildModelAdmin, admin.ModelAdmin):
    raw_id_fields = ("project",)
    base_model = RegexAutomationRule


@admin.register(VersionAutomationRule)
class VersionAutomationRuleAdmin(PolymorphicParentModelAdmin, admin.ModelAdmin):
    base_model = VersionAutomationRule
    list_display = (
        "id",
        "project",
        "priority",
        "predefined_match_arg",
        "match_arg",
        "action",
        "version_type",
    )
    child_models = (RegexAutomationRule,)
    search_fields = ("project__slug",)
    list_filter = ("action", "version_type")


admin.site.register(Build, BuildAdmin)
admin.site.register(Version, VersionAdmin)