ControlPoint: subscriptions

Author: pschatzmann

examples/control-point-media-renderer/control-point-media-renderer.ino

@@ -34,6 +34,9 @@ void setup() {
 
   setupWifi();
 
+  // Provide local URL for notifications
+  renderer.setLocalURL(WiFi.localIP(), port, "/events");
+
   // Start control point to discover devices: 10 min
   if (!renderer.begin(1000, 10 * 60 * 1000)) {
     Serial.println("No devices found");
@@ -46,8 +49,9 @@ void setup() {
 
   // Use first discovered renderer device
   renderer.setDeviceIndex(0);
+
   // Subscribe to event notifications
-  renderer.setNotificationsActive(true);
+  renderer.subscribe();
 
   // Starting playback
   Serial.println("Starting playback...");

src/dlna/clients/DLNAControlPoint.h

@@ -5,11 +5,11 @@
 #include "Client.h"
 #include "DLNAControlPointRequestParser.h"
 #include "basic/Url.h"
+#include "dlna/clients/IControlPoint.h"
+#include "dlna/clients/SubscriptionMgrControlPoint.h"
 #include "dlna/common/DLNADeviceInfo.h"
 #include "dlna/common/Schedule.h"
 #include "dlna/common/Scheduler.h"
-#include "dlna/clients/IControlPoint.h"
-#include "dlna/clients/SubscriptionMgrControlPoint.h"
 #include "dlna/devices/DLNADevice.h"
 #include "dlna/xml/XMLDeviceParser.h"
 #include "dlna/xml/XMLParser.h"
@@ -87,10 +87,11 @@ class DLNAControlPoint : public IControlPoint {
 
   /// Defines the local url (needed for subscriptions)
   void setLocalURL(Url url) override { local_url = url; }
-  void setLocalURL(IPAddress url, int port=9001, const char* path="") override {
+  void setLocalURL(IPAddress url, int port = 9001,
+                   const char* path = "") override {
     char buffer[200];
-    snprintf(buffer, sizeof(buffer), "http://%s:%d%s", url.toString().c_str(), port,
-             path);
+    snprintf(buffer, sizeof(buffer), "http://%s:%d%s", url.toString().c_str(),
+             port, path);
     local_url.setUrl(buffer);
   }
 
@@ -118,7 +119,6 @@ class DLNAControlPoint : public IControlPoint {
   void setHttpServer(IHttpServer& server) override {
     DlnaLogger.log(DlnaLogLevel::Debug, "DLNAControlPointMgr::setHttpServer");
     p_http_server = &server;
-    subscription_mgr.setHttpServer(server);
   }
 
   /// Register a callback that will be invoked when parsing SOAP/Action results
@@ -161,14 +161,6 @@ class DLNAControlPoint : public IControlPoint {
     is_active = true;
     setTransports(http, udp);
 
-    if (p_http_server) {
-      // handle server requests
-      if (!p_http_server->begin()) {
-        DlnaLogger.log(DlnaLogLevel::Error, "HttpServer begin failed");
-        return false;
-      }
-    }
-
     // setup multicast UDP
     if (!(p_udp->begin(DLNABroadcastAddress))) {
       DlnaLogger.log(DlnaLogLevel::Error, "UDP begin failed");
@@ -200,22 +192,6 @@ class DLNAControlPoint : public IControlPoint {
       loop();
     }
 
-    // setup subscription manager
-    if (local_url && p_http_server) {
-      subscription_mgr.setup(http, udp, local_url, getDevice());
-    } else {
-      if (!local_url && !p_http_server) {
-        DlnaLogger.log(DlnaLogLevel::Info,
-                       "No local URL and no HttpServer for subscriptions");
-      } else if (!local_url) {
-        DlnaLogger.log(DlnaLogLevel::Warning,
-                       "No local URL for subscriptions");
-      } else {
-        DlnaLogger.log(DlnaLogLevel::Warning,
-                       "No HttpServer for subscriptions");
-      }
-    }
-
     // If we exited early because a device was found, deactivate the MSearch
     // schedule so it will stop repeating. The scheduler will clean up
     // inactive schedules on its next pass.
@@ -236,6 +212,36 @@ class DLNAControlPoint : public IControlPoint {
     p_udp = &udp;
   }
 
+  /// Subscribes to event notifications for all services of the selected device
+  bool subscribe() {
+    if (devices.size() == 0) return false;
+    if (!getDevice()) return false;
+
+    // setup subscription manager
+    if (local_url && p_http_server) {
+      if (p_http_server) {
+        // handle server requests
+        if (!p_http_server->begin()) {
+          DlnaLogger.log(DlnaLogLevel::Error, "HttpServer begin failed");
+          return false;
+        }
+      }
+      subscription_mgr.setHttpServer(*p_http_server);
+      subscription_mgr.setup(*p_http, *p_udp, local_url, getDevice());
+      return true;
+    }
+    
+    if (!local_url && !p_http_server) {
+      DlnaLogger.log(DlnaLogLevel::Info,
+                     "No local URL and no HttpServer for subscriptions");
+    } else if (!local_url) {
+      DlnaLogger.log(DlnaLogLevel::Warning, "No local URL for subscriptions");
+    } else {
+      DlnaLogger.log(DlnaLogLevel::Warning, "No HttpServer for subscriptions");
+    }
+    return false;
+  }
+
   /// Stops the processing and releases the resources
   void end() override {
     DlnaLogger.log(DlnaLogLevel::Debug, "DLNAControlPointMgr::end");
@@ -365,6 +371,8 @@ class DLNAControlPoint : public IControlPoint {
   /// Provides the device information of the actually selected device
   DLNADeviceInfo& getDevice() override {
     DlnaLogger.log(DlnaLogLevel::Debug, "DLNAControlPointMgr::getDevice");
+    if (default_device_idx < 0 || default_device_idx >= devices.size())
+      return NO_DEVICE;
     return devices[default_device_idx];
   }
 
@@ -672,7 +680,8 @@ class DLNAControlPoint : public IControlPoint {
   bool matches(const char* usn) {
     if (search_target == nullptr || *search_target == '\0') return true;
     if (StrView(search_target).equals("ssdp:all")) return true;
-    return StrView(usn).contains(search_target) || StrView(search_target).contains(usn);
+    return StrView(usn).contains(search_target) ||
+           StrView(search_target).contains(usn);
   }
 
   /// processes a bye-bye message
@@ -776,7 +785,8 @@ class DLNAControlPoint : public IControlPoint {
                    "Service control_url: %s, device base: %s",
                    StrView(service.control_url).c_str(),
                    StrView(device.getBaseURL()).c_str());
-    Url post_url = getUrl(device, service.control_url, url_buffer, DLNA_MAX_URL_LEN);
+    Url post_url =
+        getUrl(device, service.control_url, url_buffer, DLNA_MAX_URL_LEN);
     DlnaLogger.log(DlnaLogLevel::Info, "POST URL computed: %s", post_url.url());
 
     // send HTTP POST and collect/handle response. If the caller provided an

src/dlna/clients/DLNAControlPointMediaRenderer.h

@@ -56,6 +56,13 @@ class DLNAControlPointMediaRenderer {
   void setDeviceTypeFilter(const char* filter) {
     device_type_filter = filter ? filter : device_type_filter_default;
   }
+  /// Defines the local URL for the control point
+  void setLocalURL(Url url) { p_mgr->setLocalURL(url); }
+
+  /// Defines the local URL for the control point
+  void setLocalURL(IPAddress url, int port=9001, const char* path="")  {
+    this->p_mgr->setLocalURL(url, port, path);
+  }
 
   /**
    * @brief Begin discovery and processing
@@ -105,6 +112,10 @@ class DLNAControlPointMediaRenderer {
    */
   void setDeviceIndex(int idx) { device_index = idx; }
 
+  /// Subscribe to event notifications: call after selecting the device
+  bool subscribe() { return p_mgr->subscribe(); }
+
+
   /// Setter for the HTTP wrapper used for subscriptions and callbacks
   void setHttp(IHttpRequest& http) { p_http = &http; }
 

src/dlna/clients/DLNAControlPointMediaServer.h

@@ -40,6 +40,14 @@ class DLNAControlPointMediaServer {
   /// Set the control point manager instance (required before using helper)
   void setDLNAControlPoint(DLNAControlPoint& m) { p_mgr = &m; }
 
+   /// Defines the local URL for the control point
+  void setLocalURL(Url url) { p_mgr->setLocalURL(url); }
+
+  /// Defines the local URL for the control point
+  void setLocalURL(IPAddress url, int port=9001, const char* path="")  {
+    this->p_mgr->setLocalURL(url, port, path);
+  }
+ 
   /**
    * @brief Begin discovery and processing (forwards to underlying control
    * point)
@@ -103,6 +111,9 @@ class DLNAControlPointMediaServer {
    */
   void setDeviceIndex(int idx) { p_mgr->setDeviceIndex(idx); }
 
+  bool subscribe() { return p_mgr->subscribe(); }  /// Subscribe to event notifications: call after selecting the device
+
+
   /// Activate/deactivate subscription notifications
   void setNotificationsActive(bool flag) {
     p_mgr->setNotificationsActive(flag);

src/dlna/clients/SubscriptionMgrControlPoint.h

@@ -67,6 +67,7 @@ class SubscriptionMgrControlPoint {
     p_local_url = &localCallbackUrl;
     p_device = &device;
     is_setup = true;
+    attachHttpServer(*p_http_server);
     // Initialize event subscription state
     setNotificationsActive(event_subscription_active);
   }
@@ -84,7 +85,6 @@ class SubscriptionMgrControlPoint {
   void setHttpServer(IHttpServer& server) {
     DlnaLogger.log(DlnaLogLevel::Debug, "DLNAControlPointMgr::setHttpServer");
     p_http_server = &server;
-    attachHttpServer(server);
   }
 
   /**
@@ -328,14 +328,9 @@ class SubscriptionMgrControlPoint {
     DlnaLogger.log(DlnaLogLevel::Debug,
                    "DLNAControlPointMgr::attachHttpServer");
     p_http_server = &server;
-    // register handler at the local path. If local_url is not set we use
-    // a default path "/dlna/events"
-    const char* path = "/dlna/events";
-    if (p_local_url && !StrView(p_local_url->url()).isEmpty())
-      path = p_local_url->path();
-
     void* ctx[1];
     ctx[0] = this;
+    const char* path = p_local_url->path();
     server.on(path, T_NOTIFY, notifyHandler, ctx, 1);
   }
 
@@ -434,15 +429,22 @@ class SubscriptionMgrControlPoint {
     char seconds_txt[80] = {0};
     snprintf(seconds_txt, sizeof(seconds_txt), "Second-%d",
              event_subscription_duration_sec);
+    char callback_url[256] = {0};
+    snprintf(callback_url, sizeof(callback_url), "<%s>",
+             p_local_url ? p_local_url->url() : "");
     p_http->request().put("NT", "upnp:event");
     p_http->request().put("TIMEOUT", seconds_txt);
-    p_http->request().put("CALLBACK", p_local_url ? p_local_url->url() : "");
+    p_http->request().put("CALLBACK", callback_url);
     // For re-subscribe, include existing SID header if present
     if (!service.subscription_id.isEmpty()) {
       p_http->request().put("SID", service.subscription_id.c_str());
     }
+    p_http->request().put("CONTENT-LENGTH", "0");
 
     int rc = p_http->subscribe(url);
+    if (!p_http->isKeepAlive()) {
+      p_http->stop();
+    }
     if (rc == 200) {
       const char* sid = p_http->reply().get("SID");
       if (sid != nullptr) {
@@ -530,7 +532,8 @@ class SubscriptionMgrControlPoint {
    * @param handlerLine Pointer to the server-provided handler context which
    *                    contains the manager instance in its context array.
    */
-  static void notifyHandler(IClientHandler& client, IHttpServer* server, const char* requestPath,
+  static void notifyHandler(IClientHandler& client, IHttpServer* server,
+                            const char* requestPath,
                             HttpRequestHandlerLine* handlerLine) {
     if (handlerLine == nullptr || handlerLine->contextCount < 1) return;
     void* ctx0 = handlerLine->context[0];
@@ -575,12 +578,14 @@ class SubscriptionMgrControlPoint {
   }
 
   Str getURLString(DLNAServiceInfo& service) {
-     Str url_str{100};
+    Str url_str{100};
     if (service.event_sub_url.startsWith("/")) {
       // relative URL: need to build full URL using device base URL
       url_str = p_device->getBaseURL();
-      url_str += service.event_sub_url.c_str();
-      url_str.replace("//", "/");
+      if (url_str.endsWith("/") && service.event_sub_url.startsWith("/"))
+        url_str += service.event_sub_url.c_str() + 1;
+      else
+        url_str += service.event_sub_url.c_str();
 
     } else {
       url_str = service.event_sub_url.c_str();

src/http/Server/HttpRequest.h

@@ -131,14 +131,14 @@ class HttpRequest : public IHttpRequest {
 
   /// Sends a SUBSCRIBE request.
   int subscribe(Url& url) override {
-    DlnaLogger.log(DlnaLogLevel::Info, "post %s", url.url());
+    DlnaLogger.log(DlnaLogLevel::Info, "%s %s", methods[T_SUBSCRIBE], url.path());
     return process(T_SUBSCRIBE, url, nullptr, nullptr, 0);
   }
 
   /// Sends an UNSUBSCRIBE request.
   int unsubscribe(Url& url, const char* sid) override {
-    DlnaLogger.log(DlnaLogLevel::Info, "unsubscribe %s (SID=%s)", url.url(),
-                   sid);
+    DlnaLogger.log(DlnaLogLevel::Info, "%s %s (SID=%s)", methods[T_UNSUBSCRIBE],
+                   url.path(), sid);
     if (sid != nullptr) {
       request_header.put("SID", sid);
     }
@@ -226,7 +226,7 @@ class HttpRequest : public IHttpRequest {
     DlnaLogger.log(DlnaLogLevel::Info, "HttpRequest::connect %s:%d", ip, port);
     uint64_t end = millis() + client_ptr->getTimeout();
     bool rc = false;
-    for (int j=0;j < 3; j++) {
+    for (int j = 0; j < 3; j++) {
       rc = this->client_ptr->connect(ip, port);
       if (rc) break;
       delay(200);