signal handlers for syncing of project views and tasks

rdmo/core/settings.py

@@ -208,7 +208,9 @@
     'PROJECT_IMPORTS',
     'PROJECT_IMPORTS_LIST',
     'PROJECT_SEND_ISSUE',
-    'NESTED_PROJECTS'
+    'NESTED_PROJECTS',
+    'PROJECT_VIEWS_SYNC',
+    'PROJECT_TASKS_SYNC'
 ]
 
 SETTINGS_API = [
@@ -331,7 +333,8 @@
 
 PROJECT_SEND_INVITE = True
 
-PROJECT_REMOVE_VIEWS = True
+PROJECT_VIEWS_SYNC = True
+PROJECT_TASKS_SYNC = True
 
 PROJECT_CREATE_RESTRICTED = False
 PROJECT_CREATE_GROUPS = []

rdmo/projects/apps.py

@@ -10,5 +10,7 @@ class ProjectsConfig(AppConfig):
     def ready(self):
         from . import rules  # noqa: F401
 
-        if settings.PROJECT_REMOVE_VIEWS:
-            from . import handlers  # noqa: F401
+        if settings.PROJECT_VIEWS_SYNC:
+            from .handlers import m2m_changed_views, project_save_views  # noqa: F401
+        if settings.PROJECT_TASKS_SYNC:
+            from .handlers import m2m_changed_tasks, project_save_tasks  # noqa: F401

rdmo/projects/forms.py

@@ -160,12 +160,21 @@ class Meta:
             'catalog': forms.RadioSelect()
         }
 
+    def save(self, *args, **kwargs):
+        # if the catalog is the same, do nothing
+        if self.instance.catalog.id == self.cleaned_data.get('catalog'):
+            return self.instance
+        return super().save(*args, **kwargs)
+
 
 class ProjectUpdateTasksForm(forms.ModelForm):
 
     use_required_attribute = False
 
     def __init__(self, *args, **kwargs):
+        if settings.PROJECT_TASKS_SYNC:
+            raise ValidationError(_("Editing tasks is disabled."))
+
         tasks = kwargs.pop('tasks')
         super().__init__(*args, **kwargs)
         self.fields['tasks'].queryset = tasks
@@ -180,12 +189,20 @@ class Meta:
             'tasks': forms.CheckboxSelectMultiple()
         }
 
+    def save(self, *args, **kwargs):
+        if settings.PROJECT_TASKS_SYNC:
+            raise ValidationError(_("Editing tasks is disabled."))
+        super().save(*args, **kwargs)
+
 
 class ProjectUpdateViewsForm(forms.ModelForm):
 
     use_required_attribute = False
 
     def __init__(self, *args, **kwargs):
+        if settings.PROJECT_VIEWS_SYNC:
+            raise ValidationError(_("Editing views is disabled."))
+
         views = kwargs.pop('views')
         super().__init__(*args, **kwargs)
         self.fields['views'].queryset = views
@@ -200,6 +217,11 @@ class Meta:
             'views': forms.CheckboxSelectMultiple()
         }
 
+    def save(self, *args, **kwargs):
+        if settings.PROJECT_VIEWS_SYNC:
+            raise ValidationError(_("Editing views is disabled."))
+        super().save(*args, **kwargs)
+
 
 class ProjectUpdateParentForm(forms.ModelForm):
 

rdmo/projects/handlers/generic_handlers.py

