oarepo-workflows 1.0.0__tar.gz

oarepo_workflows-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2021 CESNET.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

oarepo_workflows-1.0.0/MANIFEST.in

@@ -0,0 +1,10 @@
+recursive-exclude tests *
+recursive-include oarepo_requests *.yaml
+recursive-include oarepo_requests *.json
+recursive-include oarepo_requests *.po
+recursive-include oarepo_requests *.pot
+recursive-include oarepo_requests *.mo
+recursive-include oarepo_requests *.js
+recursive-include oarepo_requests *.jsx
+recursive-include oarepo_requests *.less
+recursive-include oarepo_requests *.jinja

oarepo_workflows-1.0.0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.1
+Name: oarepo-workflows
+Version: 1.0.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: invenio-records-resources
+Requires-Dist: invenio-requests
+Requires-Dist: oarepo-runtime
+
+# OARepo workflows

oarepo_workflows-1.0.0/README.md

@@ -0,0 +1 @@
+# OARepo workflows

oarepo_workflows-1.0.0/oarepo_workflows/ext.py

@@ -0,0 +1,72 @@
+from functools import cached_property
+
+import importlib_metadata
+
+
+class OARepoWorkflows(object):
+
+    def __init__(self, app=None):
+        if app:
+            self.init_config(app)
+            self.init_app(app)
+
+    def init_config(self, app):
+        """Initialize configuration."""
+        from . import ext_config
+
+        if "OAREPO_PERMISSIONS_PRESETS" not in app.config:
+            app.config["OAREPO_PERMISSIONS_PRESETS"] = {}
+
+        for k in ext_config.OAREPO_PERMISSIONS_PRESETS:
+            if k not in app.config["OAREPO_PERMISSIONS_PRESETS"]:
+                app.config["OAREPO_PERMISSIONS_PRESETS"][k] = (
+                    ext_config.OAREPO_PERMISSIONS_PRESETS[k]
+                )
+
+    @cached_property
+    def state_changed_notifiers(self):
+        group_name = "oarepo_workflows.state_changed_notifiers"
+        return importlib_metadata.entry_points().select(group=group_name)
+
+    @cached_property
+    def workflow_changed_notifiers(self):
+        group_name = "oarepo_workflows.workflow_changed_notifiers"
+        return importlib_metadata.entry_points().select(group=group_name)
+
+    @cached_property
+    def default_workflow_getters(self):
+        group_name = "oarepo_workflows.default_workflow_getters"
+        return importlib_metadata.entry_points().select(group=group_name)
+
+    def set_state(self, identity, record, value, *args, uow=None, **kwargs):
+        previous_value = record.state
+        record.state = value
+        for state_changed_notifier_ep in self.state_changed_notifiers:
+            state_changed_notifier = state_changed_notifier_ep.load()
+            state_changed_notifier(
+                identity, record, previous_value, value, *args, uow=uow, **kwargs
+            )
+
+    def get_default_workflow(self, default="default", *args, **kwargs):
+        for default_workflow_getter_ep in self.default_workflow_getters:
+            default_workflow_getter = default_workflow_getter_ep.load()
+            default = default_workflow_getter(default, *args, **kwargs)
+        return default
+
+    def set_workflow(self, identity, record, value, *args, uow=None, **kwargs):
+        previous_value = record.parent["workflow"]
+        record.parent.workflow = value
+        for workflow_changed_notifier_ep in self.workflow_changed_notifiers:
+            workflow_changed_notifier = workflow_changed_notifier_ep.load()
+            workflow_changed_notifier(
+                identity, record, previous_value, value, *args, uow=uow, **kwargs
+            )
+
+    @property
+    def record_workflows(self):
+        return self.app.config["RECORD_WORKFLOWS"]
+
+    def init_app(self, app):
+        """Flask application initialization."""
+        self.app = app
+        app.extensions["oarepo-workflows"] = self

oarepo_workflows-1.0.0/oarepo_workflows/ext_config.py

@@ -0,0 +1,5 @@
+from oarepo_workflows.permissions.policy import WorkflowPermissionPolicy
+
+OAREPO_PERMISSIONS_PRESETS = {
+    "workflow": WorkflowPermissionPolicy,
+}

oarepo_workflows-1.0.0/oarepo_workflows/permissions/generators.py

