simo 1.7.20__py3-none-any.whl → 2.0.0__py3-none-any.whl

simo/core/middleware.py

@@ -14,6 +14,26 @@ def get_current_request():
         pass
 
 
+def introduce_instance(instance, request=None):
+    _thread_locals.instance = instance
+    if request:
+        request.session['instance_id'] = instance.id
+
+
+def get_current_instance(request=None):
+    instance = getattr(_thread_locals, 'instance', None)
+    if not instance and request and request.session.get('instance_id'):
+        from simo.core.models import Instance
+        instance = Instance.objects.filter(
+            id=request.session['instance_id']
+        ).first()
+        if not instance:
+            del request.session['instance_id']
+        else:
+            introduce_instance(instance, request)
+    return instance
+
+
 def simo_router_middleware(get_response):
 
     def middleware(request):
@@ -34,11 +54,15 @@ def instance_middleware(get_response):
         from simo.core.models import Instance
 
         instance = None
+        # API calls
         if request.resolver_match:
             instance = Instance.objects.filter(
                 slug=request.resolver_match.kwargs.get('instance_slug')
             ).first()
 
+        if not instance:
+            instance = get_current_instance(request)
+
         if not instance:
             if request.user.is_authenticated:
                 if len(request.user.instances) == 1:
@@ -46,6 +70,7 @@ def instance_middleware(get_response):
                         instance = inst
 
         if instance:
+            introduce_instance(instance, request)
             tz = pytz.timezone(instance.timezone)
             timezone.activate(tz)
 

simo/core/migrations/0026_category_instance.py

@@ -0,0 +1,20 @@
+# Generated by Django 3.2.9 on 2024-01-24 11:39
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0025_auto_20240122_1321'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='category',
+            name='instance',
+            field=models.ForeignKey(default=1, on_delete=django.db.models.deletion.CASCADE, to='core.instance'),
+            preserve_default=False,
+        ),
+    ]

simo/core/migrations/0027_remove_component_tags.py

@@ -0,0 +1,17 @@
+# Generated by Django 3.2.9 on 2024-01-25 12:04
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0026_category_instance'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='component',
+            name='tags',
+        ),
+    ]

simo/core/migrations/0028_rename_subcomponents_component_slaves.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.9 on 2024-02-07 10:14
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0027_remove_component_tags'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='component',
+            old_name='subcomponents',
+            new_name='slaves',
+        ),
+    ]

simo/core/migrations/0029_auto_20240229_1331.py

@@ -0,0 +1,33 @@
+# Generated by Django 3.2.9 on 2024-02-29 13:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0028_rename_subcomponents_component_slaves'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='gateway',
+            name='discovery',
+            field=models.JSONField(blank=True, editable=False, null=True),
+        ),
+        migrations.AlterField(
+            model_name='component',
+            name='instance_methods',
+            field=models.TextField(blank=True, default='\n\ndef is_in_alarm(self):\n    return bool(self.value)\n\n', help_text='Add your own component methods or override existing ones'),
+        ),
+        migrations.AlterField(
+            model_name='component',
+            name='slaves',
+            field=models.ManyToManyField(blank=True, null=True, related_name='masters', to='core.Component'),
+        ),
+        migrations.AlterField(
+            model_name='gateway',
+            name='type',
+            field=models.CharField(choices=[], db_index=True, max_length=200, unique=True),
+        ),
+    ]

simo/core/models.py

@@ -1,9 +1,11 @@
 import os
 import sys
 import inspect
-
+import time
+from collections.abc import Iterable
 from django.utils.text import slugify
 from django.core.cache import cache
+from django.utils.functional import cached_property
 from django.urls import reverse_lazy
 from django.utils.translation import gettext_lazy as _
 from django.db import models
@@ -21,6 +23,7 @@ from taggit.managers import TaggableManager
 from simo.core.utils.mixins import SimoAdminMixin
 from simo.core.storage import OverwriteStorage
 from simo.core.utils.validators import validate_svg
+from .managers import ZonesManager, CategoriesManager, ComponentsManager
 from .events import GatewayObjectCommand, OnChangeMixin
 
 
@@ -112,6 +115,7 @@ class Instance(DirtyFieldsMixin, models.Model, SimoAdminMixin):
         User, null=True, blank=True, on_delete=models.SET_NULL
     )
 
+
     def __str__(self):
         return self.name
 
@@ -130,6 +134,7 @@ class Zone(DirtyFieldsMixin, models.Model, SimoAdminMixin):
     order = models.PositiveIntegerField(
         default=0, blank=False, null=False, db_index=True
     )
+    objects = ZonesManager()
 
     # TODO: Admin ordering not working via remote!
 
@@ -143,6 +148,7 @@ class Zone(DirtyFieldsMixin, models.Model, SimoAdminMixin):
 
 
 class Category(DirtyFieldsMixin, models.Model, SimoAdminMixin):
