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

simo/core/admin.py

@@ -1,5 +1,6 @@
 from django.utils.translation import gettext_lazy as _
 from django.contrib import admin
+from django.urls import reverse
 from easy_thumbnails.fields import ThumbnailerField
 from adminsortable2.admin import SortableAdminMixin
 from django.template.loader import render_to_string
@@ -21,6 +22,7 @@ from .forms import (
 )
 from .filters import ZonesFilter
 from .widgets import AdminImageWidget
+from .middleware import get_current_instance
 from simo.conf import dynamic_settings
 
 csrf_protect_m = method_decorator(csrf_protect)
@@ -79,12 +81,6 @@ class ZoneAdmin(SortableAdminMixin, admin.ModelAdmin):
     search_fields = 'name',
     list_filter = 'instance',
 
-    def get_queryset(self, request):
-        qs = super().get_queryset(request)
-        if request.user.is_master:
-            return qs
-        return qs.filter(instance__in=request.user.instances)
-
     def get_fields(self, request, obj=None):
         if request.user.is_master:
             return super().get_fields(request, obj)
@@ -271,7 +267,7 @@ class ComponentAdmin(admin.ModelAdmin):
         'control', 'value', 'arm_status', 'history', 'meta'
     )
     list_filter = (
-        'gateway', 'base_type', 'tags', ('zone', ZonesFilter), 'category', 'alive',
+        'gateway', 'base_type', ('zone', ZonesFilter), 'category', 'alive',
         'alarm_category', 'arm_status'
     )
 
@@ -280,12 +276,6 @@ class ComponentAdmin(admin.ModelAdmin):
     change_list_template = 'admin/component_change_list.html'
     inlines = ComponentPermissionInline,
 
-    def get_queryset(self, request):
-        qs = super().get_queryset(request)
-        if request.user.is_master:
-            return qs
-        return qs.filter(zone__instance__in=request.user.instances)
-
     def get_fieldsets(self, request, obj=None):
         form = self._get_form_for_get_fields(request, obj)
         fieldsets = form.get_admin_fieldsets(request, obj)
@@ -338,7 +328,6 @@ class ComponentAdmin(admin.ModelAdmin):
                     )[request.session['add_comp_type']]
                 except:
                     request.session.pop('add_comp_type')
-                    print("No such controller type!")
                     return redirect(request.path)
 
                 add_form = controller_cls.add_form
@@ -350,6 +339,8 @@ class ComponentAdmin(admin.ModelAdmin):
                     ):
                         if field_neme in form.fields:
                             form.fields.pop(field_neme)
+                    if 'slaves' not in form.declared_fields:
+                        form.fields.pop('slaves')
 
                 ctx['is_last'] = True
                 ctx['current_step'] = 3
@@ -359,13 +350,33 @@ class ComponentAdmin(admin.ModelAdmin):
                 if request.method == 'POST':
                     ctx['form'] = add_form(
                         request=request,
-                        gateway=gateway,
-                        controller_cls=controller_cls,
+                        controller_uid=controller_cls.uid,
                         data=request.POST, files=request.FILES,
                         initial=request.session.get('c_add_init'),
                     )
                     pop_fields_from_form(ctx['form'])
                     if ctx['form'].is_valid():
+                        if ctx['form'].controller.is_discoverable:
+                            ctx['form'].controller.init_discovery(
+                                ctx['form'].cleaned_data
+                            )
+                            ctx['discovery_msg'] = ctx['form'].controller.discovery_msg
+                            instance = ctx['form'].cleaned_data['zone'].instance
+                            ctx['api_check_url'] = reverse(
+                                'discoveries-list',
+                                kwargs={'instance_slug': instance.slug}
+                            ) + f"?controller_uid={ctx['form'].controller.uid}"
+                            ctx['api_retry_url'] = reverse(
+                                'discoveries-list',
+                                kwargs={'instance_slug': instance.slug}
+                            ) + f"retry/?controller_uid={ctx['form'].controller.uid}"
+                            ctx['api_components_url'] = reverse(
+                                'components-list',
+                                kwargs={'instance_slug': instance.slug}
+                            )
+                            return render(
+                                request, 'admin/wizard/discovery.html', ctx
+                            )
                         new_comp = ctx['form'].save()
                         request.session.pop('add_comp_gateway')
                         request.session.pop('add_comp_type')
