summaryrefslogtreecommitdiffstats
path: root/plugins/vnc/vnc_plugin.h
blob: a0a1732d9feeafc94732a38e72dcf8b29656bdd0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * Remmina - The GTK+ Remote Desktop Client
 * Copyright (C) 2016-2023 Antenore Gatta, Giovanni Panozzo
 *
 * 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; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 *
 *  In addition, as a special exception, the copyright holders give
 *  permission to link the code of portions of this program with the
 *  OpenSSL library under certain conditions as described in each
 *  individual source file, and distribute linked combinations
 *  including the two.
 *  You must obey the GNU General Public License in all respects
 *  for all of the code used other than OpenSSL. *  If you modify
 *  file(s) with this exception, you may extend this exception to your
 *  version of the file(s), but you are not obligated to do so. *  If you
 *  do not wish to do so, delete this exception statement from your
 *  version. *  If you delete this exception statement from all source
 *  files in the program, then also delete it here.
 *
 */

#pragma once
#include "common/remmina_plugin.h"

#ifndef __PLUGIN_CONFIG_H
#define __PLUGIN_CONFIG_H

#define VNC_PLUGIN_NAME        "VNC"
#define VNC_PLUGIN_DESCRIPTION N_("Remmina VNC Plugin")
#define VNC_PLUGIN_VERSION     VERSION
#define VNC_PLUGIN_APPICON     "org.remmina.Remmina-vnc-symbolic"
#define VNC_PLUGIN_SSH_APPICON     "org.remmina.Remmina-vnc-ssh-symbolic"
#define VNCI_PLUGIN_NAME        "VNCI"
#define VNCI_PLUGIN_DESCRIPTION N_("Remmina VNC listener Plugin")
#define VNCI_PLUGIN_VERSION     VERSION
#define VNCI_PLUGIN_APPICON     "org.remmina.Remmina-vnc-symbolic"
#define VNCI_PLUGIN_SSH_APPICON     "org.remmina.Remmina-vnc-ssh-symbolic"
#endif

#define REMMINA_PLUGIN_INFO(fmt, ...) \
		remmina_plugin_service->_remmina_info(__func__, fmt, ##__VA_ARGS__)

#define REMMINA_PLUGIN_MESSAGE(fmt, ...) \
		remmina_plugin_service->_remmina_message(__func, fmt, ##__VA_ARGS__)

#define REMMINA_PLUGIN_DEBUG(fmt, ...) \
		remmina_plugin_service->_remmina_debug(__func__, fmt, ##__VA_ARGS__)

#define REMMINA_PLUGIN_WARNING(fmt, ...) \
		remmina_plugin_service->_remmina_warning(__func__, fmt, ##__VA_ARGS__)

/* This will intentionally crash Remmina */
#define REMMINA_PLUGIN_ERROR(fmt, ...) \
		remmina_plugin_service->_remmina_error(__func__, fmt, ##__VA_ARGS__)

#define REMMINA_PLUGIN_CRITICAL(fmt, ...) \
		remmina_plugin_service->_remmina_critical(__func__, fmt, ##__VA_ARGS__)
#define REMMINA_PLUGIN_AUDIT(fmt, ...) \
		remmina_plugin_service->_remmina_audit(__func__, fmt, ##__VA_ARGS__)

#define LIBVNCSERVER_CHECK_VERSION_VERSION(major,minor,patchlevel)                    \
        (LIBVNC_INT_MAJOR > (major) ||                                       \
        (LIBVNC_INT_MAJOR == (major) && LIBVNC_INT_MINOR > (minor)) || \
        (LIBVNC_INT_MAJOR == (major) && LIBVNC_INT_MINOR == (minor) && \
         LIBVNC_INT_PATCH >= (patchlevel)))

typedef struct _RemminaPluginVncData {
	/* Whether the user requests to connect/disconnect */
	gboolean		connected;
	/* Whether the vnc process is running */
	gboolean		running;
	/* Whether the initialization calls the authentication process */
	gboolean		auth_called;
	/* Whether it is the first attempt for authentication. Only first attempt will try to use cached credentials */
	gboolean		auth_first;

	GtkWidget *		drawing_area;
	guchar *		vnc_buffer;
	cairo_surface_t *	rgb_buffer;

	gint			queuedraw_x, queuedraw_y, queuedraw_w, queuedraw_h;
	guint			queuedraw_handler;

	gulong			clipboard_handler;
	GDateTime		*clipboard_timer;

	cairo_surface_t *	queuecursor_surface;
	gint			queuecursor_x, queuecursor_y;
	guint			queuecursor_handler;

	gpointer		client;
	gint			listen_sock;

	gint			button_mask;

	GPtrArray *		pressed_keys;

	pthread_mutex_t		vnc_event_queue_mutex;
	GQueue *		vnc_event_queue;
	gint			vnc_event_pipe[2];

	pthread_t		thread;
	pthread_mutex_t		buffer_mutex;

	float		scroll_x_accumulator, scroll_y_accumulator;

} RemminaPluginVncData;

enum {
	REMMINA_PLUGIN_VNC_EVENT_KEY,
	REMMINA_PLUGIN_VNC_EVENT_POINTER,
	REMMINA_PLUGIN_VNC_EVENT_CUTTEXT,
	REMMINA_PLUGIN_VNC_EVENT_CHAT_OPEN,
	REMMINA_PLUGIN_VNC_EVENT_CHAT_SEND,
	REMMINA_PLUGIN_VNC_EVENT_CHAT_CLOSE
};

typedef struct _RemminaPluginVncEvent {
	gint event_type;
	union {
		struct {
			guint		keyval;
			gboolean	pressed;
		} key;
		struct {
			gint	x;
			gint	y;
			gint	button_mask;
		} pointer;
		struct {
			gchar *text;
		} text;
	} event_data;
} RemminaPluginVncEvent;

typedef struct _RemminaPluginVncCoordinates {
	gint x, y;
} RemminaPluginVncCoordinates;

G_BEGIN_DECLS

/* --------- Support for execution on main thread of GUI functions -------------- */
static void remmina_plugin_vnc_update_scale(RemminaProtocolWidget *gp, gboolean scale);

G_END_DECLS