+    instance = models.ForeignKey(Instance, on_delete=models.CASCADE)
     name = models.CharField(_('name'), max_length=40)
     icon = models.ForeignKey(Icon, on_delete=models.SET_NULL, null=True)
     header_image = ThumbnailerImageField(
@@ -159,14 +165,13 @@ class Category(DirtyFieldsMixin, models.Model, SimoAdminMixin):
     order = models.PositiveIntegerField(
         default=0, blank=False, null=False, db_index=True
     )
-
+    objects = CategoriesManager()
 
     class Meta:
         verbose_name = _("category")
         verbose_name_plural = _("categories")
         ordering = ('order', 'id')
 
-
     def __str__(self):
         return self.name
 
@@ -175,7 +180,9 @@ class Category(DirtyFieldsMixin, models.Model, SimoAdminMixin):
         dirty_fields = self.get_dirty_fields()
         if 'all' in dirty_fields:
             if self.all:
-                Category.objects.all().update(all=False)
+                Category.objects.filter(
+                    instance=self.instance
+                ).update(all=False)
         if 'header_image' in dirty_fields:
             self.header_image_last_change = timezone.now()
         return super().save(*args, **kwargs)
@@ -197,6 +204,11 @@ class Gateway(DirtyFieldsMixin, models.Model, SimoAdminMixin):
             (key, val) for key, val in RUN_STATUS_CHOICES_MAP.items()
         ),
     )
+    discovery = models.JSONField(
+        null=True, blank=True, editable=False
+    )
+
+
     handler = None
 
     def __str__(self):
@@ -243,6 +255,52 @@ class Gateway(DirtyFieldsMixin, models.Model, SimoAdminMixin):
                 urlconf=settings.CHANNELS_URLCONF
             )
 
+    def start_discovery(self, controller_uid, init_data, timeout=None):
+        self.discovery = {
+            'start': time.time(),
+            'timeout': timeout if timeout else 60,
+            'controller_uid': controller_uid,
+            'init_data': init_data,
+            'result': []
+        }
+        self.save()
+
+    def retry_discovery(self):
+        self.discovery['start'] = time.time()
+        self.discovery.pop('finished', None)
+        self.save()
+
+    def process_discovery(self, data):
+        self.refresh_from_db()
+        from .utils.type_constants import get_controller_types_map
+        ControllerClass = get_controller_types_map().get(
+            self.discovery['controller_uid']
+        )
+        if ControllerClass and hasattr(
+            ControllerClass, '_process_discovery'
+        ):
+            result = ControllerClass._process_discovery(
+                started_with=self.discovery['init_data'], data=data
+            )
+            if result:
+                if not isinstance(result, dict) and isinstance(result, Iterable):
+                    for res in result:
+                        if isinstance(res, models.Model):
+                            self.discovery['result'].append(res.pk)
+                        else:
+                            self.discovery['result'].append(res)
+                else:
+                    if isinstance(result, models.Model):
+                        self.discovery['result'].append(result.pk)
+                    else:
+                        self.discovery['result'].append(result)
+
+        self.save(update_fields=['discovery'])
+
+    def finish_discovery(self):
+        self.discovery['finished'] = time.time()
+        self.save(update_fields=['discovery'])
+
 
 class Component(DirtyFieldsMixin, models.Model, SimoAdminMixin, OnChangeMixin):
     name = models.CharField(
@@ -258,19 +316,12 @@ class Component(DirtyFieldsMixin, models.Model, SimoAdminMixin, OnChangeMixin):
         Category, related_name='components', on_delete=models.CASCADE,
         null=True, blank=True
     )
-    tags = TaggableManager(blank=True)
-    # TODO: Remove gateway instance from component.
-    # There can't be two instances of same type gateway, therefore its
-    # instance is only required to deliver configuration and
-    # background service responsible for components management.
-    # Convert this to CharField for components filtering.
     gateway = models.ForeignKey(
         Gateway, on_delete=models.CASCADE, related_name='components'
     )
     base_type = models.CharField(
         _("base type"), max_length=200, db_index=True#, choices=BASE_TYPE_CHOICES
     )
-    # Rename to controller_uid
     controller_uid = models.CharField(
         _("type"), max_length=200, choices=(), db_index=True,
     )
@@ -282,9 +333,8 @@ class Component(DirtyFieldsMixin, models.Model, SimoAdminMixin, OnChangeMixin):
     value_previous = models.JSONField(null=True, blank=True, editable=False)
     value_units = models.CharField(max_length=100, null=True, blank=True)
 