@@ -373,8 +384,7 @@ class ComponentAdmin(admin.ModelAdmin):
                 else:
                     ctx['form'] = add_form(
                         request=request,
-                        gateway=gateway,
-                        controller_cls=controller_cls,
+                        controller_uid=controller_cls.uid,
                         initial=request.session.get('c_add_init'),
                     )
                     pop_fields_from_form(ctx['form'])

simo/core/api.py

@@ -1,38 +1,43 @@
 import datetime
 from calendar import monthrange
 import pytz
-import logging
+import time
 from django.db.models import Q, Prefetch
 from django.utils.translation import gettext_lazy as _
 from django.utils import timezone
 from django.shortcuts import get_object_or_404
-from easy_thumbnails.files import get_thumbnailer
-from simo.core.utils.helpers import get_self_ip
+from simo.core.utils.helpers import get_self_ip, search_queryset
 from rest_framework.pagination import PageNumberPagination
 from rest_framework import viewsets
 from django_filters.rest_framework import DjangoFilterBackend
 from rest_framework.decorators import action
 from rest_framework.response import Response as RESTResponse
-from django.core.exceptions import ValidationError
 from rest_framework.exceptions import ValidationError as APIValidationError
-from simo.conf import dynamic_settings
 from simo.core.utils.config_values import ConfigException
 from .models import (
     Instance, Category, Zone, Component, Icon, ComponentHistory,
-    HistoryAggregate
+    HistoryAggregate, Gateway
 )
 from .serializers import (
     IconSerializer, CategorySerializer, ZoneSerializer,
     ComponentSerializer, ComponentHistorySerializer
 )
+from .permissions import IsInstanceSuperuser, InstanceSuperuserCanEdit
 
 
 class InstanceMixin:
 
     def dispatch(self, request, *args, **kwargs):
-        self.instance = Instance.objects.get(
-            slug=self.request.resolver_match.kwargs.get('instance_slug')
-        )
+        try:
+            self.instance = Instance.objects.get(
+                slug=self.request.resolver_match.kwargs.get('instance_slug')
+            )
+        except Instance.DoesNotExist:
+            raise APIValidationError(
+                f"Instance {self.request.resolver_match.kwargs.get('instance_slug')} "
+                "is not found on this SIMO.io hub!",
+                code=400
+            )
         return super().dispatch(request, *args, **kwargs)
 
     def get_serializer_context(self):
@@ -50,18 +55,51 @@ class IconViewSet(viewsets.ReadOnlyModelViewSet):
     def get_queryset(self):
         queryset = super().get_queryset()
         if 'slugs' in self.request.GET:
-            queryset = queryset.filter(slug__in=self.request.GET['slugs'].split(','))
+            queryset = queryset.filter(
+                slug__in=self.request.GET['slugs'].split(',')
+            )
+        if 'q' in self.request.GET:
+            queryset = search_queryset(
+                queryset, self.request.GET['q'], ['slug', 'keywords']
+            )[:10]
         return queryset
 
+    def get_view_name(self):
+        singular = "Icon"
+        plural = "Icons"
+        suffix = getattr(self, 'suffix', None)
+        if suffix and suffix.lower() == 'list':
+            return plural
+        return singular
 
-class CategoryViewSet(viewsets.ReadOnlyModelViewSet):
+
+class CategoryViewSet(InstanceMixin, viewsets.ModelViewSet):
     url = 'core/categories'
     basename = 'categories'
-    queryset = Category.objects.all()
     serializer_class = CategorySerializer
 
+    def get_permissions(self):
+        permissions = super().get_permissions()
+        permissions.append(InstanceSuperuserCanEdit())
+        return permissions
+
+    def get_queryset(self):
+        return Category.objects.filter(instance=self.instance)
+
+    def get_view_name(self):
+        singular = "Category"
+        plural = "Categories"
+        suffix = getattr(self, 'suffix', None)
+        if suffix and suffix.lower() == 'list':
+            return plural
+        return singular
 
