Home Information - Your home, your data, organized.
Python
Improved security satte display anmd initialization. Begin on emails.
Anthony Cassandra880d04bb4877
diff --git a/src/hi/apps/alert/alert.py b/src/hi/apps/alert/alert.pyindex 03ca2b14..9941c52e 100644--- a/src/hi/apps/alert/alert.py+++ b/src/hi/apps/alert/alert.py@@ -5,6 +5,7 @@ import uuidimport hi.apps.common.datetimeproxy as datetimeproxyfrom hi.apps.config.audio_signal import AudioSignal+from hi.apps.notify.transient_models import NotificationItemfrom .alarm import Alarmfrom .enums import AlarmLevel, AlarmSource@@ -81,9 +82,6 @@ class Alert:def is_acknowledged( self, value : bool ):self._is_acknowledged = valuereturn-- def is_matching_alarm( self, alarm : Alarm ) -> bool:- return self._first_alarm.signature == alarm.signature@propertydef alert_priority(self) -> int:@@ -91,7 +89,20 @@ class Alert:# this to better order alerts with the same alarm priorityreturn self._first_alarm.alarm_level.priority+ @property+ def signature(self):+ # N.B. All alarms in an Alert should have the same signature.+ return self.first_alarm.signature++ @property+ def has_single_alarm(self):+ return bool( len(self._latest_alarms) == 1 )++ def is_matching_alarm( self, alarm : Alarm ) -> bool:+ return bool( self._first_alarm.signature == alarm.signature )+def add_alarm( self, alarm : Alarm ):+ assert alarm.signature == self.first_alarm.signatureself._end_datetime = datetimeproxy.now() + timedelta( seconds = alarm.alarm_lifetime_secs )self._latest_alarms.appendleft( alarm )return@@ -101,3 +112,7 @@ class Alert:return self._latest_alarms[0]return None+ def to_notification_item(self):+ return NotificationItem(+ signature = self.signature,+ )diff --git a/src/hi/apps/alert/alert_manager.py b/src/hi/apps/alert/alert_manager.pyindex 8b255eb7..efd71061 100644--- a/src/hi/apps/alert/alert_manager.py+++ b/src/hi/apps/alert/alert_manager.py@@ -2,6 +2,8 @@ from datetime import datetimeimport loggingfrom hi.apps.common.singleton import Singleton+from hi.apps.security.security_manager import SecurityManager+from hi.apps.notify.notification_queue import NotificationQueuefrom .alert import Alertfrom .alert_queue import AlertQueue@@ -15,6 +17,7 @@ class AlertManager(Singleton):def __init_singleton__(self):self._alert_queue = AlertQueue()+ self._notification_queue = NotificationQueue()return@property@@ -67,26 +70,28 @@ class AlertManager(Singleton):max_audio_signal = max_alert.audio_signal if max_alert else None,new_audio_signal = new_alert.audio_signal if new_alert else None,)++ def acknowledge_alert( self, alert_id : str ):+ self._alert_queue.acknowledge_alert( alert_id = alert_id )+ returnasync def add_alarm( self, alarm : Alarm ):logging.debug( f'Adding Alarm: {alarm}' )+ security_state = SecurityManager().security_statetry:- self._alert_queue.add_alarm( alarm = alarm )+ alert = self._alert_queue.add_alarm( alarm = alarm )+ if security_state.uses_notifications and alert.has_single_alarm:+ self._notification_queue.add_item( notification = alert.to_notification_item() )except ValueError as ve:logging.info( str(ve) )- return-- def acknowledge_alert( self, alert_id : str ):- self._alert_queue.acknowledge_alert( alert_id = alert_id )+ except Exception as e:+ logger.exception( 'Problem adding alarm to alert queue.', e )returndef do_periodic_maintenance(self):- self._alert_queue.remove_expired_or_acknowledged_alerts()- self.check_email_queues()- return-- def check_email_queues(self):-- # TODO: Implement this method after adding email sending.-+ try:+ self._alert_queue.remove_expired_or_acknowledged_alerts()+ self._notification_queue.check_for_notifications()+ except Exception as e:+ logger.exception( 'Problem doing periodic alert maintenance.', e )returndiff --git a/src/hi/apps/alert/alert_queue.py b/src/hi/apps/alert/alert_queue.pyindex 2774c69f..67961865 100644--- a/src/hi/apps/alert/alert_queue.py+++ b/src/hi/apps/alert/alert_queue.py@@ -129,7 +129,7 @@ class AlertQueue:self._active_alerts_lock.release()return- def add_alarm( self, alarm : Alarm ):+ def add_alarm( self, alarm : Alarm ) -> Alert:if alarm.alarm_level == AlarmLevel.NONE:raise ValueError( f'Alarm not alert-worthy: {alarm}' )try:@@ -140,13 +140,13 @@ class AlertQueue:alert.add_alarm( alarm = alarm )self._last_changed_datetime = datetimeproxy.now()logger.debug( f'Added to existing alert: alarm={alarm}, alert={alert}' )- return+ return alertnew_alert = Alert( first_alarm = alarm )self._alert_list.append( new_alert )self._last_changed_datetime = datetimeproxy.now()logger.debug( f'Added new alert: {new_alert}' )- return+ return new_alertfinally:self._active_alerts_lock.release()diff --git a/src/hi/apps/api/views.py b/src/hi/apps/api/views.pyindex 868b32f2..08255014 100644--- a/src/hi/apps/api/views.py+++ b/src/hi/apps/api/views.py@@ -10,8 +10,7 @@ from hi.apps.alert.alert_manager import AlertManagerimport hi.apps.common.datetimeproxy as datetimeproxyfrom hi.apps.config.settings_manager import SettingsManagerfrom hi.apps.monitor.status_display_manager import StatusDisplayManager-from hi.apps.monitor.status_display_data import StatusDisplayData-+from hi.apps.security.security_manager import SecurityManagerlogger = logging.getLogger(__name__)@@ -23,6 +22,7 @@ class StatusView( View ):LastServerTimestampAttr = 'lastTimestamp'AlertStatusDataAttr = 'alertData'CssClassUpdateMapAttr = 'cssClassUpdateMap'+ IdReplaceUpdateMapAttr = 'idReplaceUpdateMap'def get( self, request, *args, **kwargs ):@@ -44,20 +44,18 @@ class StatusView( View ):alert_status_data = AlertManager().get_alert_status_data(last_alert_status_datetime = last_server_datetime,)- entity_state_status_data_list = StatusDisplayManager().get_all_entity_state_status_data_list()- status_display_data_list = [ StatusDisplayData(x) for x in entity_state_status_data_list ]++ id_replace_map = dict()+ id_replace_map.update( SecurityManager().get_status_id_replace_map( request = request ) )css_class_update_map = dict()- for status_display_data in status_display_data_list:- if status_display_data.should_skip:- continue- css_class_update_map[status_display_data.css_class] = status_display_data.attribute_dict- continue-+ css_class_update_map.update( StatusDisplayManager().get_status_css_class_update_map() )+data = {self.ServerStartTimestampAttr: server_start_datetime.isoformat(),self.ServerTimestampAttr: server_datetime.isoformat(),self.AlertStatusDataAttr: alert_status_data.to_dict( request = request ),+ self.IdReplaceUpdateMapAttr: id_replace_map,self.CssClassUpdateMapAttr: css_class_update_map,}return HttpResponse(diff --git a/src/hi/apps/common/queues.py b/src/hi/apps/common/queues.pynew file mode 100644index 00000000..f028a436--- /dev/null+++ b/src/hi/apps/common/queues.py@@ -0,0 +1,129 @@+import collections+from datetime import datetime, timedelta+from typing import Optional, List++import hi.apps.common.datetimeproxy as datetimeproxy+++class RateLimitError(Exception):+ """Raised when rate limits are exceeded and no items can be dequeued."""+ pass+++class EmptyQueueError(Exception):+ """Raised when there are no items left in the queue."""+ pass+++class RateLimitedQueue:+ """+ A queue that emits items one at a time in a rate-limited manner.++ Note: This class is not thread-safe.+ """+ def __init__( self,+ label : str,+ emit_interval_secs : int = 60,+ max_queue_size : int = 30,+ unique_items_only : bool = True ):+ self._label = label+ self._emit_interval_secs = emit_interval_secs+ self._unique_items_only = unique_items_only+ self._queue = collections.deque( maxlen = max_queue_size )+ self._next_emit_datetime = datetimeproxy.min()+ return++ @property+ def label(self) -> str:+ return self._label++ def __len__(self) -> int:+ return len(self._queue)++ def get_next_item(self, cur_datetime: Optional[datetime] = None):+ """+ Returns the next item in the queue if rate limits allow. Raises exceptions otherwise.+ """+ if not self._queue:+ raise EmptyQueueError("No items in queue.")++ cur_datetime = cur_datetime or datetimeproxy.now()++ if cur_datetime < self._next_emit_datetime:+ raise RateLimitError("Rate limit reached.")++ self._next_emit_datetime = cur_datetime + timedelta( seconds = self._emit_interval_secs )+ return self._queue.popleft()++ def add_to_queue(self, item) -> bool:+ """+ Adds an item to the queue if unique_items_only is False or if the item is not already in the queue.+ """+ if self._unique_items_only and item in self._queue:+ return False+ self._queue.append(item)+ return True++ def clear_queue(self):+ self._queue.clear()+ return+++class ExponentialBackoffRateLimitedQueue:+ """+ A queue that emits items in a rate-limited manner with exponential backoff.++ Note: This class is not thread-safe.+ """+ INITIAL_EMIT_INTERVAL_SECS = 60+ EMIT_INTERVAL_BACKOFF_FACTOR = 2+ MAX_EMIT_INTERVAL_SECS = 3600++ def __init__( self,+ label : str,+ first_emit_datetime : datetime ):+ self._label = label+ self._queue = list()+ self._emit_delay_secs = 0+ self._next_emit_datetime = first_emit_datetime++ @property+ def label(self) -> str:+ return self._label++ def __len__(self) -> int:+ return len(self._queue)++ def get_queue_emissions( self, cur_datetime : datetime ) -> List:+ """+ Returns a list of items in the queue if rate limits allow. Emits all items that+ have been queued since the last emission.+ """+ if not self._queue or ( cur_datetime < self._next_emit_datetime ):+ return list()++ items = self._queue[:]+ self._queue.clear()++ time_since_last_emit = cur_datetime - self._next_emit_datetime+ if time_since_last_emit.total_seconds() > self.MAX_EMIT_INTERVAL_SECS:+ self._emit_delay_secs = 0++ self._emit_delay_secs = max(+ self._emit_delay_secs * self.EMIT_INTERVAL_BACKOFF_FACTOR+ if self._emit_delay_secs+ else self.INITIAL_EMIT_INTERVAL_SECS,++ self.MAX_EMIT_INTERVAL_SECS+ )+ self._next_emit_datetime = cur_datetime + timedelta( seconds = self._emit_delay_secs )++ return items++ def add_to_queue( self, item ):+ self._queue.append(item)+ return++ def clear_queue(self):+ self._queue.clear()+ returndiff --git a/src/hi/apps/config/enums.py b/src/hi/apps/config/enums.pyindex 529d6832..08f614fe 100644--- a/src/hi/apps/config/enums.py+++ b/src/hi/apps/config/enums.py@@ -153,16 +153,6 @@ class SubsystemAttributeType(LabeledEnum):True,'5',)- ALERTS_STARTUP_SECURITY_STATE = (- 'Startup Security State',- 'Security state to enter when system starts.',- SubsystemType.ALERTS,- AttributeValueType.ENUM,- 'hi.security.state',- True,- True,- SecurityState.default_value(),- )def __init__( self,label : str,diff --git a/src/hi/apps/event/event_manager.py b/src/hi/apps/event/event_manager.pyindex 26773e8a..f4f00211 100644--- a/src/hi/apps/event/event_manager.py+++ b/src/hi/apps/event/event_manager.py@@ -13,6 +13,7 @@ from hi.apps.alert.alert_manager import AlertManagerimport hi.apps.common.datetimeproxy as datetimeproxyfrom hi.apps.common.singleton import Singletonfrom hi.apps.control.controller_manager import ControllerManager+from hi.apps.security.security_manager import SecurityManagerfrom .models import AlarmAction, ControlAction, EventClause, EventDefinition, EventHistoryfrom .transient_models import Event, EntityStateTransition@@ -134,9 +135,13 @@ class EventManager(Singleton):async def _do_new_event_action( self, event_list : List[ Event ] ):+ current_security_level = SecurityManager().security_level+for event in event_list:for alarm_action in event.event_definition.alarm_actions.all():+ if alarm_action.security_level != current_security_level:+ continuealarm = event.to_alarm( alarm_action = alarm_action )await self._alert_manager.add_alarm( alarm )continuediff --git a/src/hi/apps/model_helper.py b/src/hi/apps/model_helper.pyindex a81759f5..10b34e75 100644--- a/src/hi/apps/model_helper.py+++ b/src/hi/apps/model_helper.py@@ -30,16 +30,16 @@ class HiModelHelper:EntityStateType.MULTVALUED,}- DEFAULT_CONNECTIVITY_EVENT_WINDOW_SECS = 60+ DEFAULT_CONNECTIVITY_EVENT_WINDOW_SECS = 180DEFAULT_CONNECTIVITY_ALARM_LIFETIME_SECS = 0- DEFAULT_OPEN_CLOSE_EVENT_WINDOW_SECS = 60- DEFAULT_OPEN_CLOSE_ALARM_LIFETIME_SECS = 180+ DEFAULT_OPEN_CLOSE_EVENT_WINDOW_SECS = 180+ DEFAULT_OPEN_CLOSE_ALARM_LIFETIME_SECS = 600- DEFAULT_MOVEMENT_EVENT_WINDOW_SECS = 60- DEFAULT_MOVEMENT_ALARM_LIFETIME_SECS = 180+ DEFAULT_MOVEMENT_EVENT_WINDOW_SECS = 180+ DEFAULT_MOVEMENT_ALARM_LIFETIME_SECS = 600- DEFAULT_BATTERY_EVENT_WINDOW_SECS = 60+ DEFAULT_BATTERY_EVENT_WINDOW_SECS = 180DEFAULT_BATTERY_ALARM_LIFETIME_SECS = 0@classmethoddiff --git a/src/hi/apps/monitor/monitor_manager.py b/src/hi/apps/monitor/monitor_manager.pyindex 5b6a1154..a1092242 100644--- a/src/hi/apps/monitor/monitor_manager.py+++ b/src/hi/apps/monitor/monitor_manager.py@@ -24,7 +24,7 @@ class MonitorManager( Singleton ):self._monitor_map[monitor.id] = monitorif not self._event_loop:- logger.error("No running event loop. Deferring monitor start")+ logger.warning("No running event loop. Deferring monitor start")returnif self._event_loop.is_running():diff --git a/src/hi/apps/monitor/status_display_manager.py b/src/hi/apps/monitor/status_display_manager.pyindex ad4fe185..20d5f1d1 100644--- a/src/hi/apps/monitor/status_display_manager.py+++ b/src/hi/apps/monitor/status_display_manager.py@@ -11,6 +11,7 @@ from hi.apps.sense.models import Sensorfrom hi.apps.sense.sensor_response_manager import SensorResponseManagerfrom hi.apps.sense.transient_models import SensorResponse+from .status_display_data import StatusDisplayDatafrom .transient_models import EntityStatusData, EntityStateStatusData@@ -24,7 +25,21 @@ class StatusDisplayManager( Singleton ):ttl = self.STATUS_VALUE_OVERRIDES_SECS,)return-++ def get_status_css_class_update_map( self ) -> Dict[ str, str ]:++ entity_state_status_data_list = self.get_all_entity_state_status_data_list()+ status_display_data_list = [ StatusDisplayData(x) for x in entity_state_status_data_list ]++ css_class_update_map = dict()+ for status_display_data in status_display_data_list:+ if status_display_data.should_skip:+ continue+ css_class_update_map[status_display_data.css_class] = status_display_data.attribute_dict+ continue++ return css_class_update_map+def get_all_entity_state_status_data_list( self ) -> List[ EntityStateStatusData ]:"""Gets the latest sensor responses for all EntityStates. Used by clientdiff --git a/src/hi/apps/notify/__init__.py b/src/hi/apps/notify/__init__.pynew file mode 100644index 00000000..e69de29bdiff --git a/src/hi/apps/notify/apps.py b/src/hi/apps/notify/apps.pynew file mode 100644index 00000000..6bee3274--- /dev/null+++ b/src/hi/apps/notify/apps.py@@ -0,0 +1,6 @@+from django.apps import AppConfig+++class NotifyConfig(AppConfig):+ default_auto_field = "django.db.models.BigAutoField"+ name = "hi.apps.notify"diff --git a/src/hi/apps/notify/email_sender.py b/src/hi/apps/notify/email_sender.pynew file mode 100644index 00000000..fab7be70--- /dev/null+++ b/src/hi/apps/notify/email_sender.py@@ -0,0 +1,97 @@+from dataclasses import dataclass, field+import logging+from typing import Dict, List++from django.conf import settings+from django.http.request import HttpRequest+from django.urls import reverse++from hi.apps.common.email_utils import send_html_email+from hi.apps.common.utils import hash_with_seed++from .models import UnsubscribedEmail++logger = logging.getLogger(__name__)+++class UnsubscribedEmailError(Exception):+ pass+++@dataclass+class EmailSenderData:+ request : HttpRequest+ subject_template_name : str+ message_text_template_name : str+ message_html_template_name : str+ to_email_address : str+ from_email_address : str = None # Defaults to system-wide FROM+ template_context : Dict[str, str] = field( default_factory = dict )+ files : List = None # For attachments+ non_blocking : bool = True++ # For testing (can use the unsubscribe link to test for the original intended "to" email)+ override_to_email_address : str = None+++class EmailSender:+ """ For sending a single email message. """++ def __init__( self, data : EmailSenderData ):+ self._data = data+ return++ def send( self):+ if UnsubscribedEmail.objects.exists_by_email( email = self._data.to_email_address ):+ raise UnsubscribedEmailError( f'Email address is unsubscribed for {self._data.to_email_address}' )++ context = self._data.template_context+ self._add_base_url( context = context )+ self._add_game_home_url( context = context )+ self._add_unsubscribe_url( context = context )++ effective_to_email_address = self._data.to_email_address+ if self._data.override_to_email_address:+ effective_to_email_address = self._data.override_to_email_address++ send_html_email(+ request = self._data.request,+ subject_template_name = self._data.subject_template_name,+ message_text_template_name = self._data.message_text_template_name,+ message_html_template_name = self._data.message_html_template_name,+ to_email_addresses = [ effective_to_email_address ],+ from_email_address = self._data.from_email_address,+ context = context,+ files = self._data.files,+ non_blocking = self._data.non_blocking,+ )+ return++ def _add_base_url( self, context : Dict ):+ if self._data.request:+ context['BASE_URL'] = self._data.request.build_absolute_uri('/')[:-1]+ else:+ context['BASE_URL'] = settings.BASE_URL_FOR_EMAIL_LINKS+ return++ def _add_game_home_url( self, context : Dict ):+ relative_url = reverse( 'game_home' )+ if self._data.request:+ context['USER_HOME_URL'] = self._data.request.build_absolute_uri( relative_url )+ elif "BASE_URL" in context:+ context['USER_HOME_URL'] = f'{context["BASE_URL"]}{relative_url}'+ return++ def _add_unsubscribe_url( self, context : Dict ):+ token = hash_with_seed( self._data.to_email_address )+ relative_url = reverse( 'user_unsubscribe_email',+ kwargs = {+ 'email': self._data.to_email_address,+ 'token': token,+ })+ if self._data.request:+ context['UNSUBSCRIBE_URL'] = self._data.request.build_absolute_uri( relative_url )+ elif "BASE_URL" in context:+ context['UNSUBSCRIBE_URL'] = f'{context["BASE_URL"]}{relative_url}'+ return+diff --git a/src/hi/apps/notify/managers.py b/src/hi/apps/notify/managers.pynew file mode 100644index 00000000..2db612f7--- /dev/null+++ b/src/hi/apps/notify/managers.py@@ -0,0 +1,16 @@+from django.db import models+++class UnsubscribedEmailManager(models.Manager):++ def exists_by_user( self, user ):+ if not user.email:+ return False+ return self.exists_by_email( email = user.email )++ def exists_by_email( self, email : str ):+ if not email:+ return False+ return self.filter( email__iexact = email ).exists()++diff --git a/src/hi/apps/notify/migrations/__init__.py b/src/hi/apps/notify/migrations/__init__.pynew file mode 100644index 00000000..e69de29bdiff --git a/src/hi/apps/notify/models.py b/src/hi/apps/notify/models.pynew file mode 100644index 00000000..673e6015--- /dev/null+++ b/src/hi/apps/notify/models.py@@ -0,0 +1,23 @@+from django.db import models++from . import managers+++class UnsubscribedEmail( models.Model ):++ objects = managers.UnsubscribedEmailManager()++ email = models.EmailField(+ unique = True,+ max_length = 254,+ verbose_name = 'Email',+ )++ created_datetime = models.DateTimeField(+ 'Created',+ auto_now_add = True,+ blank = True,+ db_index = True,+ )++diff --git a/src/hi/apps/notify/notification_queue.py b/src/hi/apps/notify/notification_queue.pynew file mode 100644index 00000000..2b8e4f82--- /dev/null+++ b/src/hi/apps/notify/notification_queue.py@@ -0,0 +1,72 @@+import logging+import threading++import hi.apps.common.datetimeproxy as datetimeproxy+from hi.apps.common.queues import ExponentialBackoffRateLimitedQueue++from .transient_models import Notification, NotificationItem++logger = logging.getLogger(__name__)+++class NotificationQueue:++ def __init__(self):+ self._queues_map = dict()+ self._queues_lock = threading.Lock()+ return++ def add_item( self, notification_item : NotificationItem ):+ try:+ self._queues_lock.acquire()++ if notification_item.signature not in self._queues_map:+ now_datetime = datetimeproxy.now()+ self._queues_map[notification_item.signature] = ExponentialBackoffRateLimitedQueue(+ label = notification_item.signature,+ first_emit_datetime = now_datetime,+ )+ queue = self._queues_map[notification_item.signature]+ queue.add_to_queue( notification_item )+ logger.debug( f'Added notification event to queue: {notification_item}' )++ except Exception as e:+ logger.exception( 'Problem adding notification to notification queue.', e )+ finally:+ self._queues_lock.release()+ return++ def check_for_notifications( self ):+ notifications_map = dict()+ try:+ self._queues_lock.acquire()++ now = datetimeproxy.now()+ for signature, queue in self._queues_map.items():+ notification_item_list = queue.get_queue_emissions( cur_datetime = now )+ if len(notification_item_list) < 1:+ continue+ notification = Notification(+ item_list = notification_item_list,+ )+ notifications_map[signature] = notification+ logger.debug( f'Notify queue "{signature}" emitted {len(notification_item_list)} items.' )+ continue++ except Exception as e:+ logger.exception( 'Problem with sending notifications.', e )+ finally:+ self._queues_lock.release()++ # We do not want to send notifications while we have the data lock+ try:+ for signature, notification in notifications_map.items():+ self.send_notifications( notification )+ continue+ except Exception as e:+ logger.exception( "Problem Sending notifications", e )+ return++ def send_notifications( self, notification : Notification ):+ pass+diff --git a/src/hi/apps/notify/transient_models.py b/src/hi/apps/notify/transient_models.pynew file mode 100644index 00000000..ec1eafd5--- /dev/null+++ b/src/hi/apps/notify/transient_models.py@@ -0,0 +1,13 @@+from dataclasses import dataclass+from typing import List+++@dataclass+class NotificationItem:+ signature : str+++@dataclass+class Notification:+ item_list : List[ NotificationItem ]+diff --git a/src/hi/apps/security/constants.py b/src/hi/apps/security/constants.pynew file mode 100644index 00000000..2dffb4a4--- /dev/null+++ b/src/hi/apps/security/constants.py@@ -0,0 +1,3 @@+class SecurityConstants:++ SECURITY_STATE_CONTROL_TEMPLATE_NAME = 'security/panes/security_state_control.html'diff --git a/src/hi/apps/security/enums.py b/src/hi/apps/security/enums.pyindex 6f8b8bf9..dbbc3a25 100644--- a/src/hi/apps/security/enums.py+++ b/src/hi/apps/security/enums.py@@ -30,17 +30,19 @@ class SecurityState( LabeledEnum ):that dictates what type of security events are relevant."""- DISABLED = ( 'Disabled' , '' , False )- DAY = ( 'Day' , '' , True )- NIGHT = ( 'Night' , '' , True )- AWAY = ( 'Away' , '' , False )+ DISABLED = ( 'Disabled' , '' , False , False )+ DAY = ( 'Day' , '' , True , False )+ NIGHT = ( 'Night' , '' , True , False )+ AWAY = ( 'Away' , '' , False , True )def __init__( self,- label : str,- description : str,- auto_change_allowed : bool ):+ label : str,+ description : str,+ auto_change_allowed : bool,+ uses_notifications : bool ):super().__init__( label, description )self.auto_change_allowed = auto_change_allowed # Can automated tasks change from this state+ self.uses_notifications = uses_notificationsreturn@@ -50,8 +52,8 @@ class SecurityStateAction( LabeledEnum ):that dictates what type of security events are relevant."""- DISABLE = ( 'Disable' , '' )- SET_DAY = ( 'Day' , '' )+ DISABLE = ( 'Disable' , '' )+ SET_DAY = ( 'Day' , '' )SET_NIGHT = ( 'Night' , '' )SET_AWAY = ( 'Away' , '' )- SNOOZE = ( 'Snooze' , '' )+ SNOOZE = ( 'Snooze' , '' )diff --git a/src/hi/apps/security/security_manager.py b/src/hi/apps/security/security_manager.pyindex 208f7047..960dc044 100644--- a/src/hi/apps/security/security_manager.py+++ b/src/hi/apps/security/security_manager.py@@ -1,12 +1,20 @@import loggingfrom threading import Timer, Lock+from typing import Dictfrom django.core.exceptions import BadRequest+from django.http import HttpRequest+from django.template.loader import get_template+import hi.apps.common.datetimeproxy as datetimeproxy+from hi.apps.common.redis_client import get_redis_clientfrom hi.apps.common.singleton import Singletonfrom hi.apps.config.enums import SubsystemAttributeTypefrom hi.apps.config.settings_manager import SettingsManager+from hi.constants import DIVID++from .constants import SecurityConstantsfrom .enums import SecurityLevel, SecurityState, SecurityStateActionfrom .transient_models import SecurityStatusData@@ -16,6 +24,10 @@ logger = logging.getLogger(__name__)class SecurityManager(Singleton):DEFAULT_TRANSITION_DELAY_SECS = 5 * 60+ SECURITY_STATE_LABEL_DELAYED_AWAY = 'Delayed'+ SECURITY_STATE_LABEL_SNOOZED = 'Snoozed'++ SECURITY_STATE_CACHE_KEY = 'hi.security.state'def __init_singleton__(self):self._security_state = SecurityState.DISABLED@@ -25,7 +37,11 @@ class SecurityManager(Singleton):self._delayed_security_state = Noneself._security_status_lock = Lock()- self._initialize_security_state()+ self._redis_client = get_redis_client()+ try:+ self._initialize_security_state()+ except Exception as e:+ logger.exception( 'Problem trying to initialize security state', e )return@property@@ -39,16 +55,33 @@ class SecurityManager(Singleton):def get_security_status_data(self) -> SecurityStatusData:try:self._security_status_lock.acquire()-+ current_security_state_label = self._security_state.label+ if self._delayed_security_state:+ if self._delayed_security_state == SecurityState.AWAY:+ current_security_state_label = self.SECURITY_STATE_LABEL_DELAYED_AWAY+ else:+ current_security_state_label = self.SECURITY_STATE_LABEL_SNOOZED+return SecurityStatusData(current_security_level = self._security_level,current_security_state = self._security_state,+ current_security_state_label = current_security_state_label,)finally:self._security_status_lock.release()return- def set_security_state( self, security_state_action : SecurityStateAction ):+ def get_status_id_replace_map( self, request : HttpRequest ) -> Dict[ str, str ]:++ security_status_data = self.get_security_status_data()+ context = { 'security_status_data': security_status_data }+ template = get_template( SecurityConstants.SECURITY_STATE_CONTROL_TEMPLATE_NAME )+ security_control_html_str = template.render( context, request = request )+ return {+ DIVID['SECURITY_STATE_CONTROL']: security_control_html_str,+ }++ def update_security_state_user( self, security_state_action : SecurityStateAction ):future_security_state = Nonedelay_mins_str = None@@ -88,7 +121,7 @@ class SecurityManager(Singleton):delay_secs = self.DEFAULT_TRANSITION_DELAY_SECSelse:delay_secs = 0-+self._update_security_state(immediate_security_state = immediate_security_state,future_security_state = future_security_state,@@ -137,6 +170,7 @@ class SecurityManager(Singleton):returndef _apply_delayed_state( self ):+ logger.debug( f'Applying delayed security state = {self._delayed_security_state}' )self.update_security_state_immediate( new_security_state = self._delayed_security_state )return@@ -203,7 +237,8 @@ class SecurityManager(Singleton):returnself._security_state = new_security_state-+ self._redis_client.set( self.SECURITY_STATE_CACHE_KEY, str( self._security_state ))+finally:if not lock_acquired:self._security_status_lock.release()@@ -218,12 +253,68 @@ class SecurityManager(Singleton):def _initialize_security_state(self):+ # This makes sure any DISABLED or AWAY state is preserved.+ previous_security_state_str = self._redis_client.get( self.SECURITY_STATE_CACHE_KEY )+ if previous_security_state_str:+ previous_security_state = SecurityState.from_name_safe( previous_security_state_str )+ if not previous_security_state.auto_change_allowed:+ self.update_security_state_immediate( new_security_state = previous_security_state )+ return++ # Else, revert to look at time of day to initialize the state.settings_manager = SettingsManager()- default_security_state_str = settings_manager.get_setting_value(- SubsystemAttributeType.ALERTS_STARTUP_SECURITY_STATE,++ tz_name = settings_manager.get_setting_value(+ SubsystemAttributeType.TIMEZONE,)- default_security_state_str = SecurityState.from_name_safe( default_security_state_str )- self.update_security_state_immediate( new_security_state = default_security_state_str )- return-+ day_start_time_of_day_str = settings_manager.get_setting_value(+ SubsystemAttributeType.ALERTS_DAY_START,+ )+ night_start_time_of_day_str = settings_manager.get_setting_value(+ SubsystemAttributeType.ALERTS_NIGHT_START,+ )++ current_datetime = datetimeproxy.now()+ start_of_day_datetime = current_datetime.replace( hour=0, minute=0, second=0, microsecond=0 )+ end_of_day_datetime = current_datetime.replace( hour=23, minute=59, second=59, microsecond=999999 )++ # Normally, one would expect the day start to be defined before the+ # night start, but we do not want to assume or enforce this. e.g.,+ # Someone working a night shift may have an inverted sense of the+ # lower security DAY hours.+ #+ if day_start_time_of_day_str < night_start_time_of_day_str:+ if datetimeproxy.is_time_of_day_in_interval(+ time_of_day_str = day_start_time_of_day_str,+ tz_name = tz_name,+ start_datetime = start_of_day_datetime,+ end_datetime = current_datetime ):+ initial_security_state = SecurityState.NIGHT+ elif datetimeproxy.is_time_of_day_in_interval(+ time_of_day_str = night_start_time_of_day_str,+ tz_name = tz_name,+ start_datetime = current_datetime,+ end_datetime = end_of_day_datetime ):+ initial_security_state = SecurityState.NIGHT+ else:+ initial_security_state = SecurityState.DAY++ else:+ if datetimeproxy.is_time_of_day_in_interval(+ time_of_day_str = night_start_time_of_day_str,+ tz_name = tz_name,+ start_datetime = start_of_day_datetime,+ end_datetime = current_datetime ):+ initial_security_state = SecurityState.DAY+ elif datetimeproxy.is_time_of_day_in_interval(+ time_of_day_str = day_start_time_of_day_str,+ tz_name = tz_name,+ start_datetime = current_datetime,+ end_datetime = end_of_day_datetime ):+ initial_security_state = SecurityState.DAY+ else:+ initial_security_state = SecurityState.NIGHT+ self.update_security_state_immediate( new_security_state = initial_security_state )+ return+diff --git a/src/hi/apps/security/security_monitor.py b/src/hi/apps/security/security_monitor.pyindex 850caade..e2a59f93 100644--- a/src/hi/apps/security/security_monitor.py+++ b/src/hi/apps/security/security_monitor.py@@ -13,7 +13,7 @@ logger = logging.getLogger(__name__)class SecurityMonitor( PeriodicMonitor ):- SECURITY_POLLING_INTERVAL_SECS = 10+ SECURITY_POLLING_INTERVAL_SECS = 5 * 60def __init__( self ):super().__init__(diff --git a/src/hi/apps/security/templates/security/panes/security_state_control.html b/src/hi/apps/security/templates/security/panes/security_state_control.htmlindex 326283c6..17f647e5 100644--- a/src/hi/apps/security/templates/security/panes/security_state_control.html+++ b/src/hi/apps/security/templates/security/panes/security_state_control.html@@ -1,8 +1,8 @@-<div id="hi-security-state-control">+<div id="{{ DIVID.SECURITY_STATE_CONTROL }}"><div class="dropdown"><button class="btn btn-secondary btn-control dropdown-toggle" type="button"id="hi-location-menu" data-toggle="dropdown">- Security: {{ security_status_data.current_security_state.label }}+ Security: {{ security_status_data.current_security_state_label }}<span class="caret"></span></button><div class="dropdown-menu"@@ -13,7 +13,7 @@{% endif %}<a role="menuitem" class="dropdown-item plain"href="{% url 'security_state_action' action=value %} "- data-async="#hi-security-state-control" data-mode="replace">+ data-async="#{{ DIVID.SECURITY_STATE_CONTROL }}" data-mode="replace">{{ label }}</a>{% empty %}diff --git a/src/hi/apps/security/transient_models.py b/src/hi/apps/security/transient_models.pyindex 4dedbec3..be9dad04 100644--- a/src/hi/apps/security/transient_models.py+++ b/src/hi/apps/security/transient_models.py@@ -9,9 +9,14 @@ class SecurityStatusData:current_security_state : SecurityStatecurrent_security_level : SecurityLevel- security_state_action_choices : List[ Tuple[ str, str ]] = None+ current_security_state_label : str = Nonedef __post_init__(self):- self.security_state_action_choices = SecurityStateAction.choices()+ if not self.current_security_state_label:+ self.current_security_state_label = self.current_security_state.labelreturn++ @property+ def security_state_action_choices(self) -> List[ Tuple[ str, str ]]:+ return SecurityStateAction.choices()diff --git a/src/hi/apps/security/views.py b/src/hi/apps/security/views.pyindex 90cac125..23573c55 100644--- a/src/hi/apps/security/views.py+++ b/src/hi/apps/security/views.py@@ -2,12 +2,13 @@ from django.core.exceptions import BadRequestfrom django.shortcuts import renderfrom django.views.generic import View+from .constants import SecurityConstantsfrom .enums import SecurityStateActionfrom .security_manager import SecurityManagerclass SecurityStateActionView( View ):-+def get( self, request, *args, **kwargs ):action_str = kwargs.get( 'action' )try:@@ -16,9 +17,9 @@ class SecurityStateActionView( View ):raise BadRequest( 'Bad action value.' )security_manager = SecurityManager()- security_manager.set_security_state( security_state_action = security_state_action )+ security_manager.update_security_state_user( security_state_action = security_state_action )context = {'security_status_data': security_manager.get_security_status_data(),}- return render( request, 'security/panes/security_state_control.html', context )+ return render( request, SecurityConstants.SECURITY_STATE_CONTROL_TEMPLATE_NAME, context )diff --git a/src/hi/constants.py b/src/hi/constants.pyindex 2a56612c..8d4e6ed0 100644--- a/src/hi/constants.py+++ b/src/hi/constants.py@@ -55,4 +55,5 @@ DIVID = {'ALERT_BANNER_CONTAINER': 'hi-alert-banner-container','ALERT_BANNER_CONTENT': 'hi-alert-banner-content',+ 'SECURITY_STATE_CONTROL': 'hi-security-state-control',}diff --git a/src/hi/settings/base.py b/src/hi/settings/base.pyindex 2334ca0f..1876cb9b 100644--- a/src/hi/settings/base.py+++ b/src/hi/settings/base.py@@ -144,6 +144,7 @@ INSTALLED_APPS = ['hi.apps.sense','hi.apps.control','hi.apps.event',+ 'hi.apps.notify','hi.apps.alert','hi.apps.security','hi.apps.edit',@@ -328,3 +329,35 @@ CACHES = {"KEY_PREFIX": f'main:{REDIS_KEY_PREFIX}',}}++#====================+# Transactional Emails++SITE_DOMAIN = 'pomdp.com'++EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'++EMAIL_SUBJECT_PREFIX = "%s " % get_env_variable('HI_EMAIL_SUBJECT_PREFIX')+DEFAULT_FROM_EMAIL = get_env_variable('HI_DEFAULT_FROM_EMAIL')+SERVER_EMAIL = get_env_variable('HI_SERVER_EMAIL')+FROM_EMAIL_NAME = "Home Information"++# Normal Settings+EMAIL_HOST = get_env_variable('HI_EMAIL_HOST')+EMAIL_PORT = int(get_env_variable('HI_EMAIL_PORT'))+EMAIL_HOST_USER = get_env_variable('HI_EMAIL_HOST_USER')+EMAIL_HOST_PASSWORD = get_env_variable('HI_EMAIL_HOST_PASSWORD')++if get_env_variable('HI_EMAIL_USE_TLS').lower() == 'true':+ EMAIL_USE_TLS = True+ EMAIL_USE_SSL = False+elif get_env_variable('HI_EMAIL_USE_SSL').lower() == 'true':+ EMAIL_USE_TLS = False+ EMAIL_USE_SSL = True+else:+ EMAIL_USE_TLS = False+ EMAIL_USE_SSL = False++# Override this for test sites+BASE_URL_FOR_EMAIL_LINKS = 'https://{SITE_DOMAIN}'+diff --git a/src/hi/static/js/status.js b/src/hi/static/js/status.jsindex a2f27dd1..de6b4ca2 100644--- a/src/hi/static/js/status.js+++ b/src/hi/static/js/status.js@@ -28,6 +28,7 @@const ServerStartTimestampAttr = 'startTimestamp';const ServerTimestampAttr = 'timestamp';const LastServerTimestampAttr = 'lastTimestamp';+ const IdReplaceUpdateMapAttr = 'idReplaceUpdateMap';const CssClassUpdateMapAttr = 'cssClassUpdateMap';const AlertStatusDataAttr = 'alertData';@@ -119,6 +120,9 @@if ( AlertStatusDataAttr in respObj ) {handleAlertStatusData( respObj[AlertStatusDataAttr] );}+ if ( IdReplaceUpdateMapAttr in respObj ) {+ handleIdReplacements( respObj[IdReplaceUpdateMapAttr] );+ }if ( CssClassUpdateMapAttr in respObj ) {handleCssClassUpdates( respObj[CssClassUpdateMapAttr] );}@@ -166,6 +170,13 @@}}+ function handleIdReplacements( replaceMap ) {+ for ( let html_id in replaceMap ) {+ let replacementContent = replaceMap[html_id];+ $(`#${html_id}`).replaceWith( replacementContent );+ }+ }+function handleCssClassUpdates( updateMap ) {for ( let cssClass in updateMap ) {