@@ -0,0 +1,115 @@
+import operator
+from functools import reduce
+from itertools import chain
+
+from invenio_records.dictutils import dict_lookup
+from invenio_records_permissions.generators import ConditionalGenerator, Generator
+from invenio_search.engine import dsl
+
+from oarepo_workflows.proxies import current_oarepo_workflows
+
+
+def needs_from_generators(generators, **kwargs):
+    if not generators:
+        return []
+    needs = [
+        g.needs(
+            **kwargs,
+        )
+        for g in generators
+    ]
+    return set(chain.from_iterable(needs))
+
+
+def reference_receiver_from_generators(generators, **kwargs):
+    if not generators:
+        return None
+    for generator in generators:
+        if hasattr(generator, 'reference_receiver'):
+            ref = generator.reference_receiver(**kwargs)
+            if ref:
+                return ref
+
+
+def query_filters_from_generators(generators, **kwargs):
+    queries = [g.query_filter(**kwargs) for g in generators]
+    queries = [q for q in queries if q]
+    return reduce(operator.or_, queries) if queries else None
+
+
+def _needs_from_workflow(workflow_id, action, record, **kwargs):
+    try:
+        generators = dict_lookup(
+            current_oarepo_workflows, f"{workflow_id}.permissions.{action}"
+        )
+    except KeyError:
+        return []
+    return needs_from_generators(generators, record, **kwargs)
+
+
+def get_workflow_from_record(record, **kwargs):
+    if hasattr(record, "parent"):
+        record = record.parent
+    if hasattr(record, "workflow") and record.workflow:
+        return record.workflow
+    else:
+        if "record" not in kwargs:
+            return current_oarepo_workflows.get_default_workflow(
+                record=record, **kwargs
+            )
+        else:
+            return current_oarepo_workflows.get_default_workflow(**kwargs)
+
+
+def get_permission_class_from_workflow(record=None, action_name=None, **kwargs):
+    if record:
+        workflow_id = get_workflow_from_record(record)
+    else:
+        workflow_id = current_oarepo_workflows.get_default_workflow(**kwargs)
+
+    policy = dict_lookup(
+        current_oarepo_workflows.record_workflows, f"{workflow_id}.permissions"
+    )
+    return policy(action_name, **kwargs)
+
+
+class WorkflowPermission(Generator):
+    def __init__(self, action):
+        super().__init__()
+        self._action = action
+
+    def _get_generators(self, record, **kwargs):
+        permission_class = get_permission_class_from_workflow(
+            record, action_name=self._action, **kwargs
+        )
+        return getattr(permission_class, self._action, None)
+
+    def needs(self, record=None, **kwargs):
+        generators = self._get_generators(record, **kwargs)
+        return needs_from_generators(generators, record=record, **kwargs)
+
+    def query_filter(self, record=None, **kwargs):
+        generators = self._get_generators(record, **kwargs)
+        return query_filters_from_generators(generators, record=record, **kwargs)
+
+
+class IfInState(ConditionalGenerator):
+    def __init__(self, state, then_):
+        super().__init__(then_, else_=[])
+        self.state = state
+
+    def _condition(self, record, **kwargs):
+        try:
+            state = record.state
+        except AttributeError:
+            return False
+        return state == self.state
+
+    def query_filter(self, **kwargs):
+        """Filters for queries."""
+        field = "state"
+
+        q_instate = dsl.Q("match", **{field: self.state})
+        then_query = self._make_query(self.then_, **kwargs)
+
+        return q_instate & then_query

oarepo_workflows-1.0.0/oarepo_workflows/permissions/policy.py