-class ZoneViewSet(InstanceMixin, viewsets.ReadOnlyModelViewSet):
+    def perform_create(self, serializer):
+        serializer.validated_data['instance'] = self.instance
+        serializer.save()
+
+
+class ZoneViewSet(InstanceMixin, viewsets.ModelViewSet):
     url = 'core/zones'
     basename = 'zones'
     serializer_class = ZoneSerializer
@@ -69,6 +107,23 @@ class ZoneViewSet(InstanceMixin, viewsets.ReadOnlyModelViewSet):
     def get_queryset(self):
         return Zone.objects.filter(instance=self.instance)
 
+    def get_permissions(self):
+        permissions = super().get_permissions()
+        permissions.append(InstanceSuperuserCanEdit())
+        return permissions
+
+    def get_view_name(self):
+        singular = "Zone"
+        plural = "Zones"
+        suffix = getattr(self, 'suffix', None)
+        if suffix and suffix.lower() == 'list':
+            return plural
+        return singular
+
+    def perform_create(self, serializer):
+        serializer.validated_data['instance'] = self.instance
+        serializer.save()
+
 
 def get_components_queryset(instance, user):
     qs = Component.objects.filter(zone__instance=instance)
@@ -102,17 +157,31 @@ def get_components_queryset(instance, user):
     return qs
 
 
-class ComponentViewSet(InstanceMixin, viewsets.ReadOnlyModelViewSet):
+class ComponentViewSet(InstanceMixin, viewsets.ModelViewSet):
     url = 'core/components'
     basename = 'components'
     serializer_class = ComponentSerializer
 
+    def get_permissions(self):
+        permissions = super().get_permissions()
+        permissions.append(InstanceSuperuserCanEdit())
+        return permissions
+
     def get_queryset(self):
         return get_components_queryset(self.instance, self.request.user).filter(
             zone__instance=self.instance
         )
 
+    def get_view_name(self):
+        singular = "Component"
+        plural = "Components"
+        suffix = getattr(self, 'suffix', None)
+        if suffix and suffix.lower() == 'list':
+            return plural
+        return singular
+
     def perform_controller_method(self, json_data, component):
+        component.prepare_controller()
         for method_name, param in json_data.items():
             if not hasattr(component, method_name):
                 raise APIValidationError(
@@ -152,7 +221,7 @@ class ComponentViewSet(InstanceMixin, viewsets.ReadOnlyModelViewSet):
         json_data = request.data
         subcomponent_id = json_data.pop('id', -1)
         try:
-            subcomponent = component.subcomponents.get(pk=subcomponent_id)
+            subcomponent = component.slaves.get(pk=subcomponent_id)
         except Component.DoesNotExist:
             raise APIValidationError(
                 _('Subcomponent with id %d does not exist!' % str(subcomponent_id)),
@@ -463,7 +532,6 @@ class InfoViewSet(InstanceMixin, viewsets.GenericViewSet):
     permission_classes = []
 
     def list(self, request, format=None, *args, **kwargs):
-        from simo.conf import dynamic_settings
         resp = RESTResponse({'uid': self.instance.uid})
         resp["Access-Control-Allow-Origin"] = "*"
         return resp
@@ -502,3 +570,76 @@ class StatesViewSet(InstanceMixin, viewsets.GenericViewSet):
                 }
             ).data
         })
