simo 3.0.5__py3-none-any.whl → 3.1.1__py3-none-any.whl

simo/generic/gateways.py

@@ -7,9 +7,8 @@ import traceback
 from django.conf import settings
 from django.utils import timezone
 import paho.mqtt.client as mqtt
-from simo.core.utils.helpers import get_self_ip
-from simo.core.models import Component, PublicFile
-from simo.core.middleware import drop_current_instance
+from simo.core.models import Instance, Component
+from simo.core.middleware import introduce_instance, drop_current_instance
 from simo.core.gateways import BaseObjectCommandsGatewayHandler
 from simo.core.forms import BaseGatewayForm
 from simo.core.events import GatewayObjectCommand, get_event_obj
@@ -176,15 +175,18 @@ class GenericGatewayHandler(
 ):
     name = "Generic"
     config_form = BaseGatewayForm
+    auto_create = True
     info = "Provides generic type components which use other components to operate like " \
            "thermostats, alarm groups, watering programs, alarm clocks," \
            "etc. "
 
     running_scripts = {}
     periodic_tasks = (
+        ('watch_timers', 1),
         ('watch_thermostats', 60),
         ('watch_alarm_clocks', 30),
         ('watch_watering', 60),
+        ('low_battery_notifications', 60 * 60),
         ('watch_main_states', 60),
         ('watch_groups', 60)
     )
