Parse and display messages received by echo msg commands
Process four new echo commands to construct messages to be
displayed to the user:
echo msg message-text
echo msg-n message-text
echo msg-window message-title
echo msg-notify message-title
Note: All rules of push and echo processing apply and determine
what is received as echo commands by the GUI. In addition,
'url-encoded' characters (% followed by two hex digits) are
decoded and displayed.
The message is constructed in the GUI by concatenating the text
specified in one or more "echo msg text" or "echo msg-n text"
commands. In case of "echo msg text" text is appended with a new
line. An empty text in this case will
just add a new line.
The message ends and gets displayed when one of the following
are receieved:
echo msg-window title
echo msg-notify title
where "title" becomes the title of the message window. In case of
msg-window, a modeless window shows the message, in the latter case
a notification balloon is shown.
Example: when pushed from the server:
push "echo msg I say let the world go to hell%2C"
push "echo msg I must have my cup of tea."
push "echo msg-window Notes from the underground"
will display a modeless window with title
"Notes from the underground" and a two line body
--
I say let the world go to hell,
I must have my cup of tea.
--
Note that the message itself is not quoted in the above examples
and so it relies on the server's option-parser combining
individual words into a space separated string. Number of words
on a line is limited by the maximum number of parameters allowed
in openvpn commands (16). This limitation may be avoided by quoting
the text that follows so that the option parser sees it as one
parameter.
The comma character is not allowed in pushed strings, so
it has to be sent encoded as %2C as shown above.
Such encoding of arbitrary bytes is suppored. For example,
newlines may be embedded as %0A, though discouraged. Instead
use multiple "echo msg" commands to separate lines by new line.
An example with embedded spaces and multiple lines concatenated
without a new line in between (note use of single quotes):
push "echo msg-n I swear to you gentlemen%2C that to be"
push "echo msg-n ' overly conscious is a sickness%2C ' "
push "echo msg-n a real%2C thorough sickness."
push "echo msg-notify Quote of the Day"
will show up as a notification that displays for an
OS-dependent interval as:
--
Quote of the Day
I swear to you gentlemen, that to be overly conscious
is a sickness, a real, thorough sickness.
--
where the location of the line break is automatically determined
by the notification API and is OS version-dependent.
Commands like "echo msg ..." in the config file are also
processed the same way. It gets displayed when the GUI connects
to the management interface and receives all pending echo.
Pushed message(s) get displayed when the client daemon
processes push-reply and passes on echo directives to the
GUI.
TODO: The actual window that displays the messages is
implemented in the next commit.
Signed-off-by: Selva Nair <selva.nair@gmail.com>
7 years ago
|
|
|
/*
|
|
|
|
|
* OpenVPN-GUI -- A Windows GUI for OpenVPN.
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2017 Selva Nair <selva.nair@gmail.com>
|
|
|
|
|
*
|
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
|
* (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
|
* along with this program (see the file COPYING included with this
|
|
|
|
|
* distribution); if not, write to the Free Software Foundation, Inc.,
|
|
|
|
|
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef ECHO_H
|
|
|
|
|
#define ECHO_H
|
|
|
|
|
|
|
|
|
|
#include <wchar.h>
|
|
|
|
|
|
|
|
|
|
/* data structures and methods for handling echo msg */
|
|
|
|
|
#define HASHLEN 20
|
|
|
|
|
|
|
|
|
|
/* message finger print consists of a SHA1 hash and a timestamp */
|
|
|
|
|
struct echo_msg_fp {
|
|
|
|
|
BYTE digest[HASHLEN];
|
|
|
|
|
time_t timestamp;
|
|
|
|
|
};
|
|
|
|
|
struct echo_msg_history;
|
|
|
|
|
struct echo_msg {
|
|
|
|
|
struct echo_msg_fp fp; /* keep this as the first element */
|
|
|
|
|
wchar_t *title;
|
|
|
|
|
wchar_t *text;
|
|
|
|
|
int txtlen;
|
|
|
|
|
int type;
|
|
|
|
|
struct echo_msg_history *history;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/* init echo message -- call on program start */
|
|
|
|
|
void echo_msg_init();
|
|
|
|
|
|
|
|
|
|
/* Process echo msg and related commands received from mgmt iterface. */
|
|
|
|
|
void echo_msg_process(connection_t *c, time_t timestamp, const char *msg);
|
|
|
|
|
|
|
|
|
|
/* Clear echo msg buffers and optionally history */
|
|
|
|
|
void echo_msg_clear(connection_t *c, BOOL clear_history);
|
|
|
|
|
|
|
|
|
|
/* Load echo msg history from the registry */
|
|
|
|
|
void echo_msg_load(connection_t *c);
|
|
|
|
|
|
|
|
|
|
#endif /* ifndef ECHO_H */
|