@@ -0,0 +1,92 @@
+from django.contrib.auth.models import Group, User
+from django.contrib.sites.models import Site
+
+from rdmo.projects.models import Membership, Project
+from rdmo.questions.models import Catalog
+
+
+def m2m_catalogs_changed_projects_sync_signal_handler(instance, action, pk_set, project_field):
+
+    if action == 'post_remove' and pk_set:
+        related_instances = Catalog.objects.filter(pk__in=pk_set)
+        projects_to_change = Project.objects.filter_catalogs(catalogs=related_instances).filter(
+            **{project_field: instance}
+        )
+        for project in projects_to_change:  # remove instance from project
+            getattr(project, project_field).remove(instance)
+
+    elif action == 'post_clear':
+        projects_to_change = Project.objects.filter(**{project_field: instance})
+        for project in projects_to_change:  # remove instance from project
+            getattr(project, project_field).remove(instance)
+
+    elif action == 'post_add' and pk_set:
+        related_instances = Catalog.objects.filter(pk__in=pk_set)
+        projects_to_change = Project.objects.filter_catalogs(catalogs=related_instances).exclude(
+            **{project_field: instance}
+        )
+        for project in projects_to_change:  # add instance to project
+            getattr(project, project_field).add(instance)
+
+
+def m2m_sites_changed_projects_sync_signal_handler(instance, action, pk_set, project_field):
+
+    if action == 'post_remove' and pk_set:
+        related_sites = Site.objects.filter(pk__in=pk_set)
+        catalogs = instance.catalogs.all()
+
+        projects_to_change = Project.objects.filter_catalogs(catalogs=catalogs).filter(
+            site__in=related_sites,
+            **{project_field: instance}
+        )
+        for project in projects_to_change:  # remove instance from project
+            getattr(project, project_field).remove(instance)
+
+    elif action == 'post_clear':
+        projects_to_change = Project.objects.filter_catalogs().filter(**{project_field: instance})
+        for project in projects_to_change:  # remove instance from project
+            getattr(project, project_field).remove(instance)
+
+    elif action == 'post_add' and pk_set:
+        related_sites = Site.objects.filter(pk__in=pk_set)
+        catalogs = instance.catalogs.all()
+
+        projects_to_change = Project.objects.filter_catalogs(catalogs=catalogs).filter(
+            site__in=related_sites
+        ).exclude(**{project_field: instance})
+        for project in projects_to_change:  # add instance to project
+            getattr(project, project_field).add(instance)
+
+
+def m2m_groups_changed_projects_sync_signal_handler(instance, action, pk_set, project_field):
+
+    if action == 'post_remove' and pk_set:
+        related_groups = Group.objects.filter(pk__in=pk_set)
+        users = User.objects.filter(groups__in=related_groups)
+        memberships = Membership.objects.filter(role='owner', user__in=users).values_list('id', flat=True)
+        catalogs = instance.catalogs.all()
+
+        projects_to_change = Project.objects.filter_catalogs(catalogs=catalogs).filter(
+            memberships__in=memberships,
+            **{project_field: instance}
+        )
+        for project in projects_to_change:  # remove instance from project
+            getattr(project, project_field).remove(instance)
+
+    elif action == 'post_clear':
+        # Remove all linked projects regardless of catalogs
+        projects_to_change = Project.objects.filter_catalogs().filter(**{project_field: instance})
+        for project in projects_to_change:  # remove instance from project
+            getattr(project, project_field).remove(instance)
+
+    elif action == 'post_add' and pk_set:
+        related_groups = Group.objects.filter(pk__in=pk_set)
+        users = User.objects.filter(groups__in=related_groups)
+        memberships = Membership.objects.filter(role='owner', user__in=users).values_list('id', flat=True)
+        catalogs = instance.catalogs.all()
+
+        projects_to_change = Project.objects.filter_catalogs(catalogs=catalogs).filter(
+            memberships__in=memberships
+        ).exclude(**{project_field: instance})
+        for project in projects_to_change:  # add instance to project
+            getattr(project, project_field).add(instance)

rdmo/projects/handlers/m2m_changed_tasks.py

@@ -0,0 +1,25 @@
+from django.db.models.signals import m2m_changed
+from django.dispatch import receiver
+
+from rdmo.tasks.models import Task
+
+from .generic_handlers import (
+    m2m_catalogs_changed_projects_sync_signal_handler,
+    m2m_groups_changed_projects_sync_signal_handler,
+    m2m_sites_changed_projects_sync_signal_handler,
+)
+
+
+@receiver(m2m_changed, sender=Task.catalogs.through)
+def m2m_changed_task_catalog_signal(sender, instance, action, pk_set, **kwargs):
+    m2m_catalogs_changed_projects_sync_signal_handler(instance, action, pk_set, 'tasks')
+
+
+@receiver(m2m_changed, sender=Task.sites.through)
+def m2m_changed_task_sites_signal(sender, instance, action, pk_set, **kwargs):
+    m2m_sites_changed_projects_sync_signal_handler(instance, action, pk_set, 'tasks')
+
+
+@receiver(m2m_changed, sender=Task.groups.through)
+def m2m_changed_task_groups_signal(sender, instance, action, pk_set, **kwargs):
+    m2m_groups_changed_projects_sync_signal_handler(instance, action, pk_set, 'tasks')

rdmo/projects/handlers/m2m_changed_views.py

@@ -0,0 +1,25 @@
+from django.db.models.signals import m2m_changed
+from django.dispatch import receiver
+
+from rdmo.views.models import View
+
+from .generic_handlers import (
+    m2m_catalogs_changed_projects_sync_signal_handler,
+    m2m_groups_changed_projects_sync_signal_handler,
+    m2m_sites_changed_projects_sync_signal_handler,
+)
+
+
+@receiver(m2m_changed, sender=View.catalogs.through)
+def m2m_changed_view_catalog_signal(sender, instance, action, pk_set, **kwargs):
+    m2m_catalogs_changed_projects_sync_signal_handler(instance, action, pk_set, 'views')
+
+
+@receiver(m2m_changed, sender=View.sites.through)
+def m2m_changed_view_sites_signal(sender, instance, action, pk_set, **kwargs):
+    m2m_sites_changed_projects_sync_signal_handler(instance, action, pk_set, 'views')
+
+
+@receiver(m2m_changed, sender=View.groups.through)
+def m2m_changed_view_groups_signal(sender, instance, action, pk_set, **kwargs):
+    m2m_groups_changed_projects_sync_signal_handler(instance, action, pk_set, 'views')

