add AskUser to remote interface

Author: flensrocker

HISTORY

@@ -99,3 +99,7 @@ VDR Plugin 'dbus2vdr' Revision History
 2012-01-26: Version 0.0.3g
 
 - add "List" to setup interface
+
+2012-02-08: Version 0.0.3h
+
+- add "AskUser" to remote interface

README

@@ -87,6 +87,13 @@ If the SVDRP command doesn't take a parameter you can ommit it or pass an empty
 - hit a key
   vdr-dbus-send.sh /Remote remote.HitKey string:'Menu'
 
+- display list of strings on the osd and let the user select one
+  vdr-dbus-send.sh /Remote remote.AskUser string:'title' string:'item 1' string:'item 2' ...
+
+  The zero-based index of the selected item will be returned with the signal "AskUserSelect",
+  the first parameter is the title-string, the second the index.
+  An index of -1 means, no item is selected (or osd closed because of a timeout).
+
 - open the main menu entry of a plugin
   vdr-dbus-send.sh /Remote remote.CallPlugin string:'name-of-plugin'
 

dbus2vdr.c

@@ -18,9 +18,10 @@
 #include "skin.h"
 #include "timer.h"
 
+#include <vdr/osdbase.h>
 #include <vdr/plugin.h>
 
-static const char *VERSION        = "0.0.3g";
+static const char *VERSION        = "0.0.3h";
 static const char *DESCRIPTION    = trNOOP("control vdr via D-Bus");
 static const char *MAINMENUENTRY  = NULL;
 
@@ -150,7 +151,7 @@ time_t cPluginDbus2vdr::WakeupTime(void)
 cOsdObject *cPluginDbus2vdr::MainMenuAction(void)
 {
   // Perform the action when selected from the main VDR menu.
-  return NULL;
+  return cDBusDispatcherRemote::MainMenuAction;
 }
 
 cMenuSetupPage *cPluginDbus2vdr::SetupMenu(void)

message.c

@@ -116,6 +116,12 @@ bool cDBusMessageDispatcher::Introspect(DBusMessage *msg, cString &Data)
   return false;
 }
 
+void cDBusMessageDispatcher::Stop()
+{
+  for (cDBusMessageDispatcher *d = _dispatcher.First(); d; d = _dispatcher.Next(d))
+      d->OnStop();
+}
+
 void cDBusMessageDispatcher::Shutdown(void)
 {
   cDBusMessageHandler::DeleteHandler();

message.h

@@ -20,10 +20,12 @@ class cDBusMessageDispatcher : public cListObject
 protected:
   virtual cDBusMessage *CreateMessage(DBusConnection* conn, DBusMessage* msg) = 0;
   virtual bool          OnIntrospect(DBusMessage *msg, cString &Data) { return false; }
+  virtual void          OnStop(void) {}
 
 public:
   static bool Dispatch(DBusConnection* conn, DBusMessage* msg);
   static bool Introspect(DBusMessage *msg, cString &Data);
+  static void Stop(void);
   static void Shutdown(void);
 
   cDBusMessageDispatcher(const char *interface);

monitor.c

@@ -110,6 +110,7 @@ void cDBusMonitor::Action(void)
            dbus_message_unref(msg);
            }
         }
+  cDBusMessageDispatcher::Stop();
   isyslog("dbus2vdr: monitor stopped on bus %s", DBUS_VDR_BUSNAME);
   dbus_connection_unref(conn);
 }

remote.c

@@ -6,6 +6,70 @@
 #include <vdr/remote.h>
 
 
+class cDbusSelectMenu : public cOsdMenu
+{
+private:
+  DBusConnection *_conn;
+  bool _selected;
+
+  void SendSelectedItem(int item)
+  {
+    if (cDBusDispatcherRemote::MainMenuAction != this)
+       return;
+
+    DBusMessage *msg = dbus_message_new_signal("/Remote", DBUS_VDR_REMOTE_INTERFACE, "AskUserSelect");
+    if (msg == NULL) { 
+       esyslog("dbus2vdr: can't create signal");
+       return;
+       }
+
+    dbus_uint32_t serial = 0;
+    const char *title = Title();
+    DBusMessageIter args;
+    dbus_message_iter_init_append(msg, &args);
+    if (!dbus_message_iter_append_basic(&args, DBUS_TYPE_STRING, &title))
+       esyslog("dbus2vdr: can't add title to signal");
+    else if (!dbus_message_iter_append_basic(&args, DBUS_TYPE_INT32, &item))
+       esyslog("dbus2vdr: can't add selected item to signal");
+    else if (!dbus_connection_send(_conn, msg, &serial))
+       esyslog("dbus2vdr: can't send signal");
+    else
+       dbus_connection_flush(_conn);
+    dbus_message_unref(msg);
+  }
+
+public:
+ cDbusSelectMenu(DBusConnection* conn, const char *title)
+  :cOsdMenu(title)
+  ,_conn(conn)
+  ,_selected(false) 
+ {
+ }
+
+ virtual ~cDbusSelectMenu(void)
+ {
+   if (!_selected) {
+      isyslog("dbus2vdr: selected nothing");
+      SendSelectedItem(-1);
+      }
+   cDBusDispatcherRemote::MainMenuAction = NULL;
+ }
+
+ virtual eOSState ProcessKey(eKeys Key)
+ {
+   int state = cOsdMenu::ProcessKey(Key);
+   if (state > os_User) {
+      _selected = true;
+      int item = state - os_User - 1;
+      isyslog("dbus2vdr: select item %d", item);
+      SendSelectedItem(item);
+      return osEnd;
+      }
+   return (eOSState)state;
+ }
+};
+
+
 cDBusMessageRemote::cDBusMessageRemote(cDBusMessageRemote::eAction action, DBusConnection* conn, DBusMessage* msg)
 :cDBusMessage(conn, msg)
 ,_action(action)
