-
-
Notifications
You must be signed in to change notification settings - Fork 647
/
Copy pathnfd_portal.cpp
1793 lines (1635 loc) · 71.1 KB
/
nfd_portal.cpp
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
/*
Native File Dialog Extended
Repository: https://github.com/btzy/nativefiledialog-extended
License: Zlib
Authors: Bernard Teo
Note: We do not check for malloc failure on Linux - Linux overcommits memory!
*/
#include <assert.h>
#include <dbus/dbus.h>
#include <errno.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h> // for access()
#if !defined(__has_include) || !defined(__linux__)
#include <sys/random.h> // for getrandom() - the random token string
#elif __has_include(<sys/random.h>)
#include <sys/random.h>
#else // for GLIBC < 2.25
#include <sys/syscall.h>
#define getrandom(buf, sz, flags) syscall(SYS_getrandom, buf, sz, flags)
#endif
#include "nfd.h"
/*
Define NFD_APPEND_EXTENSION if you want the file extension to be appended when missing. Linux
programs usually don't append the file extension, but for consistency with other OSes you might want
to append it. However, when using portals, the file overwrite prompt and the Flatpak sandbox won't
know that we appended an extension, so they will not check or whitelist the correct file. Enabling
NFD_APPEND_EXTENSION is not recommended for portals.
*/
namespace {
template <typename T = void>
T* NFDi_Malloc(size_t bytes) {
void* ptr = malloc(bytes);
assert(ptr); // Linux malloc never fails
return static_cast<T*>(ptr);
}
template <typename T>
void NFDi_Free(T* ptr) {
assert(ptr);
free(static_cast<void*>(ptr));
}
template <typename T>
struct Free_Guard {
T* data;
Free_Guard(T* freeable) noexcept : data(freeable) {}
~Free_Guard() { NFDi_Free(data); }
};
template <typename T>
struct FreeCheck_Guard {
T* data;
FreeCheck_Guard(T* freeable = nullptr) noexcept : data(freeable) {}
~FreeCheck_Guard() {
if (data) NFDi_Free(data);
}
};
struct DBusMessage_Guard {
DBusMessage* data;
DBusMessage_Guard(DBusMessage* freeable) noexcept : data(freeable) {}
~DBusMessage_Guard() { dbus_message_unref(data); }
};
/* D-Bus connection handle */
DBusConnection* dbus_conn;
/* current D-Bus error */
DBusError dbus_err;
/* current non D-Bus error */
constexpr size_t OWNED_ERR_LEN = 1024;
char owned_err[OWNED_ERR_LEN]{};
/* current error (may be a pointer to dbus_err.message, owned_err, or a pointer to some string
* literal) */
const char* err_ptr = nullptr;
/* the unique name of our connection, used for the Request handle; owned by D-Bus so we don't free
* it */
const char* dbus_unique_name;
void NFDi_SetError(const char* msg) {
err_ptr = msg;
}
void NFDi_SetFormattedError(const char* format, ...) {
va_list args;
va_start(args, format);
vsnprintf(owned_err, OWNED_ERR_LEN, format, args);
va_end(args);
err_ptr = owned_err;
}
template <typename T>
T* copy(const T* begin, const T* end, T* out) {
for (; begin != end; ++begin) {
*out++ = *begin;
}
return out;
}
template <typename T, typename Callback>
T* transform(const T* begin, const T* end, T* out, Callback callback) {
for (; begin != end; ++begin) {
*out++ = callback(*begin);
}
return out;
}
template <typename T>
T* reverse_copy(const T* begin, const T* end, T* out) {
while (begin != end) {
*out++ = *--end;
}
return out;
}
// Returns true if ch is in [0-9A-Za-z], false otherwise.
bool IsHex(char ch) {
return ('0' <= ch && ch <= '9') || ('A' <= ch && ch <= 'F') || ('a' <= ch && ch <= 'f');
}
// Returns the hexadecimal value contained in the char. Precondition: IsHex(ch)
char ParseHexUnchecked(char ch) {
if ('0' <= ch && ch <= '9') return ch - '0';
if ('A' <= ch && ch <= 'F') return ch - ('A' - 10);
if ('a' <= ch && ch <= 'f') return ch - ('a' - 10);
#if defined(__GNUC__)
__builtin_unreachable();
#endif
}
// Writes val as a hex string to out
char* FormatUIntToHexString(char* out, uintptr_t val) {
char tmp[sizeof(uintptr_t) * 2];
char* tmp_end = tmp;
do {
const uintptr_t digit = val & 15u;
*tmp_end++ = digit < 10 ? '0' + digit : 'A' - 10 + digit;
val >>= 4;
} while (val != 0);
return reverse_copy(tmp, tmp_end, out);
}
constexpr const char* STR_EMPTY = "";
constexpr const char* STR_OPEN_FILE = "Open File";
constexpr const char* STR_OPEN_FILES = "Open Files";
constexpr const char* STR_SAVE_FILE = "Save File";
constexpr const char* STR_SELECT_FOLDER = "Select Folder";
constexpr const char* STR_SELECT_FOLDERS = "Select Folders";
constexpr const char* STR_HANDLE_TOKEN = "handle_token";
constexpr const char* STR_MULTIPLE = "multiple";
constexpr const char* STR_DIRECTORY = "directory";
constexpr const char* STR_FILTERS = "filters";
constexpr const char* STR_CURRENT_FILTER = "current_filter";
constexpr const char* STR_CURRENT_NAME = "current_name";
constexpr const char* STR_CURRENT_FOLDER = "current_folder";
constexpr const char* STR_CURRENT_FILE = "current_file";
constexpr const char* STR_ALL_FILES = "All files";
constexpr const char* STR_ASTERISK = "*";
constexpr const char* DBUS_DESTINATION = "org.freedesktop.portal.Desktop";
constexpr const char* DBUS_PATH = "/org/freedesktop/portal/desktop";
constexpr const char* DBUS_FILECHOOSER_IFACE = "org.freedesktop.portal.FileChooser";
constexpr const char* DBUS_REQUEST_IFACE = "org.freedesktop.portal.Request";
void AppendOpenFileQueryParentWindow(DBusMessageIter& iter, const nfdwindowhandle_t& parentWindow) {
switch (parentWindow.type) {
case NFD_WINDOW_HANDLE_TYPE_X11: {
constexpr size_t maxX11WindowStrLen =
4 + sizeof(uintptr_t) * 2 + 1; // "x11:" + "<hex>" + "\0"
char serializedWindowBuf[maxX11WindowStrLen];
char* serializedWindow = serializedWindowBuf;
const uintptr_t handle = reinterpret_cast<uintptr_t>(parentWindow.handle);
char* out = serializedWindowBuf;
*out++ = 'x';
*out++ = '1';
*out++ = '1';
*out++ = ':';
out = FormatUIntToHexString(out, handle);
*out = '\0';
dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &serializedWindow);
return;
}
default: {
dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &STR_EMPTY);
return;
}
}
}
template <bool Multiple, bool Directory>
void AppendOpenFileQueryTitle(DBusMessageIter&);
template <>
void AppendOpenFileQueryTitle<false, false>(DBusMessageIter& iter) {
dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &STR_OPEN_FILE);
}
template <>
void AppendOpenFileQueryTitle<true, false>(DBusMessageIter& iter) {
dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &STR_OPEN_FILES);
}
template <>
void AppendOpenFileQueryTitle<false, true>(DBusMessageIter& iter) {
dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &STR_SELECT_FOLDER);
}
template <>
void AppendOpenFileQueryTitle<true, true>(DBusMessageIter& iter) {
dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &STR_SELECT_FOLDERS);
}
void AppendSaveFileQueryTitle(DBusMessageIter& iter) {
dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &STR_SAVE_FILE);
}
void AppendOpenFileQueryDictEntryHandleToken(DBusMessageIter& sub_iter, const char* handle_token) {
DBusMessageIter sub_sub_iter;
DBusMessageIter variant_iter;
dbus_message_iter_open_container(&sub_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &sub_sub_iter);
dbus_message_iter_append_basic(&sub_sub_iter, DBUS_TYPE_STRING, &STR_HANDLE_TOKEN);
dbus_message_iter_open_container(&sub_sub_iter, DBUS_TYPE_VARIANT, "s", &variant_iter);
dbus_message_iter_append_basic(&variant_iter, DBUS_TYPE_STRING, &handle_token);
dbus_message_iter_close_container(&sub_sub_iter, &variant_iter);
dbus_message_iter_close_container(&sub_iter, &sub_sub_iter);
}
template <bool Multiple>
void AppendOpenFileQueryDictEntryMultiple(DBusMessageIter&);
template <>
void AppendOpenFileQueryDictEntryMultiple<true>(DBusMessageIter& sub_iter) {
DBusMessageIter sub_sub_iter;
DBusMessageIter variant_iter;
dbus_message_iter_open_container(&sub_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &sub_sub_iter);
dbus_message_iter_append_basic(&sub_sub_iter, DBUS_TYPE_STRING, &STR_MULTIPLE);
dbus_message_iter_open_container(&sub_sub_iter, DBUS_TYPE_VARIANT, "b", &variant_iter);
{
int b = true;
dbus_message_iter_append_basic(&variant_iter, DBUS_TYPE_BOOLEAN, &b);
}
dbus_message_iter_close_container(&sub_sub_iter, &variant_iter);
dbus_message_iter_close_container(&sub_iter, &sub_sub_iter);
}
template <>
void AppendOpenFileQueryDictEntryMultiple<false>(DBusMessageIter&) {}
template <bool Directory>
void AppendOpenFileQueryDictEntryDirectory(DBusMessageIter&);
template <>
void AppendOpenFileQueryDictEntryDirectory<true>(DBusMessageIter& sub_iter) {
DBusMessageIter sub_sub_iter;
DBusMessageIter variant_iter;
dbus_message_iter_open_container(&sub_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &sub_sub_iter);
dbus_message_iter_append_basic(&sub_sub_iter, DBUS_TYPE_STRING, &STR_DIRECTORY);
dbus_message_iter_open_container(&sub_sub_iter, DBUS_TYPE_VARIANT, "b", &variant_iter);
{
int b = true;
dbus_message_iter_append_basic(&variant_iter, DBUS_TYPE_BOOLEAN, &b);
}
dbus_message_iter_close_container(&sub_sub_iter, &variant_iter);
dbus_message_iter_close_container(&sub_iter, &sub_sub_iter);
}
template <>
void AppendOpenFileQueryDictEntryDirectory<false>(DBusMessageIter&) {}
void AppendSingleFilter(DBusMessageIter& base_iter, const nfdnfilteritem_t& filter) {
DBusMessageIter filter_list_struct_iter;
DBusMessageIter filter_sublist_iter;
DBusMessageIter filter_sublist_struct_iter;
dbus_message_iter_open_container(
&base_iter, DBUS_TYPE_STRUCT, nullptr, &filter_list_struct_iter);
// count number of file extensions
size_t sep = 1;
for (const char* p = filter.spec; *p; ++p) {
if (*p == L',') {
++sep;
}
}
{
const size_t name_len = strlen(filter.name);
const size_t spec_len = strlen(filter.spec);
char* buf = static_cast<char*>(alloca(sep + name_len + 2 + spec_len + 1));
char* buf_end = buf;
buf_end = copy(filter.name, filter.name + name_len, buf_end);
*buf_end++ = ' ';
*buf_end++ = '(';
const char* spec_ptr = filter.spec;
do {
*buf_end++ = *spec_ptr;
if (*spec_ptr == ',') *buf_end++ = ' ';
++spec_ptr;
} while (*spec_ptr != '\0');
*buf_end++ = ')';
*buf_end = '\0';
dbus_message_iter_append_basic(&filter_list_struct_iter, DBUS_TYPE_STRING, &buf);
}
{
dbus_message_iter_open_container(
&filter_list_struct_iter, DBUS_TYPE_ARRAY, "(us)", &filter_sublist_iter);
const char* extn_begin = filter.spec;
const char* extn_end = extn_begin;
while (true) {
dbus_message_iter_open_container(
&filter_sublist_iter, DBUS_TYPE_STRUCT, nullptr, &filter_sublist_struct_iter);
{
const unsigned zero = 0;
dbus_message_iter_append_basic(
&filter_sublist_struct_iter, DBUS_TYPE_UINT32, &zero);
}
do {
++extn_end;
} while (*extn_end != ',' && *extn_end != '\0');
char* buf = static_cast<char*>(alloca(2 + (extn_end - extn_begin) + 1));
char* buf_end = buf;
*buf_end++ = '*';
*buf_end++ = '.';
buf_end = copy(extn_begin, extn_end, buf_end);
*buf_end = '\0';
dbus_message_iter_append_basic(&filter_sublist_struct_iter, DBUS_TYPE_STRING, &buf);
dbus_message_iter_close_container(&filter_sublist_iter, &filter_sublist_struct_iter);
if (*extn_end == '\0') {
break;
}
extn_begin = extn_end + 1;
extn_end = extn_begin;
}
}
dbus_message_iter_close_container(&filter_list_struct_iter, &filter_sublist_iter);
dbus_message_iter_close_container(&base_iter, &filter_list_struct_iter);
}
bool AppendSingleFilterCheckExtn(DBusMessageIter& base_iter,
const nfdnfilteritem_t& filter,
const nfdnchar_t* match_extn) {
DBusMessageIter filter_list_struct_iter;
DBusMessageIter filter_sublist_iter;
DBusMessageIter filter_sublist_struct_iter;
dbus_message_iter_open_container(
&base_iter, DBUS_TYPE_STRUCT, nullptr, &filter_list_struct_iter);
// count number of file extensions
size_t sep = 1;
for (const char* p = filter.spec; *p; ++p) {
if (*p == L',') {
++sep;
}
}
{
const size_t name_len = strlen(filter.name);
const size_t spec_len = strlen(filter.spec);
char* buf = static_cast<char*>(alloca(sep + name_len + 2 + spec_len + 1));
char* buf_end = buf;
buf_end = copy(filter.name, filter.name + name_len, buf_end);
*buf_end++ = ' ';
*buf_end++ = '(';
const char* spec_ptr = filter.spec;
do {
*buf_end++ = *spec_ptr;
if (*spec_ptr == ',') *buf_end++ = ' ';
++spec_ptr;
} while (*spec_ptr != '\0');
*buf_end++ = ')';
*buf_end = '\0';
dbus_message_iter_append_basic(&filter_list_struct_iter, DBUS_TYPE_STRING, &buf);
}
bool extn_matched = false;
{
dbus_message_iter_open_container(
&filter_list_struct_iter, DBUS_TYPE_ARRAY, "(us)", &filter_sublist_iter);
const char* extn_begin = filter.spec;
const char* extn_end = extn_begin;
while (true) {
dbus_message_iter_open_container(
&filter_sublist_iter, DBUS_TYPE_STRUCT, nullptr, &filter_sublist_struct_iter);
{
const unsigned zero = 0;
dbus_message_iter_append_basic(
&filter_sublist_struct_iter, DBUS_TYPE_UINT32, &zero);
}
do {
++extn_end;
} while (*extn_end != ',' && *extn_end != '\0');
char* buf = static_cast<char*>(alloca(2 + (extn_end - extn_begin) + 1));
char* buf_end = buf;
*buf_end++ = '*';
*buf_end++ = '.';
buf_end = copy(extn_begin, extn_end, buf_end);
*buf_end = '\0';
dbus_message_iter_append_basic(&filter_sublist_struct_iter, DBUS_TYPE_STRING, &buf);
dbus_message_iter_close_container(&filter_sublist_iter, &filter_sublist_struct_iter);
if (!extn_matched) {
const char* match_extn_p;
const char* p;
for (p = extn_begin, match_extn_p = match_extn; p != extn_end && *match_extn_p;
++p, ++match_extn_p) {
if (*p != *match_extn_p) break;
}
if (p == extn_end && !*match_extn_p) {
extn_matched = true;
}
}
if (*extn_end == '\0') {
break;
}
extn_begin = extn_end + 1;
extn_end = extn_begin;
}
}
dbus_message_iter_close_container(&filter_list_struct_iter, &filter_sublist_iter);
dbus_message_iter_close_container(&base_iter, &filter_list_struct_iter);
return extn_matched;
}
void AppendWildcardFilter(DBusMessageIter& base_iter) {
DBusMessageIter filter_list_struct_iter;
DBusMessageIter filter_sublist_iter;
DBusMessageIter filter_sublist_struct_iter;
dbus_message_iter_open_container(
&base_iter, DBUS_TYPE_STRUCT, nullptr, &filter_list_struct_iter);
dbus_message_iter_append_basic(&filter_list_struct_iter, DBUS_TYPE_STRING, &STR_ALL_FILES);
dbus_message_iter_open_container(
&filter_list_struct_iter, DBUS_TYPE_ARRAY, "(us)", &filter_sublist_iter);
dbus_message_iter_open_container(
&filter_sublist_iter, DBUS_TYPE_STRUCT, nullptr, &filter_sublist_struct_iter);
{
const unsigned zero = 0;
dbus_message_iter_append_basic(&filter_sublist_struct_iter, DBUS_TYPE_UINT32, &zero);
}
dbus_message_iter_append_basic(&filter_sublist_struct_iter, DBUS_TYPE_STRING, &STR_ASTERISK);
dbus_message_iter_close_container(&filter_sublist_iter, &filter_sublist_struct_iter);
dbus_message_iter_close_container(&filter_list_struct_iter, &filter_sublist_iter);
dbus_message_iter_close_container(&base_iter, &filter_list_struct_iter);
}
template <bool FilterEnabled>
void AppendOpenFileQueryDictEntryFilters(DBusMessageIter&,
const nfdnfilteritem_t*,
nfdfiltersize_t);
template <>
void AppendOpenFileQueryDictEntryFilters<true>(DBusMessageIter& sub_iter,
const nfdnfilteritem_t* filterList,
nfdfiltersize_t filterCount) {
if (filterCount != 0) {
DBusMessageIter sub_sub_iter;
DBusMessageIter variant_iter;
DBusMessageIter filter_list_iter;
// filters
dbus_message_iter_open_container(&sub_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &sub_sub_iter);
dbus_message_iter_append_basic(&sub_sub_iter, DBUS_TYPE_STRING, &STR_FILTERS);
dbus_message_iter_open_container(
&sub_sub_iter, DBUS_TYPE_VARIANT, "a(sa(us))", &variant_iter);
dbus_message_iter_open_container(
&variant_iter, DBUS_TYPE_ARRAY, "(sa(us))", &filter_list_iter);
for (nfdfiltersize_t i = 0; i != filterCount; ++i) {
AppendSingleFilter(filter_list_iter, filterList[i]);
}
AppendWildcardFilter(filter_list_iter);
dbus_message_iter_close_container(&variant_iter, &filter_list_iter);
dbus_message_iter_close_container(&sub_sub_iter, &variant_iter);
dbus_message_iter_close_container(&sub_iter, &sub_sub_iter);
// current_filter
dbus_message_iter_open_container(&sub_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &sub_sub_iter);
dbus_message_iter_append_basic(&sub_sub_iter, DBUS_TYPE_STRING, &STR_CURRENT_FILTER);
dbus_message_iter_open_container(
&sub_sub_iter, DBUS_TYPE_VARIANT, "(sa(us))", &variant_iter);
AppendSingleFilter(variant_iter, filterList[0]);
dbus_message_iter_close_container(&sub_sub_iter, &variant_iter);
dbus_message_iter_close_container(&sub_iter, &sub_sub_iter);
}
}
template <>
void AppendOpenFileQueryDictEntryFilters<false>(DBusMessageIter&,
const nfdnfilteritem_t*,
nfdfiltersize_t) {}
void AppendSaveFileQueryDictEntryFilters(DBusMessageIter& sub_iter,
const nfdnfilteritem_t* filterList,
nfdfiltersize_t filterCount,
const nfdnchar_t* defaultName) {
if (filterCount != 0) {
DBusMessageIter sub_sub_iter;
DBusMessageIter variant_iter;
DBusMessageIter filter_list_iter;
// The extension of the defaultName (without the '.'). If NULL, it means that there is no
// extension.
const nfdnchar_t* extn = NULL;
if (defaultName) {
const nfdnchar_t* p = defaultName;
while (*p) ++p;
while (*--p != '.')
;
++p;
if (*p) extn = p;
}
bool extn_matched = false;
size_t selected_filter_index;
// filters
dbus_message_iter_open_container(&sub_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &sub_sub_iter);
dbus_message_iter_append_basic(&sub_sub_iter, DBUS_TYPE_STRING, &STR_FILTERS);
dbus_message_iter_open_container(
&sub_sub_iter, DBUS_TYPE_VARIANT, "a(sa(us))", &variant_iter);
dbus_message_iter_open_container(
&variant_iter, DBUS_TYPE_ARRAY, "(sa(us))", &filter_list_iter);
for (nfdfiltersize_t i = 0; i != filterCount; ++i) {
if (!extn_matched && extn) {
extn_matched = AppendSingleFilterCheckExtn(filter_list_iter, filterList[i], extn);
if (extn_matched) selected_filter_index = i;
} else {
AppendSingleFilter(filter_list_iter, filterList[i]);
}
}
AppendWildcardFilter(filter_list_iter);
dbus_message_iter_close_container(&variant_iter, &filter_list_iter);
dbus_message_iter_close_container(&sub_sub_iter, &variant_iter);
dbus_message_iter_close_container(&sub_iter, &sub_sub_iter);
// current_filter
dbus_message_iter_open_container(&sub_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &sub_sub_iter);
dbus_message_iter_append_basic(&sub_sub_iter, DBUS_TYPE_STRING, &STR_CURRENT_FILTER);
dbus_message_iter_open_container(
&sub_sub_iter, DBUS_TYPE_VARIANT, "(sa(us))", &variant_iter);
if (extn_matched) {
AppendSingleFilter(variant_iter, filterList[selected_filter_index]);
} else {
AppendWildcardFilter(variant_iter);
}
dbus_message_iter_close_container(&sub_sub_iter, &variant_iter);
dbus_message_iter_close_container(&sub_iter, &sub_sub_iter);
}
}
void AppendSaveFileQueryDictEntryCurrentName(DBusMessageIter& sub_iter, const char* name) {
if (!name) return;
DBusMessageIter sub_sub_iter;
DBusMessageIter variant_iter;
dbus_message_iter_open_container(&sub_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &sub_sub_iter);
dbus_message_iter_append_basic(&sub_sub_iter, DBUS_TYPE_STRING, &STR_CURRENT_NAME);
dbus_message_iter_open_container(&sub_sub_iter, DBUS_TYPE_VARIANT, "s", &variant_iter);
dbus_message_iter_append_basic(&variant_iter, DBUS_TYPE_STRING, &name);
dbus_message_iter_close_container(&sub_sub_iter, &variant_iter);
dbus_message_iter_close_container(&sub_iter, &sub_sub_iter);
}
void AppendOpenFileQueryDictEntryCurrentFolder(DBusMessageIter& sub_iter, const char* path) {
if (!path) return;
DBusMessageIter sub_sub_iter;
DBusMessageIter variant_iter;
DBusMessageIter array_iter;
dbus_message_iter_open_container(&sub_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &sub_sub_iter);
dbus_message_iter_append_basic(&sub_sub_iter, DBUS_TYPE_STRING, &STR_CURRENT_FOLDER);
dbus_message_iter_open_container(&sub_sub_iter, DBUS_TYPE_VARIANT, "ay", &variant_iter);
dbus_message_iter_open_container(&variant_iter, DBUS_TYPE_ARRAY, "y", &array_iter);
// Append string as byte array, including the terminating null byte as required by the portal.
const char* p = path;
do {
dbus_message_iter_append_basic(&array_iter, DBUS_TYPE_BYTE, p);
} while (*p++);
dbus_message_iter_close_container(&variant_iter, &array_iter);
dbus_message_iter_close_container(&sub_sub_iter, &variant_iter);
dbus_message_iter_close_container(&sub_iter, &sub_sub_iter);
}
void AppendSaveFileQueryDictEntryCurrentFile(DBusMessageIter& sub_iter,
const char* path,
const char* name) {
if (!path || !name) return;
const size_t path_len = strlen(path);
const size_t name_len = strlen(name);
char* pathname;
char* pathname_end;
size_t pathname_len;
if (path_len && path[path_len - 1] == '/') {
pathname_len = path_len + name_len;
pathname = NFDi_Malloc<char>(pathname_len + 1);
pathname_end = pathname;
pathname_end = copy(path, path + path_len, pathname_end);
pathname_end = copy(name, name + name_len, pathname_end);
*pathname_end++ = '\0';
} else {
pathname_len = path_len + 1 + name_len;
pathname = NFDi_Malloc<char>(pathname_len + 1);
pathname_end = pathname;
pathname_end = copy(path, path + path_len, pathname_end);
*pathname_end++ = '/';
pathname_end = copy(name, name + name_len, pathname_end);
*pathname_end++ = '\0';
}
Free_Guard<char> guard(pathname);
if (access(pathname, F_OK) != 0) return;
DBusMessageIter sub_sub_iter;
DBusMessageIter variant_iter;
DBusMessageIter array_iter;
dbus_message_iter_open_container(&sub_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &sub_sub_iter);
dbus_message_iter_append_basic(&sub_sub_iter, DBUS_TYPE_STRING, &STR_CURRENT_FILE);
dbus_message_iter_open_container(&sub_sub_iter, DBUS_TYPE_VARIANT, "ay", &variant_iter);
dbus_message_iter_open_container(&variant_iter, DBUS_TYPE_ARRAY, "y", &array_iter);
// This includes the terminating null character, which is required by the portal.
for (const char* p = pathname; p != pathname_end; ++p) {
dbus_message_iter_append_basic(&array_iter, DBUS_TYPE_BYTE, p);
}
dbus_message_iter_close_container(&variant_iter, &array_iter);
dbus_message_iter_close_container(&sub_sub_iter, &variant_iter);
dbus_message_iter_close_container(&sub_iter, &sub_sub_iter);
}
// Append OpenFile() portal params to the given query.
template <bool Multiple, bool Directory>
void AppendOpenFileQueryParams(DBusMessage* query,
const char* handle_token,
const nfdnfilteritem_t* filterList,
nfdfiltersize_t filterCount,
const nfdnchar_t* defaultPath,
const nfdwindowhandle_t& parentWindow) {
DBusMessageIter iter;
dbus_message_iter_init_append(query, &iter);
AppendOpenFileQueryParentWindow(iter, parentWindow);
AppendOpenFileQueryTitle<Multiple, Directory>(iter);
DBusMessageIter sub_iter;
dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "{sv}", &sub_iter);
AppendOpenFileQueryDictEntryHandleToken(sub_iter, handle_token);
AppendOpenFileQueryDictEntryMultiple<Multiple>(sub_iter);
AppendOpenFileQueryDictEntryDirectory<Directory>(sub_iter);
AppendOpenFileQueryDictEntryFilters<!Directory>(sub_iter, filterList, filterCount);
AppendOpenFileQueryDictEntryCurrentFolder(sub_iter, defaultPath);
dbus_message_iter_close_container(&iter, &sub_iter);
}
// Append SaveFile() portal params to the given query.
void AppendSaveFileQueryParams(DBusMessage* query,
const char* handle_token,
const nfdnfilteritem_t* filterList,
nfdfiltersize_t filterCount,
const nfdnchar_t* defaultPath,
const nfdnchar_t* defaultName,
const nfdwindowhandle_t& parentWindow) {
DBusMessageIter iter;
dbus_message_iter_init_append(query, &iter);
AppendOpenFileQueryParentWindow(iter, parentWindow);
AppendSaveFileQueryTitle(iter);
DBusMessageIter sub_iter;
dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "{sv}", &sub_iter);
AppendOpenFileQueryDictEntryHandleToken(sub_iter, handle_token);
AppendSaveFileQueryDictEntryFilters(sub_iter, filterList, filterCount, defaultName);
AppendSaveFileQueryDictEntryCurrentName(sub_iter, defaultName);
AppendOpenFileQueryDictEntryCurrentFolder(sub_iter, defaultPath);
AppendSaveFileQueryDictEntryCurrentFile(sub_iter, defaultPath, defaultName);
dbus_message_iter_close_container(&iter, &sub_iter);
}
nfdresult_t ReadDictImpl(const char*, DBusMessageIter&) {
return NFD_OKAY;
}
template <typename Callback, typename... Args>
nfdresult_t ReadDictImpl(const char* key,
DBusMessageIter& iter,
const char*& candidate_key,
Callback& candidate_callback,
Args&... args) {
if (strcmp(key, candidate_key) == 0) {
// this is the correct callback
return candidate_callback(iter);
} else {
return ReadDictImpl(key, iter, args...);
}
}
// Read a dictionary from the given iterator. The type of the element under this iterator will be
// checked. The args are alternately key and callback. Key is a const char*, and callback is a
// function that returns nfdresult_t. Return NFD_ERROR to stop processing and return immediately.
template <typename... Args>
nfdresult_t ReadDict(DBusMessageIter iter, Args... args) {
if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_ARRAY) {
NFDi_SetError("D-Bus response signal argument is not an array.");
return NFD_ERROR;
}
DBusMessageIter sub_iter;
dbus_message_iter_recurse(&iter, &sub_iter);
while (dbus_message_iter_get_arg_type(&sub_iter) == DBUS_TYPE_DICT_ENTRY) {
DBusMessageIter de_iter;
dbus_message_iter_recurse(&sub_iter, &de_iter);
if (dbus_message_iter_get_arg_type(&de_iter) != DBUS_TYPE_STRING) {
NFDi_SetError("D-Bus response signal dict entry does not start with a string.");
return NFD_ERROR;
}
const char* key;
dbus_message_iter_get_basic(&de_iter, &key);
if (!dbus_message_iter_next(&de_iter)) {
NFDi_SetError("D-Bus response signal dict entry is missing one or more arguments.");
return NFD_ERROR;
}
// unwrap the variant
if (dbus_message_iter_get_arg_type(&de_iter) != DBUS_TYPE_VARIANT) {
NFDi_SetError("D-Bus response signal dict entry value is not a variant.");
return NFD_ERROR;
}
DBusMessageIter de_variant_iter;
dbus_message_iter_recurse(&de_iter, &de_variant_iter);
if (ReadDictImpl(key, de_variant_iter, args...) == NFD_ERROR) return NFD_ERROR;
if (!dbus_message_iter_next(&sub_iter)) break;
}
return NFD_OKAY;
}
// Read the message, returning an iterator to the `results` dictionary of the response. If response
// was okay, then returns NFD_OKAY and set `resultsIter` to the results dictionary iterator (this is
// the iterator to the entire dictionary (which has type DBUS_TYPE_ARRAY), not an iterator to the
// first item in the dictionary). It does not check that this iterator is DBUS_TYPE_ARRAY; you
// should use ReadDict() which will check it. Otherwise, returns NFD_CANCEL or NFD_ERROR as
// appropriate, and does not modify `resultsIter`. `resultsIter` can be copied by value.
nfdresult_t ReadResponseResults(DBusMessage* msg, DBusMessageIter& resultsIter) {
DBusMessageIter iter;
if (!dbus_message_iter_init(msg, &iter)) {
NFDi_SetError("D-Bus response signal is missing one or more arguments.");
return NFD_ERROR;
}
if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_UINT32) {
NFDi_SetError("D-Bus response signal argument is not a uint32.");
return NFD_ERROR;
}
dbus_uint32_t resp_code;
dbus_message_iter_get_basic(&iter, &resp_code);
if (resp_code != 0) {
if (resp_code == 1) {
// User pressed cancel
return NFD_CANCEL;
} else {
// Some error occurred
NFDi_SetFormattedError(
"D-Bus file dialog interaction was ended abruptly with response code %u.",
resp_code);
return NFD_ERROR;
}
}
// User successfully responded
if (!dbus_message_iter_next(&iter)) {
NFDi_SetError("D-Bus response signal is missing one or more arguments.");
return NFD_ERROR;
}
resultsIter = iter;
return NFD_OKAY;
}
// Read the message. If response was okay, then returns NFD_OKAY and set `uriIter` to the URI array
// iterator. Otherwise, returns NFD_CANCEL or NFD_ERROR as appropriate, and does not modify
// `uriIter`. `uriIter` can be copied by value.
nfdresult_t ReadResponseUris(DBusMessage* msg, DBusMessageIter& uriIter) {
DBusMessageIter iter;
const nfdresult_t res = ReadResponseResults(msg, iter);
if (res != NFD_OKAY) return res;
bool has_uris = false;
if (ReadDict(iter, "uris", [&uriIter, &has_uris](DBusMessageIter& uris_iter) {
if (dbus_message_iter_get_arg_type(&uris_iter) != DBUS_TYPE_ARRAY) {
NFDi_SetError("D-Bus response signal URI iter is not an array.");
return NFD_ERROR;
}
dbus_message_iter_recurse(&uris_iter, &uriIter);
has_uris = true;
return NFD_OKAY;
}) == NFD_ERROR)
return NFD_ERROR;
if (!has_uris) {
NFDi_SetError("D-Bus response signal has no URI field.");
return NFD_ERROR;
}
return NFD_OKAY;
}
// Same as ReadResponseUris, but does not perform any message type checks.
// You should only use this if you previously used ReadResponseUris and it returned NFD_OKAY!
void ReadResponseUrisUnchecked(DBusMessage* msg, DBusMessageIter& uriIter) {
DBusMessageIter iter;
dbus_message_iter_init(msg, &iter);
dbus_message_iter_next(&iter);
ReadDict(iter, "uris", [&uriIter](DBusMessageIter& uris_iter) {
dbus_message_iter_recurse(&uris_iter, &uriIter);
return NFD_OKAY;
});
}
nfdpathsetsize_t ReadResponseUrisUncheckedGetArraySize(DBusMessage* msg) {
DBusMessageIter iter;
dbus_message_iter_init(msg, &iter);
dbus_message_iter_next(&iter);
nfdpathsetsize_t sz = 0; // Initialization will never be used, but we initialize it to prevent
// the uninitialized warning otherwise.
ReadDict(iter, "uris", [&sz](DBusMessageIter& uris_iter) {
sz = dbus_message_iter_get_element_count(&uris_iter);
return NFD_OKAY;
});
return sz;
}
// Read the response URI. If response was okay, then returns NFD_OKAY and set file to it (the
// pointer is set to some string owned by msg, so you should not manually free it). Otherwise,
// returns NFD_CANCEL or NFD_ERROR as appropriate, and does not modify `file`.
nfdresult_t ReadResponseUrisSingle(DBusMessage* msg, const char*& file) {
DBusMessageIter uri_iter;
const nfdresult_t res = ReadResponseUris(msg, uri_iter);
if (res != NFD_OKAY) return res; // can be NFD_CANCEL or NFD_ERROR
if (dbus_message_iter_get_arg_type(&uri_iter) != DBUS_TYPE_STRING) {
NFDi_SetError("D-Bus response signal URI sub iter is not a string.");
return NFD_ERROR;
}
dbus_message_iter_get_basic(&uri_iter, &file);
return NFD_OKAY;
}
#ifdef NFD_APPEND_EXTENSION
// Read the response URI and selected extension (in the form "*.abc" or "*") (if any). If response
// was okay, then returns NFD_OKAY and set file and extn to them (the pointer is set to some string
// owned by msg, so you should not manually free it). `file` is the user-entered file name, and
// `extn` is the selected file extension (the first one if there are multiple extensions in the
// selected option) (this is NULL if "All files" is selected). Otherwise, returns NFD_CANCEL or
// NFD_ERROR as appropriate, and does not modify `file` and `extn`.
nfdresult_t ReadResponseUrisSingleAndCurrentExtension(DBusMessage* msg,
const char*& file,
const char*& extn) {
DBusMessageIter iter;
const nfdresult_t res = ReadResponseResults(msg, iter);
if (res != NFD_OKAY) return res;
const char* tmp_file = nullptr;
const char* tmp_extn = nullptr;
if (ReadDict(
iter,
"uris",
[&tmp_file](DBusMessageIter& uris_iter) {
if (dbus_message_iter_get_arg_type(&uris_iter) != DBUS_TYPE_ARRAY) {
NFDi_SetError("D-Bus response signal URI iter is not an array.");
return NFD_ERROR;
}
DBusMessageIter uri_iter;
dbus_message_iter_recurse(&uris_iter, &uri_iter);
if (dbus_message_iter_get_arg_type(&uri_iter) != DBUS_TYPE_STRING) {
NFDi_SetError("D-Bus response signal URI sub iter is not a string.");
return NFD_ERROR;
}
dbus_message_iter_get_basic(&uri_iter, &tmp_file);
return NFD_OKAY;
},
"current_filter",
[&tmp_extn](DBusMessageIter& current_filter_iter) {
// current_filter is best_effort, so if we fail, we still return NFD_OKAY.
if (dbus_message_iter_get_arg_type(¤t_filter_iter) != DBUS_TYPE_STRUCT) {
return NFD_OKAY;
}
DBusMessageIter current_filter_struct_iter;
dbus_message_iter_recurse(¤t_filter_iter, ¤t_filter_struct_iter);
if (!dbus_message_iter_next(¤t_filter_struct_iter)) {
return NFD_OKAY;
}
if (dbus_message_iter_get_arg_type(¤t_filter_struct_iter) !=
DBUS_TYPE_ARRAY) {
return NFD_OKAY;
}
DBusMessageIter current_filter_array_iter;
dbus_message_iter_recurse(¤t_filter_struct_iter, ¤t_filter_array_iter);
if (dbus_message_iter_get_arg_type(¤t_filter_array_iter) !=
DBUS_TYPE_STRUCT) {
return NFD_OKAY;
}
DBusMessageIter current_filter_extn_iter;
dbus_message_iter_recurse(¤t_filter_array_iter, ¤t_filter_extn_iter);
if (dbus_message_iter_get_arg_type(¤t_filter_extn_iter) != DBUS_TYPE_UINT32) {
return NFD_OKAY;
}
dbus_uint32_t type;
dbus_message_iter_get_basic(¤t_filter_extn_iter, &type);
if (type != 0) {
return NFD_OKAY;
}
if (!dbus_message_iter_next(¤t_filter_extn_iter)) {
return NFD_OKAY;
}
if (dbus_message_iter_get_arg_type(¤t_filter_extn_iter) != DBUS_TYPE_STRING) {
return NFD_OKAY;
}
dbus_message_iter_get_basic(¤t_filter_extn_iter, &tmp_extn);
return NFD_OKAY;
}) == NFD_ERROR)
return NFD_ERROR;
if (!tmp_file) {
NFDi_SetError("D-Bus response signal has no URI field.");
return NFD_ERROR;
}
file = tmp_file;
extn = tmp_extn;
return NFD_OKAY;
}
#endif
// Appends up to 64 random chars to the given pointer. Returns the end of the appended chars.
char* Generate64RandomChars(char* out) {
size_t amount = 32;
while (amount > 0) {
unsigned char buf[32];
ssize_t res = getrandom(buf, amount, 0);
if (res == -1) {
if (errno == EINTR)
continue;
else
break; // too bad, urandom isn't working well
}
amount -= res;
// we encode each random char using two chars, since they must be [A-Z][a-z][0-9]_
for (size_t i = 0; i != static_cast<size_t>(res); ++i) {
*out++ = 'A' + static_cast<char>(buf[i] & 15);
*out++ = 'A' + static_cast<char>(buf[i] >> 4);
}
}
return out;
}
constexpr const char STR_RESPONSE_HANDLE_PREFIX[] = "/org/freedesktop/portal/desktop/request/";
constexpr size_t STR_RESPONSE_HANDLE_PREFIX_LEN =
sizeof(STR_RESPONSE_HANDLE_PREFIX) - 1; // -1 to remove the \0.
// Allocates and returns a path like "/org/freedesktop/portal/desktop/request/SENDER/TOKEN" with
// randomly generated TOKEN as recommended by flatpak. `handle_token_ptr` is a pointer to the
// TOKEN part.
char* MakeUniqueObjectPath(const char** handle_token_ptr) {
const char* sender = dbus_unique_name;
if (*sender == ':') ++sender;
const size_t sender_len = strlen(sender);
const size_t sz = STR_RESPONSE_HANDLE_PREFIX_LEN + sender_len + 1 +
64; // 1 for '/', followed by 64 random chars
char* path = NFDi_Malloc<char>(sz + 1);
char* path_ptr = path;
path_ptr = copy(STR_RESPONSE_HANDLE_PREFIX,
STR_RESPONSE_HANDLE_PREFIX + STR_RESPONSE_HANDLE_PREFIX_LEN,
path_ptr);
path_ptr = transform(
sender, sender + sender_len, path_ptr, [](char ch) { return ch != '.' ? ch : '_'; });
*path_ptr++ = '/';
*handle_token_ptr = path_ptr;
path_ptr = Generate64RandomChars(path_ptr);
*path_ptr = '\0';
return path;
}
constexpr const char STR_RESPONSE_SUBSCRIPTION_PATH_1[] =
"type='signal',sender='org.freedesktop.portal.Desktop',path='";
constexpr const char STR_RESPONSE_SUBSCRIPTION_PATH_1_LEN =
sizeof(STR_RESPONSE_SUBSCRIPTION_PATH_1) - 1;
constexpr const char STR_RESPONSE_SUBSCRIPTION_PATH_2[] =
"',interface='org.freedesktop.portal.Request',member='Response',destination='";
constexpr const char STR_RESPONSE_SUBSCRIPTION_PATH_2_LEN =
sizeof(STR_RESPONSE_SUBSCRIPTION_PATH_2) - 1;
constexpr const char STR_RESPONSE_SUBSCRIPTION_PATH_3[] = "'";
constexpr const char STR_RESPONSE_SUBSCRIPTION_PATH_3_LEN =
sizeof(STR_RESPONSE_SUBSCRIPTION_PATH_3) - 1;
class DBusSignalSubscriptionHandler {
private:
char* sub_cmd;
public:
DBusSignalSubscriptionHandler() : sub_cmd(nullptr) {}
~DBusSignalSubscriptionHandler() {
if (sub_cmd) Unsubscribe();
}
nfdresult_t Subscribe(const char* handle_path) {
if (sub_cmd) Unsubscribe();
sub_cmd = MakeResponseSubscriptionPath(handle_path, dbus_unique_name);
DBusError err;
dbus_error_init(&err);
dbus_bus_add_match(dbus_conn, sub_cmd, &err);
if (dbus_error_is_set(&err)) {
dbus_error_free(&dbus_err);
dbus_move_error(&err, &dbus_err);
NFDi_SetError(dbus_err.message);
return NFD_ERROR;
}
return NFD_OKAY;
}
void Unsubscribe() {
DBusError err;
dbus_error_init(&err);
dbus_bus_remove_match(dbus_conn, sub_cmd, &err);
NFDi_Free(sub_cmd);
sub_cmd = nullptr;
dbus_error_free(
&err); // silence unsubscribe errors, because this is intuitively part of 'cleanup'
}