pywemo 1.2.1__py3-none-any.whl → 1.3.1__py3-none-any.whl

pywemo/ouimeaux_device/api/xsd/device.py

@@ -6,7 +6,7 @@
 # pylint: skip-file
 
 #
-# Generated  by generateDS.py version 2.42.2.
+# Generated  by generateDS.py version 2.43.2.
 # Python [sys.version]
 #
 # Command line options:
@@ -1219,10 +1219,11 @@ def _cast(typ, value):
 
 
 #
-# Data representation classes.
+# Start enum classes
+#
+#
+# Start data representation classes
 #
-
-
 class root(GeneratedsSuper):
     __hash__ = GeneratedsSuper.__hash__
     subclass = None
@@ -3635,6 +3636,11 @@ class serviceType(GeneratedsSuper):
 # end class serviceType
 
 
+#
+# End data representation classes.
+#
+
+
 GDSClassesMapping = {}
 
 

pywemo/ouimeaux_device/api/xsd/service.py

@@ -6,7 +6,7 @@
 # pylint: skip-file
 
 #
-# Generated  by generateDS.py version 2.42.2.
+# Generated  by generateDS.py version 2.43.2.
 # Python [sys.version]
 #
 # Command line options:
@@ -1219,10 +1219,11 @@ def _cast(typ, value):
 
 
 #
-# Data representation classes.
+# Start enum classes
+#
+#
+# Start data representation classes
 #
-
-
 class scpd(GeneratedsSuper):
     __hash__ = GeneratedsSuper.__hash__
     subclass = None
@@ -3593,6 +3594,11 @@ class retvalType(GeneratedsSuper):
 # end class retvalType
 
 
+#
+# End data representation classes.
+#
+
+
 GDSClassesMapping = {}
 
 

pywemo/ouimeaux_device/dimmer.py

@@ -38,6 +38,10 @@ class Dimmer(Switch):
 
     def get_state(self, force_update: bool = False) -> int:
         """Update the state & brightness for the Dimmer."""
+        force_update = force_update or (
+            self._brightness is None
+            and "brightness" not in self.basic_state_params
+        )
         state = super().get_state(force_update)
         if force_update or self._brightness is None:
             try:

pywemo/subscribe.py

@@ -37,8 +37,10 @@ import collections
 import logging
 import os
 import sched
+import secrets
 import threading
 import time
+import warnings
 from collections.abc import Iterable, MutableMapping
 from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
 from typing import Any, Callable
@@ -140,7 +142,7 @@ class Subscription:
     scheduler_active: bool = True
     """
     Controls whether or not the subscription will continue to be periodically
-    scheduled by the Scheduler. Set to False when the device us unregistered.
+    scheduled by the Scheduler. Set to False when the device is unregistered.
     """
 
     expiration_time: float = 0.0
@@ -171,6 +173,9 @@ class Subscription:
     service_name: str
     """Name of the subscription endpoint service."""
 
+    path: str
+    """Unique path used to for the subscription callback."""
+
     def __init__(
         self, device: Device, callback_port: int, service_name: str
     ) -> None:
@@ -178,6 +183,7 @@ class Subscription:
         self.device = device
         self.callback_port = callback_port
         self.service_name = service_name
+        self.path = f"/sub/{service_name}/{secrets.token_urlsafe(24)}"
 
     def __repr__(self) -> str:
         """Return a string representation of the Subscription."""
@@ -221,6 +227,16 @@ class Subscription:
 
         return self._update_subscription(response.headers)
 
+    def cancel(self) -> None:
+        """Cancel a subscription."""
+        if self.expiration_time > time.time():
+            try:
+                self._unsubscribe()
+            except requests.RequestException:
+                pass
+
+        self._reset_subscription()
+
     def _subscribe(self) -> requests.Response:
         """Start/renew a subscription with a UPnP SUBSCRIBE request.
 
@@ -290,11 +306,6 @@ class Subscription:
         """URL for the UPnP subscription endoint."""
         return self.device.services[self.service_name].eventSubURL
 
-    @property
-    def path(self) -> str:
-        """Path for the callback to disambiguate multiple subscriptions."""
-        return f"/sub/{self.service_name}"
-
     @property
     def is_subscribed(self) -> bool:
         """Return True if the subscription is active, False otherwise.
