Support sending multiple actions to a running instance

selvanair · selvanair · commit 6787306b165d · 2022-05-26T22:16:14.000-04:00
Currently we support only one --command action arg type of option. Extend it to allow multiple such commands in one invocation. Trac OpenVPN#498 Signed-off-by: Selva Nair <selva.nair@gmail.com>
diff --git a/main.c b/main.c
@@ -100,7 +100,7 @@ VerifyAutoConnections()
  * to the running instance and return success or error.
  */
 static int
-NotifyRunningInstance()
+NotifyRunningInstance(int action_type, wchar_t *action_arg)
 {
     /* Check if a previous instance has a window initialized
      * Even if we are not the first instance this may return null
@@ -110,22 +110,16 @@ NotifyRunningInstance()
     int exit_code = 0;
     if (hwnd_master)
     {
-        /* GUI up and running -- send a message if any action is pecified,
-           else show the balloon */
+        /* GUI up and running -- send a message for the specified action */
         COPYDATASTRUCT config_data = {0};
         int timeout = 30*1000;             /* 30 seconds */
-        if (!o.action)
+        config_data.dwData = action_type;
+        if (action_arg)
         {
-            o.action = WM_OVPN_NOTIFY;
-            o.action_arg = LoadLocalizedString(IDS_NFO_CLICK_HERE_TO_START);
+            config_data.cbData = (wcslen(action_arg)+1)*sizeof(action_arg[0]);
+            config_data.lpData = (void *) action_arg;
         }
-        config_data.dwData = o.action;
-        if (o.action_arg)
-        {
-            config_data.cbData = (wcslen(o.action_arg)+1)*sizeof(o.action_arg[0]);
-            config_data.lpData = (void *) o.action_arg;
-        }
-        PrintDebug(L"Instance 2: called with action %d : %ls", o.action, o.action_arg);
+        PrintDebug(L"Instance 2: called with action %d : %ls", action_type, action_arg);
         if (!SendMessageTimeout (hwnd_master, WM_COPYDATA, 0,
                                  (LPARAM) &config_data, 0, timeout, NULL))
         {
@@ -245,23 +239,40 @@ int WINAPI _tWinMain (HINSTANCE hThisInstance,
 
   if (!first_instance)
   {
-      int res = NotifyRunningInstance();
-      exit(res);
-  }
-  else if (o.action == WM_OVPN_START)
-  {
-      PrintDebug(L"Instance 1: Called with --command connect xxx. Treating it as --connect xxx");
-  }
-  else if (o.action == WM_OVPN_IMPORT)
-  {
-     ; /* pass -- import is handled after Window initialization */
+      int exit_code = 0;
+      struct action *a = o.action_list.head;
+      if (!a) /* no actions -- send a balloon notification */
+      {
+          exit_code = NotifyRunningInstance(WM_OVPN_NOTIFY,
+                LoadLocalizedString(IDS_NFO_CLICK_HERE_TO_START));
+      }
+      else while (a)
+      {
+          int res = NotifyRunningInstance(a->type, a->arg);
+          exit_code = res > exit_code ? res : exit_code;
+          a = a->next;
+      }
+      exit(exit_code);
   }
-  else if (o.action)
+  else
   {
-      MsgToEventLog(EVENTLOG_ERROR_TYPE, L"Called with --command when no previous instance available");
-      exit(OVPN_EXITCODE_ERROR);
+      for (struct action *a = o.action_list.head; a; a = a->next)
+      {
+          if (a->type == WM_OVPN_START)
+          {
+              PrintDebug(L"Instance 1: Called with --command connect xxx. Treating it as --connect xxx");
+          }
+          else if (a->type == WM_OVPN_IMPORT)
+          {
+              ; /* pass -- import is handled after Window initialization */
+          }
+          else
+          {
+              MsgToEventLog(EVENTLOG_ERROR_TYPE, L"Called with --command when no previous instance available (action type = %d arg = %s", a->type, a->arg ? a->arg : L"");
+              exit(OVPN_EXITCODE_ERROR);
+          }
+      }
   }
-
   if (!CheckVersion()) {
     exit(1);
   }
@@ -528,9 +539,12 @@ LRESULT CALLBACK WindowProcedure (HWND hwnd, UINT message, WPARAM wParam, LPARAM
         CheckServiceStatus();	// Check if service is running or not
 
       /* if '--import' was specified, do it now */
-      if (o.action == WM_OVPN_IMPORT && o.action_arg)
+      for (struct action *a = o.action_list.head; a ; a = a->next)
       {
-        ImportConfigFile(o.action_arg, true); /* prompt user */
+          if (a->type == WM_OVPN_IMPORT && a->arg)
+          {
+              ImportConfigFile(a->arg, true); /* prompt user */
+          }
       }
 
       if (!AutoStartConnections()) {
diff --git a/options.c b/options.c
@@ -36,6 +36,7 @@
 #include <shlobj.h>
 #include <shlwapi.h>
 #include <combaseapi.h>
+#include <assert.h>
 
 #include "options.h"
 #include "main.h"
@@ -81,9 +82,32 @@ ExpandOptions (void)
     ExpandString (o.install_path, _countof(o.install_path));
 }
 
+static void
+add_action(struct action_list *al, DWORD type, wchar_t *arg)
+{
+    struct action *a = calloc(sizeof(*a), 1);
+    if (!a)
+    {
+        ErrorExit(1, L"Out of memory while parsing command line");
+    }
+    a->type = type;
+    a->arg = arg;
+    if (!al->head)  /* first entry */
+    {
+        al->head = a;
+    }
+    else
+    {
+        assert(al->tail);
+        al->tail->next = a;
+    }
+    al->tail = a;
+}
+
 static int
 add_option(options_t *options, int i, TCHAR **p)
 {
+    struct action_list *al = &options->action_list;
     if (streq(p[0], _T("help")))
     {
         TCHAR caption[200];
@@ -112,23 +136,18 @@ add_option(options_t *options, int i, TCHAR **p)
             options->auto_connect = tmp;
         }
         options->auto_connect[options->num_auto_connect++] = p[1];
-        /* Treat the first connect option to also mean --command connect profile.
+        /* Treat connect option to also mean --command connect profile.
          * This gets used if we are not the first instance.
          */
-        if (options->num_auto_connect == 1)
-        {
-            options->action = WM_OVPN_START;
-            options->action_arg = p[1];
-        }
+        add_action(al, WM_OVPN_START, p[1]);
     }
     else if (streq(p[0], L"import") && p[1])
     {
         ++i;
         /* This is interpreted directly or as a command depending
          * on we are the first instance or not. So, set as an action.
          */
-        options->action = WM_OVPN_IMPORT;
-        options->action_arg = p[1];
+        add_action(al, WM_OVPN_IMPORT, p[1]);
     }
     else if (streq(p[0], _T("exe_path")) && p[1])
     {
@@ -248,52 +267,44 @@ add_option(options_t *options, int i, TCHAR **p)
         if (streq(p[1], _T("connect")) && p[2])
         {
             /* Treat this as "--connect profile" in case this is the first instance */
-            add_option(options, i, &p[1]);
-            ++i;
-            options->action = WM_OVPN_START;
-            options->action_arg = p[2];
+            i = add_option(options, i, &p[1]);
         }
         else if (streq(p[1], _T("disconnect")) && p[2])
         {
             ++i;
-            options->action = WM_OVPN_STOP;
-            options->action_arg = p[2];
+            add_action(al, WM_OVPN_STOP, p[2]);
         }
         else if (streq(p[1], _T("reconnect")) && p[2])
         {
             ++i;
-            options->action = WM_OVPN_RESTART;
-            options->action_arg = p[2];
+            add_action(al, WM_OVPN_RESTART, p[2]);
         }
         else if (streq(p[1], _T("status")) && p[2])
         {
             ++i;
-            options->action = WM_OVPN_SHOWSTATUS;
-            options->action_arg = p[2];
+            add_action(al, WM_OVPN_SHOWSTATUS, p[2]);
         }
         else if (streq(p[1], L"import") && p[2])
         {
             ++i;
-            options->action = WM_OVPN_IMPORT;
-            options->action_arg = p[2];
+            add_action(al, WM_OVPN_IMPORT, p[2]);
         }
         else if (streq(p[1], _T("silent_connection")))
         {
             ++i;
-            options->action = WM_OVPN_SILENT;
-            options->action_arg = p[2] ? p[2] : _T("1");
+            add_action(al, WM_OVPN_SILENT, p[2] ? p[2] : L"1");
         }
         else if (streq(p[1], _T("disconnect_all")))
         {
-            options->action = WM_OVPN_STOPALL;
+            add_action(al, WM_OVPN_STOPALL, NULL);
         }
         else if (streq(p[1], _T("exit")))
         {
-            options->action = WM_OVPN_EXIT;
+            add_action(al, WM_OVPN_EXIT, NULL);
         }
         else if (streq(p[1], _T("rescan")))
         {
-            options->action = WM_OVPN_RESCAN;
+            add_action(al, WM_OVPN_RESCAN, NULL);
         }
         else
         {
diff --git a/options.h b/options.h
@@ -158,6 +158,17 @@ struct connection {
     struct echo_msg echo_msg;      /* Message echo-ed from server or client config and related data */
 };
 
+/* Command actions to be send to running instance */
+struct action {
+    int type;
+    wchar_t *arg;
+    struct action *next;
+};
+
+struct action_list {
+    struct action *head, *tail;
+};
+
 /* All options used within OpenVPN GUI */
 typedef struct {
     /* Array of configs to autostart */
@@ -223,8 +234,7 @@ typedef struct {
     unsigned int dpi_scale;
     COLORREF clr_warning;
     COLORREF clr_error;
-    int action;            /* action to send to a running instance */
-    TCHAR *action_arg;
+    struct action_list action_list; /* list of actions to send to a running instance */
     HANDLE session_semaphore;
     HANDLE event_log;
 } options_t;

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@`
`36`	`36`	`#include <shlobj.h>`
`37`	`37`	`#include <shlwapi.h>`
`38`	`38`	`#include <combaseapi.h>`
	`39`	`+#include <assert.h>`
`39`	`40`
`40`	`41`	`#include "options.h"`
`41`	`42`	`#include "main.h"`
`@@ -81,9 +82,32 @@ ExpandOptions (void)`
`81`	`82`	`ExpandString (o.install_path, _countof(o.install_path));`
`82`	`83`	`}`
`83`	`84`
	`85`	`+static void`
	`86`	`+add_action(struct action_list al, DWORD type, wchar_t arg)`
	`87`	`+{`
	`88`	`+ struct action a = calloc(sizeof(a), 1);`
	`89`	`+ if (!a)`
	`90`	`+ {`
	`91`	`+ ErrorExit(1, L"Out of memory while parsing command line");`
	`92`	`+ }`
	`93`	`+ a->type = type;`
	`94`	`+ a->arg = arg;`
	`95`	`+ if (!al->head) /* first entry */`
	`96`	`+ {`
	`97`	`+ al->head = a;`
	`98`	`+ }`
	`99`	`+ else`
	`100`	`+ {`
	`101`	`+ assert(al->tail);`
	`102`	`+ al->tail->next = a;`
	`103`	`+ }`
	`104`	`+ al->tail = a;`
	`105`	`+}`
	`106`	`+`
`84`	`107`	`static int`
`85`	`108`	`add_option(options_t options, int i, TCHAR *p)`
`86`	`109`	`{`
	`110`	`+ struct action_list *al = &options->action_list;`
`87`	`111`	`if (streq(p[0], _T("help")))`
`88`	`112`	`{`
`89`	`113`	`TCHAR caption[200];`
`@@ -112,23 +136,18 @@ add_option(options_t options, int i, TCHAR *p)`
`112`	`136`	`options->auto_connect = tmp;`
`113`	`137`	`}`
`114`	`138`	`options->auto_connect[options->num_auto_connect++] = p[1];`
`115`		`- /* Treat the first connect option to also mean --command connect profile.`
	`139`	`+ /* Treat connect option to also mean --command connect profile.`
`116`	`140`	`* This gets used if we are not the first instance.`
`117`	`141`	`*/`
`118`		`- if (options->num_auto_connect == 1)`
`119`		`- {`
`120`		`- options->action = WM_OVPN_START;`
`121`		`- options->action_arg = p[1];`
`122`		`- }`
	`142`	`+ add_action(al, WM_OVPN_START, p[1]);`
`123`	`143`	`}`
`124`	`144`	`else if (streq(p[0], L"import") && p[1])`
`125`	`145`	`{`
`126`	`146`	`++i;`
`127`	`147`	`/* This is interpreted directly or as a command depending`
`128`	`148`	`* on we are the first instance or not. So, set as an action.`
`129`	`149`	`*/`
`130`		`- options->action = WM_OVPN_IMPORT;`
`131`		`- options->action_arg = p[1];`
	`150`	`+ add_action(al, WM_OVPN_IMPORT, p[1]);`
`132`	`151`	`}`
`133`	`152`	`else if (streq(p[0], _T("exe_path")) && p[1])`
`134`	`153`	`{`
`@@ -248,52 +267,44 @@ add_option(options_t options, int i, TCHAR *p)`
`248`	`267`	`if (streq(p[1], _T("connect")) && p[2])`
`249`	`268`	`{`
`250`	`269`	`/* Treat this as "--connect profile" in case this is the first instance */`
`251`		`- add_option(options, i, &p[1]);`
`252`		`- ++i;`
`253`		`- options->action = WM_OVPN_START;`
`254`		`- options->action_arg = p[2];`
	`270`	`+ i = add_option(options, i, &p[1]);`
`255`	`271`	`}`
`256`	`272`	`else if (streq(p[1], _T("disconnect")) && p[2])`
`257`	`273`	`{`
`258`	`274`	`++i;`
`259`		`- options->action = WM_OVPN_STOP;`
`260`		`- options->action_arg = p[2];`
	`275`	`+ add_action(al, WM_OVPN_STOP, p[2]);`
`261`	`276`	`}`
`262`	`277`	`else if (streq(p[1], _T("reconnect")) && p[2])`
`263`	`278`	`{`
`264`	`279`	`++i;`
`265`		`- options->action = WM_OVPN_RESTART;`
`266`		`- options->action_arg = p[2];`
	`280`	`+ add_action(al, WM_OVPN_RESTART, p[2]);`
`267`	`281`	`}`
`268`	`282`	`else if (streq(p[1], _T("status")) && p[2])`
`269`	`283`	`{`
`270`	`284`	`++i;`
`271`		`- options->action = WM_OVPN_SHOWSTATUS;`
`272`		`- options->action_arg = p[2];`
	`285`	`+ add_action(al, WM_OVPN_SHOWSTATUS, p[2]);`
`273`	`286`	`}`
`274`	`287`	`else if (streq(p[1], L"import") && p[2])`
`275`	`288`	`{`
`276`	`289`	`++i;`
`277`		`- options->action = WM_OVPN_IMPORT;`
`278`		`- options->action_arg = p[2];`
	`290`	`+ add_action(al, WM_OVPN_IMPORT, p[2]);`
`279`	`291`	`}`
`280`	`292`	`else if (streq(p[1], _T("silent_connection")))`
`281`	`293`	`{`
`282`	`294`	`++i;`
`283`		`- options->action = WM_OVPN_SILENT;`
`284`		`- options->action_arg = p[2] ? p[2] : _T("1");`
	`295`	`+ add_action(al, WM_OVPN_SILENT, p[2] ? p[2] : L"1");`
`285`	`296`	`}`
`286`	`297`	`else if (streq(p[1], _T("disconnect_all")))`
`287`	`298`	`{`
`288`		`- options->action = WM_OVPN_STOPALL;`
	`299`	`+ add_action(al, WM_OVPN_STOPALL, NULL);`
`289`	`300`	`}`
`290`	`301`	`else if (streq(p[1], _T("exit")))`
`291`	`302`	`{`
`292`		`- options->action = WM_OVPN_EXIT;`
	`303`	`+ add_action(al, WM_OVPN_EXIT, NULL);`
`293`	`304`	`}`
`294`	`305`	`else if (streq(p[1], _T("rescan")))`
`295`	`306`	`{`
`296`		`- options->action = WM_OVPN_RESCAN;`
	`307`	`+ add_action(al, WM_OVPN_RESCAN, NULL);`
`297`	`308`	`}`
`298`	`309`	`else`
`299`	`310`	`{`