+
+
+class ControllerTypes(InstanceMixin, viewsets.GenericViewSet):
+    url = 'core/controller-types'
+    basename = 'controller-types'
+    queryset = []
+
+    def get_permissions(self):
+        permissions = super().get_permissions()
+        permissions.append(IsInstanceSuperuser())
+        return permissions
+
+    def list(self, request, *args, **kwargs):
+        from .utils.type_constants import get_controller_types_map
+        data = {}
+
+        for uid, cls in get_controller_types_map().items():
+            if cls.gateway_class.name not in data:
+                data[cls.gateway_class.name] = []
+            data[cls.gateway_class.name].append({
+                'uid': uid,
+                'name': cls.name,
+                'is_discoverable': cls.is_discoverable
+            })
+
+        return RESTResponse(data)
+
+
+class RunningDiscoveries(InstanceMixin, viewsets.GenericViewSet):
+    url = 'core/discoveries'
+    basename = 'discoveries'
+    queryset = []
+
+
+    def get_permissions(self):
+        permissions = super().get_permissions()
+        permissions.append(IsInstanceSuperuser())
+        return permissions
+
+    def get_data(self, gateways):
+        data = []
+        for gateway in gateways:
+            data.append({
+                'gateway': gateway.id,
+                'start': gateway.discovery['start'],
+                'controller_uid': gateway.discovery['controller_uid'],
+                'result': gateway.discovery['result'],
+                'finished': gateway.discovery.get('finished'),
+            })
+        return data
+
+    def get_gateways(self, request):
+        gateways = Gateway.objects.filter(
+            discovery__start__gt=time.time() - 60 * 60  # no more than an hour
+        )
+        if 'controller_uid' in request.GET:
+            gateways = gateways.filter(
+                discovery__controller_uid=request.GET['controller_uid']
+            )
+        return gateways
+
+    def list(self, request, *args, **kwargs):
+        return RESTResponse(self.get_data(self.get_gateways(request)))
+
+    @action(detail=False, methods=['get'])
+    def retry(self, request, *args, **kwargs):
+        gateways = self.get_gateways(request)
+        if 'controller_uid' in request.GET:
+            for gateway in gateways:
+                gateway.retry_discovery()
+        return RESTResponse(self.get_data(gateways))
+
+

simo/core/api_meta.py

@@ -0,0 +1,87 @@
+from collections import OrderedDict
+from django.utils.encoding import force_str
+from rest_framework import serializers
+from rest_framework.metadata import SimpleMetadata
+from rest_framework.utils.field_mapping import ClassLookupDict
+from .serializers import ComponentManyToManyRelatedField
+
+
+class SIMOAPIMetadata(SimpleMetadata):
+
+    label_lookup = ClassLookupDict({
+        serializers.Field: 'field',
+        serializers.BooleanField: 'boolean',
+        serializers.CharField: 'string',
+        serializers.UUIDField: 'string',
+        serializers.URLField: 'url',
+        serializers.EmailField: 'email',
+        serializers.RegexField: 'regex',
+        serializers.SlugField: 'slug',
+        serializers.IntegerField: 'integer',
+        serializers.FloatField: 'float',
+        serializers.DecimalField: 'decimal',
+        serializers.DateField: 'date',
+        serializers.DateTimeField: 'datetime',
+        serializers.TimeField: 'time',
+        serializers.ChoiceField: 'choice',
+        serializers.MultipleChoiceField: 'multiple choice',
+        serializers.FileField: 'file upload',
+        serializers.ImageField: 'image upload',
+        serializers.ListField: 'list',
+        serializers.DictField: 'nested object',
+        serializers.Serializer: 'nested object',
+        serializers.RelatedField: 'related object',
+        serializers.ManyRelatedField: 'many related objects',
+        ComponentManyToManyRelatedField: 'many related objects'
+    })
+
+    def get_field_info(self, field):
+        """
+        Given an instance of a serializer field, return a dictionary
+        of metadata about it.
+        """
+        field_info = OrderedDict()
+        field_info['type'] = self.label_lookup[field]
+        field_info['required'] = getattr(field, 'required', False)
+
+        form_field = field.style.get('form_field')
+        if form_field:
+            if hasattr(form_field, 'queryset'):
+                model = form_field.queryset.model
+                field_info['related_object'] = ".".join(
+                    [model.__module__, model.__name__]
+                )
+            if hasattr(form_field, 'filter_by'):
+                field_info['filter_by'] = form_field.filter_by
+
+        attrs = [
+            'read_only', 'label', 'help_text',
+            'min_length', 'max_length',
+            'min_value', 'max_value',
+            'initial'
+        ]
+
+        for attr in attrs:
+            value = getattr(field, attr, None)
+            if value is not None and value != '':
+                field_info[attr] = force_str(value, strings_only=True)
+
+        if getattr(field, 'child', None):
+            field_info['child'] = self.get_field_info(field.child)
+        elif getattr(field, 'fields', None):
+            field_info['children'] = self.get_serializer_info(field)
+
+        if not field_info.get('read_only') and hasattr(field, 'choices'):
+            add_choices = True
+            queryset = getattr(field, 'queryset', None)
+            if queryset and queryset.count() > 1000:
+                add_choices = False
+            if add_choices:
+                field_info['choices'] = [
+                    {
+                        'value': choice_value,
+                        'display_name': force_str(choice_name, strings_only=True)
+                    }
+                    for choice_value, choice_name in field.choices.items()
+                ]
+        return field_info