rdmo/projects/handlers/project_save_tasks.py

@@ -0,0 +1,31 @@
+from django.db.models.signals import post_save, pre_save
+from django.dispatch import receiver
+
+from rdmo.projects.models import Project
+from rdmo.tasks.models import Task
+
+
+@receiver(pre_save, sender=Project)
+def pre_save_project_sync_tasks_from_catalog(sender, instance, raw, update_fields, **kwargs):
+    instance._catalog_has_changed_sync_tasks = False
+
+    if raw or (update_fields and 'catalog' not in update_fields):
+        return
+
+    if instance.id is not None:
+        # Fetch the original catalog from the database
+        if sender.objects.get(id=instance.id).catalog == instance.catalog:
+            # Do nothing if the catalog has not changed
+            return
+
+    # Defer synchronization of views
+    instance._catalog_has_changed_sync_tasks = True
+
+
+@receiver(post_save, sender=Project)
+def post_save_project_sync_tasks_from_catalog(sender, instance, created, raw, update_fields, **kwargs):
+    if raw or (update_fields and 'catalog' not in update_fields):
+        return
+
+    if instance._catalog_has_changed_sync_tasks or (created and not instance.tasks.exists) :
+        instance.tasks.set(Task.objects.filter_available_tasks_for_project(instance).values_list('id', flat=True))

rdmo/projects/handlers/project_save_views.py

@@ -0,0 +1,31 @@
+from django.db.models.signals import post_save, pre_save
+from django.dispatch import receiver
+
+from rdmo.projects.models import Project
+from rdmo.views.models import View
+
+
+@receiver(pre_save, sender=Project)
+def pre_save_project_sync_views_from_catalog(sender, instance, raw, update_fields, **kwargs):
+    instance._catalog_has_changed_sync_views = False
+
+    if raw or (update_fields and 'catalog' not in update_fields):
+        return
+
+    if instance.id is not None:
+        # Fetch the original catalog from the database
+        if sender.objects.get(id=instance.id).catalog == instance.catalog:
+            # Do nothing if the catalog has not changed
+            return
+
+    # Defer synchronization of views
+    instance._catalog_has_changed_sync_views = True
+
+
+@receiver(post_save, sender=Project)
+def post_save_project_sync_views_from_catalog(sender, instance, created, raw, update_fields, **kwargs):
+    if raw or (update_fields and 'catalog' not in update_fields):
+        return
+
+    if instance._catalog_has_changed_sync_views or (created and not instance.views.exists):
+        instance.views.set(View.objects.filter_available_views_for_project(instance).values_list('id', flat=True))

rdmo/projects/managers.py

@@ -35,6 +35,16 @@ def filter_visibility(self, user):
         visibility_filter = Q(visibility__isnull=False) & sites_filter & groups_filter
         return self.filter(Q(user=user) | visibility_filter)
 
+    def filter_catalogs(self, catalogs=None, exclude_catalogs=None, exclude_null=True):
+        catalogs_filter = Q()
+        if exclude_null:
+          catalogs_filter &= Q(catalog__isnull=False)
+        if catalogs:
+            catalogs_filter &= Q(catalog__in=catalogs)
+        if exclude_catalogs:
+            catalogs_filter &= ~Q(catalog__in=exclude_catalogs)
+        return self.filter(catalogs_filter)
+
 
 class MembershipQuerySet(models.QuerySet):
 
@@ -193,6 +203,10 @@ def filter_user(self, user):
     def filter_visibility(self, user):
         return self.get_queryset().filter_visibility(user)
 
+    def filter_catalogs(self, catalogs=None, exclude_catalogs=None, exclude_null=True):
+        return self.get_queryset().filter_catalogs(catalogs=catalogs, exclude_catalogs=exclude_catalogs,
+                                                   exclude_null=exclude_null)
+
 
 class MembershipManager(CurrentSiteManagerMixin, models.Manager):
 

rdmo/projects/models/project.py

@@ -123,6 +123,14 @@ def authors(self):
     def guests(self):
         return self.get_members('guest')
 
+    @cached_property
+    def groups_str(self):
+        return ', '.join(str(i) for i in self.groups if i is not None)
+
+    @property
+    def groups(self):
+        return {group for user in self.get_members('owner') for group in user.groups.all()}
+
     @property
     def file_size(self):
         queryset = self.values.filter(snapshot=None).exclude(models.Q(file='') | models.Q(file=None))