wbcore 2.2.1__py2.py3-none-any.whl

wbcore/contrib/workflow/viewsets/process.py

@@ -0,0 +1,171 @@
+from django.db.models import F, Q, QuerySet
+from django.shortcuts import get_object_or_404
+from django.utils.functional import cached_property
+from rest_framework import permissions
+from rest_framework.decorators import action
+from rest_framework.response import Response
+from wbcore import viewsets
+from wbcore.contrib.authentication.models import User
+from wbcore.contrib.workflow.filters import (
+    AssignedProcessStepFilter,
+    ProcessFilter,
+    ProcessStepFilter,
+    ProcessStepProcessFilter,
+    ProcessStepStepFilter,
+    ProcessWorkflowFilter,
+)
+from wbcore.contrib.workflow.models import (
+    Process,
+    ProcessStep,
+    Step,
+    Transition,
+    UserStep,
+)
+from wbcore.contrib.workflow.serializers import (
+    AssignedProcessStepSerializer,
+    ProcessModelSerializer,
+    ProcessStepModelSerializer,
+)
+from wbcore.contrib.workflow.viewsets.display import (
+    AssignedProcessStepDisplayConfig,
+    ProcessDisplayConfig,
+    ProcessStepDisplayConfig,
+)
+from wbcore.contrib.workflow.viewsets.endpoints import (
+    AssignedProcessStepEndpointConfig,
+    ProcessEndpointConfig,
+)
+from wbcore.contrib.workflow.viewsets.titles import (
+    AssignedProcessStepTitleConfig,
+    ProcessStepTitleConfig,
+    ProcessTitleConfig,
+)
+
+
+class ProcessModelViewSet(viewsets.ModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/process.md"
+    queryset = Process.objects.all()
+    serializer_class = ProcessModelSerializer
+    display_config_class = ProcessDisplayConfig
+    title_config_class = ProcessTitleConfig
+    endpoint_config_class = ProcessEndpointConfig
+    search_fields = ("workflow__name", "content_type__model")
+    ordering = ("workflow__name", "state", "content_type__model", "id")
+    ordering_fields = (
+        "id",
+        "workflow__name",
+        "started",
+        "finished",
+        "content_type__model",
+    )
+
+    def get_queryset(self):
+        if workflow_id := self.kwargs.get("workflow_id"):
+            return super().get_queryset().filter(workflow=workflow_id)
+        return super().get_queryset()
+
+    def get_filterset_class(self, request):
+        if self.kwargs.get("workflow_id"):
+            return ProcessWorkflowFilter
+        return ProcessFilter
+
+
+class ProcessStepModelViewSet(viewsets.ModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/processstep.md"
+    queryset = ProcessStep.objects.all()
+    serializer_class = ProcessStepModelSerializer
+    title_config_class = ProcessStepTitleConfig
+    endpoint_config_class = ProcessEndpointConfig
+    display_config_class = ProcessStepDisplayConfig
+    serializer_class = ProcessStepModelSerializer
+    search_fields = ("process__workflow__name", "step__name")
+    ordering = ("step__name", "state", "process__id", "id")
+    ordering_fields = (
+        "id",
+        "process__id",
+        "step__name",
+        "started",
+        "finished",
+        "assignee__computed_str",
+        "group__name",
+        "permission__name",
+        "status",
+        "error_message",
+    )
+
+    @cached_property
+    def request_user(self) -> User:
+        return self.request.user
+
+    def get_queryset(self) -> QuerySet[ProcessStep]:
+        queryset: QuerySet[ProcessStep] = (
+            super().get_queryset().select_related("assignee", "permission", "group", "process")
+        )
+        if not self.request_user.is_superuser:
+            queryset = queryset.filter(
+                Q(permission__user=self.request_user)
+                | Q(permission__group__user=self.request_user)
+                | Q(permission__isnull=True)
+            )
+        if process_id := self.kwargs.get("process_id"):
+            queryset = queryset.filter(process=process_id)
+        elif step_id := self.kwargs.get("step_id"):
+            queryset = queryset.filter(step=step_id)
+        return queryset
+
+    def get_filterset_class(self, request):
+        if self.kwargs.get("process_id"):
+            return ProcessStepProcessFilter
+        if self.kwargs.get("step_id"):
+            return ProcessStepStepFilter
+        return ProcessStepFilter
+
+    @action(detail=True, methods=["PATCH"], permission_classes=[permissions.IsAuthenticated])
+    def next(self, request, pk=None):
+        process_step = get_object_or_404(ProcessStep, pk=pk)
+        transition = get_object_or_404(Transition, pk=request.GET.get("transition_id"))
+        Step.start_next_step(process_step, transition)
+        return Response({"status": "ok"})
+
+
+class AssignedProcessStepModelViewSet(ProcessStepModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/assignedprocessstep.md"
+    title_config_class = AssignedProcessStepTitleConfig
+    serializer_class = AssignedProcessStepSerializer
+    endpoint_config_class = AssignedProcessStepEndpointConfig
+    display_config_class = AssignedProcessStepDisplayConfig
+    search_fields = ("process__workflow__name", "step__name")
+    ordering = ("step__name", "step__workflow__name", "process__id", "id")
+    ordering_fields = (
+        "step__name",
+        "started",
+        "finished",
+        "group__name",
+        "permission__name",
+        "status",
+        "attached_model",
+        "workflow_name",
+    )
+
+    def get_queryset(self) -> QuerySet[ProcessStep]:
+        qs = (
+            super()
+            .get_queryset()
+            .filter(
+                Q(step__step_type=Step.StepType.USERSTEP)
+                & Q(state=ProcessStep.StepState.ACTIVE)
+                & Q(
+                    Q(assignee=self.request_user)
+                    | Q(
+                        Q(group__user=self.request_user)
+                        & Q(step__in=UserStep.objects.filter(assignee_method__isnull=True))
+                        & Q(assignee__isnull=True)
+                    )
+                )
+            )
+            .annotate(attached_model=F("step__workflow__model__model"), workflow_name=F("step__workflow__name"))
+        ).select_related("step__workflow")
+        return qs
+
+    def get_filterset_class(self, request):
+        return AssignedProcessStepFilter

wbcore/contrib/workflow/viewsets/step.py

@@ -0,0 +1,229 @@
+from wbcore import viewsets
+from wbcore.contrib.workflow.filters import (
+    DecisionStepFilter,
+    EmailStepFilter,
+    FinishStepFilter,
+    JoinStepFilter,
+    ScriptStepFilter,
+    SplitStepFilter,
+    StartStepFilter,
+    StepFilter,
+    StepWorkflowFilter,
+    UserStepFilter,
+)
+from wbcore.contrib.workflow.models import (
+    DecisionStep,
+    Display,
+    EmailStep,
+    FinishStep,
+    JoinStep,
+    ScriptStep,
+    SplitStep,
+    StartStep,
+    Step,
+    UserStep,
+)
+from wbcore.contrib.workflow.serializers import (
+    DecisionStepModelSerializer,
+    DisplayModelSerializer,
+    EmailStepModelSerializer,
+    FinishStepModelSerializer,
+    JoinStepModelSerializer,
+    ScriptStepModelSerializer,
+    SplitStepModelSerializer,
+    StartStepModelSerializer,
+    StepModelSerializer,
+    UserStepModelSerializer,
+)
+from wbcore.contrib.workflow.viewsets.buttons import StepButtonConfig
+from wbcore.contrib.workflow.viewsets.display import (
+    BaseStepDisplayConfig,
+    EmailStepDisplayConfig,
+    FinishDisplayConfig,
+    JoinStepDisplayConfig,
+    ScriptStepDisplayConfig,
+    StartStepDisplay,
+    StepDisplayConfig,
+    UserStepDisplayConfig,
+)
+from wbcore.contrib.workflow.viewsets.endpoints import (
+    DisplayEndpointConfig,
+    StepEndpointConfig,
+)
+from wbcore.contrib.workflow.viewsets.titles import (
+    DecisionStepTitleConfig,
+    EmailStepTitleConfig,
+    FinishStepTitleConfig,
+    JoinStepTitleConfig,
+    ScriptStepTitleConfig,
+    SplitStepTitleConfig,
+    StartStepTitleConfig,
+    StepTitleConfig,
+    UserStepTitleConfig,
+)
+from wbcore.metadata.configs.buttons import ButtonViewConfig
+
+
+class StepModelViewSet(viewsets.ModelViewSet):
+    queryset = Step.objects.all()
+    serializer_class = StepModelSerializer
+    display_config_class = StepDisplayConfig
+    search_fields = ("name",)
+    ordering = ("workflow__name", "name")
+    endpoint_config_class = StepEndpointConfig
+    title_config_class = StepTitleConfig
+    button_config_class = StepButtonConfig
+    ordering_fields = (
+        "name",
+        "workflow__name",
+        "code",
+        "status",
+        "step_type",
+    )
+
+    def get_queryset(self):
+        # TODO: OPTIMIZE PERFORMANCE, 390 duplicate queries
+        queryset = super().get_queryset().select_related("workflow")
+        if workflow_id := self.kwargs.get("workflow_id"):
+            return queryset.filter(workflow=workflow_id)
+        return queryset
+
+    def get_filterset_class(self, request):
+        if self.kwargs.get("workflow_id"):
+            return StepWorkflowFilter
+        return StepFilter
+
+
+class UserStepModelViewSet(StepModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/userstep.md"
+    queryset = UserStep.objects.all()
+    serializer_class = UserStepModelSerializer
+    display_config_class = UserStepDisplayConfig
+    title_config_class = UserStepTitleConfig
+    search_fields = ("name", "assignee", "group")
+    button_config_class = ButtonViewConfig
+    ordering = ("workflow__name", "assignee__email", "name")
+    ordering_fields = StepModelViewSet.ordering_fields + (
+        "assignee__computed_str",
+        "group__name",
+        "notify_user",
+        "permission__name",
+        "assignee_method",
+    )
+
+    def get_queryset(self):
+        return super().get_queryset().select_related("assignee")
+
+    def get_filterset_class(self, request):
+        return UserStepFilter
+
+
+class DecisionStepModelViewSet(StepModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/decisionstep.md"
+    queryset = DecisionStep.objects.all()
+    title_config_class = DecisionStepTitleConfig
+    button_config_class = ButtonViewConfig
+    display_config_class = BaseStepDisplayConfig
+    serializer_class = DecisionStepModelSerializer
+
+    def get_filterset_class(self, request):
+        return DecisionStepFilter
+
+
+class StartStepModelViewSet(StepModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/startstep.md"
+    queryset = StartStep.objects.all()
+    title_config_class = StartStepTitleConfig
+    button_config_class = ButtonViewConfig
+    display_config_class = StartStepDisplay
+    serializer_class = StartStepModelSerializer
+
+    def get_filterset_class(self, request):
+        return StartStepFilter
+
+
+class SplitStepModelViewSet(StepModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/splitstep.md"
+    queryset = SplitStep.objects.all()
+    title_config_class = SplitStepTitleConfig
+    button_config_class = ButtonViewConfig
+    display_config_class = BaseStepDisplayConfig
+    serializer_class = SplitStepModelSerializer
+
+    def get_filterset_class(self, request):
+        return SplitStepFilter
+
+
+class JoinStepModelViewSet(StepModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/joinstep.md"
+    queryset = JoinStep.objects.all()
+    title_config_class = JoinStepTitleConfig
+    button_config_class = ButtonViewConfig
+    display_config_class = JoinStepDisplayConfig
+    serializer_class = JoinStepModelSerializer
+    ordering = ("workflow__name", "wait_for_all", "name")
+    ordering_fields = StepModelViewSet.ordering_fields + ("wait_for_all",)
+
+    def get_filterset_class(self, request):
+        return JoinStepFilter
+
+
+class ScriptStepModelViewSet(StepModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/scriptstep.md"
+    queryset = ScriptStep.objects.all()
+    title_config_class = ScriptStepTitleConfig
+    button_config_class = ButtonViewConfig
+    display_config_class = ScriptStepDisplayConfig
+    serializer_class = ScriptStepModelSerializer
+    ordering_fields = StepModelViewSet.ordering_fields + ("script",)
+
+    def get_filterset_class(self, request):
+        return ScriptStepFilter
+
+
+class EmailStepModelViewSet(StepModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/emailstep.md"
+    queryset = EmailStep.objects.all()
+    title_config_class = EmailStepTitleConfig
+    button_config_class = ButtonViewConfig
+    display_config_class = EmailStepDisplayConfig
+    serializer_class = EmailStepModelSerializer
+    ordering_fields = StepModelViewSet.ordering_fields + (
+        "subject",
+        "to__adress",
+        "cc__adress",
+        "bcc__address",
+        "template__name",
+    )
+    search_fields = ("name", "subject", "to__address")
+
+    def get_filterset_class(self, request):
+        return EmailStepFilter
+
+    def get_queryset(self):
+        return super().get_queryset().prefetch_related("to", "cc", "bcc")
+
+
+class FinishStepModelViewSet(StepModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/finishstep.md"
+    queryset = FinishStep.objects.all()
+    title_config_class = FinishStepTitleConfig
+    button_config_class = ButtonViewConfig
+    display_config_class = FinishDisplayConfig
+    serializer_class = FinishStepModelSerializer
+    ordering_fields = StepModelViewSet.ordering_fields + ("write_preserved_instance",)
+
+    def get_filterset_class(self, request):
+        return FinishStepFilter
+
+
+class DisplayModelViewSet(viewsets.ModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/display.md"
+    queryset = Display.objects.all()
+    serializer_class = DisplayModelSerializer
+    endpoint_config_class = DisplayEndpointConfig
+    search_fields = ordering = ("name",)
+    ordering_fields = (
+        "name",
+        "grid_template_areas",
+    )

wbcore/contrib/workflow/viewsets/titles/__init__.py

@@ -0,0 +1,16 @@
+from .condition import ConditionTitleConfig
+from .data import DataTitleConfig
+from .process import ProcessStepTitleConfig, ProcessTitleConfig, AssignedProcessStepTitleConfig
+from .step import (
+    DecisionStepTitleConfig,
+    EmailStepTitleConfig,
+    FinishStepTitleConfig,
+    JoinStepTitleConfig,
+    ScriptStepTitleConfig,
+    SplitStepTitleConfig,
+    StepTitleConfig,
+    UserStepTitleConfig,
+    StartStepTitleConfig,
+)
+from .transition import TransitionTitleConfig
+from .workflow import WorkflowTitleConfig

wbcore/contrib/workflow/viewsets/titles/condition.py

@@ -0,0 +1,13 @@
+from django.utils.translation import gettext as _
+from wbcore.metadata.configs.titles import TitleViewConfig
+
+
+class ConditionTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Conditions")
+
+    def get_create_title(self):
+        return _("Create Condition")
+
+    def get_instance_title(self):
+        return _("Condition")

wbcore/contrib/workflow/viewsets/titles/data.py

@@ -0,0 +1,13 @@
+from django.utils.translation import gettext as _
+from wbcore.metadata.configs.titles import TitleViewConfig
+
+
+class DataTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Data")
+
+    def get_create_title(self):
+        return _("Create Data")
+
+    def get_instance_title(self):
+        return _("Data")

wbcore/contrib/workflow/viewsets/titles/process.py

@@ -0,0 +1,26 @@
+from django.utils.translation import gettext as _
+from wbcore.metadata.configs.titles import TitleViewConfig
+
+
+class ProcessTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Processes")
+
+    def get_instance_title(self):
+        return _("Process")
+
+
+class ProcessStepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Process Steps")
+
+    def get_instance_title(self):
+        return _("Process Step")
+
+
+class AssignedProcessStepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Assigned Process Steps")
+
+    def get_instance_title(self):
+        return _("Assigned Process Step")

wbcore/contrib/workflow/viewsets/titles/step.py

@@ -0,0 +1,101 @@
+from django.utils.translation import gettext as _
+from wbcore.metadata.configs.titles import TitleViewConfig
+
+
+class StepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Steps")
+
+    def get_create_title(self):
+        return _("Create Step")
+
+    def get_instance_title(self):
+        return _("Step")
+
+
+class UserStepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("User Steps")
+
+    def get_create_title(self):
+        return _("Create User Step")
+
+    def get_instance_title(self):
+        return _("User Step")
+
+
+class DecisionStepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Decision Steps")
+
+    def get_create_title(self):
+        return _("Create Decision Step")
+
+    def get_instance_title(self):
+        return _("Decision Step")
+
+
+class StartStepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Start Steps")
+
+    def get_create_title(self):
+        return _("Create Start Step")
+
+    def get_instance_title(self):
+        return _("Start Step")
+
+
+class SplitStepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Split Steps")
+
+    def get_create_title(self):
+        return _("Create Split Step")
+
+    def get_instance_title(self):
+        return _("Split Step")
+
+
+class JoinStepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Join Steps")
+
+    def get_create_title(self):
+        return _("Create Join Step")
+
+    def get_instance_title(self):
+        return _("Join Step")
+
+
+class ScriptStepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Script Steps")
+
+    def get_create_title(self):
+        return _("Create Script Step")
+
+    def get_instance_title(self):
+        return _("Script Step")
+
+
+class EmailStepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Email Steps")
+
+    def get_create_title(self):
+        return _("Create Email Step")
+
+    def get_instance_title(self):
+        return _("Email Step")
+
+
+class FinishStepTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Finish Steps")
+
+    def get_create_title(self):
+        return _("Create Finish Step")
+
+    def get_instance_title(self):
+        return _("Finish Step")

wbcore/contrib/workflow/viewsets/titles/transition.py

@@ -0,0 +1,13 @@
+from django.utils.translation import gettext as _
+from wbcore.metadata.configs.titles import TitleViewConfig
+
+
+class TransitionTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Transitions")
+
+    def get_create_title(self):
+        return _("Create Transition")
+
+    def get_instance_title(self):
+        return _("Transition")

wbcore/contrib/workflow/viewsets/titles/workflow.py

@@ -0,0 +1,13 @@
+from django.utils.translation import gettext as _
+from wbcore.metadata.configs.titles import TitleViewConfig
+
+
+class WorkflowTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Workflows")
+
+    def get_create_title(self):
+        return _("Create Workflow")
+
+    def get_instance_title(self):
+        return _("Workflow")

wbcore/contrib/workflow/viewsets/transition.py

@@ -0,0 +1,57 @@
+from django.db.models import Q
+from django.utils.functional import cached_property
+from django.utils.translation import gettext_lazy as _
+from wbcore import viewsets
+from wbcore.contrib.workflow.filters import TransitionFilter
+from wbcore.contrib.workflow.models import Step, Transition, Workflow
+from wbcore.contrib.workflow.serializers import TransitionModelSerializer
+from wbcore.contrib.workflow.viewsets.display import TransitionDisplayConfig
+from wbcore.contrib.workflow.viewsets.endpoints import TransitionEndpointConfig
+from wbcore.contrib.workflow.viewsets.titles import TransitionTitleConfig
+from wbcore.serializers import PrimaryKeyRelatedField
+
+
+class TransitionModelViewSet(viewsets.ModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/transition.md"
+    queryset = Transition.objects.all()
+    serializer_class = TransitionModelSerializer
+    display_config_class = TransitionDisplayConfig
+    title_config_class = TransitionTitleConfig
+    endpoint_config_class = TransitionEndpointConfig
+    search_fields = ("name",)
+    ordering = ("name", "to_step__name")
+    filterset_class = TransitionFilter
+    ordering_fields = (
+        "name",
+        "from_step__name",
+        "to_step__name",
+    )
+
+    def get_queryset(self):
+        queryset = super().get_queryset().select_related("from_step", "to_step")
+        if step_id := self.kwargs.get("step_id"):
+            return queryset.filter(Q(from_step=step_id) | Q(to_step=step_id))
+        if workflow_id := self.kwargs.get("workflow_id"):
+            return queryset.filter(to_step__workflow=workflow_id)
+        return queryset
+
+    @cached_property
+    def workflow(self) -> Workflow | None:
+        if step_id := self.kwargs.get("step_id"):
+            return Step.objects.get(id=step_id).workflow
+        elif workflow_id := self.kwargs.get("workflow_id"):
+            return Workflow.objects.get(id=workflow_id)
+
+    def get_serializer_class(self):
+        if self.workflow:
+
+            class Serializer(TransitionModelSerializer):
+                from_step = PrimaryKeyRelatedField(
+                    queryset=Step.objects.filter(workflow=self.workflow), label=_("From"), required=False
+                )
+                to_step = PrimaryKeyRelatedField(
+                    queryset=Step.objects.filter(workflow=self.workflow), label=_("To"), required=False
+                )
+
+            return Serializer
+        return super().get_serializer_class()

wbcore/contrib/workflow/viewsets/workflow.py

@@ -0,0 +1,36 @@
+from django.shortcuts import get_object_or_404
+from rest_framework import permissions
+from rest_framework.decorators import action
+from rest_framework.response import Response
+from wbcore import viewsets
+from wbcore.contrib.workflow.filters import WorkflowFilter
+from wbcore.contrib.workflow.models import StartStep, Workflow
+from wbcore.contrib.workflow.serializers import WorkflowModelSerializer
+from wbcore.contrib.workflow.viewsets.display import WorkflowDisplayConfig
+from wbcore.contrib.workflow.viewsets.titles import WorkflowTitleConfig
+
+
+class WorkflowModelViewSet(viewsets.ModelViewSet):
+    LIST_DOCUMENTATION = "workflow/markdown/documentation/workflow.md"
+    queryset = Workflow.objects.all()
+    serializer_class = WorkflowModelSerializer
+    display_config_class = WorkflowDisplayConfig
+    title_config_class = WorkflowTitleConfig
+    search_fields = ordering = ("name",)
+    filterset_class = WorkflowFilter
+    ordering_fields = (
+        "name",
+        "single_instance_execution",
+        "model__model",
+        "status_field",
+        "preserve_instance",
+    )
+
+    @action(detail=True, methods=["PATCH"], permission_classes=[permissions.IsAuthenticated])
+    def start(self, request, pk=None):
+        start_step = get_object_or_404(StartStep, pk=request.GET.get("step_id"))
+        workflow = get_object_or_404(Workflow, pk=pk)
+        instance_id: int | None = request.GET.get("instance_id")
+        instance = get_object_or_404(workflow.model.model_class(), pk=instance_id) if instance_id else None
+        workflow.start_workflow(start_step, instance)
+        return Response({"status": "ok"})