simo/core/auto_urls.py

@@ -1,5 +1,7 @@
 from django.urls import path
-from .views import get_timestamp, setup_wizard, update, restart, reboot
+from .views import (
+    get_timestamp, setup_wizard, update, restart, reboot, set_instance
+)
 from .autocomplete_views import (
     IconModelAutocomplete, #IconSlugAutocomplete,
     CategoryAutocomplete, ZoneAutocomplete,
@@ -28,6 +30,7 @@ urlpatterns = [
         'autocomplete-component',
         ComponentAutocomplete.as_view(), name='autocomplete-component'
     ),
+    path('set-instance/<slug:instance_slug>/', set_instance, name='set-instance'),
     path('setup/', setup_wizard, name='setup-wizard'),
     path('update/', update, name='update'),
     path('restart/', restart, name='restart'),

simo/core/autocomplete_views.py

@@ -18,7 +18,7 @@ class IconModelAutocomplete(autocomplete.Select2QuerySetView):
 
         if self.q:
             qs = search_queryset(qs, self.q, ('slug', 'keywords'))
-        return qs
+        return qs.distinct()
 
     def get_result_label(self, item):
         return render_to_string(
@@ -55,6 +55,7 @@ class CategoryAutocomplete(autocomplete.Select2QuerySetView):
     def get_queryset(self):
         qs = Category.objects.all()
 
+
         if not self.request.user.is_staff:
             return qs.none()
 
@@ -64,7 +65,7 @@ class CategoryAutocomplete(autocomplete.Select2QuerySetView):
         qs = qs.filter(all=False)
         if self.q:
             qs = search_queryset(qs, self.q, ('name'))
-        return qs
+        return qs.distinct()
 
     def get_result_label(self, item):
         return render_to_string(
@@ -90,7 +91,7 @@ class ZoneAutocomplete(autocomplete.Select2QuerySetView):
 
         if self.q:
             qs = search_queryset(qs, self.q, ('name',))
-        return qs
+        return qs.distinct()
 
     def get_result_label(self, item):
         return render_to_string(
@@ -119,6 +120,9 @@ class ComponentAutocomplete(autocomplete.Select2QuerySetView):
         if 'base_type' in self.forwarded:
             qs = qs.filter(base_type__in=self.forwarded['base_type'])
 
+        if 'controller_uid' in self.forwarded:
+            qs = qs.filter(controller_uid__in=self.forwarded['controller_uid'])
+
         if 'alarm_category' in self.forwarded:
             qs = qs.filter(
                 Q(base_type='alarm-group') |
@@ -127,7 +131,7 @@ class ComponentAutocomplete(autocomplete.Select2QuerySetView):
 
         if self.q:
             qs = search_queryset(qs, self.q, ('name',))
-        return qs
+        return qs.distinct()
 
     def get_result_label(self, item):
         return render_to_string(

simo/core/base_types.py

@@ -9,6 +9,7 @@ BASE_TYPES = {
     'multi-sensor': _("Multi sensor"),
     'binary-sensor': _("Binary sensor"),
     'dimmer': _("Dimmer"),
+    'dimmer-plus': _("Dimmer Plus"),
     'rgbw-light': _('RGB(W) light'),
     'switch': _("Switch"),
     'switch-double': _("Switch Double"),

simo/core/context.py

@@ -6,6 +6,7 @@ from django.apps import apps
 from simo.core.models import Instance
 from simo.conf import dynamic_settings
 from simo.core.utils.helpers import is_update_available
+from simo.core.middleware import get_current_instance
 
 
 def additional_templates_context(request):
@@ -14,7 +15,8 @@ def additional_templates_context(request):
         'dynamic_settings': dynamic_settings,
         'current_version': pkg_resources.get_distribution('simo').version,
         'update_available': is_update_available(True),
-        'instances': Instance.objects.all()
+        'instances': Instance.objects.all(),
+        'current_instance': get_current_instance()
     }
 
     if request.path.endswith('/admin/'):