simo 2.0.24__py3-none-any.whl → 2.0.26__py3-none-any.whl

simo/core/admin.py

@@ -60,6 +60,7 @@ class IconAdmin(admin.ModelAdmin):
 @admin.register(Instance)
 class InstanceAdmin(admin.ModelAdmin):
     list_display = 'name', 'timezone', 'uid'
+    exclude = 'learn_fingerprints_start', 'learn_fingerprints'
 
 
     def has_module_permission(self, request):

simo/core/api.py

@@ -2,11 +2,13 @@ import datetime
 from calendar import monthrange
 import pytz
 import time
-from django.db.models import Q, Prefetch
+import json
+from django.db.models import Q
 from django.utils.translation import gettext_lazy as _
 from django.utils import timezone
 from django.http import HttpResponse, Http404
 from simo.core.utils.helpers import get_self_ip, search_queryset
+from rest_framework import status
 from rest_framework.pagination import PageNumberPagination
 from rest_framework import viewsets
 from django_filters.rest_framework import DjangoFilterBackend
@@ -14,6 +16,7 @@ from rest_framework.decorators import action
 from rest_framework.response import Response as RESTResponse
 from rest_framework.exceptions import ValidationError as APIValidationError
 from simo.core.utils.config_values import ConfigException
+from simo.core.utils.json import restore_json
 from .models import (
     Instance, Category, Zone, Component, Icon, ComponentHistory,
     HistoryAggregate, Gateway
@@ -35,11 +38,7 @@ class InstanceMixin:
                 slug=self.request.resolver_match.kwargs.get('instance_slug')
             )
         except Instance.DoesNotExist:
-            return HttpResponse(
-                f"Instance {self.request.resolver_match.kwargs.get('instance_slug')} "
-                "is not found on this SIMO.io hub!",
-                status=400
-            )
+            raise Http404()
         return super().dispatch(request, *args, **kwargs)
 
     def get_serializer_context(self):
@@ -159,7 +158,9 @@ def get_components_queryset(instance, user):
     return qs
 
 
-class ComponentViewSet(InstanceMixin, viewsets.ModelViewSet):
+class ComponentViewSet(
+    InstanceMixin, viewsets.ModelViewSet
+):
     url = 'core/components'
     basename = 'components'
     serializer_class = ComponentSerializer
@@ -185,11 +186,14 @@ class ComponentViewSet(InstanceMixin, viewsets.ModelViewSet):
 
     def perform_controller_method(self, json_data, component):
         for method_name, param in json_data.items():
+            if method_name in ('id', 'secret'):
+                continue
             if not hasattr(component, method_name):
                 raise APIValidationError(
                      _('"%s" method not found on controller') % method_name,
                     code=400
                 )
+            print("VARYSIM: ", method_name, param, type(param))
             call = getattr(component, method_name)
 
             if not isinstance(param, list) and not isinstance(param, dict):
@@ -210,10 +214,13 @@ class ComponentViewSet(InstanceMixin, viewsets.ModelViewSet):
             return RESTResponse(result)
 
     # TODO: remove post when app is updated for all users
-    @action(detail=True, methods=['post', 'put'])
+    @action(detail=True, methods=['post'])
     def subcomponent(self, request, pk=None, *args, **kwargs):
         component = self.get_object()
-        json_data = request.data
+        data = request.data
+        if not isinstance(request.data, dict):
+            data = data.dict()
+        json_data = restore_json(data)
         subcomponent_id = json_data.pop('id', -1)
         try:
             subcomponent = component.slaves.get(pk=subcomponent_id)
@@ -230,18 +237,28 @@ class ComponentViewSet(InstanceMixin, viewsets.ModelViewSet):
         self.check_object_permissions(self.request, subcomponent)
         return self.perform_controller_method(json_data, subcomponent)
 
-    @action(detail=True, methods=['post', 'put'])
+    @action(detail=True, methods=['post'])
     def controller(self, request, pk=None, *args, **kwargs):
         component = self.get_object()
