Skip to content

Home Information - Your home, your data, organized.

Python

Integration enable/disable now centralized and controls monitors.

Anthony Cassandra1bf533d440ff
diff --git a/src/hi/apps/monitor/apps.py b/src/hi/apps/monitor/apps.py
index caaca878..bf1b4b20 100644
--- a/src/hi/apps/monitor/apps.py
+++ b/src/hi/apps/monitor/apps.py
@@ -24,7 +24,7 @@ class MonitorConfig(AppConfig):
# This is for development only as the gunicorn.conf.py file
# handles this initialization when execution with gunicorn.
#
- thread = threading.Thread( target = self._start_monitors, daemon = True )
+ thread = threading.Thread( target = self._start_all_app_monitors, daemon = True )
thread.start()
def handle_signal(signal_number, frame):
@@ -37,7 +37,7 @@ class MonitorConfig(AppConfig):
return
- def _start_monitors(self):
+ def _start_all_app_monitors(self):
from hi.apps.monitor.monitor_manager import AppMonitorManager
loop = asyncio.new_event_loop()
asyncio.set_event_loop( loop )
diff --git a/src/hi/integrations/core/helpers.py b/src/hi/integrations/core/helpers.py
deleted file mode 100644
index 8064be84..00000000
--- a/src/hi/integrations/core/helpers.py
+++ /dev/null
@@ -1,94 +0,0 @@
-import json
-
-from django.db import transaction
-
-from hi.apps.attribute.enums import AttributeType
-
-from hi.integrations.core.enums import IntegrationAttributeType
-from hi.integrations.core.integration_key import IntegrationKey
-from hi.integrations.core.models import Integration, IntegrationAttribute
-from hi.integrations.core.transient_models import IntegrationMetaData
-
-
-class IntegrationHelperMixin:
-
- def get_or_create_integration( self, integration_metadata : IntegrationMetaData ):
- try:
- integration = Integration.objects.get(
- integration_id = integration_metadata.integration_id,
- )
- self._ensure_all_attributes_exist(
- integration_metadata = integration_metadata,
- integration = integration,
- )
- return integration
- except Integration.DoesNotExist:
- pass
-
- with transaction.atomic():
- integration = Integration.objects.create(
- integration_id = integration_metadata.integration_id,
- is_enabled = False,
- )
- AttributeType = integration_metadata.attribute_type
- for attribute_type in AttributeType:
- self._create_integration_attribute(
- integration = integration,
- attribute_type = attribute_type,
- )
- continue
- return integration
-
- def _ensure_all_attributes_exist( self,
- integration_metadata : IntegrationMetaData,
- integration : Integration ):
- """
- After an integration is created, we need to be able to detect if any
- new attributes might have been defined. This allows new code
- features to be added for existing installations.
- """
-
- new_attribute_types = set()
- existing_attribute_integration_keys = set([ x.integration_key
- for x in integration.attributes.all() ])
-
- AttributeType = integration_metadata.attribute_type
- for attribute_type in AttributeType:
- integration_key = IntegrationKey(
- integration_id = integration.integration_id,
- integration_name = str(attribute_type),
- )
- if integration_key not in existing_attribute_integration_keys:
- new_attribute_types.add( attribute_type )
- continue
-
- if new_attribute_types:
- with transaction.atomic():
- for attribute_type in new_attribute_types:
- self._create_integration_attribute(
- integration = integration,
- attribute_type = attribute_type,
- )
- continue
- return
-
- def _create_integration_attribute( self,
- integration : Integration,
- attribute_type : IntegrationAttributeType ):
- integration_key = IntegrationKey(
- integration_id = integration.integration_id,
- integration_name = str(attribute_type),
- )
- IntegrationAttribute.objects.create(
- integration = integration,
- name = attribute_type.label,
- value = attribute_type.initial_value,
- value_type_str = str(attribute_type.value_type),
- value_range_str = json.dumps( attribute_type.value_range_dict ),
- integration_key_str = str(integration_key),
- attribute_type_str = AttributeType.PREDEFINED,
- is_editable = attribute_type.is_editable,
- is_required = attribute_type.is_required,
- )
- return
-
diff --git a/src/hi/integrations/core/integration_data.py b/src/hi/integrations/core/integration_data.py
index 4310bd3f..69834f62 100644
--- a/src/hi/integrations/core/integration_data.py
+++ b/src/hi/integrations/core/integration_data.py
@@ -11,6 +11,12 @@ class IntegrationData:
integration_gateway : IntegrationGateway
integration : Integration
+ def __repr__(self):
+ return self.__str__()
+
+ def __str__(self):
+ return self.integration_id
+
@property
def integration_id(self) -> str:
return self.integration_metadata.integration_id
diff --git a/src/hi/integrations/core/integration_manager.py b/src/hi/integrations/core/integration_manager.py
index 9e86fc57..f3df7881 100644
--- a/src/hi/integrations/core/integration_manager.py
+++ b/src/hi/integrations/core/integration_manager.py
@@ -1,16 +1,23 @@
from asgiref.sync import sync_to_async
import asyncio
+import json
import logging
from typing import Dict, List
from django.apps import apps
+from django.db import transaction
+from hi.apps.attribute.enums import AttributeType
from hi.apps.common.singleton import Singleton
from hi.apps.common.module_utils import import_module_safe
-from .integration_gateway import IntegrationGateway
-from .models import Integration
+from .enums import IntegrationAttributeType
+from .forms import IntegrationAttributeFormSet
from .integration_data import IntegrationData
+from .integration_gateway import IntegrationGateway
+from .integration_key import IntegrationKey
+from .models import Integration, IntegrationAttribute
+from .transient_models import IntegrationMetaData
logger = logging.getLogger(__name__)
@@ -52,7 +59,7 @@ class IntegrationManager( Singleton ):
async def initialize(self) -> None:
await self._load_integration_data()
- await self._start_monitors()
+ await self._start_all_integration_monitors()
return
async def _load_integration_data(self) -> None:
@@ -81,7 +88,7 @@ class IntegrationManager( Singleton ):
continue
return
- async def _start_monitors(self) -> None:
+ async def _start_all_integration_monitors(self) -> None:
if self._event_loop:
self.shutdown()
@@ -89,25 +96,65 @@ class IntegrationManager( Singleton ):
for integration_data in self._integration_data_map.values():
if not integration_data.is_enabled:
+ logger.debug( f'Skipping monitor start for {integration_data}. Integration is disabled.' )
continue
- monitor = integration_data.integration_gateway.get_monitor()
- if not monitor:
- continue
- self._monitor_map[monitor.id] = monitor
- if not monitor.is_running:
- logger.debug(f"Starting monitor: {monitor.id}")
- asyncio.run_coroutine_threadsafe( monitor.start(), self._event_loop )
+ self._start_integration_monitor( integration_data = integration_data )
continue
return
+ def _start_integration_monitor( self, integration_data : IntegrationData ):
+ integration_id = integration_data.integration_id
+ logger.debug( f'Starting integration monitor for {integration_id}' )
+
+ assert self._event_loop is not None
+
+ if not integration_data.is_enabled:
+ logger.warning( f'Tried to start monitor for disabled integration: {integration_id}' )
+ return
+
+ monitor = integration_data.integration_gateway.get_monitor()
+ if not monitor:
+ logger.debug( f'No monitor defined {integration_id}' )
+ return
+
+ if integration_id in self._monitor_map:
+ existing_monitor = self._monitor_map[integration_id]
+ if existing_monitor.is_running:
+ logger.warning( f'Found existing running monitor for integration: {integration_id}' )
+ return
+
+ self._monitor_map[integration_id] = monitor
+ if not monitor.is_running:
+ logger.debug(f"Starting monitor: {integration_id}")
+ asyncio.run_coroutine_threadsafe( monitor.start(), self._event_loop )
+ return
+
+ def _stop_integration_monitor( self, integration_data : IntegrationData ):
+ integration_id = integration_data.integration_id
+ logger.debug( f'Stopping integration monitor for {integration_id}' )
+
+ if integration_id not in self._monitor_map:
+ logger.debug( f'No monitor running for {integration_id}' )
+ return
+
+ existing_monitor = self._monitor_map[integration_id]
+ if existing_monitor.is_running:
+ existing_monitor.stop()
+ else:
+ logger.debug( f'Existing monitor is not running for {integration_id}' )
+
+ del self._monitor_map[integration_id]
+ return
+
def shutdown(self) -> None:
if not self._event_loop:
logger.info("Cannot stop all monitors. No event loop.")
return
- logger.info("Stopping all registered monitors...")
+ logger.info("Stopping all integration monitors...")
- for monitor in self._monitor_map.values():
+ for integration_id, monitor in self._monitor_map.items():
+ logger.debug( f'Stopping integration monitor for {integration_id}' )
monitor.stop()
continue
@@ -153,3 +200,74 @@ class IntegrationManager( Singleton ):
integration_queryset = Integration.objects.all()
return { x.integration_id: x for x in integration_queryset }
+ def _ensure_all_attributes_exist( self,
+ integration_metadata : IntegrationMetaData,
+ integration : Integration ):
+ """
+ After an integration is created, we need to be able to detect if any
+ new attributes might have been defined. This allows new code
+ features to be added for existing installations.
+ """
+
+ new_attribute_types = set()
+ existing_attribute_integration_keys = set([ x.integration_key
+ for x in integration.attributes.all() ])
+
+ AttributeType = integration_metadata.attribute_type
+ for attribute_type in AttributeType:
+ integration_key = IntegrationKey(
+ integration_id = integration.integration_id,
+ integration_name = str(attribute_type),
+ )
+ if integration_key not in existing_attribute_integration_keys:
+ new_attribute_types.add( attribute_type )
+ continue
+
+ if new_attribute_types:
+ with transaction.atomic():
+ for attribute_type in new_attribute_types:
+ self._create_integration_attribute(
+ integration = integration,
+ attribute_type = attribute_type,
+ )
+ continue
+ return
+
+ def _create_integration_attribute( self,
+ integration : Integration,
+ attribute_type : IntegrationAttributeType ):
+ integration_key = IntegrationKey(
+ integration_id = integration.integration_id,
+ integration_name = str(attribute_type),
+ )
+ IntegrationAttribute.objects.create(
+ integration = integration,
+ name = attribute_type.label,
+ value = attribute_type.initial_value,
+ value_type_str = str(attribute_type.value_type),
+ value_range_str = json.dumps( attribute_type.value_range_dict ),
+ integration_key_str = str(integration_key),
+ attribute_type_str = AttributeType.PREDEFINED,
+ is_editable = attribute_type.is_editable,
+ is_required = attribute_type.is_required,
+ )
+ return
+
+ def enable_integration( self,
+ integration_data : IntegrationData,
+ integration_attribute_formset : IntegrationAttributeFormSet ):
+ with transaction.atomic():
+ integration_data.integration.is_enabled = True
+ integration_data.integration.save()
+ integration_attribute_formset.save()
+ self._start_integration_monitor( integration_data = integration_data )
+ return
+
+ def disable_integration( self, integration_data : IntegrationData ):
+
+ with transaction.atomic():
+ integration_data.integration.is_enabled = False
+ integration_data.integration.save()
+ self._stop_integration_monitor( integration_data = integration_data )
+ return
+
diff --git a/src/hi/integrations/core/views.py b/src/hi/integrations/core/views.py
index c47058d0..85991d8a 100644
--- a/src/hi/integrations/core/views.py
+++ b/src/hi/integrations/core/views.py
@@ -11,7 +11,6 @@ from hi.exceptions import ForceRedirectException
from hi.hi_async_view import HiModalView
from .forms import IntegrationAttributeFormSet
-from .helpers import IntegrationHelperMixin
from .integration_manager import IntegrationManager
logger = logging.getLogger(__name__)
@@ -48,20 +47,21 @@ class IntegrationSelectView( HiModalView ):
return self.modal_response( request, context )
-class IntegrationEnableView( HiModalView, IntegrationHelperMixin ):
+class IntegrationEnableView( HiModalView ):
def get_template_name( self ) -> str:
return 'core/modals/integration_enable.html'
def get(self, request, *args, **kwargs):
+ integration_manager = IntegrationManager()
integration_id = kwargs.get('integration_id')
- integration_data = IntegrationManager().get_integration_data(
+ integration_data = integration_manager.get_integration_data(
integration_id = integration_id,
)
if integration_data.integration.is_enabled:
raise BadRequest( f'{integration_data.label} is already enabled' )
- self._ensure_all_attributes_exist(
+ integration_manager._ensure_all_attributes_exist(
integration_metadata = integration_data.integration_metadata,
integration = integration_data.integration,
)
@@ -80,8 +80,9 @@ class IntegrationEnableView( HiModalView, IntegrationHelperMixin ):
return self.modal_response( request, context )
def post(self, request, *args, **kwargs):
+ integration_manager = IntegrationManager()
integration_id = kwargs.get('integration_id')
- integration_data = IntegrationManager().get_integration_data(
+ integration_data = integration_manager.get_integration_data(
integration_id = integration_id,
)
if integration_data.integration.is_enabled:
@@ -100,16 +101,15 @@ class IntegrationEnableView( HiModalView, IntegrationHelperMixin ):
}
return self.modal_response( request, context, status_code = 400 )
- with transaction.atomic():
- integration_data.integration.is_enabled = True
- integration_data.integration.save()
- integration_attribute_formset.save()
-
+ integration_manager.enable_integration(
+ integration_data = integration_data,
+ integration_attribute_formset = integration_attribute_formset,
+ )
redirect_url = reverse( 'integrations_home' )
return self.redirect_response( request, redirect_url )
-class IntegrationDisableView( HiModalView, IntegrationHelperMixin ):
+class IntegrationDisableView( HiModalView ):
def get_template_name( self ) -> str:
return 'core/modals/integration_disable.html'
@@ -128,17 +128,17 @@ class IntegrationDisableView( HiModalView, IntegrationHelperMixin ):
return self.modal_response( request, context )
def post(self, request, *args, **kwargs):
+ integration_manager = IntegrationManager()
integration_id = kwargs.get('integration_id')
- integration_data = IntegrationManager().get_integration_data(
+ integration_data = integration_manager.get_integration_data(
integration_id = integration_id,
)
if not integration_data.integration.is_enabled:
raise BadRequest( f'{integration_data.label} is already disabled' )
- with transaction.atomic():
- integration_data.integration.is_enabled = False
- integration_data.integration.save()
-
+ integration_manager.disable_integration(
+ integration_data = integration_data,
+ )
redirect_url = reverse( 'integrations_home' )
return self.redirect_response( request, redirect_url )
diff --git a/src/hi/integrations/hass/views.py b/src/hi/integrations/hass/views.py
index 76ee2855..e87c3210 100644
--- a/src/hi/integrations/hass/views.py
+++ b/src/hi/integrations/hass/views.py
@@ -7,7 +7,7 @@ from django.shortcuts import render
from django.views.generic import View
from hi.integrations.core.forms import IntegrationAttributeFormSet
-from hi.integrations.core.helpers import IntegrationHelperMixin
+from hi.integrations.core.integration_manager import IntegrationManager
from hi.hi_async_view import HiModalView
@@ -16,21 +16,20 @@ from .hass_mixins import HassMixin
from .hass_sync import HassSynchronizer
-class HassSettingsView( View, IntegrationHelperMixin, HassMixin ):
+class HassSettingsView( View, HassMixin ):
def post( self, request, *args, **kwargs ):
-
- integration = self.get_or_create_integration(
- integration_metadata = HassMetaData,
+ integration_data = IntegrationManager().get_integration_data(
+ integration_id = HassMetaData.integration_id,
)
- if not integration.is_enabled:
+ if not integration_data.is_enabled:
raise BadRequest( 'HAss is not enabled' )
integration_attribute_formset = IntegrationAttributeFormSet(
request.POST,
request.FILES,
- instance = integration,
- prefix = f'integration-{integration.id}',
+ instance = integration_data.integration,
+ prefix = f'integration-{integration_data.integration_id}',
)
if integration_attribute_formset.is_valid():
with transaction.atomic():
diff --git a/src/hi/integrations/zoneminder/views.py b/src/hi/integrations/zoneminder/views.py
index 5dff0ed8..a02dd857 100644
--- a/src/hi/integrations/zoneminder/views.py
+++ b/src/hi/integrations/zoneminder/views.py
@@ -4,7 +4,7 @@ from django.shortcuts import render
from django.views.generic import View
from hi.integrations.core.forms import IntegrationAttributeFormSet
-from hi.integrations.core.helpers import IntegrationHelperMixin
+from hi.integrations.core.integration_manager import IntegrationManager
from hi.hi_async_view import HiModalView
@@ -13,21 +13,20 @@ from .zm_metadata import ZmMetaData
from .zm_sync import ZoneMinderSynchronizer
-class ZmSettingsView( View, IntegrationHelperMixin, ZoneMinderMixin ):
+class ZmSettingsView( View, ZoneMinderMixin ):
def post( self, request, *args, **kwargs ):
-
- integration = self.get_or_create_integration(
- integration_metadata = ZmMetaData,
+ integration_data = IntegrationManager().get_integration_data(
+ integration_id = ZmMetaData.integration_id,
)
- if not integration.is_enabled:
- raise BadRequest( 'ZoneMinder not is enabled' )
+ if not integration_data.is_enabled:
+ raise BadRequest( 'ZoneMinder is not enabled' )
integration_attribute_formset = IntegrationAttributeFormSet(
request.POST,
request.FILES,
- instance = integration,
- prefix = f'integration-{integration.id}',
+ instance = integration_data.integration,
+ prefix = f'integration-{integration_data.integration_id}',
)
if integration_attribute_formset.is_valid():
with transaction.atomic():