@@ -0,0 +1,73 @@
+
+from invenio_records_permissions import RecordPermissionPolicy
+from invenio_records_permissions.generators import AuthenticatedUser, SystemProcess
+from oarepo_runtime.services.generators import RecordOwners
+
+from oarepo_workflows.permissions.generators import WorkflowPermission
+
+from .generators import IfInState
+
+
+class DefaultWorkflowPermissionPolicy(RecordPermissionPolicy):
+
+    PERMISSIONS_REMAP = {
+        "can_read_draft": "can_read",
+        "can_update_draft": "can_update",
+        "can_delete_draft": "can_delete",
+        "can_draft_create_files": "can_create_files",
+        "can_draft_set_content_files": "can_set_content_files",
+        "can_draft_get_content_files": "can_get_content_files",
+        "can_draft_commit_files": "can_commit_files",
+        "can_draft_read_files": "can_read_files",
+        "can_draft_update_files": "can_update_files",
+        "can_search_drafts": "can_search",
+    }
+
+    def __init__(self, action_name=None, **over):
+        action_name = DefaultWorkflowPermissionPolicy.PERMISSIONS_REMAP.get(
+            action_name, action_name
+        )
+        can = getattr(self, action_name)
+        can.append(SystemProcess())
+        super().__init__(action_name, **over)
+
+    can_search = [AuthenticatedUser()]
+    can_read = [
+        IfInState("draft", [RecordOwners()]),
+        IfInState("published", [AuthenticatedUser()]),
+    ]
+    can_update = [IfInState("draft", RecordOwners())]
+    can_delete = [
+        IfInState("draft", RecordOwners()),
+        # published record can not be deleted directly by anyone else than system
+        SystemProcess(),
+    ]
+    can_create = [AuthenticatedUser()]
+    can_publish = [AuthenticatedUser()]
+
+
+class WorkflowPermissionPolicy(RecordPermissionPolicy):
+
+    can_create = [WorkflowPermission("can_create")]
+    can_publish = [WorkflowPermission("can_publish")]
+    can_search = [WorkflowPermission("can_search")]
+    can_read = [WorkflowPermission("can_read")]
+    can_update = [WorkflowPermission("can_update")]
+    can_delete = [WorkflowPermission("can_delete")]
+    can_create_files = [WorkflowPermission("can_create_files")]
+    can_set_content_files = [WorkflowPermission("can_set_content_files")]
+    can_get_content_files = [WorkflowPermission("can_get_content_files")]
+    can_commit_files = [WorkflowPermission("can_commit_files")]
+    can_read_files = [WorkflowPermission("can_read_files")]
+    can_update_files = [WorkflowPermission("can_update_files")]
+
+    can_search_drafts = [WorkflowPermission("can_search")]
+    can_read_draft = [WorkflowPermission("can_read")]
+    can_update_draft = [WorkflowPermission("can_update")]
+    can_delete_draft = [WorkflowPermission("can_delete")]
+    can_draft_create_files = [WorkflowPermission("can_create_files")]
+    can_draft_set_content_files = [WorkflowPermission("can_set_content_files")]
+    can_draft_get_content_files = [WorkflowPermission("can_get_content_files")]
+    can_draft_commit_files = [WorkflowPermission("can_commit_files")]
+    can_draft_read_files = [WorkflowPermission("can_read_files")]
+    can_draft_update_files = [WorkflowPermission("can_update_files")]

oarepo_workflows-1.0.0/oarepo_workflows/proxies.py

@@ -0,0 +1,6 @@
+from flask import current_app
+from werkzeug.local import LocalProxy
+
+current_oarepo_workflows = LocalProxy(
+    lambda: current_app.extensions["oarepo-workflows"]
+)

oarepo_workflows-1.0.0/oarepo_workflows/records/models.py

@@ -0,0 +1,18 @@
+from invenio_db import db
+from sqlalchemy import String
+from sqlalchemy.ext.declarative import declared_attr
+from sqlalchemy_utils.types import UUIDType
+
+
+class RecordWorkflowModelMixin:
+    __record_model__ = None
+
+    @declared_attr
+    def record_id(cls):
+        return db.Column(
+            UUIDType,
+            db.ForeignKey(cls.__record_model__.id, ondelete="CASCADE"),
+            primary_key=True,
+        )
+
+    workflow = db.Column(String)

oarepo_workflows-1.0.0/oarepo_workflows/records/systemfields/state.py

@@ -0,0 +1,20 @@
+from invenio_records.systemfields.base import SystemField
+
+
+class RecordStateField(SystemField):
+    def __init__(self, key="state", initial="draft", config=None):
+        self._config = config
+        self._initial = initial
+        super().__init__(key=key)
+
+    def post_create(self, record):
+        self.set_dictkey(record, self._initial)
+
+    def __get__(self, record, owner=None):
+        """Get the persistent identifier."""
+        if record is None:
+            return self
+        return self.get_dictkey(record)
+
+    def __set__(self, record, value):
+        self.set_dictkey(record, value)

oarepo_workflows-1.0.0/oarepo_workflows/records/systemfields/workflow.py

@@ -0,0 +1,61 @@
+from invenio_db import db
+from invenio_records.systemfields.base import SystemField
+from sqlalchemy.exc import NoResultFound
+
+from ...proxies import current_oarepo_workflows
+
+
+class WorkflowField(SystemField):
+
+    def __init__(self, record_workflow_model, key="workflow"):
+        self._workflow = None  # added in db
+        self._record_workflow_model = record_workflow_model
+        super().__init__(key=key)
+
+    def _get_workflow_from_parent_db(self, record):
+        if record.id is None:
+            return
+        try:
+            res = (
+                db.session.query(self._record_workflow_model.workflow)
+                .filter(self._record_workflow_model.record_id == record.id)
+                .one()
+            )
+            return res[0]
+        except NoResultFound:
+            return None
+
+    def _get_workflow(self, record):
+        if "workflow" in record and record["workflow"]:
+            return record["workflow"]
+        workflow = self._get_workflow_from_parent_db(record)
+        if not workflow:
+            workflow = current_oarepo_workflows.get_default_workflow(record=record)
+        return workflow
+
+    def post_create(self, record):
+        workflow = self._get_workflow(record)
+        if workflow:
+            self.set_dictkey(record, workflow)
+
+    def pre_commit(self, record):
+        super().pre_commit(record)
+        saved_workflow = self._get_workflow_from_parent_db(record)
+        if not saved_workflow:
+            default = self._get_workflow(
+                record
+            )
+            if default:
+                new = self._record_workflow_model(
+                    workflow=default, record_id=str(record.id)
+                )
+                db.session.add(new)
+
+    def __get__(self, record, owner=None):
+        """Get the persistent identifier."""
+        if record is None:
+            return self
+        return self._get_workflow(record)
+
+    def __set__(self, record, value):
+        self.set_dictkey(record, value)