-        return self.perform_controller_method(request.data, component)
+        data = request.data
+        if not isinstance(request.data, dict):
+            data = data.dict()
+        request_data = restore_json(data)
+        return self.perform_controller_method(
+            restore_json(request_data), component
+        )
 
-    @action(detail=False, methods=['post', 'put'])
+    @action(detail=False, methods=['post'])
     def control(self, request, *args, **kwargs):
-        component = self.get_queryset().filter(id=request.data.pop('id', 0))
+        data = request.data
+        if not isinstance(request.data, dict):
+            data = data.dict()
+        request_data = restore_json(data)
+        component = self.get_queryset().filter(id=request_data.pop('id', 0)).first()
         if not component:
             raise Http404()
         self.check_object_permissions(self.request, component)
-        return self.perform_controller_method(request.data, component)
+        return self.perform_controller_method(request_data, component)
 
     @action(detail=True, methods=['get'])
     def value_history(self, request, pk=None, *args, **kwargs):
@@ -255,6 +272,8 @@ class ComponentViewSet(InstanceMixin, viewsets.ModelViewSet):
         return RESTResponse(resp_data)
 
 
+
+
 class HistoryResultsSetPagination(PageNumberPagination):
     page_size = 50
     page_size_query_param = 'page_size'
@@ -532,9 +551,7 @@ class StatesViewSet(InstanceMixin, viewsets.GenericViewSet):
         ).exclude(email__in=('system@simo.io', 'device@simo.io'))
         component_values = get_components_queryset(
             self.instance, request.user
-        ).filter(zone__instance=self.instance).prefetch_related(
-            Prefetch('history', queryset=ComponentHistory.objects.filter())
-        ).values(
+        ).filter(zone__instance=self.instance).values(
             'id', 'value', 'last_change', 'arm_status', 'battery_level',
             'alive', 'meta'
         )
@@ -623,6 +640,4 @@ class RunningDiscoveries(InstanceMixin, viewsets.GenericViewSet):
         if 'controller_uid' in request.GET:
             for gateway in gateways:
                 gateway.retry_discovery()
-        return RESTResponse(self.get_data(gateways))
-
-
+        return RESTResponse(self.get_data(gateways))

simo/core/controllers.py

@@ -187,6 +187,8 @@ class ControllerBase(ABC):
             bulk_send_map = {self.component: value}
             for slave in self.component.slaves.all():
                 bulk_send_map[slave] = value
+
+            print("BULK SEND MAP: ", bulk_send_map)
             from .models import Component
             Component.objects.bulk_send(bulk_send_map)
             return
@@ -652,7 +654,9 @@ class MultiSwitchBase(ControllerBase):
         if not(0 < number_of_values < 16):
             raise ValidationError("Wrong number of values")
         if number_of_values == 1:
-            if not isinstance(value, bool):
+            if isinstance(value, int):
+                value = bool(value)
+            elif not isinstance(value, bool):
                 raise ValidationError("Must be a boolean value")
         else:
             if not isinstance(value, list):

simo/core/forms.py

@@ -195,6 +195,9 @@ class ConfigFieldsMixin:
 
     def save(self, commit=True):
         for field_name in self.config_fields:
+            # support for partial forms
+            if field_name not in self.cleaned_data:
+                continue
             if isinstance(self.cleaned_data[field_name], models.Model):
                 self.instance.config[field_name] = \
                     self.cleaned_data[field_name].pk
@@ -282,6 +285,10 @@ class ComponentAdminForm(forms.ModelForm):
     has_icon = True
     has_alarm = True
 
+    # fields that can be edited via SIMO.io app by instance owners.
+    # Users who have is_owner enabled on their user role.
+    basic_fields = ['name', 'icon', 'zone', 'category']
+
     class Meta:
         model = Component
         fields = '__all__'
@@ -324,6 +331,27 @@ class ComponentAdminForm(forms.ModelForm):
                 self.instance.config = self.controller.default_config
                 self.instance.meta = self.controller.default_meta
 