@@ -346,6 +357,8 @@ def _cancel_events(
             # event might execute and be removed from queue
             # concurrently.  Safe to ignore
             pass
+        if subscription.scheduler_active:
+            scheduler.enter(0, 0, subscription.cancel)
         # Prevent the subscription from being scheduled again.
         subscription.scheduler_active = False
         subscription.scheduler_event = None
@@ -407,7 +420,16 @@ class RequestHandler(BaseHTTPRequestHandler):
         """Handle subscription responses received from devices."""
         sender_ip, _ = self.client_address
         outer = self.server.outer
-        if (device := outer.devices.get(sender_ip)) is None:
+        # Security consideration: Given that the subscription paths are
+        # randomized, I considered removing the host/IP check below. However,
+        # since these requests are not encrypted, it is possible for someone
+        # to observe the random URL path. I therefore have kept the host/IP
+        # check as a defense-in-depth strategy for preventing the device state
+        # from being changed by someone who could observe the http requests.
+        if (
+            # pylint: disable=protected-access
+            subscription := outer._subscription_paths.get(self.path)
+        ) is None or subscription.device.host != sender_ip:
             LOG.warning(
                 "Received %s event for unregistered device %s",
                 self.path,
@@ -418,7 +440,7 @@ class RequestHandler(BaseHTTPRequestHandler):
             for propnode in doc.findall(f"./{NS}property"):
                 for property_ in list(propnode):
                     outer.event(
-                        device,
+                        subscription.device,
                         property_.tag,
                         property_.text or "",
                         path=self.path,
@@ -440,14 +462,19 @@ class RequestHandler(BaseHTTPRequestHandler):
         if self.path.endswith("/upnp/control/basicevent1"):
             sender_ip, _ = self.client_address
             outer = self.server.outer
-            if (device := outer.devices.get(sender_ip)) is None:
-                LOG.warning(
-                    "Received event for unregistered device %s", sender_ip
-                )
-            else:
+            for (
+                device
+            ) in outer._subscriptions:  # pylint: disable=protected-access
+                if device.host != sender_ip:
+                    continue
                 doc = self._get_xml_from_http_body()
                 if binary_state := doc.findtext(".//BinaryState"):
                     outer.event(device, EVENT_TYPE_LONG_PRESS, binary_state)
+                break
+            else:
+                LOG.warning(
+                    "Received event for unregistered device %s", sender_ip
+                )
             action = self.headers.get("SOAPACTION", "")
             response = SOAP_ACTION_RESPONSE.get(
                 action, ERROR_SOAP_ACTION_RESPONSE
@@ -526,7 +553,6 @@ class SubscriptionRegistry:  # pylint: disable=too-many-instance-attributes
 
     def __init__(self, requested_port: int | None = None) -> None:
         """Create the subscription registry object."""
-        self.devices: dict[str, Device] = {}
         self._callbacks: dict[
             Device, list[tuple[str | None, SubscriberCallback]]
         ] = collections.defaultdict(list)
@@ -535,6 +561,7 @@ class SubscriptionRegistry:  # pylint: disable=too-many-instance-attributes
         self._event_thread: threading.Thread | None = None
         self._event_thread_cond = threading.Condition()
         self._subscriptions: dict[Device, list[Subscription]] = {}
+        self._subscription_paths: dict[str, Subscription] = {}
 
         def sleep(secs: float) -> None:
             with self._event_thread_cond:
@@ -559,14 +586,13 @@ class SubscriptionRegistry:  # pylint: disable=too-many-instance-attributes
             return
 
         LOG.info("Subscribing to events from %r", device)
-        self.devices[device.host] = device
-
         with self._event_thread_cond:
             subscriptions = self._subscriptions[device] = []
             for service in self.subscription_service_names:
                 if service in device.services:
                     subscription = Subscription(device, self.port, service)
                     subscriptions.append(subscription)
+                    self._subscription_paths[subscription.path] = subscription
                     self._schedule(0, subscription)
             self._event_thread_cond.notify()
 
@@ -580,13 +606,11 @@ class SubscriptionRegistry:  # pylint: disable=too-many-instance-attributes
 
         with self._event_thread_cond:
             # Remove any events, callbacks, and the device itself
-            if device in self._callbacks:
-                del self._callbacks[device]
-            if device in self._subscriptions:
-                _cancel_events(self._sched, self._subscriptions[device])
-                del self._subscriptions[device]
-            if device.host in self.devices:
-                del self.devices[device.host]
+            self._callbacks.pop(device, None)
+            subscriptions = self._subscriptions.pop(device, [])
+            _cancel_events(self._sched, subscriptions)
+            for subscription in subscriptions:
+                del self._subscription_paths[subscription.path]
             self._event_thread_cond.notify()
 
     def _resubscribe(self, subscription: Subscription, retry: int = 0) -> None:
@@ -646,10 +670,10 @@ class SubscriptionRegistry:  # pylint: disable=too-many-instance-attributes
         )
         if path:
             # Update the event_received property for the subscription.
-            for subscription in self._subscriptions.get(device, []):
-                if subscription.path == path:
-                    subscription.event_received = True
-                    break
+            if (
+                subscription := self._subscription_paths.get(path)
+            ) is not None:
+                subscription.event_received = True
             else:
                 LOG.warning(
                     "Received unexpected subscription path (%s) for device %s",
@@ -745,3 +769,14 @@ class SubscriptionRegistry:  # pylint: disable=too-many-instance-attributes
                 while not self._exiting and self._sched.empty():
                     self._event_thread_cond.wait(10)
             self._sched.run()
+
+    @property
+    def devices(self) -> dict[str, Device]:
+        """Deprecated mapping of IP address to device."""
+        warnings.warn(
+            "The devices dict is deprecated "
+            "and will be removed in a future release.",
+            DeprecationWarning,
+            stacklevel=1,
+        )
+        return {device.host: device for device in self._subscriptions}

{pywemo-1.2.1.dist-info → pywemo-1.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pywemo
-Version: 1.2.1
+Version: 1.3.1
 Summary: Lightweight Python module to discover and control WeMo devices
 Home-page: https://github.com/pywemo/pywemo
 License: MIT

{pywemo-1.2.1.dist-info → pywemo-1.3.1.dist-info}/RECORD

@@ -14,15 +14,15 @@ pywemo/ouimeaux_device/api/service.py,sha256=qeNThZXVPEuRIM9Xou8aVk34Up8F1ei1O6E
 pywemo/ouimeaux_device/api/wemo_services.py,sha256=z5wbX10ok2ltdpucJr0H6Cy9CoIoCb3vfbkeMdWt8qc,912
 pywemo/ouimeaux_device/api/wemo_services.pyi,sha256=Amybn9pfO-EJUge6gYPeADw-_iQYmqfP_fSB1mlkpQk,6838
 pywemo/ouimeaux_device/api/xsd/__init__.py,sha256=xv1RKXPNighlx3L88tkedXQfSDYI5ifA8zPmSiXdiyY,60
-pywemo/ouimeaux_device/api/xsd/device.py,sha256=6NvcCAkYEkG7bZgBtXtxdIxyAxOkbZPpTR-pC0hXDAw,126828
+pywemo/ouimeaux_device/api/xsd/device.py,sha256=CFxdcT6s9yVECitIM2AI-63XaUqbc2zx3XF1a1iXjBQ,126897
 pywemo/ouimeaux_device/api/xsd/device.xsd,sha256=D4yqFUD-kDXUXWz3Y2No_XTiNRY2TbxecjV5wEbh5Gw,4305
-pywemo/ouimeaux_device/api/xsd/service.py,sha256=SQ_ZhVXxRMILjhq-zTgMOiGN9FFZMR94GDlpbp6TwJo,122520
+pywemo/ouimeaux_device/api/xsd/service.py,sha256=OE_VA1zAp8boxGQ-9qa9JyMPC3Lw6tq2AGb01alDMis,122589
 pywemo/ouimeaux_device/api/xsd/service.xsd,sha256=Hqzc1ovP7q8SbW-IDN7ZaLQCN_vP50Qrqx7PDAbDAyQ,3526
 pywemo/ouimeaux_device/api/xsd_types.py,sha256=pUzyktm26SK6nnwAJYVINkYx4tLFE0MDK4lOaLIOZ5A,7275
 pywemo/ouimeaux_device/bridge.py,sha256=yI_JCCqyO6Ye_Ol3wDtBuvVUuX82V4c1StnFEsqzMd8,18975
 pywemo/ouimeaux_device/coffeemaker.py,sha256=B80yKYZCJKr9tC-Zf7Bc4YlHYj74jAq2GLANsL_TqQo,3345
 pywemo/ouimeaux_device/crockpot.py,sha256=PXPvFRfwNXyvkhkQJl3Hcdf1VEpazJ2DGOrfa5WGKpQ,5035
-pywemo/ouimeaux_device/dimmer.py,sha256=RVAp6G_9K6zyVR_pLtadmoSMCFxI2WK2aME99LEOf7U,2250
+pywemo/ouimeaux_device/dimmer.py,sha256=k_GJIcMygOZ2VjzSlJslYh3T0X3BxyakcyNecvi4gA8,2398
 pywemo/ouimeaux_device/humidifier.py,sha256=dnqwTOlWun1crsBR8E5H-oMF0851qz2K_o3cH6qVDhs,7162
 pywemo/ouimeaux_device/insight.py,sha256=EVcFWZN2UVNj4vA4xrDk7FdbVvnELSdKg9OJ200BT4w,6125
 pywemo/ouimeaux_device/lightswitch.py,sha256=_lbaLmxPIKhWLmjEhZ6NBSzFHDvg9sW0Z3Dn4PiO5mw,328
@@ -32,9 +32,9 @@ pywemo/ouimeaux_device/outdoor_plug.py,sha256=M8AmM_eaU43JaIPF1F-NGoY-zaE99JQucN
 pywemo/ouimeaux_device/switch.py,sha256=VMLyoXRwOIFbjnwR2GcFRzwkzDNqVawu5z3f_9M7cB8,1023
 pywemo/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pywemo/ssdp.py,sha256=koDFc8INDuWzPNWftnfCOpSUz4t3Q9giB6GeSbMOZVw,12531
-pywemo/subscribe.py,sha256=jOs3NRov_FC5O44ILJ7niVqBFMIwwHB4ScQVJOZp1I4,28315
+pywemo/subscribe.py,sha256=j_zbbgnWZZRPSE5fmpsX1sIPGbCxzGQmNIiI1GZ_dvA,29780
 pywemo/util.py,sha256=LHOD-MSIkl78jElP5uFnZVJ9dBovhYQ_2Gx2JRlbgxs,4417
-pywemo-1.2.1.dist-info/LICENSE,sha256=uEhWS0rrkJ-nVSDY4avaxJrszZOBwR_hIOiBVkd4Sk8,2831
-pywemo-1.2.1.dist-info/METADATA,sha256=bLVhIZAdBLB8ZULuZwUklQNPTFq6ntccwoYc4aUuzk4,9084
-pywemo-1.2.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-pywemo-1.2.1.dist-info/RECORD,,
+pywemo-1.3.1.dist-info/LICENSE,sha256=uEhWS0rrkJ-nVSDY4avaxJrszZOBwR_hIOiBVkd4Sk8,2831
+pywemo-1.3.1.dist-info/METADATA,sha256=YpeYKC4GnPfxuERaj4FclOLWzI9X1e3yTHE_WpYbuoI,9084
+pywemo-1.3.1.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+pywemo-1.3.1.dist-info/RECORD,,

{pywemo-1.2.1.dist-info → pywemo-1.3.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.6.1
+Generator: poetry-core 1.7.0
 Root-Is-Purelib: true
 Tag: py3-none-any