forked from rdesktop/rdesktop
-
Notifications
You must be signed in to change notification settings - Fork 1
/
xclip.c
1223 lines (1086 loc) · 36.8 KB
/
xclip.c
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
/* -*- c-basic-offset: 8 -*-
rdesktop: A Remote Desktop Protocol client.
Protocol services - Clipboard functions
Copyright 2003-2008 Erik Forsberg <[email protected]> for Cendio AB
Copyright (C) Matthew Chapman <matthewc.unsw.edu.au> 2003-2008
Copyright 2006-2011 Pierre Ossman <[email protected]> for Cendio AB
Copyright 2017 Henrik Andersson <[email protected]> for Cendio AB
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 3 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, see <http://www.gnu.org/licenses/>.
*/
#include <X11/Xlib.h>
#include <X11/Xatom.h>
#include "rdesktop.h"
/*
To gain better understanding of this code, one could be assisted by the following documents:
- Inter-Client Communication Conventions Manual (ICCCM)
HTML: http://tronche.com/gui/x/icccm/
PDF: http://ftp.xfree86.org/pub/XFree86/4.5.0/doc/PDF/icccm.pdf
- MSDN: Clipboard Formats
http://msdn.microsoft.com/library/en-us/winui/winui/windowsuserinterface/dataexchange/clipboard/clipboardformats.asp
*/
#ifdef HAVE_LANGINFO_H
#include <langinfo.h>
#include <iconv.h>
#define USE_UNICODE_CLIPBOARD
#endif
#ifdef USE_UNICODE_CLIPBOARD
#define RDP_CF_TEXT CF_UNICODETEXT
#else
#define RDP_CF_TEXT CF_TEXT
#endif
#define MAX_TARGETS 8
extern Display *g_display;
extern Window g_wnd;
extern Time g_last_gesturetime;
extern RD_BOOL g_rdpclip;
/* Mode of operation.
- Auto: Look at both PRIMARY and CLIPBOARD and use the most recent.
- Non-auto: Look at just CLIPBOARD. */
static RD_BOOL auto_mode = True;
/* Atoms of the two X selections we're dealing with: CLIPBOARD (explicit-copy) and PRIMARY (selection-copy) */
static Atom clipboard_atom, primary_atom;
/* Atom of the TARGETS clipboard target */
static Atom targets_atom;
/* Atom of the TIMESTAMP clipboard target */
static Atom timestamp_atom;
/* Atom _RDESKTOP_CLIPBOARD_TARGET which is used as the 'property' argument in
XConvertSelection calls: This is the property of our window into which
XConvertSelection will store the received clipboard data. */
static Atom rdesktop_clipboard_target_atom;
/* Atoms _RDESKTOP_PRIMARY_TIMESTAMP_TARGET and _RDESKTOP_CLIPBOARD_TIMESTAMP_TARGET
are used to store the timestamps for when a window got ownership of the selections.
We use these to determine which is more recent and should be used. */
static Atom rdesktop_primary_timestamp_target_atom, rdesktop_clipboard_timestamp_target_atom;
/* Storage for timestamps since we get them in two separate notifications. */
static Time primary_timestamp, clipboard_timestamp;
/* Clipboard target for getting a list of native Windows clipboard formats. The
presence of this target indicates that the selection owner is another rdesktop. */
static Atom rdesktop_clipboard_formats_atom;
/* The clipboard target (X jargon for "clipboard format") for rdesktop-to-rdesktop
interchange of Windows native clipboard data. The requestor must supply the
desired native Windows clipboard format in the associated property. */
static Atom rdesktop_native_atom;
/* Local copy of the list of native Windows clipboard formats. */
static uint8 *formats_data = NULL;
static uint32 formats_data_length = 0;
/* We need to know when another rdesktop process gets or loses ownership of a
selection. Without XFixes we do this by touching a property on the root window
which will generate PropertyNotify notifications. */
static Atom rdesktop_selection_notify_atom;
/* State variables that indicate if we're currently probing the targets of the
selection owner. reprobe_selections indicate that the ownership changed in
the middle of the current probe so it should be restarted. */
static RD_BOOL probing_selections, reprobe_selections;
/* Atoms _RDESKTOP_PRIMARY_OWNER and _RDESKTOP_CLIPBOARD_OWNER. Used as properties
on the root window to indicate which selections that are owned by rdesktop. */
static Atom rdesktop_primary_owner_atom, rdesktop_clipboard_owner_atom;
static Atom format_string_atom, format_utf8_string_atom, format_unicode_atom;
/* Atom of the INCR clipboard type (see ICCCM on "INCR Properties") */
static Atom incr_atom;
/* Stores the last "selection request" (= another X client requesting clipboard data from us).
To satisfy such a request, we request the clipboard data from the RDP server.
When we receive the response from the RDP server (asynchronously), this variable gives us
the context to proceed. */
static XSelectionRequestEvent selection_request;
/* Denotes we have a pending selection request. */
static RD_BOOL has_selection_request;
/* Stores the clipboard format (CF_TEXT, CF_UNICODETEXT etc.) requested in the last
CLIPDR_DATA_REQUEST (= the RDP server requesting clipboard data from us).
When we receive this data from whatever X client offering it, this variable gives us
the context to proceed.
*/
static int rdp_clipboard_request_format;
/* Array of offered clipboard targets that will be sent to fellow X clients upon a TARGETS request. */
static Atom targets[MAX_TARGETS];
static int num_targets;
/* Denotes that an rdesktop (not this rdesktop) is owning the selection,
allowing us to interchange Windows native clipboard data directly. */
static RD_BOOL rdesktop_is_selection_owner = False;
/* Time when we acquired the selection. */
static Time acquire_time = 0;
/* Denotes that an INCR ("chunked") transfer is in progress. */
static int g_waiting_for_INCR = 0;
/* Denotes the target format of the ongoing INCR ("chunked") transfer. */
static Atom g_incr_target = 0;
/* Buffers an INCR transfer. */
static uint8 *g_clip_buffer = 0;
/* Denotes the size of g_clip_buffer. */
static uint32 g_clip_buflen = 0;
/* Translates CR-LF to LF.
Changes the string in-place.
Does not stop on embedded nulls.
The length is updated. */
static void
crlf2lf(uint8 * data, uint32 * length)
{
uint8 *dst, *src;
src = dst = data;
while (src < data + *length)
{
if (*src != '\x0d')
*dst++ = *src;
src++;
}
*length = dst - data;
}
#ifdef USE_UNICODE_CLIPBOARD
/* Translate LF to CR-LF. To do this, we must allocate more memory.
The returned string is null-terminated, as required by CF_UNICODETEXT.
The size is updated. */
static uint8 *
utf16_lf2crlf(uint8 * data, uint32 * size)
{
uint8 *result;
uint16 *inptr, *outptr;
RD_BOOL swap_endianness;
/* Worst case: Every char is LF */
result = xmalloc((*size * 2) + 2);
if (result == NULL)
return NULL;
inptr = (uint16 *) data;
outptr = (uint16 *) result;
/* Check for a reversed BOM */
swap_endianness = (*inptr == 0xfffe);
uint16 uvalue_previous = 0; /* Kept so we'll avoid translating CR-LF to CR-CR-LF */
while ((uint8 *) inptr < data + *size)
{
uint16 uvalue = *inptr;
if (swap_endianness)
uvalue = ((uvalue << 8) & 0xff00) + (uvalue >> 8);
if ((uvalue == 0x0a) && (uvalue_previous != 0x0d))
*outptr++ = swap_endianness ? 0x0d00 : 0x0d;
uvalue_previous = uvalue;
*outptr++ = *inptr++;
}
*outptr++ = 0; /* null termination */
*size = (uint8 *) outptr - result;
return result;
}
#else
/* Translate LF to CR-LF. To do this, we must allocate more memory.
The length is updated. */
static uint8 *
lf2crlf(uint8 * data, uint32 * length)
{
uint8 *result, *p, *o;
/* Worst case: Every char is LF */
result = xmalloc(*length * 2);
p = data;
o = result;
uint8 previous = '\0'; /* Kept to avoid translating CR-LF to CR-CR-LF */
while (p < data + *length)
{
if ((*p == '\x0a') && (previous != '\x0d'))
*o++ = '\x0d';
previous = *p;
*o++ = *p++;
}
*length = o - result;
/* Convenience */
*o++ = '\0';
return result;
}
#endif
static void
xclip_provide_selection(XSelectionRequestEvent * req, Atom type, unsigned int format, uint8 * data,
uint32 length)
{
XEvent xev;
logger(Clipboard, Debug,
"xclip_provide_selection(), requestor=0x%08x, target=%s, property=%s, length=%u",
(unsigned) req->requestor, XGetAtomName(g_display, req->target),
XGetAtomName(g_display, req->property), (unsigned) length);
XChangeProperty(g_display, req->requestor, req->property,
type, format, PropModeReplace, data, length);
xev.xselection.type = SelectionNotify;
xev.xselection.serial = 0;
xev.xselection.send_event = True;
xev.xselection.requestor = req->requestor;
xev.xselection.selection = req->selection;
xev.xselection.target = req->target;
xev.xselection.property = req->property;
xev.xselection.time = req->time;
XSendEvent(g_display, req->requestor, False, NoEventMask, &xev);
}
/* Replies a clipboard requestor, telling that we're unable to satisfy his request for whatever reason.
This has the benefit of finalizing the clipboard negotiation and thus not leaving our requestor
lingering (and, potentially, stuck). */
static void
xclip_refuse_selection(XSelectionRequestEvent * req)
{
XEvent xev;
logger(Clipboard, Debug,
"xclip_refuse_selection(), requestor=0x%08x, target=%s, property=%s",
(unsigned) req->requestor, XGetAtomName(g_display, req->target),
XGetAtomName(g_display, req->property));
xev.xselection.type = SelectionNotify;
xev.xselection.serial = 0;
xev.xselection.send_event = True;
xev.xselection.requestor = req->requestor;
xev.xselection.selection = req->selection;
xev.xselection.target = req->target;
xev.xselection.property = None;
xev.xselection.time = req->time;
XSendEvent(g_display, req->requestor, False, NoEventMask, &xev);
}
/* Wrapper for cliprdr_send_data which also cleans the request state. */
static void
helper_cliprdr_send_response(uint8 * data, uint32 length)
{
if (rdp_clipboard_request_format != 0)
{
cliprdr_send_data(data, length);
rdp_clipboard_request_format = 0;
if (!rdesktop_is_selection_owner)
cliprdr_send_simple_native_format_announce(RDP_CF_TEXT);
}
}
/* Last resort, when we have to provide clipboard data but for whatever
reason couldn't get any.
*/
static void
helper_cliprdr_send_empty_response()
{
helper_cliprdr_send_response(NULL, 0);
}
/* Replies with clipboard data to RDP, converting it from the target format
to the expected RDP format as necessary. Returns true if data was sent.
*/
static RD_BOOL
xclip_send_data_with_convert(uint8 * source, size_t source_size, Atom target)
{
logger(Clipboard, Debug, "xclip_send_data_with_convert(), target=%s, size=%u",
XGetAtomName(g_display, target), (unsigned) source_size);
#ifdef USE_UNICODE_CLIPBOARD
if (target == format_string_atom ||
target == format_unicode_atom || target == format_utf8_string_atom)
{
size_t unicode_buffer_size;
char *unicode_buffer;
iconv_t cd;
size_t unicode_buffer_size_remaining;
char *unicode_buffer_remaining;
char *data_remaining;
size_t data_size_remaining;
uint32 translated_data_size;
uint8 *translated_data;
if (rdp_clipboard_request_format != RDP_CF_TEXT)
return False;
/* Make an attempt to convert any string we send to Unicode.
We don't know what the RDP server's ANSI Codepage is, or how to convert
to it, so using CF_TEXT is not safe (and is unnecessary, since all
WinNT versions are Unicode-minded).
*/
if (target == format_string_atom)
{
char *locale_charset = nl_langinfo(CODESET);
cd = iconv_open(WINDOWS_CODEPAGE, locale_charset);
if (cd == (iconv_t) - 1)
{
logger(Clipboard, Error,
"xclip_send_data_with_convert(), convert failed, locale charset %s not found",
locale_charset);
return False;
}
unicode_buffer_size = source_size * 4;
}
else if (target == format_unicode_atom)
{
cd = iconv_open(WINDOWS_CODEPAGE, "UCS-2");
if (cd == (iconv_t) - 1)
{
return False;
}
unicode_buffer_size = source_size;
}
else if (target == format_utf8_string_atom)
{
cd = iconv_open(WINDOWS_CODEPAGE, "UTF-8");
if (cd == (iconv_t) - 1)
{
return False;
}
/* UTF-8 is guaranteed to be less or equally compact
as UTF-16 for all Unicode chars >=2 bytes.
*/
unicode_buffer_size = source_size * 2;
}
else
{
return False;
}
unicode_buffer = xmalloc(unicode_buffer_size);
unicode_buffer_size_remaining = unicode_buffer_size;
unicode_buffer_remaining = unicode_buffer;
data_remaining = (char *) source;
data_size_remaining = source_size;
iconv(cd, (char **) &data_remaining, &data_size_remaining,
&unicode_buffer_remaining, &unicode_buffer_size_remaining);
iconv_close(cd);
/* translate linebreaks */
translated_data_size = unicode_buffer_size - unicode_buffer_size_remaining;
translated_data = utf16_lf2crlf((uint8 *) unicode_buffer, &translated_data_size);
if (translated_data != NULL)
{
logger(Clipboard, Debug,
"xclip_send_data_with_convert(), sending unicode string of %d bytes",
translated_data_size);
helper_cliprdr_send_response(translated_data, translated_data_size);
xfree(translated_data); /* Not the same thing as XFree! */
}
xfree(unicode_buffer);
return True;
}
#else
if (target == format_string_atom)
{
uint8 *translated_data;
uint32 length = source_size;
if (rdp_clipboard_request_format != RDP_CF_TEXT)
return False;
logger(Clipboard, Debug,
"xclip_send_data_with_convert(), translating linebreaks before sending data");
translated_data = lf2crlf(source, &length);
if (translated_data != NULL)
{
helper_cliprdr_send_response(translated_data, length + 1);
xfree(translated_data); /* Not the same thing as XFree! */
}
return True;
}
#endif
else if (target == rdesktop_native_atom)
{
helper_cliprdr_send_response(source, source_size + 1);
return True;
}
else
{
return False;
}
}
static void
xclip_clear_target_props()
{
XDeleteProperty(g_display, g_wnd, rdesktop_clipboard_target_atom);
XDeleteProperty(g_display, g_wnd, rdesktop_primary_timestamp_target_atom);
XDeleteProperty(g_display, g_wnd, rdesktop_clipboard_timestamp_target_atom);
}
static void
xclip_notify_change()
{
XChangeProperty(g_display, DefaultRootWindow(g_display),
rdesktop_selection_notify_atom, XA_INTEGER, 32, PropModeReplace, NULL, 0);
}
static void
xclip_probe_selections()
{
Window primary_owner, clipboard_owner;
if (probing_selections)
{
logger(Clipboard, Debug,
"xclip_probe_selection(), already probing selections, scheduling reprobe");
reprobe_selections = True;
return;
}
logger(Clipboard, Debug, "xclip_probe_selection(), probing selections");
probing_selections = True;
reprobe_selections = False;
xclip_clear_target_props();
if (auto_mode)
primary_owner = XGetSelectionOwner(g_display, primary_atom);
else
primary_owner = None;
clipboard_owner = XGetSelectionOwner(g_display, clipboard_atom);
/* If we own all relevant selections then don't do anything. */
if (((primary_owner == g_wnd) || !auto_mode) && (clipboard_owner == g_wnd))
goto end;
/* Both available */
if ((primary_owner != None) && (clipboard_owner != None))
{
primary_timestamp = 0;
clipboard_timestamp = 0;
XConvertSelection(g_display, primary_atom, timestamp_atom,
rdesktop_primary_timestamp_target_atom, g_wnd, CurrentTime);
XConvertSelection(g_display, clipboard_atom, timestamp_atom,
rdesktop_clipboard_timestamp_target_atom, g_wnd, CurrentTime);
return;
}
/* Just PRIMARY */
if (primary_owner != None)
{
XConvertSelection(g_display, primary_atom, targets_atom,
rdesktop_clipboard_target_atom, g_wnd, CurrentTime);
return;
}
/* Just CLIPBOARD */
if (clipboard_owner != None)
{
XConvertSelection(g_display, clipboard_atom, targets_atom,
rdesktop_clipboard_target_atom, g_wnd, CurrentTime);
return;
}
logger(Clipboard, Debug, "xclip_probe_selection(), no owner of any selection");
/* FIXME:
Without XFIXES, we cannot reliably know the formats offered by an
upcoming selection owner, so we just lie about him offering
RDP_CF_TEXT. */
cliprdr_send_simple_native_format_announce(RDP_CF_TEXT);
end:
probing_selections = False;
}
/* This function is called for SelectionNotify events.
The SelectionNotify event is sent from the clipboard owner to the requestor
after his request was satisfied.
If this function is called, we're the requestor side. */
void
xclip_handle_SelectionNotify(XSelectionEvent * event)
{
unsigned long i, nitems, bytes_left;
XWindowAttributes wa;
Atom type;
Atom *supported_targets;
int res, format;
uint8 *data = NULL;
if (event->property == None)
goto fail;
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), selection=%s, target=%s, property=%s",
XGetAtomName(g_display, event->selection), XGetAtomName(g_display, event->target),
XGetAtomName(g_display, event->property));
if (event->target == timestamp_atom)
{
if (event->selection == primary_atom)
{
res = XGetWindowProperty(g_display, g_wnd,
rdesktop_primary_timestamp_target_atom, 0,
XMaxRequestSize(g_display), False, AnyPropertyType,
&type, &format, &nitems, &bytes_left, &data);
}
else
{
res = XGetWindowProperty(g_display, g_wnd,
rdesktop_clipboard_timestamp_target_atom, 0,
XMaxRequestSize(g_display), False, AnyPropertyType,
&type, &format, &nitems, &bytes_left, &data);
}
if ((res != Success) || (nitems != 1) || (format != 32))
{
logger(Clipboard, Error,
"xclip_handle_SelectionNotify(), XGetWindowProperty failed");
goto fail;
}
if (event->selection == primary_atom)
{
primary_timestamp = *(Time *) data;
if (primary_timestamp == 0)
primary_timestamp++;
XDeleteProperty(g_display, g_wnd, rdesktop_primary_timestamp_target_atom);
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), got PRIMARY timestamp: %u",
(unsigned) primary_timestamp);
}
else
{
clipboard_timestamp = *(Time *) data;
if (clipboard_timestamp == 0)
clipboard_timestamp++;
XDeleteProperty(g_display, g_wnd, rdesktop_clipboard_timestamp_target_atom);
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), got CLIPBOARD timestamp: %u",
(unsigned) clipboard_timestamp);
}
XFree(data);
if (primary_timestamp && clipboard_timestamp)
{
if (primary_timestamp > clipboard_timestamp)
{
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), PRIMARY is most recent selection");
XConvertSelection(g_display, primary_atom, targets_atom,
rdesktop_clipboard_target_atom, g_wnd,
event->time);
}
else
{
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), CLIPBOARD is most recent selection");
XConvertSelection(g_display, clipboard_atom, targets_atom,
rdesktop_clipboard_target_atom, g_wnd,
event->time);
}
}
return;
}
if (probing_selections && reprobe_selections)
{
probing_selections = False;
xclip_probe_selections();
return;
}
res = XGetWindowProperty(g_display, g_wnd, rdesktop_clipboard_target_atom,
0, XMaxRequestSize(g_display), False, AnyPropertyType,
&type, &format, &nitems, &bytes_left, &data);
xclip_clear_target_props();
if (res != Success)
{
logger(Clipboard, Error,
"xclip_handle_SelectionNotify(), XGetWindowProperty() failed");
goto fail;
}
if (type == incr_atom)
{
logger(Clipboard, Debug, "xclip_handle_SelectionNotify(), received INCR");
XGetWindowAttributes(g_display, g_wnd, &wa);
if ((wa.your_event_mask | PropertyChangeMask) != wa.your_event_mask)
{
XSelectInput(g_display, g_wnd, (wa.your_event_mask | PropertyChangeMask));
}
XFree(data);
data = NULL;
g_incr_target = event->target;
g_waiting_for_INCR = 1;
goto end;
}
/* Negotiate target format */
if (event->target == targets_atom)
{
/* Determine the best of text targets that we have available:
Prefer UTF8_STRING > text/unicode (unspecified encoding) > STRING
(ignore TEXT and COMPOUND_TEXT because we don't have code to handle them)
*/
int text_target_satisfaction = 0;
Atom best_text_target = 0; /* measures how much we're satisfied with what we found */
if (type != None)
{
supported_targets = (Atom *) data;
for (i = 0; i < nitems; i++)
{
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), target %d: %s", i,
XGetAtomName(g_display, supported_targets[i]));
if (supported_targets[i] == format_string_atom)
{
if (text_target_satisfaction < 1)
{
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), other party supports STRING, choosing that as best_target");
best_text_target = supported_targets[i];
text_target_satisfaction = 1;
}
}
#ifdef USE_UNICODE_CLIPBOARD
else if (supported_targets[i] == format_unicode_atom)
{
if (text_target_satisfaction < 2)
{
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), other party supports text/unicode, choosing that as best_target");
best_text_target = supported_targets[i];
text_target_satisfaction = 2;
}
}
else if (supported_targets[i] == format_utf8_string_atom)
{
if (text_target_satisfaction < 3)
{
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), other party supports UTF8_STRING, choosing that as best_target");
best_text_target = supported_targets[i];
text_target_satisfaction = 3;
}
}
#endif
else if (supported_targets[i] == rdesktop_clipboard_formats_atom)
{
if (probing_selections && (text_target_satisfaction < 4))
{
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), other party supports native formats, choosing that as best_target");
best_text_target = supported_targets[i];
text_target_satisfaction = 4;
}
}
}
}
/* Kickstarting the next step in the process of satisfying RDP's
clipboard request -- specifically, requesting the actual clipboard data.
*/
if ((best_text_target != 0)
&& (!probing_selections
|| (best_text_target == rdesktop_clipboard_formats_atom)))
{
XConvertSelection(g_display, event->selection, best_text_target,
rdesktop_clipboard_target_atom, g_wnd, event->time);
goto end;
}
else
{
logger(Clipboard, Error,
"xclip_handle_SelectionNotify(), unable to find a textual target to satisfy RDP clipboard text request");
goto fail;
}
}
else
{
if (probing_selections)
{
Window primary_owner, clipboard_owner;
/* FIXME:
Without XFIXES, we must make sure that the other
rdesktop owns all relevant selections or we might try
to get a native format from non-rdesktop window later
on. */
clipboard_owner = XGetSelectionOwner(g_display, clipboard_atom);
if (auto_mode)
primary_owner = XGetSelectionOwner(g_display, primary_atom);
else
primary_owner = clipboard_owner;
if (primary_owner != clipboard_owner)
goto fail;
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), got fellow rdesktop formats");
probing_selections = False;
rdesktop_is_selection_owner = True;
cliprdr_send_native_format_announce(data, nitems);
}
else if ((!nitems) || (!xclip_send_data_with_convert(data, nitems, event->target)))
{
goto fail;
}
}
end:
if (data)
XFree(data);
return;
fail:
xclip_clear_target_props();
if (probing_selections)
{
logger(Clipboard, Debug,
"xclip_handle_SelectionNotify(), unable to find suitable target, using default text format");
probing_selections = False;
rdesktop_is_selection_owner = False;
/* FIXME:
Without XFIXES, we cannot reliably know the formats offered by an
upcoming selection owner, so we just lie about him offering
RDP_CF_TEXT. */
cliprdr_send_simple_native_format_announce(RDP_CF_TEXT);
}
else
{
helper_cliprdr_send_empty_response();
}
goto end;
}
/* This function is called for SelectionRequest events.
The SelectionRequest event is sent from the requestor to the clipboard owner
to request clipboard data.
*/
void
xclip_handle_SelectionRequest(XSelectionRequestEvent * event)
{
unsigned long nitems, bytes_left;
unsigned char *prop_return = NULL;
int format, res;
Atom type;
logger(Clipboard, Debug,
"xclip_handle_SelectionRequest(), selection=%s, target=%s, property=%s",
XGetAtomName(g_display, event->selection), XGetAtomName(g_display, event->target),
XGetAtomName(g_display, event->property));
if (event->target == targets_atom)
{
xclip_provide_selection(event, XA_ATOM, 32, (uint8 *) & targets, num_targets);
return;
}
else if (event->target == timestamp_atom)
{
xclip_provide_selection(event, XA_INTEGER, 32, (uint8 *) & acquire_time, 1);
return;
}
else if (event->target == rdesktop_clipboard_formats_atom)
{
xclip_provide_selection(event, XA_STRING, 8, formats_data, formats_data_length);
}
else
{
/* All the following targets require an async operation with the RDP server
and currently we don't do X clipboard request queueing so we can only
handle one such request at a time. */
if (has_selection_request)
{
logger(Clipboard, Warning,
"xclip_handle_SelectionRequest(), overlapping clipboard request, skipping.");
xclip_refuse_selection(event);
return;
}
if (event->target == rdesktop_native_atom)
{
/* Before the requestor makes a request for the _RDESKTOP_NATIVE target,
he should declare requestor[property] = CF_SOMETHING. */
res = XGetWindowProperty(g_display, event->requestor,
event->property, 0, 1, True,
XA_INTEGER, &type, &format, &nitems, &bytes_left,
&prop_return);
if (res != Success || (!prop_return))
{
logger(Clipboard, Error,
"xclip_handle_SelectionRequest(), requested native format without specify which");
xclip_refuse_selection(event);
return;
}
format = *(uint32 *) prop_return;
XFree(prop_return);
}
else if (event->target == format_string_atom || event->target == XA_STRING)
{
/* STRING and XA_STRING are defined to be ISO8859-1 */
format = CF_TEXT;
}
else if (event->target == format_utf8_string_atom)
{
#ifdef USE_UNICODE_CLIPBOARD
format = CF_UNICODETEXT;
#else
logger(Clipboard, Warning,
"xclip_handle_SelectionRequest(), target unavailable due to lack of unicode support");
xclip_refuse_selection(event);
return;
#endif
}
else if (event->target == format_unicode_atom)
{
/* Assuming text/unicode to be UTF-16 */
format = CF_UNICODETEXT;
}
else
{
logger(Clipboard, Warning,
"xclip_handle_SelectionRequest(), unsupported target format, target='%s'",
XGetAtomName(g_display, event->target));
xclip_refuse_selection(event);
return;
}
cliprdr_send_data_request(format);
selection_request = *event;
has_selection_request = True;
return; /* wait for data */
}
}
/* While this rdesktop holds ownership over the clipboard, it means the clipboard data
is offered by the RDP server (and when it is pasted inside RDP, there's no network
roundtrip).
This event (SelectionClear) symbolizes this rdesktop lost ownership of the clipboard
to some other X client. We should find out what clipboard formats this other
client offers and announce that to RDP. */
void
xclip_handle_SelectionClear(void)
{
logger(Clipboard, Debug, "xclip_handle_SelectionClear()");
xclip_notify_change();
xclip_probe_selections();
}
/* Called when any property changes in our window or the root window. */
void
xclip_handle_PropertyNotify(XPropertyEvent * event)
{
unsigned long nitems;
unsigned long offset = 0;
unsigned long bytes_left = 1;
int format;
XWindowAttributes wa;
uint8 *data;
Atom type;
if (event->state == PropertyNewValue && g_waiting_for_INCR)
{
logger(Clipboard, Debug, "xclip_handle_PropertyNotify(), g_waiting_for_INCR != 0");
while (bytes_left > 0)
{
/* Unlike the specification, we don't set the 'delete' argument to True
since we slurp the INCR's chunks in even-smaller chunks of 4096 bytes. */
if ((XGetWindowProperty
(g_display, g_wnd, rdesktop_clipboard_target_atom, offset, 4096L,
False, AnyPropertyType, &type, &format, &nitems, &bytes_left,
&data) != Success))
{
XFree(data);
return;
}
if (nitems == 0)
{
/* INCR transfer finished */
XGetWindowAttributes(g_display, g_wnd, &wa);
XSelectInput(g_display, g_wnd,
(wa.your_event_mask ^ PropertyChangeMask));
XFree(data);
g_waiting_for_INCR = 0;
if (g_clip_buflen > 0)
{
if (!xclip_send_data_with_convert
(g_clip_buffer, g_clip_buflen, g_incr_target))
{
helper_cliprdr_send_empty_response();
}
xfree(g_clip_buffer);
g_clip_buffer = NULL;
g_clip_buflen = 0;
}
}
else
{
/* Another chunk in the INCR transfer */
offset += (nitems / 4); /* offset at which to begin the next slurp */
g_clip_buffer = xrealloc(g_clip_buffer, g_clip_buflen + nitems);
memcpy(g_clip_buffer + g_clip_buflen, data, nitems);
g_clip_buflen += nitems;
XFree(data);
}
}
XDeleteProperty(g_display, g_wnd, rdesktop_clipboard_target_atom);
return;
}
if ((event->atom == rdesktop_selection_notify_atom) &&
(event->window == DefaultRootWindow(g_display)))
xclip_probe_selections();
}
/* Called when the RDP server announces new clipboard data formats.
In response, we:
- take ownership over the clipboard
- declare those formats in their Windows native form
to other rdesktop instances on this X server */
void
ui_clip_format_announce(uint8 * data, uint32 length)
{
acquire_time = g_last_gesturetime;
XSetSelectionOwner(g_display, primary_atom, g_wnd, acquire_time);
if (XGetSelectionOwner(g_display, primary_atom) != g_wnd)
logger(Clipboard, Warning, "failed to acquire ownership of PRIMARY clipboard");
XSetSelectionOwner(g_display, clipboard_atom, g_wnd, acquire_time);
if (XGetSelectionOwner(g_display, clipboard_atom) != g_wnd)
logger(Clipboard, Warning, "failed to acquire ownership of CLIPBOARD clipboard");
if (formats_data)
xfree(formats_data);
formats_data = xmalloc(length);
memcpy(formats_data, data, length);
formats_data_length = length;
xclip_notify_change();
}
/* Called when the RDP server responds with clipboard data (after we've requested it). */
void
ui_clip_handle_data(uint8 * data, uint32 length)
{
RD_BOOL free_data = False;
if (length == 0)
{
xclip_refuse_selection(&selection_request);
has_selection_request = False;
return;
}
if (selection_request.target == format_string_atom || selection_request.target == XA_STRING)
{
/* We're expecting a CF_TEXT response */