+        self.cleanup_missing_keys(kwargs.get("data"))
+
+    def cleanup_missing_keys(self, data):
+        """
+        Removes missing keys from fields on form submission.
+        This avoids resetting fields that are not present in
+        the submitted data, which may be the sign of a buggy
+        or incomplete template.
+        Note that this cleanup relies on the HTML form being
+        patched to send all keys, even for checkboxes, via
+        input[type="hidden"] fields or some JS magic.
+        """
+        if data is None:
+            # not a form submission, don't modify self.fields
+            return
+
+        got_keys = data.keys()
+        field_names = self.fields.keys()
+        for missing in set(field_names) - set(got_keys):
+            del self.fields[missing]
+
     @classmethod
     def get_admin_fieldsets(cls, request, obj=None):
         main_fields = (
@@ -518,7 +546,7 @@ class SwitchForm(BaseComponentForm):
 
     def save(self, commit=True):
         obj = super().save(commit=commit)
-        if commit:
+        if commit and 'slaves' in self.cleaned_data:
             obj.slaves.set(self.cleaned_data['slaves'])
         return obj
 

simo/core/middleware.py

@@ -1,5 +1,6 @@
 import pytz
 import threading
+import time
 from django.urls import set_script_prefix
 from django.utils import timezone
 from simo.conf import dynamic_settings

simo/core/migrations/0032_auto_20240506_0834.py

@@ -0,0 +1,24 @@
+# Generated by Django 3.2.9 on 2024-05-06 08:34
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0031_auto_20240429_1231'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='category',
+            name='order',
+            field=models.PositiveIntegerField(db_index=True),
+        ),
+        migrations.AlterField(
+            model_name='instance',
+            name='indoor_climate_sensor',
+            field=models.ForeignKey(blank=True, limit_choices_to={'base_type__in': ['numeric-sensor', 'multi-sensor']}, null=True, on_delete=django.db.models.deletion.SET_NULL, to='core.component'),
+        ),
+    ]

simo/core/models.py

@@ -80,7 +80,7 @@ class Instance(DirtyFieldsMixin, models.Model, SimoAdminMixin):
     name = models.CharField(max_length=100, db_index=True, unique=True)
     slug = models.CharField(max_length=100, db_index=True, unique=True)
     cover_image = models.ImageField(
-        upload_to='hub_covers', null=True, blank=True
+        name='cover_image', upload_to='hub_covers', null=True, blank=True
     )
     cover_image_synced = models.BooleanField(default=False)
     secret_key = models.CharField(max_length=100, blank=True)
@@ -100,7 +100,8 @@ class Instance(DirtyFieldsMixin, models.Model, SimoAdminMixin):
 
     )
     indoor_climate_sensor = models.ForeignKey(
-        'Component', null=True, blank=True, on_delete=models.SET_NULL
+        'Component', null=True, blank=True, on_delete=models.SET_NULL,
+        limit_choices_to={'base_type__in': ['numeric-sensor', 'multi-sensor']}
     )
     history_days = models.PositiveIntegerField(
         default=90, help_text="How many days of component history do we keep?"
@@ -128,6 +129,7 @@ class Instance(DirtyFieldsMixin, models.Model, SimoAdminMixin):
     def components(self):
         return Component.objects.filter(zone__instance=self)
 
+
 class Zone(DirtyFieldsMixin, models.Model, SimoAdminMixin):
     instance = models.ForeignKey(Instance, on_delete=models.CASCADE)
     name = models.CharField(_('name'), max_length=40)

simo/core/permissions.py

@@ -1,4 +1,5 @@
 from rest_framework.permissions import BasePermission, SAFE_METHODS, IsAuthenticated
+from django.http import Http404
 from .models import Instance, Category, Zone
 
 
@@ -13,7 +14,7 @@ class InstancePermission(BasePermission):
             slug=request.resolver_match.kwargs.get('instance_slug')
         ).first()
         if not instance:
-            return False
+            raise Http404()
 
         if instance not in request.user.instances:
             return False
@@ -37,12 +38,14 @@ class InstanceSuperuserCanEdit(BasePermission):
     def has_object_permission(self, request, view, obj):
         '''
         in this permission we only care about:
-        POST - create new object
+        POST - new object can be created
+        PUT - create new object
         PATCH - modify an object
         DELETE - delete an oject
         '''
+        # TODO: allow object creation only with PUT method, this way proper permissions system will be guaranteed.
 
-        if request.method in SAFE_METHODS + ('PUT', 'POST', ): # TODO: remove POST
+        if request.method in SAFE_METHODS + ('POST',):
             return True
 
         # allow deleting only empty categories and zones
@@ -56,6 +59,9 @@ class InstanceSuperuserCanEdit(BasePermission):
         if user_role.is_superuser:
             return True
 
+        if user_role.is_owner and request.method == 'PUT':
+            return True
+
         return False
 
 

simo/core/serializers.py

@@ -261,6 +261,12 @@ class ComponentSerializer(FormSerializer):
         self.set_form_cls()
 
         ret = OrderedDict()
+        if not self.context['request'].user.is_master:
+            user_role = self.context['request'].user.get_role(
+                self.context['instance']
+            )
+            if not any([user_role.is_superuser, user_role.is_owner]):
+                return ret
 
         field_mapping = reduce_attr_dict_from_instance(
             self,
@@ -269,9 +275,10 @@ class ComponentSerializer(FormSerializer):
         )
 
         if not self.instance or isinstance(self.instance, Iterable):
-            form = self.Meta.form()
+            form = self.get_form()
         else:
-            form = self.Meta.form(instance=self.instance)
+            form = self.get_form(instance=self.instance)
+
         for field_name in form.fields:
             # if field is specified as excluded field
             if field_name in getattr(self.Meta, 'exclude', []):
@@ -355,7 +362,7 @@ class ComponentSerializer(FormSerializer):
 
     def get_form(self, data=None, **kwargs):
         self.set_form_cls()
-        if not self.instance:
+        if not self.instance or isinstance(self.instance, Iterable):
             #controller_uid = 'simo.generic.controllers.AlarmClock'
             controller_uid = self.context['request'].META.get('HTTP_CONTROLLER')
         else:
@@ -365,6 +372,14 @@ class ComponentSerializer(FormSerializer):
             controller_uid=controller_uid,
             **kwargs
         )
+        if not self.context['request'].user.is_master:
+            user_role = self.context['request'].user.get_role(
+                self.context['instance']
+            )
+            if not user_role.is_superuser and user_role.is_owner:
+                for field_name in list(form.fields.keys()):
+                    if field_name not in form.basic_fields:
+                        del form.fields[field_name]
         return form
 
     def accomodate_formsets(self, form, data):
@@ -395,6 +410,7 @@ class ComponentSerializer(FormSerializer):
                 )
         form = self.get_form(instance=self.instance)
         a_data = self.accomodate_formsets(form, data)
+
         form = self.get_form(
             data=a_data, instance=self.instance
         )
@@ -410,6 +426,7 @@ class ComponentSerializer(FormSerializer):
         a_data = self.accomodate_formsets(form, validated_data)
         form = self.get_form(instance=instance, data=a_data)
         if form.is_valid():
+            print("FORM FIELDS", form.fields)
             instance = form.save(commit=True)
             return instance
         raise serializers.ValidationError(form.errors)

simo/core/utils/json.py

@@ -0,0 +1,20 @@
+
+def restore_json(data):
+    for key, val in data.items():
+        if not isinstance(val, str):
+            continue
+        try:
+            data[key] = int(val)
+            continue
+        except:
+            pass
+        try:
+            data[key] = float(val)
+            continue
+        except:
+            pass
+        if val.lower() == 'true':
+            data[key] = True
+        elif val.lower() == 'false':
+            data[key] = False
+    return data