@@ -198,6 +200,21 @@ class GenericGatewayHandler(
         self.pulsing_switches = {}
 
 
+    def watch_timers(self):
+        from simo.core.models import Component
+        drop_current_instance()
+        for component in Component.objects.filter(
+            meta__timer_to__gt=0
+        ).filter(meta__timer_to__lt=time.time()):
+            component.meta['timer_to'] = 0
+            component.meta['timer_start'] = 0
+            component.save()
+            try:
+                component.controller._on_timer_end()
+            except Exception as e:
+                print(traceback.format_exc(), file=sys.stderr)
+
+
     def watch_thermostats(self):
         from .controllers import Thermostat
         drop_current_instance()
@@ -206,7 +223,7 @@ class GenericGatewayHandler(
         ):
             tz = pytz.timezone(thermostat.zone.instance.timezone)
             timezone.activate(tz)
-            thermostat._evaluate()
+            thermostat.controller._evaluate()
 
 
     def watch_alarm_clocks(self):
@@ -217,7 +234,7 @@ class GenericGatewayHandler(
         ):
             tz = pytz.timezone(alarm_clock.zone.instance.timezone)
             timezone.activate(tz)
-            alarm_clock._tick()
+            alarm_clock.controller._tick()
 
 
     def watch_watering(self):
@@ -227,12 +244,46 @@ class GenericGatewayHandler(
             tz = pytz.timezone(watering.zone.instance.timezone)
             timezone.activate(tz)
             if watering.value['status'] == 'running_program':
-                watering._set_program_progress(
+                watering.controller._set_program_progress(
                     watering.value['program_progress'] + 1
                 )
             else:
                 watering.controller._perform_schedule()
 
+    def low_battery_notifications(self):
+        from simo.notifications.utils import notify_users
+        from simo.automation.helpers import be_or_not_to_be
+        for instance in Instance.objects.filter(is_active=True):
+            timezone.activate(instance.timezone)
+            hour = timezone.localtime().hour
+            if hour < 7:
+                continue
+            if hour > 21:
+                continue
+
+            introduce_instance(instance)
+            for comp in Component.objects.filter(
+                    zone__instance=instance,
+                    battery_level__isnull=False, battery_level__lt=20
+            ):
+                last_warning = comp.meta.get('last_battery_warning', 0)
+                notify = be_or_not_to_be(12 * 60 * 60, 72 * 60 * 60,
+                                         last_warning)
+                if not notify:
+                    continue
+
+                iusers = comp.zone.instance.instance_users.filter(
+                    is_active=True, role__is_owner=True
+                )
+                if iusers:
+                    notify_users(
+                        'warning',
+                        f"Low battery ({comp.battery_level}%) on {comp}",
+                        component=comp, instance_users=iusers
+                    )
+                comp.meta['last_battery_warning'] = time.time()
+                comp.save()
+
 
     def run(self, exit):
         drop_current_instance()
@@ -340,7 +391,7 @@ class GenericGatewayHandler(
     def set_get_day_evening_night_morning(self, state):
         if state.value  not in ('day', 'night', 'evening', 'morning'):
             return
-        new_state = state._get_day_evening_night_morning()
+        new_state = state.controller._get_day_evening_night_morning()
         if new_state == state.value:
             self.last_set_state = state.value
             return
@@ -377,7 +428,7 @@ class GenericGatewayHandler(
                     self.sensors_on_watch[state.id][sensor.id] = i_id
                     sensor.on_change(self.security_sensor_change)
 
-            if state._check_is_away(self.last_sensor_actions.get(i_id, 0)):
+            if state.controller._check_is_away(self.last_sensor_actions.get(i_id, 0)):
                 if state.value != 'away':
                     print(f"New main state of "
                           f"{state.zone.instance} - away")
@@ -385,7 +436,7 @@ class GenericGatewayHandler(
             else:
                 if state.value == 'away':
                     try:
-                        new_state = state._get_day_evening_night_morning()
+                        new_state = state.controller._get_day_evening_night_morning()
                     except:
                         new_state = 'day'
                     print(f"New main state of "
@@ -394,14 +445,14 @@ class GenericGatewayHandler(
 
         if state.config.get('sleeping_phones_hour') is not None:
             if state.value != 'sleep':
-                if state._is_sleep_time() and state._owner_phones_on_charge(True):
+                if state.controller._is_sleep_time() and state.controller._owner_phones_on_charge(True):
                     print(f"New main state of {state.zone.instance} - sleep")
                     state.send('sleep')
             else:
-                if not state._owner_phones_on_charge(True) \
-                and not state._is_sleep_time():
+                if not state.controller._owner_phones_on_charge(True) \
+                and not state.controller._is_sleep_time():
                     try:
-                        new_state = state._get_day_evening_night_morning()
+                        new_state = state.controller._get_day_evening_night_morning()
                     except:
                         new_state = 'day'
                     print(f"New main state of "
@@ -509,9 +560,9 @@ class GenericGatewayHandler(
 class DummyGatewayHandler(BaseObjectCommandsGatewayHandler):
     name = "Dummy"
     config_form = BaseGatewayForm
+    auto_create = True
     info = "Provides dummy components that do absolutely anything, " \
            "but comes in super handy when configuring custom automations."
 
     def perform_value_send(self, component, value):
         component.controller.set(value)
-

simo/generic/tasks.py

@@ -56,25 +56,4 @@ def fire_breach_events(ag_id):
             ag.meta['events_triggered'] = [uid]
         else:
             ag.meta['events_triggered'].append(uid)
-        ag.save(update_fields=['meta'])
-
-
-@celery_app.task
-def watch_timers():
-    from simo.core.models import Component
-    drop_current_instance()
-    for component in Component.objects.filter(
-        meta__timer_to__gt=0
-    ).filter(meta__timer_to__lt=time.time()):
-        component.meta['timer_to'] = 0
-        component.meta['timer_start'] = 0
-        component.save()
-        try:
-            component.controller._on_timer_end()
-        except Exception as e:
-            print(traceback.format_exc(), file=sys.stderr)
-
-
-@celery_app.on_after_finalize.connect
-def setup_periodic_tasks(sender, **kwargs):
-    sender.add_periodic_task(1, watch_timers.s())
+        ag.save(update_fields=['meta'])

simo/settings.py

@@ -133,6 +133,14 @@ DATABASES = {
         'ENGINE': 'simo.core.db_backend',
         'NAME': 'SIMO',
         'ATOMIC_REQUESTS': False,
+        'CONN_HEALTH_CHECKS': True,
+        'CONN_MAX_AGE': 300,
+        'OPTIONS': {
+            "keepalives": 1,
+            "keepalives_idle": 30,
+            "keepalives_interval": 10,
+            "keepalives_count": 3,
+        }
     }
 }
 

simo/urls.py

@@ -45,7 +45,8 @@ urlpatterns = [
     path('logout/', LogoutView.as_view(), name='logout'),
     path('admin/', admin_site.urls),
     path('api-hub-info/', hub_info),
-    path('api/<instance_slug>/', include(rest_router.urls)),
+    # REST API (instance-scoped)
+    path('api/<slug:instance_slug>/', include(rest_router.urls)),
 
 ]
 

simo/users/api.py

@@ -127,9 +127,16 @@ class UsersViewSet(mixins.RetrieveModelMixin,
                 raise ValidationError(
                     'You do not have permission for this!', code=403
                 )
-        self.perform_destroy(user)
+        if InstanceUser.objects.filter(user=user, is_active=True).count() > 1:
+            InstanceUser.objects.filter(
+                user=user, instance=self.instance
+            ).delete()
+        else:
+            user.delete()
         return RESTResponse(status=status.HTTP_204_NO_CONTENT)
 
+    # (moved to dedicated view at /users/mqtt-credentials/)
+
 
 class RolesViewsets(InstanceMixin, viewsets.ReadOnlyModelViewSet):
     url = 'users/roles'
@@ -406,4 +413,3 @@ class FingerprintViewSet(
     def destroy(self, request, *args, **kwargs):
         self.check_can_manage_user(request)
         return super().destroy(request, *args, **kwargs)
-

simo/users/auto_urls.py

@@ -1,5 +1,5 @@
 from django.urls import re_path, path
-from .views import accept_invitation, RolesAutocomplete
+from .views import accept_invitation, RolesAutocomplete, mqtt_credentials
 
 urlpatterns = [
     re_path(
@@ -10,4 +10,5 @@ urlpatterns = [
         'autocomplete-roles',
         RolesAutocomplete.as_view(), name='autocomplete-user-roles'
     ),
+    path('mqtt-credentials/', mqtt_credentials, name='mqtt-credentials'),
 ]

simo/users/models.py

@@ -1,4 +1,6 @@
 import datetime
+import time
+import json
 import requests
 import subprocess
 from django.urls import reverse
@@ -16,6 +18,7 @@ from actstream import action
 from django.contrib.auth.models import (
     AbstractBaseUser, PermissionsMixin, UserManager as DefaultUserManager
 )
+from django.conf import settings
 from django.utils import timezone
 from easy_thumbnails.fields import ThumbnailerImageField
 from location_field.models.plain import PlainLocationField
@@ -115,7 +118,9 @@ class InstanceUser(DirtyFieldsMixin, models.Model, OnChangeMixin):
     objects = ActiveInstanceManager()
 
     on_change_fields = (
-        'is_active', 'last_seen', 'last_seen_location', 'phone_on_charge'
+        'is_active', 'role', 'at_home',
+        'last_seen', 'last_seen_location', 'last_seen_speed_kmh',
+        'phone_on_charge'
     )
 
     class Meta:
@@ -158,13 +163,11 @@ class InstanceUser(DirtyFieldsMixin, models.Model, OnChangeMixin):
 
 @receiver(post_save, sender=InstanceUser)
 def post_instance_user_save(sender, instance, created, **kwargs):
-    if created:
-        return
-    from simo.core.events import ObjectChangeEvent
-    dirty_fields = instance.get_dirty_fields()
-    if any([f in dirty_fields.keys() for f in InstanceUser.on_change_fields]):
+    from simo.core.events import ObjectChangeEvent, dirty_fields_to_current_values
+    dirty_fields_prev = instance.get_dirty_fields()
+    if not created and any([f in dirty_fields_prev.keys() for f in InstanceUser.on_change_fields]):
         def post_update():
-            if 'at_home' in dirty_fields:
+            if 'at_home' in dirty_fields_prev:
                 if instance.at_home:
                     verb = 'came home'
                 else:
@@ -174,12 +177,57 @@ def post_instance_user_save(sender, instance, created, **kwargs):
                     instance_id=instance.instance.id,
                     action_type='user_presence', value=instance.at_home
                 )
+            # Include key fields so clients can update UI without a refetch
             ObjectChangeEvent(
-                instance.instance, instance,  dirty_fields=dirty_fields
+                instance.instance,
+                instance,
+                dirty_fields=dirty_fields_to_current_values(instance, dirty_fields_prev),
+                at_home=instance.at_home,
+                last_seen=instance.last_seen,
+                last_seen_location=instance.last_seen_location,
+                last_seen_speed_kmh=instance.last_seen_speed_kmh,
+                phone_on_charge=instance.phone_on_charge,
+                is_active=instance.is_active,
+                role=instance.role_id,
             ).publish()
+            # If role changed, notify the affected user to re-fetch states
+            if 'role' in dirty_fields_prev:
+                from paho.mqtt import publish as mqtt_publish
+                topic = f"SIMO/user/{instance.user.id}/perms-changed"
+                payload = json.dumps({
+                    'instance_id': instance.instance.id,
+                    'timestamp': int(time.time())
+                })
+                try:
+                    mqtt_publish.single(
+                        topic, payload,
+                        hostname=settings.MQTT_HOST, port=settings.MQTT_PORT,
+                        auth={'username': 'root', 'password': settings.SECRET_KEY},
+                        retain=False
+                    )
+                except Exception:
+                    pass
+            # Invalidate cached role lookups
+            try:
+                cache.delete(f'user-{instance.user.id}_instance-{instance.instance.id}-role-id')
+                cache.delete(f'user-{instance.user.id}_instance-{instance.instance.id}_role')
+            except Exception:
+                pass
         transaction.on_commit(post_update)
-    if 'role' or 'is_active' in instance.dirty_fields:
+    # Rebuild ACLs if user became active/inactive due to this role change
+    try:
+        if created or ('is_active' in dirty_fields_prev):
+            dynamic_settings['core__needs_mqtt_acls_rebuild'] = True
+    except Exception:
+        pass
+
+@receiver(post_delete, sender=InstanceUser)
+def post_instance_user_delete(sender, instance, **kwargs):
+    # Deleting role entry may change user's overall is_active; rebuild ACLs
+    try:
         dynamic_settings['core__needs_mqtt_acls_rebuild'] = True
+    except Exception:
+        pass
 
 
 # DirtyFieldsMixin does not work with AbstractBaseUser model!!!
@@ -256,6 +304,14 @@ class User(AbstractBaseUser, SimoAdminMixin):
         if not org or (org.secret_key != self.secret_key):
             self.update_mqtt_secret()
 
+        # Rebuild ACLs when a user is created or properties affecting ACLs change
+        # (username/email used by Mosquitto + master flag)
+        try:
+            if (not org) or (org.email != self.email) or (org.is_master != self.is_master):
+                dynamic_settings['core__needs_mqtt_acls_rebuild'] = True
+        except Exception:
+            pass
+
         return obj
 
     def update_mqtt_secret(self, reload=True):
@@ -408,6 +464,12 @@ class User(AbstractBaseUser, SimoAdminMixin):
 
         rebuild_authorized_keys()
 
+        # Reflect access changes in Mosquitto ACLs
+        try:
+            dynamic_settings['core__needs_mqtt_acls_rebuild'] = True
+        except Exception:
+            pass
+
         self._is_active = None
 
 
@@ -507,8 +569,28 @@ class ComponentPermission(models.Model):
 
 @receiver(post_save, sender=ComponentPermission)
 def rebuild_mqtt_acls_on_create(sender, instance, created, **kwargs):
-    if not created:
-        dynamic_settings['core__needs_mqtt_acls_rebuild'] = True
+    # ACLs are per-user prefix; permission changes don't require ACL rebuilds.
+
+    # Notify affected users to re-sync their subscriptions
+    def _notify():
+        from paho.mqtt import publish as mqtt_publish
+        role = instance.role
+        for iu in role.instance.instance_users.filter(role=role, is_active=True).select_related('user'):
+            topic = f"SIMO/user/{iu.user.id}/perms-changed"
+            payload = json.dumps({
+                'instance_id': role.instance.id,
+                'timestamp': int(time.time())
+            })
+            try:
+                mqtt_publish.single(
+                    topic, payload,
+                    hostname=settings.MQTT_HOST, port=settings.MQTT_PORT,
+                    auth={'username': 'root', 'password': settings.SECRET_KEY},
+                    retain=False
+                )
+            except Exception:
+                pass
+    transaction.on_commit(_notify)
 
 
 
@@ -524,7 +606,7 @@ def create_component_permissions_comp(sender, instance, created, **kwargs):
                     'write': role.is_superuser or role.is_owner
                 }
             )
-        dynamic_settings['core__needs_mqtt_acls_rebuild'] = True
+        # ACLs are per-user prefix; component additions don't require ACL rebuilds.
 
 
 @receiver(post_save, sender=PermissionsRole)
@@ -541,6 +623,35 @@ def create_component_permissions_role(sender, instance, created, **kwargs):
                 }
             )
 
+    # Permissions topology changed; notify users on this role
+    def _notify():
+        from paho.mqtt import publish as mqtt_publish
+        for iu in instance.instance.instance_users.filter(role=instance, is_active=True).select_related('user'):
+            topic = f"SIMO/user/{iu.user.id}/perms-changed"
+            payload = json.dumps({
+                'instance_id': instance.instance.id,
+                'timestamp': int(time.time())
+            })
+            try:
+                mqtt_publish.single(
+                    topic, payload,
+                    hostname=settings.MQTT_HOST, port=settings.MQTT_PORT,
+                    auth={'username': 'root', 'password': settings.SECRET_KEY},
+                    retain=False
+                )
+            except Exception:
+                pass
+    transaction.on_commit(_notify)
+
+
+@receiver(post_delete, sender=User)
+def rebuild_mqtt_acls_on_user_delete(sender, instance, **kwargs):
+    # Remove ACL stanza for deleted user
+    try:
+        dynamic_settings['core__needs_mqtt_acls_rebuild'] = True
+    except Exception:
+        pass
+
 
 def get_default_inviation_expire_date():
     return timezone.now() + datetime.timedelta(days=14)
@@ -607,5 +718,3 @@ class InstanceInvitation(models.Model):
 
     def get_absolute_url(self):
         return reverse('accept_invitation', kwargs={'token': self.token})
-
-

simo/users/serializers.py

@@ -32,7 +32,10 @@ class UserSerializer(serializers.ModelSerializer):
         iu = InstanceUser.objects.filter(
             user=obj, instance=get_current_instance()
         ).first()
-        return iu.is_active
+        try:
+            return iu.is_active
+        except:
+            return False
 
     def get_avatar(self, obj):
         if not obj.avatar:

simo/users/templates/conf/mosquitto_acls.conf

@@ -2,18 +2,18 @@ user root
 topic readwrite #
 
 {% for user in users %}
+{% if user.email == 'system@simo.io' %}
 user {{ user.email }}
-    {% if user.email == 'system@simo.io' or user.is_master %}
 topic readwrite #
-    {% elif user.email == 'device@simo.io' %}
+{% elif user.is_active %}
+user {{ user.email }}
+    {% if user.is_master %}
 topic readwrite #
-topic deny SIMO/#
     {% else %}
-        {% for perm in user.get_component_permissions %}
-topic read SIMO/obj-state/{{ perm.component.zone.instance.id }}/Component-{{ perm.component.id }}
-        {% endfor %}
+topic readwrite SIMO/user/{{ user.id }}/#
     {% endif %}
+{% endif %}
 {% endfor %}
 
 # This affects all clients.
-pattern deny #
+pattern deny #

simo/users/views.py

@@ -125,3 +125,15 @@ class RolesAutocomplete(autocomplete.Select2QuerySetView):
         return qs.distinct()
 
 
+@login_required
+def mqtt_credentials(request):
+    """Return MQTT credentials for the authenticated user.
+    Response payload:
+      - username: user's email
+      - password: user's MQTT secret
+    """
+    return JsonResponse({
+        'username': request.user.email,
+        'password': request.user.secret_key,
+        'user_id': request.user.id
+    })

{simo-3.0.5.dist-info → simo-3.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simo
-Version: 3.0.5
+Version: 3.1.1
 Summary: Smart Home Supremacy
 Author-email: "Simon V." <simon@simo.io>
 Project-URL: Homepage, https://simo.io