@@ -34,6 +98,9 @@ void cDBusMessageRemote::Process(void)
     case dmrHitKey:
       HitKey();
       break;
+    case dmrAskUser:
+      AskUser();
+      break;
     }
 }
 
@@ -134,6 +201,55 @@ void cDBusMessageRemote::HitKey(void)
 }
 
 
+void cDBusMessageRemote::AskUser(void)
+{
+  if (cDBusDispatcherRemote::MainMenuAction != NULL) {
+     cDBusHelper::SendReply(_conn, _msg, 550, "another selection menu already open");
+     return;
+     }
+
+  cDbusSelectMenu *menu = NULL;
+  DBusMessageIter args;
+  if (!dbus_message_iter_init(_msg, &args))
+     esyslog("dbus2vdr: %s.HitKey: message misses an argument for the keyName", DBUS_VDR_REMOTE_INTERFACE);
+  else {
+     const char *item = NULL;
+     int i = 0;
+     while (cDBusHelper::GetNextArg(args, DBUS_TYPE_STRING, &item) >= 0) {
+           if (menu == NULL)
+              menu = new cDbusSelectMenu(_conn, item);
+           else {
+              menu->Add(new cOsdItem(item, (eOSState)(osUser1 + i)));
+              i++;
+              }
+           }
+     }
+
+  if (menu == NULL) {
+     cDBusHelper::SendReply(_conn, _msg, 501, "no title for selection menu given");
+     return;
+     }
+
+  if (menu->Count() == 0) {
+     delete menu;
+     cDBusHelper::SendReply(_conn, _msg, 501, "no items for selection menu given");
+     return;
+     }
+
+  cDBusDispatcherRemote::MainMenuAction = menu;
+  if (!cRemote::CallPlugin("dbus2vdr")) {
+     cDBusDispatcherRemote::MainMenuAction = NULL;
+     delete menu;
+     cDBusHelper::SendReply(_conn, _msg, 550, "can't display selection menu");
+     return;
+     }
+
+  cDBusHelper::SendReply(_conn, _msg, 250, "display selection menu");
+}
+
+
+cOsdObject *cDBusDispatcherRemote::MainMenuAction = NULL;
+
 cDBusDispatcherRemote::cDBusDispatcherRemote(void)
 :cDBusMessageDispatcher(DBUS_VDR_REMOTE_INTERFACE)
 {
@@ -167,6 +283,9 @@ cDBusMessage *cDBusDispatcherRemote::CreateMessage(DBusConnection* conn, DBusMes
   if (dbus_message_is_method_call(msg, DBUS_VDR_REMOTE_INTERFACE, "HitKey"))
      return new cDBusMessageRemote(cDBusMessageRemote::dmrHitKey, conn, msg);
 
+  if (dbus_message_is_method_call(msg, DBUS_VDR_REMOTE_INTERFACE, "AskUser"))
+     return new cDBusMessageRemote(cDBusMessageRemote::dmrAskUser, conn, msg);
+
   return NULL;
 }
 
@@ -200,7 +319,22 @@ bool          cDBusDispatcherRemote::OnIntrospect(DBusMessage *msg, cString &Dat
   "      <arg name=\"replycode\"    type=\"i\" direction=\"out\"/>\n"
   "      <arg name=\"replymessage\" type=\"s\" direction=\"out\"/>\n"
   "    </method>\n"
+  "    <method name=\"AskUser\">\n"
+  "      <arg name=\"title\"        type=\"s\"  direction=\"in\"/>\n"
+  "      <arg name=\"items\"        type=\"as\" direction=\"in\"/>\n"
+  "      <arg name=\"replycode\"    type=\"i\"  direction=\"out\"/>\n"
+  "      <arg name=\"replymessage\" type=\"s\"  direction=\"out\"/>\n"
+  "    </method>\n"
+  "    <signal name=\"AskUserSelect\">\n"
+  "      <arg name=\"title\"        type=\"s\"/>\n"
+  "      <arg name=\"index\"        type=\"i\"/>\n"
+  "    </signal>\n"
   "  </interface>\n"
   "</node>\n";
   return true;
 }
+
+void          cDBusDispatcherRemote::OnStop(void)
+{
+  MainMenuAction = NULL;
+}

remote.h

@@ -3,13 +3,15 @@
 
 #include "message.h"
 
+#include <vdr/osdbase.h>
+
 
 class cDBusMessageRemote : public cDBusMessage
 {
 friend class cDBusDispatcherRemote;
 
 public:
-  enum eAction { dmrCallPlugin, dmrEnable, dmrDisable, dmrStatus, dmrHitKey };
+  enum eAction { dmrCallPlugin, dmrEnable, dmrDisable, dmrStatus, dmrHitKey, dmrAskUser };
 
   virtual ~cDBusMessageRemote(void);
 
@@ -23,19 +25,23 @@ friend class cDBusDispatcherRemote;
   void Disable(void);
   void Status(void);
   void HitKey(void);
+  void AskUser(void);
 
   eAction _action;
 };
 
 class cDBusDispatcherRemote : public cDBusMessageDispatcher
 {
 public:
+  static cOsdObject *MainMenuAction;
+
   cDBusDispatcherRemote(void);
   virtual ~cDBusDispatcherRemote(void);
 
 protected:
   virtual cDBusMessage *CreateMessage(DBusConnection* conn, DBusMessage* msg);
   virtual bool          OnIntrospect(DBusMessage *msg, cString &Data);
+  virtual void          OnStop(void);
 };
 
 #endif