-    subcomponents = models.ManyToManyField(
-        'Component', null=True, blank=True, editable=False,
-        related_name='masters'
+    slaves = models.ManyToManyField(
+        'Component', null=True, blank=True, related_name='masters'
     )
 
     change_init_by = models.ForeignKey(
@@ -318,15 +368,6 @@ class Component(DirtyFieldsMixin, models.Model, SimoAdminMixin, OnChangeMixin):
 def is_in_alarm(self):
     return bool(self.value)
 
-def translate_before_send(self, value):
-    '''Perform value translation just before sending it to device.'''
-    return value
-
-def translate_before_set(self, value):
-    '''Perform value translation just before value is set to component.
-    Must return a valid value for this component type.'''
-    return value
-
 """)
 
     alarm_category = models.CharField(
@@ -343,12 +384,13 @@ def translate_before_set(self, value):
         )
     )
 
+    objects = ComponentsManager()
+
     tracker = FieldTracker(fields=('value', 'arm_status'))
     # change this to False before saving to not record changes to history
     track_history = True
 
     controller_cls = None
-    controller = None
 
     _mqtt_client = None
     _on_change_function = None
@@ -359,41 +401,8 @@ def translate_before_set(self, value):
         verbose_name_plural = _("Components")
         ordering = 'zone', 'base_type', 'name'
 
-
     def __init__(self, *args, **kwargs):
-        from .utils.type_constants import (
-            get_controller_types_map,
-            get_controller_types_choices
-        )
-        self._meta.get_field('controller_uid').choices = \
-            get_controller_types_choices()
         super().__init__(*args, **kwargs)
-        if self.controller_uid and not self.controller:
-            if self.id and not 'test' in sys.argv:
-                try:
-                    self.controller_cls = cache.get('c_%d_contr_cls' % self.id)
-                except:
-                    pass
-            if not self.controller_cls:
-                self.controller_cls = get_controller_types_map(
-                    self.gateway
-                ).get(self.controller_uid)
-                if self.controller_cls and self.id and not 'test' in sys.argv:
-                    cache.set(
-                        'c_%d_contr_cls' % self.id,
-                        self.controller_cls, None
-                    )
-
-            if self.controller_cls:
-                self.controller = self.controller_cls(self)
-                controller_methods = [m for m in inspect.getmembers(
-                    self.controller, predicate=inspect.ismethod
-                ) if not m[0].startswith('_')]
-                for method in controller_methods:
-                    setattr(self, method[0], method[1])
-                if not self.id:
-                    self.value = self.controller.default_value
-
         # Goes in zero seconds!
         if self.instance_methods:
             custom_methods = {}
@@ -412,6 +421,43 @@ def translate_before_set(self, value):
             return '%s | %s' % (self.zone.name, self.name)
         return self.name
 
+    @cached_property
+    def controller(self):
+        from .utils.type_constants import (
+            get_controller_types_map,
+            get_controller_types_choices
+        )
+        self._meta.get_field('controller_uid').choices = \
+            get_controller_types_choices()
+        if self.controller_uid:
+            controller_cls = None
+            if self.id and not 'test' in sys.argv:
+                try:
+                    controller_cls = cache.get('c_%d_contr_cls' % self.id)
+                except:
+                    pass
+            if not controller_cls:
+                controller_cls = get_controller_types_map(
+                    self.gateway
+                ).get(self.controller_uid)
+                if controller_cls and self.id and not 'test' in sys.argv:
+                    cache.set(
+                        'c_%d_contr_cls' % self.id,
+                        controller_cls, None
+                    )
+            if controller_cls:
+                return controller_cls(self)
+
+    def prepare_controller(self):
+        if not self.controller:
+            return
+        controller_methods = [m for m in inspect.getmembers(
+            self.controller, predicate=inspect.ismethod
+        ) if not m[0].startswith('_')]
+        for method in controller_methods:
+            setattr(self, method[0], method[1])
+        if not self.id:
+            self.value = self.controller.default_value
 
     def get_socket_url(self):
         return reverse_lazy(
@@ -472,15 +518,6 @@ def translate_before_set(self, value):
     def is_in_alarm(self):
         return bool(self.value)
 
-    def translate_before_send(self, value):
-        '''Perform value translation just before sending it to device.'''
-        return value
-
-    def translate_before_set(self, value):
-        '''Perform value translation just before value is set to component.
-        Must return a valid value for this component type.'''
-        return value
-
     def can_read(self, user):
         if user.is_superuser:
             return True

simo/core/permissions.py

@@ -1,5 +1,5 @@
-from rest_framework.permissions import BasePermission
-from .models import Instance
+from rest_framework.permissions import BasePermission, SAFE_METHODS
+from .models import Instance, Category, Zone
 
 
 class InstancePermission(BasePermission):
@@ -21,3 +21,29 @@ class InstancePermission(BasePermission):
             return False
 
         return True
+
+
+class IsInstanceSuperuser(BasePermission):
+
+    def has_permission(self, request, view):
+        if request.user.is_master:
+            return True
+        user_role = request.user.get_role(view.instance)
+        return user_role.is_superuser
+
+
+class InstanceSuperuserCanEdit(BasePermission):
+
+    def has_object_permission(self, request, view, obj):
+
+        # allow deleting only empty categories and zones
+        if type(obj) in (Zone, Category) and request.method == 'DELETE'\
+        and obj.components.all().count():
+            return False
+
+        if request.user.is_master:
+            return True
+        user_role = request.user.get_role(view.instance)
+        if user_role.is_superuser:
+            return True
+        return request.method in SAFE_METHODS