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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
|
/*
* Project: Remmina Plugin X2Go
* Description: Remmina protocol plugin to connect via X2Go using PyHocaCLI
* Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
* Antenore Gatta <antenore@simbiosi.org>
* Copyright: 2010-2011 Vic Lee
* 2014-2015 Antenore Gatta, Fabio Castelli, Giovanni Panozzo
* 2015 Antenore Gatta
* 2016-2018 Antenore Gatta, Giovanni Panozzo
* 2019 Mike Gabriel
* 2021 Daniel Teichmann
* License: GPL-2+
*
* 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.
*
*/
#include "x2go_plugin.h"
#include "common/remmina_plugin.h"
#include <gtk/gtkx.h>
#include <gdk/gdkx.h>
#include <X11/Xlib.h>
#include <X11/XKBlib.h>
#include <X11/extensions/XKBrules.h>
#include <sys/types.h>
#include <signal.h>
#include <time.h>
#include <ctype.h>
#define FEATURE_AVAILABLE(gpdata, feature) \
gpdata->available_features ? (g_list_find_custom( \
gpdata->available_features, \
feature, \
(GCompareFunc) g_strcmp0 \
) ? TRUE : FALSE) : FALSE
#define FEATURE_NOT_AVAIL_STR(feature) \
g_strdup_printf(_("The command-line feature '%s' is not available! Attempting " \
"to start PyHoca-CLI without using this feature…"), feature)
#define GET_PLUGIN_DATA(gp) \
(RemminaPluginX2GoData*) g_object_get_data(G_OBJECT(gp), "plugin-data")
#define SET_DIALOG_DATA(gp, ddata) \
g_object_set_data_full(G_OBJECT(gp), "dialog-data", ddata, g_free);
#define GET_DIALOG_DATA(gp) \
(struct _DialogData*) g_object_get_data(G_OBJECT(gp), "dialog-data");
#define REMMINA_PLUGIN_INFO(fmt, ...) \
rm_plugin_service->_remmina_info("[%s] " fmt, \
PLUGIN_NAME, ##__VA_ARGS__)
#define REMMINA_PLUGIN_MESSAGE(fmt, ...) \
rm_plugin_service->_remmina_message("[%s] " fmt, \
PLUGIN_NAME, ##__VA_ARGS__)
#define REMMINA_PLUGIN_DEBUG(fmt, ...) \
rm_plugin_service->_remmina_debug(__func__, "[%s] " fmt, \
PLUGIN_NAME, ##__VA_ARGS__)
#define REMMINA_PLUGIN_WARNING(fmt, ...) \
rm_plugin_service->_remmina_warning(__func__, "[%s] " fmt, \
PLUGIN_NAME, ##__VA_ARGS__)
#define REMMINA_PLUGIN_ERROR(fmt, ...) \
rm_plugin_service->_remmina_error(__func__, "[%s] " fmt, \
PLUGIN_NAME, ##__VA_ARGS__)
#define REMMINA_PLUGIN_CRITICAL(fmt, ...) \
rm_plugin_service->_remmina_critical(__func__, "[%s] " fmt, \
PLUGIN_NAME, ##__VA_ARGS__)
#define GET_PLUGIN_STRING(value) \
g_strdup(rm_plugin_service->file_get_string(remminafile, value))
#define GET_PLUGIN_PASSWORD(value) \
GET_PLUGIN_STRING(value)
#define GET_PLUGIN_INT(value, default_value) \
rm_plugin_service->file_get_int(remminafile, value, default_value)
#define GET_PLUGIN_BOOLEAN(value) \
rm_plugin_service->file_get_int(remminafile, value, FALSE)
static RemminaPluginService *rm_plugin_service = NULL;
// Following str2int code was adapted from Stackoverflow:
// https://stackoverflow.com/questions/7021725/how-to-convert-a-string-to-integer-in-c
typedef enum {
STR2INT_SUCCESS,
STR2INT_OVERFLOW,
STR2INT_UNDERFLOW,
STR2INT_INCONVERTIBLE,
STR2INT_INVALID_DATA
} str2int_errno;
/**
* @brief Convert string s to int out.
*
* @param out The converted int. Cannot be NULL.
*
* @param s Input string to be converted. \n
* The format is the same as strtol,
* except that the following are inconvertible: \n
* * empty string \n
* * leading whitespace \n
* * or any trailing characters that are not part of the number \n
* Cannot be NULL.
* @param base Base to interpret string in. Same range as strtol (2 to 36).
*
* @return Indicates if the operation succeeded, or why it failed with str2int_errno enum.
*/
str2int_errno str2int(gint *out, gchar *s, gint base)
{
gchar *end;
if (!s || !out || base <= 0) return STR2INT_INVALID_DATA;
if (s[0] == '\0' || isspace(s[0])) return STR2INT_INCONVERTIBLE;
errno = 0;
glong l = strtol(s, &end, base);
/* Both checks are needed because INT_MAX == LONG_MAX is possible. */
if (l > INT_MAX || (errno == ERANGE && l == LONG_MAX)) return STR2INT_OVERFLOW;
if (l < INT_MIN || (errno == ERANGE && l == LONG_MIN)) return STR2INT_UNDERFLOW;
if (*end != '\0') return STR2INT_INCONVERTIBLE;
*out = l;
return STR2INT_SUCCESS;
}
/**
* DialogData:
* @param flags see GtkDialogFlags
* @param type see GtkMessageType
* @param buttons see GtkButtonsType
* @param title Title of the Dialog
* @param message Message of the Dialog
* @param callbackfunc A GCallback function like: \n
* callback(RemminaProtocolWidget *gp, GtkWidget *dialog) \n
* which will be executed on the dialogs 'response' signal.
* The callback function is obliged to destroy the dialog widget.
*
* The `DialogData` structure contains all info needed to open a GTK dialog with
* rmplugin_x2go_open_dialog()
*
* Quick example of a callback function: \n
* static gboolean rmplugin_x2go_test_callback(RemminaProtocolWidget *gp, gint response_id, \n
* GtkDialog *self) { \n
* REMMINA_PLUGIN_DEBUG("response: %i", response_id); \n
* if (response_id == GTK_RESPONSE_OK) { \n
* REMMINA_PLUGIN_DEBUG("OK!"); \n
* } \n
* gtk_widget_destroy(self); \n
* return G_SOURCE_REMOVE; \n
* }
*
*/
struct _DialogData
{
GtkWindow *parent;
GtkDialogFlags flags;
GtkMessageType type;
GtkButtonsType buttons;
gchar *title;
gchar *message;
GCallback callbackfunc;
};
/**
* @param gp getting DialogData via dialog-data saved in gp.
* See define GET_DIALOG_DATA
* @returns: FALSE. This source should be removed from main loop.
* #G_SOURCE_CONTINUE and #G_SOURCE_REMOVE are more memorable
* names for the return value.
*/
static gboolean rmplugin_x2go_open_dialog(RemminaProtocolWidget *gp)
{
REMMINA_PLUGIN_DEBUG("Function entry.");
struct _DialogData* ddata = GET_DIALOG_DATA(gp);
if (ddata) {
// Can't check type, flags or buttons
// because they are enums and '0' is a valid value
if (!ddata->title || !ddata->message) {
REMMINA_PLUGIN_CRITICAL("%s", _("Broken `DialogData`! Aborting…"));
return G_SOURCE_REMOVE;
}
} else {
REMMINA_PLUGIN_CRITICAL("%s", _("Can't retrieve `DialogData`! Aborting…"));
return G_SOURCE_REMOVE;
}
REMMINA_PLUGIN_DEBUG("`DialogData` checks passed. Now showing dialog…");
GtkWidget *widget_gtk_dialog;
widget_gtk_dialog = gtk_message_dialog_new(ddata->parent,
ddata->flags,
ddata->type,
ddata->buttons,
ddata->title);
gtk_message_dialog_format_secondary_text(GTK_MESSAGE_DIALOG (widget_gtk_dialog),
ddata->message);
if (ddata->callbackfunc) {
g_signal_connect_swapped(G_OBJECT(widget_gtk_dialog), "response",
G_CALLBACK(ddata->callbackfunc),
gp);
} else {
g_signal_connect(G_OBJECT(widget_gtk_dialog), "response",
G_CALLBACK(gtk_widget_destroy),
NULL);
}
gtk_widget_show_all(widget_gtk_dialog);
// Delete ddata object and reference 'dialog-data' in gp.
g_object_set_data(G_OBJECT(gp), "dialog-data", NULL);
return G_SOURCE_REMOVE;
}
typedef struct _RemminaPluginX2GoData {
GtkWidget *socket;
gint socket_id;
pthread_t thread;
Display *display;
Window window_id;
int (*orig_handler)(Display *, XErrorEvent *);
GPid pidx2go;
gboolean disconnected;
GList* available_features;
} RemminaPluginX2GoData;
#define RMPLUGIN_X2GO_FEATURE_GTKSOCKET 1
/* Forward declaration */
static RemminaProtocolPlugin rmplugin_x2go;
/* When more than one NX sessions is connecting in progress, we need this mutex and array
* to prevent them from stealing the same window ID.
*/
static pthread_mutex_t remmina_x2go_init_mutex;
static GArray *remmina_x2go_window_id_array;
/* ------------- Support for execution on main thread of GTK functions ------------- */
struct onMainThread_cb_data
{
enum { FUNC_GTK_SOCKET_ADD_ID } func;
GtkSocket* sk;
Window w;
/* Mutex for thread synchronization */
pthread_mutex_t mu;
/* Flag to catch cancellations */
gboolean cancelled;
};
static gboolean onMainThread_cb(struct onMainThread_cb_data *d)
{
TRACE_CALL(__func__);
if (!d->cancelled) {
switch (d->func) {
case FUNC_GTK_SOCKET_ADD_ID:
gtk_socket_add_id(d->sk, d->w);
break;
}
pthread_mutex_unlock(&d->mu);
} else {
/* thread has been cancelled, so we must free d memory here */
g_free(d);
}
return G_SOURCE_REMOVE;
}
static void onMainThread_cleanup_handler(gpointer data)
{
TRACE_CALL(__func__);
struct onMainThread_cb_data *d = data;
d->cancelled = TRUE;
}
static void onMainThread_schedule_callback_and_wait(struct onMainThread_cb_data *d)
{
TRACE_CALL(__func__);
d->cancelled = FALSE;
pthread_cleanup_push(onMainThread_cleanup_handler, d);
pthread_mutex_init(&d->mu, NULL);
pthread_mutex_lock(&d->mu);
gdk_threads_add_idle((GSourceFunc)onMainThread_cb, (gpointer) d);
pthread_mutex_lock(&d->mu);
pthread_cleanup_pop(0);
pthread_mutex_unlock(&d->mu);
pthread_mutex_destroy(&d->mu);
}
static void onMainThread_gtk_socket_add_id(GtkSocket* sk, Window w)
{
TRACE_CALL(__func__);
struct onMainThread_cb_data *d;
d = g_new0(struct onMainThread_cb_data, 1);
d->func = FUNC_GTK_SOCKET_ADD_ID;
d->sk = sk;
d->w = w;
onMainThread_schedule_callback_and_wait(d);
g_free(d);
}
/* /-/-/-/-/-/-/ Support for execution on main thread of GTK functions /-/-/-/-/-/-/ */
static void rmplugin_x2go_remove_window_id (Window window_id)
{
gint i;
gboolean already_seen = FALSE;
pthread_mutex_lock(&remmina_x2go_init_mutex);
for (i = 0; i < remmina_x2go_window_id_array->len; i++) {
if (g_array_index(remmina_x2go_window_id_array, Window, i) == window_id) {
already_seen = TRUE;
REMMINA_PLUGIN_DEBUG("Window of X2Go Agent with ID [0x%lx] seen already.",
window_id);
break;
}
}
if (already_seen) {
g_array_remove_index_fast(remmina_x2go_window_id_array, i);
REMMINA_PLUGIN_DEBUG("Forgetting about window of X2Go Agent with ID [0x%lx]…",
window_id);
}
pthread_mutex_unlock(&remmina_x2go_init_mutex);
}
/**
* @returns: FALSE. This source should be removed from main loop.
* #G_SOURCE_CONTINUE and #G_SOURCE_REMOVE are more memorable
* names for the return value.
*/
static gboolean rmplugin_x2go_cleanup(RemminaProtocolWidget *gp)
{
REMMINA_PLUGIN_DEBUG("Function entry.");
RemminaPluginX2GoData *gpdata = GET_PLUGIN_DATA(gp);
if (gpdata == NULL) {
REMMINA_PLUGIN_DEBUG("Exiting since gpdata is already 'NULL'…");
return G_SOURCE_REMOVE;
}
if (gpdata->thread) {
pthread_cancel(gpdata->thread);
if (gpdata->thread) pthread_join(gpdata->thread, NULL);
}
if (gpdata->window_id) {
rmplugin_x2go_remove_window_id(gpdata->window_id);
}
if (gpdata->pidx2go) {
kill(gpdata->pidx2go, SIGTERM);
g_spawn_close_pid(gpdata->pidx2go);
gpdata->pidx2go = 0;
}
if (gpdata->display) {
XSetErrorHandler(gpdata->orig_handler);
XCloseDisplay(gpdata->display);
gpdata->display = NULL;
}
g_object_steal_data(G_OBJECT(gp), "plugin-data");
rm_plugin_service->protocol_plugin_signal_connection_closed(gp);
return G_SOURCE_REMOVE;
}
static gboolean rmplugin_x2go_close_connection(RemminaProtocolWidget *gp)
{
TRACE_CALL(__func__);
RemminaPluginX2GoData *gpdata = GET_PLUGIN_DATA(gp);
REMMINA_PLUGIN_DEBUG("Function entry.");
if (gpdata->disconnected) {
REMMINA_PLUGIN_DEBUG("Doing nothing since the plugin is already disconnected.");
return G_SOURCE_REMOVE;
}
rmplugin_x2go_cleanup(gp);
// Try again.
return G_SOURCE_CONTINUE;
}
static void rmplugin_x2go_pyhoca_cli_exited(GPid pid,
gint status,
struct _RemminaProtocolWidget *gp)
{
REMMINA_PLUGIN_DEBUG("Function entry.");
RemminaPluginX2GoData *gpdata = GET_PLUGIN_DATA(gp);
if (!gpdata) {
REMMINA_PLUGIN_DEBUG("Doing nothing as the disconnection "
"has already been handled.");
return;
}
if (gpdata->pidx2go <= 0) {
REMMINA_PLUGIN_DEBUG("Doing nothing since pyhoca-cli was expected to stop.");
return;
}
REMMINA_PLUGIN_CRITICAL("%s", _("PyHoca-CLI exited unexpectedly. "
"This connection will now be closed."));
struct _DialogData *ddata = g_new0(struct _DialogData, 1);
SET_DIALOG_DATA(gp, ddata);
ddata->parent = NULL;
ddata->flags = GTK_DIALOG_MODAL;
ddata->type = GTK_MESSAGE_ERROR;
ddata->buttons = GTK_BUTTONS_OK;
ddata->title = _("An error occured.");
ddata->message = _("The necessary child process 'pyhoca-cli' stopped unexpectedly.\n"
"Please check your profile settings and PyHoca-CLI's output for "
"possible errors. Also ensure the remote server is "
"reachable.");
// We don't need the response.
ddata->callbackfunc = NULL;
IDLE_ADD((GSourceFunc) rmplugin_x2go_open_dialog, gp);
// 1 Second. Give `Dialog` chance to open.
usleep(1000 * 1000);
rmplugin_x2go_close_connection(gp);
}
/**
* @brief Get all available pyhoca-cli features by
* executing `pyhoca-cli --list-cmdline-features`.
*
* @returns Returns either a gchar* with all features,
* separated by a '\n' or NULL if it failed.
*/
static gchar* rmplugin_x2go_get_pyhoca_features()
{
REMMINA_PLUGIN_DEBUG("Function entry.");
// We will now start pyhoca-cli with only the '--list-cmdline-features' option
// and depending on the exit code and stdout output we will determine if some
// features are available or not.
gchar *argv[50];
gint argc = 0;
GError *error = NULL;
gint exit_code = 0;
gchar *standard_out;
// just supresses pyhoca-cli help message. (When pyhoca-cli has old version)
gchar *standard_err;
argv[argc++] = g_strdup("pyhoca-cli");
argv[argc++] = g_strdup("--list-cmdline-features");
argv[argc++] = NULL;
gchar **envp = g_get_environ();
gboolean success_ret = g_spawn_sync (NULL, argv, envp, G_SPAWN_SEARCH_PATH,
NULL, NULL, &standard_out, &standard_err,
&exit_code, &error);
REMMINA_PLUGIN_INFO("%s", _("Started PyHoca-CLI with the following arguments:"));
// Print every argument except passwords. Free all arg strings.
for (gint i = 0; i < argc - 1; i++) {
if (g_strcmp0(argv[i], "--password") == 0) {
g_printf("%s ", argv[i]);
g_printf("XXXXXX ");
g_free(argv[i]);
g_free(argv[++i]);
continue;
} else {
g_printf("%s ", argv[i]);
g_free(argv[i]);
}
}
g_printf("\n");
if (!success_ret || error || strcmp(standard_out, "") == 0 || exit_code) {
if (!error) {
REMMINA_PLUGIN_WARNING("%s",
g_strdup_printf(_("Could not retrieve "
"PyHoca-CLI's command-line features! Exit code: %i"),
exit_code));
} else {
REMMINA_PLUGIN_WARNING("%s",
g_strdup_printf(_("Error: '%s'"), error->message));
g_error_free(error);
}
return NULL;
}
return standard_out;
}
/**
* @brief Saves s_password and s_username if set.
* @returns either TRUE or FALSE. If FALSE gets returned, `errmsg` is set.
*/
static gboolean rmplugin_x2go_save_credentials(RemminaFile* remminafile,
gchar* s_username, gchar* s_password,
gchar* errmsg)
{
// User has requested to save credentials. We put all the new credentials
// into remminafile->settings. They will be saved later, on successful
// connection, by rcw.c
if (s_password && s_username) {
if (g_strcmp0(s_username, "") == 0) {
g_strlcpy(errmsg, _("Can't save empty username!"), 512);
//REMMINA_PLUGIN_CRITICAL("%s", errmsg); // No need.
return FALSE;
}
// We allow the possibility to set an empty password because a X2Go
// session can be still made using keyfiles or similar.
rm_plugin_service->file_set_string(remminafile, "password",
s_password);
rm_plugin_service->file_set_string(remminafile, "username",
s_username);
} else {
g_strlcpy(errmsg, g_strdup_printf(
_("Internal error: %s"),
_("Could not save new credentials.")
), 512);
REMMINA_PLUGIN_CRITICAL("%s", _("An error occured while trying to save "
"new credentials: 's_password' or "
"'s_username' strings were not set."));
return FALSE;
}
return TRUE;
}
/**
* @brief Asks the user for a username and password.
*
* @param errmsg Error message if function failed.
* @param username Default username. Gets set to new username on success.
* @param password Default password. Gets set to new password on success.
*
* @returns FALSE if auth failed and TRUE on success.
*/
static gboolean rmplugin_x2go_get_auth(RemminaProtocolWidget *gp, gchar* errmsg,
gchar* username, gchar* password)
{
gchar *s_username, *s_password;
gint ret;
gboolean save;
gboolean disable_password_storing;
RemminaFile *remminafile;
remminafile = rm_plugin_service->protocol_plugin_get_file(gp);
disable_password_storing = rm_plugin_service->file_get_int(remminafile,
"disablepasswordstoring",
FALSE);
ret = rm_plugin_service->protocol_plugin_init_auth(
gp, (disable_password_storing ? 0 :
REMMINA_MESSAGE_PANEL_FLAG_SAVEPASSWORD |
REMMINA_MESSAGE_PANEL_FLAG_USERNAME),
_("Enter X2Go credentials"),
username, // function arg 'username' is default username
password, // function arg 'password' is default password
NULL,
NULL);
if (ret == GTK_RESPONSE_OK) {
s_username = rm_plugin_service->protocol_plugin_init_get_username(gp);
s_password = rm_plugin_service->protocol_plugin_init_get_password(gp);
if (rm_plugin_service->protocol_plugin_init_get_savepassword(gp))
rm_plugin_service->file_set_string(remminafile, "password",
s_password);
// Should be renamed to protocol_plugin_init_get_savecredentials()?!
save = rm_plugin_service->protocol_plugin_init_get_savepassword(gp);
if (save) {
if (!rmplugin_x2go_save_credentials(remminafile, s_username,
s_password, errmsg)) {
return FALSE;
}
}
if (s_username) {
g_stpcpy(username, s_username);
g_free(s_username);
}
if (s_password) {
g_stpcpy(password, s_password);
g_free(s_password);
}
} else {
g_strlcpy(errmsg, "Authentication cancelled. Aborting…", 512);
REMMINA_PLUGIN_DEBUG("%s", errmsg);
return FALSE;
}
return TRUE;
}
static gboolean rmplugin_x2go_exec_x2go(gchar *host,
gint sshport,
gchar *username,
gchar *password,
gchar *command,
gchar *kbdlayout,
gchar *kbdtype,
gchar *audio,
gchar *clipboard,
gint dpi,
gchar *resolution,
RemminaProtocolWidget *gp,
gchar *errmsg)
{
TRACE_CALL(__func__);
RemminaPluginX2GoData *gpdata = GET_PLUGIN_DATA(gp);
gchar *argv[50];
gint argc = 0;
// Sets `username` and `password`.
if (!rmplugin_x2go_get_auth(gp, errmsg, username, password)) {
return FALSE;
}
argc = 0;
argv[argc++] = g_strdup("pyhoca-cli");
argv[argc++] = g_strdup("--server"); // Not listed as feature.
argv[argc++] = g_strdup_printf ("%s", host);
if (FEATURE_AVAILABLE(gpdata, "REMOTE_SSH_PORT")) {
argv[argc++] = g_strdup("-p");
argv[argc++] = g_strdup_printf ("%d", sshport);
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("REMOTE_SSH_PORT"));
}
if (FEATURE_AVAILABLE(gpdata, "USERNAME")) {
argv[argc++] = g_strdup("-u");
if (username){
argv[argc++] = g_strdup_printf ("%s", username);
} else {
argv[argc++] = g_strdup_printf ("%s", g_get_user_name());
}
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("USERNAME"));
}
if (password && FEATURE_AVAILABLE(gpdata, "PASSWORD")) {
argv[argc++] = g_strdup("--force-password");
argv[argc++] = g_strdup("--password");
argv[argc++] = g_strdup_printf ("%s", password);
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("PASSWORD"));
}
if (FEATURE_AVAILABLE(gpdata, "AUTH_ATTEMPTS")) {
argv[argc++] = g_strdup("--auth-attempts");
argv[argc++] = g_strdup_printf ("%i", 0);
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("AUTH_ATTEMPTS"));
}
if (FEATURE_AVAILABLE(gpdata, "COMMAND")) {
argv[argc++] = g_strdup("-c");
// FIXME: pyhoca-cli is picky about multiple quotes around
// the command string...
// argv[argc++] = g_strdup_printf ("%s", g_shell_quote(command));
argv[argc++] = g_strdup(command);
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("COMMAND"));
}
if (FEATURE_AVAILABLE(gpdata, "KBD_LAYOUT")) {
if (kbdlayout) {
argv[argc++] = g_strdup("--kbd-layout");
argv[argc++] = g_strdup_printf ("%s", kbdlayout);
} else {
argv[argc++] = g_strdup("--kbd-layout");
argv[argc++] = g_strdup("auto");
}
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("KBD_LAYOUT"));
}
if (FEATURE_AVAILABLE(gpdata, "KBD_TYPE")) {
if (kbdtype) {
argv[argc++] = g_strdup("--kbd-type");
argv[argc++] = g_strdup_printf ("%s", kbdtype);
} else {
argv[argc++] = g_strdup("--kbd-type");
argv[argc++] = g_strdup("auto");
}
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("KBD_TYPE"));
}
if (FEATURE_AVAILABLE(gpdata, "GEOMETRY")) {
if (!resolution)
resolution = "800x600";
argv[argc++] = g_strdup("-g");
argv[argc++] = g_strdup_printf ("%s", resolution);
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("GEOMETRY"));
}
if (FEATURE_AVAILABLE(gpdata, "TRY_RESUME")) {
argv[argc++] = g_strdup("--try-resume");
}
if (FEATURE_AVAILABLE(gpdata, "TERMINATE_ON_CTRL_C")) {
argv[argc++] = g_strdup("--terminate-on-ctrl-c");
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("TERMINATE_ON_CTRL_C"));
}
if (FEATURE_AVAILABLE(gpdata, "SOUND")) {
if (audio) {
argv[argc++] = g_strdup("--sound");
argv[argc++] = g_strdup_printf ("%s", audio);
} else {
argv[argc++] = g_strdup("--sound");
argv[argc++] = g_strdup("none");
}
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("SOUND"));
}
if (FEATURE_AVAILABLE(gpdata, "CLIPBOARD_MODE")) {
if (clipboard) {
argv[argc++] = g_strdup("--clipboard-mode");
argv[argc++] = g_strdup_printf("%s", clipboard);
}
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("CLIPBOARD_MODE"));
}
if (FEATURE_AVAILABLE(gpdata, "DPI")) {
// Event though we validate the users input in Remmina Editor,
// manipulating profile files is still very possible..
// Values are extracted from pyhoca-cli.
if (dpi < 20 || dpi > 400) {
g_strlcpy(errmsg, _("DPI setting is out of bounds. Please adjust "
"it in profile settings."), 512);
// No need, start_session() will handle output.
//REMMINA_PLUGIN_CRITICAL("%s", errmsg);
return FALSE;
}
argv[argc++] = g_strdup("--dpi");
argv[argc++] = g_strdup_printf ("%i", dpi);
} else {
REMMINA_PLUGIN_DEBUG("%s", FEATURE_NOT_AVAIL_STR("DPI"));
}
argv[argc++] = NULL;
GError *error = NULL;
gchar **envp = g_get_environ();
gboolean success = g_spawn_async_with_pipes (NULL, argv, envp,
(G_SPAWN_DO_NOT_REAP_CHILD |
G_SPAWN_SEARCH_PATH), NULL,
NULL, &gpdata->pidx2go,
NULL, NULL, NULL, &error);
REMMINA_PLUGIN_INFO("%s", _("Started pyhoca-cli with following arguments:"));
// Print every argument except passwords. Free all arg strings.
for (gint i = 0; i < argc - 1; i++) {
if (g_strcmp0(argv[i], "--password") == 0) {
g_printf("%s ", argv[i]);
g_printf("XXXXXX ");
g_free (argv[i]);
g_free (argv[++i]);
continue;
} else {
g_printf("%s ", argv[i]);
g_free (argv[i]);
}
}
g_printf("\n");
if (!success || error) {
// TRANSLATORS: Meta-error. Shouldn't be visible.
if (!error) error = g_error_new(0, 0, _("Internal error."));
gchar *error_title = _("An error occured while "
"starting an X2Go session…");
struct _DialogData* ddata = g_new0(struct _DialogData, 1);
SET_DIALOG_DATA(gp, ddata);
ddata->parent = NULL;
ddata->flags = GTK_DIALOG_MODAL;
ddata->type = GTK_MESSAGE_ERROR;
ddata->buttons = GTK_BUTTONS_OK;
ddata->title = _("Could not start X2Go session.");
ddata->message = g_strdup_printf(_("Could not start PyHoca-CLI (%i): '%s'"),
error->code,
error->message);
// We don't need the response.
ddata->callbackfunc = NULL;
IDLE_ADD((GSourceFunc) rmplugin_x2go_open_dialog, gp);
g_strlcpy(errmsg, error_title, 512);
// No need to output here. rmplugin_x2go_start_session will do this.
g_error_free(error);
return FALSE;
}
// Prevent a race condition where pyhoca-cli is not
// started yet (pidx2go == 0) but a watcher is added.
while (gpdata->pidx2go == 0) {
REMMINA_PLUGIN_DEBUG("Waiting for PyHoca-CLI to start…");
};
REMMINA_PLUGIN_DEBUG("Watching child 'pyhoca-cli' process now…");
g_child_watch_add(gpdata->pidx2go,
(GChildWatchFunc) rmplugin_x2go_pyhoca_cli_exited,
gp);
return TRUE;
}
/**
* @returns a GList* with all features which pyhoca-cli had before the feature system.
*/
static GList* rmplugin_x2go_old_pyhoca_features()
{
REMMINA_PLUGIN_DEBUG("Function entry.");
#define AMOUNT_FEATURES 43
gchar* features[AMOUNT_FEATURES] = {
"ADD_TO_KNOWN_HOSTS", "AUTH_ATTEMPTS", "BROKER_PASSWORD", "BROKER_URL",
"CLEAN_SESSIONS", "COMMAND", "DEBUG", "FORCE_PASSWORD", "FORWARD_SSHAGENT",
"GEOMETRY", "KBD_LAYOUT", "KBD_TYPE", "LIBDEBUG", "LIBDEBUG_SFTPXFER", "LINK",
"LIST_CLIENT_FEATURES", "LIST_DESKTOPS", "LIST_SESSIONS", "NEW", "PACK",
"PASSWORD", "PDFVIEW_CMD", "PRINTER", "PRINTING", "PRINT_ACTION", "PRINT_CMD",
"QUIET", "REMOTE_SSH_PORT", "RESUME", "SAVE_TO_FOLDER", "SESSION_PROFILE",
"SESSION_TYPE", "SHARE_DESKTOP", "SHARE_LOCAL_FOLDERS", "SHARE_MODE", "SOUND",
"SSH_PRIVKEY", "SUSPEND", "TERMINATE", "TERMINATE_ON_CTRL_C", "TRY_RESUME",
"USERNAME", "XINERAMA"
};
GList *features_list = NULL;
for (int i = 0; i < AMOUNT_FEATURES; i++) {
features_list = g_list_append(features_list, features[i]);
}
return features_list;
}
/**
* @returns a GList* which includes all pyhoca-cli command line features we can use.
*/
static GList* rmplugin_x2go_populate_available_features_list()
{
REMMINA_PLUGIN_DEBUG("Function entry.");
GList* returning_glist = NULL;
// Querying pyhoca-cli's command line features.
gchar* features_string = rmplugin_x2go_get_pyhoca_features();
if (!features_string) {
// We added the '--list-cmdline-features' on commit 17d1be1319ba6 of
// pyhoca-cli. In order to protect setups which don't have the newest
// version of pyhoca-cli available yet we artificially create a list
// of an old limited set of features.
REMMINA_PLUGIN_WARNING("%s",
_("Couldn't get PyHoca-CLI's command-line features. This "
"indicates it is either too old, or not installed. "
"An old limited set of features will be used for now."));
return rmplugin_x2go_old_pyhoca_features();
} else {
gchar **features_list = g_strsplit(features_string, "\n", 0);
if (features_list == NULL) {
gchar *error_msg = _("Could not parse PyHoca-CLI's command-line "
"features. Using a limited feature-set for now.");
REMMINA_PLUGIN_WARNING("%s", error_msg);
return rmplugin_x2go_old_pyhoca_features();
}
REMMINA_PLUGIN_INFO("%s", _("Retrieved the following PyHoca-CLI "
"command-line features:"));
for(int k = 0; features_list[k] != NULL; k++) {
// Filter out empty strings
if (strlen(features_list[k]) <= 0) continue;
REMMINA_PLUGIN_INFO("%s",
g_strdup_printf(_("Available feature[%i]: '%s'"),
k+1, features_list[k]));
returning_glist = g_list_append(returning_glist, features_list[k]);
}
return returning_glist;
}
}
static void rmplugin_x2go_on_plug_added(GtkSocket *socket, RemminaProtocolWidget *gp)
{
TRACE_CALL(__func__);
RemminaPluginX2GoData *gpdata = GET_PLUGIN_DATA(gp);
REMMINA_PLUGIN_DEBUG("Socket %d", gpdata->socket_id);
rm_plugin_service->protocol_plugin_signal_connection_opened(gp);
return;
}
static gboolean rmplugin_x2go_on_plug_removed(GtkSocket *socket, RemminaProtocolWidget *gp)
{
TRACE_CALL(__func__);
REMMINA_PLUGIN_DEBUG("Function entry.");
rmplugin_x2go_close_connection(gp);
return G_SOURCE_CONTINUE;
}
static void rmplugin_x2go_init(RemminaProtocolWidget *gp)
{
TRACE_CALL(__func__);
REMMINA_PLUGIN_DEBUG("Function entry.", PLUGIN_NAME);
RemminaPluginX2GoData *gpdata;
gpdata = g_new0(RemminaPluginX2GoData, 1);
g_object_set_data_full(G_OBJECT(gp), "plugin-data", gpdata, g_free);
if (!rm_plugin_service->gtksocket_available()) {
/* report this in open_connection, not reportable here... */
return;
}
GList* available_features = rmplugin_x2go_populate_available_features_list();
// available_features can't be NULL cause if it fails, it gets populated with an
// old standard feature set.
gpdata->available_features = available_features;
gpdata->socket_id = 0;
gpdata->thread = 0;
gpdata->display = NULL;
gpdata->window_id = 0;
gpdata->pidx2go = 0;
gpdata->orig_handler = NULL;
gpdata->socket = gtk_socket_new();
rm_plugin_service->protocol_plugin_register_hostkey(gp, gpdata->socket);
gtk_widget_show(gpdata->socket);
g_signal_connect(G_OBJECT(gpdata->socket), "plug-added",
G_CALLBACK(rmplugin_x2go_on_plug_added), gp);
g_signal_connect(G_OBJECT(gpdata->socket), "plug-removed",
G_CALLBACK(rmplugin_x2go_on_plug_removed), gp);
gtk_container_add(GTK_CONTAINER(gp), gpdata->socket);
}
static gboolean rmplugin_x2go_try_window_id(Window window_id)
{
TRACE_CALL(__func__);
gint i;
gboolean already_seen = FALSE;
REMMINA_PLUGIN_DEBUG("Check if the window of X2Go Agent with ID [0x%lx] is already known or if "
"it needs registration", window_id);
pthread_mutex_lock(&remmina_x2go_init_mutex);
for (i = 0; i < remmina_x2go_window_id_array->len; i++) {
if (g_array_index(remmina_x2go_window_id_array, Window, i) == window_id) {
already_seen = TRUE;
REMMINA_PLUGIN_DEBUG("Window of X2Go Agent with ID [0x%lx] "
"already seen.", window_id);
break;
}
}
if (!already_seen) {
g_array_append_val(remmina_x2go_window_id_array, window_id);
REMMINA_PLUGIN_DEBUG("Registered new window for X2Go Agent with "
"ID [0x%lx].", window_id);
}
pthread_mutex_unlock(&remmina_x2go_init_mutex);
return (!already_seen);
}
static int rmplugin_x2go_dummy_handler(Display *dsp, XErrorEvent *err)
{
TRACE_CALL(__func__);
return 0;
}
static gboolean rmplugin_x2go_start_create_notify(RemminaProtocolWidget *gp, gchar *errmsg)
{
TRACE_CALL(__func__);
RemminaPluginX2GoData *gpdata = GET_PLUGIN_DATA(gp);
gpdata->display = XOpenDisplay(gdk_display_get_name(gdk_display_get_default()));
if (gpdata->display == NULL) {
g_strlcpy(errmsg, _("Could not open X11 DISPLAY."), 512);
return FALSE;
}
gpdata->orig_handler = XSetErrorHandler(rmplugin_x2go_dummy_handler);
XSelectInput(gpdata->display,
XDefaultRootWindow(gpdata->display),
SubstructureNotifyMask);
REMMINA_PLUGIN_DEBUG("X11 event-watcher created.");
return TRUE;
}
static gboolean rmplugin_x2go_monitor_create_notify(RemminaProtocolWidget *gp,
const gchar *cmd,
gchar *errmsg)
{
TRACE_CALL(__func__);
RemminaPluginX2GoData *gpdata;
gboolean agent_window_found = FALSE;
Atom atom;
XEvent xev;
Window w;
Atom type;
int format;
unsigned long nitems, rest;
unsigned char *data = NULL;
guint16 non_createnotify_count = 0;
struct timespec ts;
// wait_amount * ts.tv_nsec = 20s
// 100 * 0.2s = 20s
int wait_amount = 100;
CANCEL_DEFER
REMMINA_PLUGIN_DEBUG("%s", _("Waiting for window of X2Go Agent to appear…"));
gpdata = GET_PLUGIN_DATA(gp);
atom = XInternAtom(gpdata->display, "WM_COMMAND", True);
if (atom == None) {
CANCEL_ASYNC
return FALSE;
}
ts.tv_sec = 0;
// 0.2s = 200000000ns
ts.tv_nsec = 200000000;
while (wait_amount > 0) {
pthread_testcancel();
if (!(gpdata->pidx2go > 0)) {
nanosleep(&ts, NULL);
REMMINA_PLUGIN_DEBUG("Waiting for X2Go session to start…");
continue;
}
while (!XPending(gpdata->display)) {
nanosleep(&ts, NULL);
wait_amount--;
// Don't spam the console. Print every second though.
if (wait_amount % 5 == 0) {
REMMINA_PLUGIN_INFO("%s", _("Waiting for PyHoca-CLI to "
"show the session's window…"));
}
continue;
}
XNextEvent(gpdata->display, &xev);
// Just ignore non CreatNotify events.
if (xev.type != CreateNotify) {
non_createnotify_count++;
if (non_createnotify_count % 5 == 0) {
REMMINA_PLUGIN_DEBUG("Saw '%i' X11 events, which weren't "
"CreateNotify.", non_createnotify_count);
}
continue;
}
w = xev.xcreatewindow.window;
if (XGetWindowProperty(gpdata->display, w, atom, 0, 255, False,
AnyPropertyType, &type, &format, &nitems, &rest,
&data) != Success) {
REMMINA_PLUGIN_DEBUG("Could not get WM_COMMAND property from X11 "
"window ID [0x%lx].", w);
continue;
}
if (data) {
REMMINA_PLUGIN_DEBUG("Saw '%i' X11 events, which weren't "
"CreateNotify.", non_createnotify_count);
REMMINA_PLUGIN_DEBUG("Found X11 window with WM_COMMAND set "
"to '%s', the window ID is [0x%lx].",
(char*)data, w);
}
if (data && g_strrstr((gchar*)data, cmd) &&
rmplugin_x2go_try_window_id(w)) {
gpdata->window_id = w;
agent_window_found = TRUE;
XFree(data);
break;
}
if (data)
XFree(data);
}
XSetErrorHandler(gpdata->orig_handler);
XCloseDisplay(gpdata->display);
gpdata->display = NULL;
CANCEL_ASYNC
if (!agent_window_found) {
g_strlcpy(errmsg, _("No X2Go session window appeared. "
"Something went wrong…"), 512);
return FALSE;
}
return TRUE;
}
static gboolean rmplugin_x2go_start_session(RemminaProtocolWidget *gp)
{
TRACE_CALL(__func__);
REMMINA_PLUGIN_DEBUG("Function entry.");
RemminaPluginX2GoData *gpdata = GET_PLUGIN_DATA(gp);;
RemminaFile *remminafile;
const gchar errmsg[512] = {0};
gboolean ret = TRUE;
gchar *servstr, *host, *username, *password, *command, *kbdlayout, *kbdtype,
*audio, *clipboard, *res;
gint sshport, dpi;
GdkDisplay *default_dsp;
gint width, height;
// We save the X Display name (:0) as we will need to synchronize the clipboards
default_dsp = gdk_display_get_default();
const gchar *default_dsp_name = gdk_display_get_name(default_dsp);
REMMINA_PLUGIN_DEBUG("Default display is '%s'.", default_dsp_name);
remminafile = rm_plugin_service->protocol_plugin_get_file(gp);
servstr = GET_PLUGIN_STRING("server");
if (servstr) {
rm_plugin_service->get_server_port(servstr, 22, &host, &sshport);
} else {
return FALSE;
}
if (!sshport) sshport=22;
username = GET_PLUGIN_STRING("username");
password = GET_PLUGIN_PASSWORD("password");
command = GET_PLUGIN_STRING("command");
if (!command) command = "TERMINAL";
kbdlayout = GET_PLUGIN_STRING("kbdlayout");
kbdtype = GET_PLUGIN_STRING("kbdtype");
audio = GET_PLUGIN_STRING("audio");
clipboard = GET_PLUGIN_STRING("clipboard");
dpi = GET_PLUGIN_INT("dpi", 0);
width = rm_plugin_service->get_profile_remote_width(gp);
height = rm_plugin_service->get_profile_remote_height(gp);
/* multiple of 4 */
width = (width + 3) & ~0x3;
height = (height + 3) & ~0x3;
if ((width > 0) && (height > 0)) {
res = g_strdup_printf ("%dx%d", width, height);
} else {
res = "800x600";
}
REMMINA_PLUGIN_DEBUG("Resolution set by user: '%s'.", res);
REMMINA_PLUGIN_DEBUG("Attached window to socket '%d'.", gpdata->socket_id);
/* register for notifications of window creation events */
if (ret) ret = rmplugin_x2go_start_create_notify(gp, (gchar*)&errmsg);
/* trigger the session start, session window should appear soon after this */
if (ret) ret = rmplugin_x2go_exec_x2go(host, sshport, username, password, command,
kbdlayout, kbdtype, audio, clipboard, dpi,
res, gp, (gchar*)&errmsg);
/* get the window ID of the remote x2goagent */
if (ret) ret = rmplugin_x2go_monitor_create_notify(gp, "x2goagent",
(gchar*)&errmsg);
if (!ret) {
REMMINA_PLUGIN_CRITICAL("%s", _(errmsg));
rm_plugin_service->protocol_plugin_set_error(gp, "%s", _(errmsg));
return FALSE;
}
/* embed it */
onMainThread_gtk_socket_add_id(GTK_SOCKET(gpdata->socket), gpdata->window_id);
return TRUE;
}
static gboolean rmplugin_x2go_main(RemminaProtocolWidget *gp)
{
TRACE_CALL(__func__);
RemminaPluginX2GoData *gpdata = GET_PLUGIN_DATA(gp);
gboolean ret = FALSE;
ret = rmplugin_x2go_start_session(gp);
gpdata->thread = 0;
return ret;
}
static gpointer rmplugin_x2go_main_thread(RemminaProtocolWidget* gp)
{
TRACE_CALL(__func__);
if (!gp) {
REMMINA_PLUGIN_CRITICAL("%s", g_strdup_printf(
_("Internal error: %s"),
_("RemminaProtocolWidget* gp is 'NULL'!")
));
return NULL;
}
pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
CANCEL_ASYNC
if (!rmplugin_x2go_main(gp)) {
IDLE_ADD((GSourceFunc) rmplugin_x2go_cleanup, gp);
}
return NULL;
}
static gboolean rmplugin_x2go_open_connection(RemminaProtocolWidget *gp)
{
TRACE_CALL(__func__);
RemminaPluginX2GoData *gpdata = GET_PLUGIN_DATA(gp);
if (!rm_plugin_service->gtksocket_available()) {
rm_plugin_service->protocol_plugin_set_error(gp, _("The %s protocol is "
"unavailable because GtkSocket only works under X.org"),
PLUGIN_NAME);
return FALSE;
}
gpdata->socket_id = gtk_socket_get_id(GTK_SOCKET(gpdata->socket));
// casting to void* is allowed since return type 'gpointer' is actually void*.
if (pthread_create(&gpdata->thread, NULL, (void*) rmplugin_x2go_main_thread, gp)) {
rm_plugin_service->protocol_plugin_set_error(gp, _("Could not initialize "
"pthread. Falling back to non-threaded mode…"));
gpdata->thread = 0;
return FALSE;
} else {
return TRUE;
}
}
static gboolean rmplugin_x2go_query_feature(RemminaProtocolWidget* gp,
const RemminaProtocolFeature* feature)
{
TRACE_CALL(__func__);
return TRUE;
}
static const RemminaProtocolFeature rmplugin_x2go_features[] = {
{REMMINA_PROTOCOL_FEATURE_TYPE_GTKSOCKET, RMPLUGIN_X2GO_FEATURE_GTKSOCKET, NULL, NULL, NULL},
{REMMINA_PROTOCOL_FEATURE_TYPE_END, 0, NULL, NULL, NULL}
};
/**
* @brief This function builds a string like: "'value1', 'value2' and 'value3'" \n
* To be used in a loop. \n
* See rmplugin_x2go_string_setting_validator() for an example.
*
* @param max_elements Number of maximum elements.
* @param element_to_add Next element to add to the string
* @param current_element Which element is element_to_add?
* @param string The string to which `element_to_add` will be added.
*/
static gchar* rmplugin_x2go_enumeration_prettifier(const guint max_elements,
const guint current_element,
gchar* element_to_add,
gchar* string)
{
if (max_elements > 2) {
if (current_element == max_elements - 1) {
// TRANSLATORS: Presumably you just want to translate 'and' into
// your language.
// (Except your listing-grammar differs from english.)
// 'value1', 'value2', 'valueN-1' and 'valueN'
return g_strdup_printf(_("%sand '%s'"), string, element_to_add);
} else if (current_element == max_elements - 2) {
// TRANSLATORS: Presumably you just want to leave it english.
// (Except your listing-grammar differs from english.)
// 'value1', 'value2', 'valueN-1' and 'valueN'
return g_strdup_printf(_("%s'%s' "), string, element_to_add);
} else {
// TRANSLATORS: Presumably you just want to leave it english.
// (Except your listing-grammar differs from english.)
// 'value1', 'value2', 'valueN-1' and 'valueN'
return g_strdup_printf(_("%s'%s', "), string, element_to_add);
}
} else if (max_elements == 2) {
if (current_element == max_elements - 1) {
// TRANSLATORS: Presumably you just want to translate 'and' into
// your language.
// (Except your listing-grammar differs from english.)
// 'value1' and 'value2'
return g_strdup_printf(_("%sand '%s'"), string, element_to_add);
} else {
// TRANSLATORS: Presumably you just want to leave it english.
// (Except your listing-grammar differs from english.)
// 'value1' and 'value2'
return g_strdup_printf(_("%s'%s' "), string, element_to_add);
}
} else {
return g_strdup(element_to_add);
}
}
/**
* @brief Validator-functions are getting executed when the user wants to save profile
* settings. It uses the given data (See RemminaProtocolSetting array) to determine
* which strings are allowed and returns a end-user friendly error message.
*
* @param key Key is the setting's name.
* @param value Value to validate.
* @param data Data needed for validation process. See RemminaProtocolSetting array.
*
* @returns End-user friendly and translated error message, explaining why the given
* value is invalid. If the given value is error-free then NULL gets returned.
*
*/
static GError* rmplugin_x2go_string_setting_validator(gchar* key, gchar* value,
gchar* data)
{
GError *error = NULL;
if (!data) {
gchar *error_msg = _("Invalid validation data in ProtocolSettings array!");
REMMINA_PLUGIN_CRITICAL("%s", error_msg);
g_set_error(&error, 1, 1, error_msg);
return error;
}
gchar **elements_list = g_strsplit(data, ",", 0);
guint elements_amount = 0;
for (; elements_list[elements_amount] != NULL; elements_amount++) {
// Just advance elements_amount...
}
if (elements_list == NULL ||
elements_list[0] == NULL ||
strlen(elements_list[0]) <= 0)
{
gchar *error_msg = _("Validation data in ProtocolSettings array is invalid!");
REMMINA_PLUGIN_CRITICAL("%s", error_msg);
g_set_error(&error, 1, 1, error_msg);
return error;
}
gchar *data_str = "";
if (!key || !value) {
REMMINA_PLUGIN_CRITICAL("%s", _("Parameters 'key' or 'value' are 'NULL'!"));
g_set_error(&error, 1, 1, _("Internal error."));
return error;
}
for (guint i = 0; elements_list[i] != NULL; i++) {
// Don't wanna crash if elements_list[i] is NULL.
gchar* element = elements_list[i] ? elements_list[i] : "";
if (g_strcmp0(value, element) == 0) {
// We found value in elements_list. Value passed validation.
return NULL;
}
data_str = rmplugin_x2go_enumeration_prettifier(elements_amount, i,
element, data_str);
}
if (elements_amount > 1) {
g_set_error(&error, 1, 1, _("Allowed values are %s."), data_str);
} else {
g_set_error(&error, 1, 1, _("The only allowed value is '%s'."), data_str);
}
g_free(data_str);
g_strfreev(elements_list);
return error;
}
/**
* @brief Validator-functions are getting executed when the user wants to save profile
* settings. It uses the given data (See RemminaProtocolSetting array) to determine
* if the given value is a valid integer is in range and returns a end-user
* friendly error message.
*
* @param key Key is the setting's name.
* @param value Value to validate.
* @param data Data needed for validation process. See RemminaProtocolSetting array.
*
* @returns End-user friendly and translated error message, explaining why the given
* value is invalid. If the given value is error-free then NULL gets returned.
*
*/
static GError* rmplugin_x2go_int_setting_validator(gchar* key, gpointer value,
gchar* data)
{
GError *error = NULL;
gchar **integer_list = g_strsplit(data, ";", 0);
if (integer_list == NULL ||
integer_list[0] == NULL ||
integer_list[1] == NULL ||
strlen(integer_list[0]) <= 0 ||
strlen(integer_list[1]) <= 0)
{
gchar *error_msg = _("Validation data in ProtocolSettings array is invalid!");
REMMINA_PLUGIN_CRITICAL("%s", error_msg);
g_set_error(&error, 1, 1, error_msg);
return error;
}
gint minimum;
str2int_errno err = str2int(&minimum, integer_list[0], 10);
if (err == STR2INT_INCONVERTIBLE) {
g_set_error(&error, 1, 1, g_strdup_printf(
_("Internal error: %s"),
_("The lower limit is not a valid integer!")
));
} else if (err == STR2INT_OVERFLOW) {
g_set_error(&error, 1, 1, g_strdup_printf(
_("Internal error: %s"),
_("The lower limit is too high!")
));
} else if (err == STR2INT_UNDERFLOW) {
g_set_error(&error, 1, 1, g_strdup_printf(
_("Internal error: %s"),
_("The lower limit is too low!")
));
} else if (err == STR2INT_INVALID_DATA) {
g_set_error(&error, 1, 1, g_strdup_printf(
_("Internal error: %s"),
_("Something unknown went wrong.")
));
}
if (error) {
REMMINA_PLUGIN_CRITICAL("%s", _("Please check the RemminaProtocolSetting "
"array for possible errors."));
return error;
}
gint maximum;
err = str2int(&maximum, integer_list[1], 10);
if (err == STR2INT_INCONVERTIBLE) {
g_set_error(&error, 1, 1, g_strdup_printf(
_("Internal error: %s"),
_("The upper limit is not a valid integer!")
));
} else if (err == STR2INT_OVERFLOW) {
g_set_error(&error, 1, 1, g_strdup_printf(
_("Internal error: %s"),
_("The upper limit is too high!")
));
} else if (err == STR2INT_UNDERFLOW) {
g_set_error(&error, 1, 1, g_strdup_printf(
_("Internal error: %s"),
_("The upper limit is too low!")
));
} else if (err == STR2INT_INVALID_DATA) {
g_set_error(&error, 1, 1, g_strdup_printf(
_("Internal error: %s"),
_("Something unknown went wrong.")
));
}
if (error) {
REMMINA_PLUGIN_CRITICAL("%s", _("Please check the RemminaProtocolSetting "
"array for possible errors."));
return error;
}
gint int_value;
err = str2int(&int_value, value, 10);
if (err == STR2INT_INCONVERTIBLE) {
// Can't happen in theory since non-numerical characters are can't
// be entered but, let's be safe.
g_set_error(&error, 1, 1, _("The input is not a valid integer!"));
} else if (err == STR2INT_OVERFLOW || err == STR2INT_UNDERFLOW) {
g_set_error(&error, 1, 1, _("Input must be a number between %i and %i."),
minimum, maximum);
} else if (err == STR2INT_INVALID_DATA) {
g_set_error(&error, 1, 1, _("Something unknown went wrong."));
}
if (error) {
REMMINA_PLUGIN_CRITICAL("%s", _("Please check the RemminaProtocolSetting "
"array for possible errors."));
return error;
}
/*REMMINA_PLUGIN_DEBUG("Key: \t%s", (gchar*) key);
REMMINA_PLUGIN_DEBUG("Value:\t%s", (gchar*) value);
REMMINA_PLUGIN_DEBUG("Data: \t%s", data);
REMMINA_PLUGIN_DEBUG("Min: %i, Max: %i", minimum, maximum);
REMMINA_PLUGIN_DEBUG("Value converted:\t%i", int_value);*/
if (err == STR2INT_SUCCESS && (minimum > int_value || int_value > maximum)) {
g_set_error(&error, 1, 1, _("Input must be a number between %i and %i."),
minimum, maximum);
}
// Should be NULL.
return error;
}
/* Array of RemminaProtocolSetting for basic settings.
* Each item is composed by:
* a) RemminaProtocolSettingType for setting type
* b) Setting name
* c) Setting description
* d) Compact disposition
* e) Values for REMMINA_PROTOCOL_SETTING_TYPE_SELECT or REMMINA_PROTOCOL_SETTING_TYPE_COMBO
* f) Setting tooltip
* g) Validation data pointer, will be passed to the validation callback method.
* h) Validation callback method (Can be NULL. Every entry will be valid then.)
* use following prototype:
* gboolean mysetting_validator_method(gpointer key, gpointer value,
* gpointer validator_data);
* gpointer key is a gchar* containing the setting's name,
* gpointer value contains the value which should be validated,
* gpointer validator_data contains your passed data.
*/
static const RemminaProtocolSetting rmplugin_x2go_basic_settings[] = {
{REMMINA_PROTOCOL_SETTING_TYPE_SERVER, "server", NULL, FALSE, NULL, NULL, NULL, NULL},
{REMMINA_PROTOCOL_SETTING_TYPE_TEXT, "username", N_("Username"), FALSE, NULL, NULL, NULL, NULL},
{REMMINA_PROTOCOL_SETTING_TYPE_PASSWORD, "password", N_("Password"), FALSE, NULL, NULL, NULL, NULL},
{REMMINA_PROTOCOL_SETTING_TYPE_COMBO, "command", N_("Startup program"), FALSE,
/* SELECT & COMBO Values */ "MATE,KDE,XFCE,LXDE,TERMINAL",
/* Tooltip */ N_("Which command should be executed after creating the X2Go session?"), NULL, NULL},
{REMMINA_PROTOCOL_SETTING_TYPE_RESOLUTION, "resolution", NULL, FALSE, NULL, NULL, NULL, NULL},
{REMMINA_PROTOCOL_SETTING_TYPE_TEXT, "kbdlayout", N_("Keyboard Layout (auto)"), FALSE, NULL, NULL, NULL, NULL},
{REMMINA_PROTOCOL_SETTING_TYPE_TEXT, "kbdtype", N_("Keyboard type (auto)"), FALSE, NULL, NULL, NULL, NULL},
{REMMINA_PROTOCOL_SETTING_TYPE_COMBO, "audio", N_("Audio support"), FALSE,
/* SELECT & COMBO Values */ "pulse,esd,none",
/* Tooltip */ N_("The sound system of the X2Go server (default: 'pulse')."),
/* Validation data */ "pulse,esd,none",
/* Validation method */ G_CALLBACK(rmplugin_x2go_string_setting_validator)},
{REMMINA_PROTOCOL_SETTING_TYPE_COMBO, "clipboard", N_("Clipboard direction"), FALSE,
/* SELECT & COMBO Values */ "none,server,client,both",
/* Tooltip */ N_("Which direction should clipboard content be copied? "
"(default: 'both')."),
/* Validation data */ "none,server,client,both",
/* Validation method */ G_CALLBACK(rmplugin_x2go_string_setting_validator)},
{REMMINA_PROTOCOL_SETTING_TYPE_INT, "dpi", N_("DPI resolution"), FALSE, NULL,
/* Tooltip */ N_("Launch session with a specific resolution (in dots per inch). "
"Must be between 20 and 400."),
/* Validation data */ "20;400", // "<min>;<max>;"
/* Validation method */ G_CALLBACK(rmplugin_x2go_int_setting_validator)},
{REMMINA_PROTOCOL_SETTING_TYPE_END, NULL, NULL, FALSE, NULL, NULL, NULL, NULL}};
/* Protocol plugin definition and features */
static RemminaProtocolPlugin rmplugin_x2go = {
REMMINA_PLUGIN_TYPE_PROTOCOL, // Type
PLUGIN_NAME, // Name
PLUGIN_DESCRIPTION, // Description
GETTEXT_PACKAGE, // Translation domain
PLUGIN_VERSION, // Version number
PLUGIN_APPICON, // Icon for normal connection
PLUGIN_SSH_APPICON, // Icon for SSH connection
rmplugin_x2go_basic_settings, // Array for basic settings
NULL, // Array for advanced settings
REMMINA_PROTOCOL_SSH_SETTING_TUNNEL, // SSH settings type
/* REMMINA_PROTOCOL_SSH_SETTING_NONE, // SSH settings type */
rmplugin_x2go_features, // Array for available features
rmplugin_x2go_init, // Plugin initialization method
rmplugin_x2go_open_connection, // Plugin open connection method
rmplugin_x2go_close_connection, // Plugin connection-method closure
rmplugin_x2go_query_feature, // Query for available features
NULL, // Call a feature
NULL, // Send a keystroke
NULL, // Screenshot
};
G_MODULE_EXPORT gboolean remmina_plugin_entry(RemminaPluginService *service)
{
TRACE_CALL("remmina_plugin_entry");
rm_plugin_service = service;
bindtextdomain(GETTEXT_PACKAGE, REMMINA_RUNTIME_LOCALEDIR);
bind_textdomain_codeset(GETTEXT_PACKAGE, "UTF-8");
if (!service->register_plugin((RemminaPlugin *) &rmplugin_x2go)) {
return FALSE;
}
pthread_mutex_init(&remmina_x2go_init_mutex, NULL);
remmina_x2go_window_id_array = g_array_new(FALSE, TRUE, sizeof(Window));
REMMINA_PLUGIN_MESSAGE("%s", _("X2Go plugin loaded."));
return TRUE;
}
|