oarepo_workflows-1.0.0/oarepo_workflows/requests/classes.py

@@ -0,0 +1,12 @@
+class WorkflowRequest:
+    def __init__(self, requesters, recipients, transitions):
+        self.requesters = requesters
+        self.recipients = recipients
+        self.transitions = transitions
+
+
+class WorkflowTransitions:
+    def __init__(self, submitted=None, approved=None, declined=None):
+        self.submitted = submitted
+        self.approved = approved
+        self.declined = declined

oarepo_workflows-1.0.0/oarepo_workflows.egg-info/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.1
+Name: oarepo-workflows
+Version: 1.0.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: invenio-records-resources
+Requires-Dist: invenio-requests
+Requires-Dist: oarepo-runtime
+
+# OARepo workflows

oarepo_workflows-1.0.0/oarepo_workflows.egg-info/SOURCES.txt

@@ -0,0 +1,26 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+oarepo_workflows/__init__.py
+oarepo_workflows/ext.py
+oarepo_workflows/ext_config.py
+oarepo_workflows/proxies.py
+oarepo_workflows.egg-info/PKG-INFO
+oarepo_workflows.egg-info/SOURCES.txt
+oarepo_workflows.egg-info/dependency_links.txt
+oarepo_workflows.egg-info/entry_points.txt
+oarepo_workflows.egg-info/requires.txt
+oarepo_workflows.egg-info/top_level.txt
+oarepo_workflows/permissions/__init__.py
+oarepo_workflows/permissions/generators.py
+oarepo_workflows/permissions/policy.py
+oarepo_workflows/records/__init__.py
+oarepo_workflows/records/models.py
+oarepo_workflows/records/systemfields/__init__.py
+oarepo_workflows/records/systemfields/state.py
+oarepo_workflows/records/systemfields/workflow.py
+oarepo_workflows/requests/__init__.py
+oarepo_workflows/requests/classes.py

oarepo_workflows-1.0.0/oarepo_workflows.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

oarepo_workflows-1.0.0/oarepo_workflows.egg-info/entry_points.txt

@@ -0,0 +1,5 @@
+[invenio_base.api_apps]
+oarepo_workflows = oarepo_workflows.ext:OARepoWorkflows
+
+[invenio_base.apps]
+oarepo_workflows = oarepo_workflows.ext:OARepoWorkflows

oarepo_workflows-1.0.0/oarepo_workflows.egg-info/requires.txt

@@ -0,0 +1,3 @@
+invenio-records-resources
+invenio-requests
+oarepo-runtime

oarepo_workflows-1.0.0/oarepo_workflows.egg-info/top_level.txt

@@ -0,0 +1 @@
+oarepo_workflows

oarepo_workflows-1.0.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build_system]
+requires = ["setuptools", "wheel", "babel>2.8"]
+build-backend = "setuptools.build_meta"

oarepo_workflows-1.0.0/setup.cfg

@@ -0,0 +1,36 @@
+[metadata]
+name = oarepo-workflows
+version = 1.0.0
+description = 
+authors = Ronald Krist <krist@cesnet.cz>
+readme = README.md
+long_description = file:README.md
+long_description_content_type = text/markdown
+
+[options]
+python = >=3.9
+install_requires = 
+	invenio-records-resources
+	invenio-requests
+	oarepo-runtime
+packages = find:
+include_package_data = True
+
+[options.package_data]
+* = *.json, *.rst, *.md, *.json5, *.jinja2, *.po, *.mo, *.pot, *.js, *.jsx, *.less, *.jinja
+
+[options.packages.find]
+exclude = 
+	tests
+	tests.*
+
+[options.entry_points]
+invenio_base.apps = 
+	oarepo_workflows = oarepo_workflows.ext:OARepoWorkflows
+invenio_base.api_apps = 
+	oarepo_workflows = oarepo_workflows.ext:OARepoWorkflows
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

oarepo_workflows-1.0.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()