freedesktop_portal_desktop.cpp 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020
  1. /**************************************************************************/
  2. /* freedesktop_portal_desktop.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "freedesktop_portal_desktop.h"
  31. #ifdef DBUS_ENABLED
  32. #include "core/crypto/crypto_core.h"
  33. #include "core/error/error_macros.h"
  34. #include "core/os/os.h"
  35. #include "core/string/ustring.h"
  36. #include "core/variant/variant.h"
  37. #ifdef SOWRAP_ENABLED
  38. #include "dbus-so_wrap.h"
  39. #else
  40. #include <dbus/dbus.h>
  41. #endif
  42. #include <unistd.h>
  43. #define BUS_OBJECT_NAME "org.freedesktop.portal.Desktop"
  44. #define BUS_OBJECT_PATH "/org/freedesktop/portal/desktop"
  45. #define BUS_INTERFACE_PROPERTIES "org.freedesktop.DBus.Properties"
  46. #define BUS_INTERFACE_SETTINGS "org.freedesktop.portal.Settings"
  47. #define BUS_INTERFACE_FILE_CHOOSER "org.freedesktop.portal.FileChooser"
  48. #define BUS_INTERFACE_SCREENSHOT "org.freedesktop.portal.Screenshot"
  49. bool FreeDesktopPortalDesktop::try_parse_variant(DBusMessage *p_reply_message, ReadVariantType p_type, void *r_value) {
  50. DBusMessageIter iter[3];
  51. dbus_message_iter_init(p_reply_message, &iter[0]);
  52. if (dbus_message_iter_get_arg_type(&iter[0]) != DBUS_TYPE_VARIANT) {
  53. return false;
  54. }
  55. dbus_message_iter_recurse(&iter[0], &iter[1]);
  56. if (dbus_message_iter_get_arg_type(&iter[1]) != DBUS_TYPE_VARIANT) {
  57. return false;
  58. }
  59. dbus_message_iter_recurse(&iter[1], &iter[2]);
  60. if (p_type == VAR_TYPE_COLOR) {
  61. if (dbus_message_iter_get_arg_type(&iter[2]) != DBUS_TYPE_STRUCT) {
  62. return false;
  63. }
  64. DBusMessageIter struct_iter;
  65. dbus_message_iter_recurse(&iter[2], &struct_iter);
  66. int idx = 0;
  67. while (dbus_message_iter_get_arg_type(&struct_iter) == DBUS_TYPE_DOUBLE) {
  68. double value = 0.0;
  69. dbus_message_iter_get_basic(&struct_iter, &value);
  70. if (value < 0.0 || value > 1.0) {
  71. return false;
  72. }
  73. if (idx == 0) {
  74. static_cast<Color *>(r_value)->r = value;
  75. } else if (idx == 1) {
  76. static_cast<Color *>(r_value)->g = value;
  77. } else if (idx == 2) {
  78. static_cast<Color *>(r_value)->b = value;
  79. }
  80. idx++;
  81. if (!dbus_message_iter_next(&struct_iter)) {
  82. break;
  83. }
  84. }
  85. if (idx != 3) {
  86. return false;
  87. }
  88. } else if (p_type == VAR_TYPE_UINT32) {
  89. if (dbus_message_iter_get_arg_type(&iter[2]) != DBUS_TYPE_UINT32) {
  90. return false;
  91. }
  92. dbus_message_iter_get_basic(&iter[2], r_value);
  93. }
  94. return true;
  95. }
  96. bool FreeDesktopPortalDesktop::read_setting(const char *p_namespace, const char *p_key, ReadVariantType p_type, void *r_value) {
  97. if (unsupported) {
  98. return false;
  99. }
  100. DBusError error;
  101. dbus_error_init(&error);
  102. DBusConnection *bus = dbus_bus_get(DBUS_BUS_SESSION, &error);
  103. if (dbus_error_is_set(&error)) {
  104. if (OS::get_singleton()->is_stdout_verbose()) {
  105. ERR_PRINT(vformat("Error opening D-Bus connection: %s", error.message));
  106. }
  107. dbus_error_free(&error);
  108. unsupported = true;
  109. return false;
  110. }
  111. DBusMessage *message = dbus_message_new_method_call(
  112. BUS_OBJECT_NAME, BUS_OBJECT_PATH, BUS_INTERFACE_SETTINGS,
  113. "Read");
  114. dbus_message_append_args(
  115. message,
  116. DBUS_TYPE_STRING, &p_namespace,
  117. DBUS_TYPE_STRING, &p_key,
  118. DBUS_TYPE_INVALID);
  119. DBusMessage *reply = dbus_connection_send_with_reply_and_block(bus, message, 50, &error);
  120. dbus_message_unref(message);
  121. if (dbus_error_is_set(&error)) {
  122. if (OS::get_singleton()->is_stdout_verbose()) {
  123. ERR_PRINT(vformat("Error on D-Bus communication: %s", error.message));
  124. }
  125. dbus_error_free(&error);
  126. dbus_connection_unref(bus);
  127. return false;
  128. }
  129. bool success = try_parse_variant(reply, p_type, r_value);
  130. dbus_message_unref(reply);
  131. dbus_connection_unref(bus);
  132. return success;
  133. }
  134. uint32_t FreeDesktopPortalDesktop::get_appearance_color_scheme() {
  135. if (unsupported) {
  136. return 0;
  137. }
  138. uint32_t value = 0;
  139. if (read_setting("org.freedesktop.appearance", "color-scheme", VAR_TYPE_UINT32, &value)) {
  140. return value;
  141. } else {
  142. return 0;
  143. }
  144. }
  145. Color FreeDesktopPortalDesktop::get_appearance_accent_color() {
  146. if (unsupported) {
  147. return Color(0, 0, 0, 0);
  148. }
  149. Color value;
  150. if (read_setting("org.freedesktop.appearance", "accent-color", VAR_TYPE_COLOR, &value)) {
  151. return value;
  152. } else {
  153. return Color(0, 0, 0, 0);
  154. }
  155. }
  156. static const char *cs_empty = "";
  157. void FreeDesktopPortalDesktop::append_dbus_string(DBusMessageIter *p_iter, const String &p_string) {
  158. CharString cs = p_string.utf8();
  159. const char *cs_ptr = cs.ptr();
  160. if (cs_ptr) {
  161. dbus_message_iter_append_basic(p_iter, DBUS_TYPE_STRING, &cs_ptr);
  162. } else {
  163. dbus_message_iter_append_basic(p_iter, DBUS_TYPE_STRING, &cs_empty);
  164. }
  165. }
  166. void FreeDesktopPortalDesktop::append_dbus_dict_options(DBusMessageIter *p_iter, const TypedArray<Dictionary> &p_options, HashMap<String, String> &r_ids) {
  167. DBusMessageIter dict_iter;
  168. DBusMessageIter var_iter;
  169. DBusMessageIter arr_iter;
  170. const char *choices_key = "choices";
  171. dbus_message_iter_open_container(p_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &dict_iter);
  172. dbus_message_iter_append_basic(&dict_iter, DBUS_TYPE_STRING, &choices_key);
  173. dbus_message_iter_open_container(&dict_iter, DBUS_TYPE_VARIANT, "a(ssa(ss)s)", &var_iter);
  174. dbus_message_iter_open_container(&var_iter, DBUS_TYPE_ARRAY, "(ss(ss)s)", &arr_iter);
  175. r_ids.clear();
  176. for (int i = 0; i < p_options.size(); i++) {
  177. const Dictionary &item = p_options[i];
  178. if (!item.has("name") || !item.has("values") || !item.has("default")) {
  179. continue;
  180. }
  181. const String &name = item["name"];
  182. const Vector<String> &options = item["values"];
  183. int default_idx = item["default"];
  184. DBusMessageIter struct_iter;
  185. DBusMessageIter array_iter;
  186. DBusMessageIter array_struct_iter;
  187. dbus_message_iter_open_container(&arr_iter, DBUS_TYPE_STRUCT, nullptr, &struct_iter);
  188. append_dbus_string(&struct_iter, "option_" + itos(i)); // ID.
  189. append_dbus_string(&struct_iter, name); // User visible name.
  190. r_ids["option_" + itos(i)] = name;
  191. dbus_message_iter_open_container(&struct_iter, DBUS_TYPE_ARRAY, "(ss)", &array_iter);
  192. for (int j = 0; j < options.size(); j++) {
  193. dbus_message_iter_open_container(&array_iter, DBUS_TYPE_STRUCT, nullptr, &array_struct_iter);
  194. append_dbus_string(&array_struct_iter, itos(j));
  195. append_dbus_string(&array_struct_iter, options[j]);
  196. dbus_message_iter_close_container(&array_iter, &array_struct_iter);
  197. }
  198. dbus_message_iter_close_container(&struct_iter, &array_iter);
  199. if (options.is_empty()) {
  200. append_dbus_string(&struct_iter, (default_idx) ? "true" : "false"); // Default selection.
  201. } else {
  202. append_dbus_string(&struct_iter, itos(default_idx)); // Default selection.
  203. }
  204. dbus_message_iter_close_container(&arr_iter, &struct_iter);
  205. }
  206. dbus_message_iter_close_container(&var_iter, &arr_iter);
  207. dbus_message_iter_close_container(&dict_iter, &var_iter);
  208. dbus_message_iter_close_container(p_iter, &dict_iter);
  209. }
  210. void FreeDesktopPortalDesktop::append_dbus_dict_filters(DBusMessageIter *p_iter, const Vector<String> &p_filter_names, const Vector<String> &p_filter_exts, const Vector<String> &p_filter_mimes) {
  211. DBusMessageIter dict_iter;
  212. DBusMessageIter var_iter;
  213. DBusMessageIter arr_iter;
  214. const char *filters_key = "filters";
  215. ERR_FAIL_COND(p_filter_names.size() != p_filter_exts.size());
  216. ERR_FAIL_COND(p_filter_names.size() != p_filter_mimes.size());
  217. dbus_message_iter_open_container(p_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &dict_iter);
  218. dbus_message_iter_append_basic(&dict_iter, DBUS_TYPE_STRING, &filters_key);
  219. dbus_message_iter_open_container(&dict_iter, DBUS_TYPE_VARIANT, "a(sa(us))", &var_iter);
  220. dbus_message_iter_open_container(&var_iter, DBUS_TYPE_ARRAY, "(sa(us))", &arr_iter);
  221. for (int i = 0; i < p_filter_names.size(); i++) {
  222. DBusMessageIter struct_iter;
  223. DBusMessageIter array_iter;
  224. DBusMessageIter array_struct_iter;
  225. dbus_message_iter_open_container(&arr_iter, DBUS_TYPE_STRUCT, nullptr, &struct_iter);
  226. append_dbus_string(&struct_iter, p_filter_names[i]);
  227. dbus_message_iter_open_container(&struct_iter, DBUS_TYPE_ARRAY, "(us)", &array_iter);
  228. const String &flt_orig = p_filter_exts[i];
  229. String flt;
  230. for (int j = 0; j < flt_orig.length(); j++) {
  231. if (is_unicode_letter(flt_orig[j])) {
  232. flt += vformat("[%c%c]", String::char_lowercase(flt_orig[j]), String::char_uppercase(flt_orig[j]));
  233. } else {
  234. flt += flt_orig[j];
  235. }
  236. }
  237. int filter_slice_count = flt.get_slice_count(",");
  238. for (int j = 0; j < filter_slice_count; j++) {
  239. dbus_message_iter_open_container(&array_iter, DBUS_TYPE_STRUCT, nullptr, &array_struct_iter);
  240. String str = (flt.get_slicec(',', j).strip_edges());
  241. {
  242. const unsigned flt_type = 0;
  243. dbus_message_iter_append_basic(&array_struct_iter, DBUS_TYPE_UINT32, &flt_type);
  244. }
  245. append_dbus_string(&array_struct_iter, str);
  246. dbus_message_iter_close_container(&array_iter, &array_struct_iter);
  247. }
  248. const String &mime = p_filter_mimes[i];
  249. filter_slice_count = mime.get_slice_count(",");
  250. for (int j = 0; j < filter_slice_count; j++) {
  251. dbus_message_iter_open_container(&array_iter, DBUS_TYPE_STRUCT, nullptr, &array_struct_iter);
  252. String str = mime.get_slicec(',', j).strip_edges();
  253. {
  254. const unsigned flt_type = 1;
  255. dbus_message_iter_append_basic(&array_struct_iter, DBUS_TYPE_UINT32, &flt_type);
  256. }
  257. append_dbus_string(&array_struct_iter, str);
  258. dbus_message_iter_close_container(&array_iter, &array_struct_iter);
  259. }
  260. dbus_message_iter_close_container(&struct_iter, &array_iter);
  261. dbus_message_iter_close_container(&arr_iter, &struct_iter);
  262. }
  263. dbus_message_iter_close_container(&var_iter, &arr_iter);
  264. dbus_message_iter_close_container(&dict_iter, &var_iter);
  265. dbus_message_iter_close_container(p_iter, &dict_iter);
  266. }
  267. void FreeDesktopPortalDesktop::append_dbus_dict_string(DBusMessageIter *p_iter, const String &p_key, const String &p_value, bool p_as_byte_array) {
  268. DBusMessageIter dict_iter;
  269. DBusMessageIter var_iter;
  270. dbus_message_iter_open_container(p_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &dict_iter);
  271. append_dbus_string(&dict_iter, p_key);
  272. if (p_as_byte_array) {
  273. DBusMessageIter arr_iter;
  274. dbus_message_iter_open_container(&dict_iter, DBUS_TYPE_VARIANT, "ay", &var_iter);
  275. dbus_message_iter_open_container(&var_iter, DBUS_TYPE_ARRAY, "y", &arr_iter);
  276. CharString cs = p_value.utf8();
  277. const char *cs_ptr = cs.get_data();
  278. do {
  279. dbus_message_iter_append_basic(&arr_iter, DBUS_TYPE_BYTE, cs_ptr);
  280. } while (*cs_ptr++);
  281. dbus_message_iter_close_container(&var_iter, &arr_iter);
  282. } else {
  283. dbus_message_iter_open_container(&dict_iter, DBUS_TYPE_VARIANT, "s", &var_iter);
  284. append_dbus_string(&var_iter, p_value);
  285. }
  286. dbus_message_iter_close_container(&dict_iter, &var_iter);
  287. dbus_message_iter_close_container(p_iter, &dict_iter);
  288. }
  289. void FreeDesktopPortalDesktop::append_dbus_dict_bool(DBusMessageIter *p_iter, const String &p_key, bool p_value) {
  290. DBusMessageIter dict_iter;
  291. DBusMessageIter var_iter;
  292. dbus_message_iter_open_container(p_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &dict_iter);
  293. append_dbus_string(&dict_iter, p_key);
  294. dbus_message_iter_open_container(&dict_iter, DBUS_TYPE_VARIANT, "b", &var_iter);
  295. {
  296. int val = p_value;
  297. dbus_message_iter_append_basic(&var_iter, DBUS_TYPE_BOOLEAN, &val);
  298. }
  299. dbus_message_iter_close_container(&dict_iter, &var_iter);
  300. dbus_message_iter_close_container(p_iter, &dict_iter);
  301. }
  302. bool FreeDesktopPortalDesktop::color_picker_parse_response(DBusMessageIter *p_iter, bool &r_cancel, Color &r_color) {
  303. ERR_FAIL_COND_V(dbus_message_iter_get_arg_type(p_iter) != DBUS_TYPE_UINT32, false);
  304. dbus_uint32_t resp_code;
  305. dbus_message_iter_get_basic(p_iter, &resp_code);
  306. if (resp_code != 0) {
  307. r_cancel = true;
  308. } else {
  309. r_cancel = false;
  310. ERR_FAIL_COND_V(!dbus_message_iter_next(p_iter), false);
  311. ERR_FAIL_COND_V(dbus_message_iter_get_arg_type(p_iter) != DBUS_TYPE_ARRAY, false);
  312. DBusMessageIter dict_iter;
  313. dbus_message_iter_recurse(p_iter, &dict_iter);
  314. while (dbus_message_iter_get_arg_type(&dict_iter) == DBUS_TYPE_DICT_ENTRY) {
  315. DBusMessageIter iter;
  316. dbus_message_iter_recurse(&dict_iter, &iter);
  317. if (dbus_message_iter_get_arg_type(&iter) == DBUS_TYPE_STRING) {
  318. const char *key;
  319. dbus_message_iter_get_basic(&iter, &key);
  320. dbus_message_iter_next(&iter);
  321. DBusMessageIter var_iter;
  322. dbus_message_iter_recurse(&iter, &var_iter);
  323. if (strcmp(key, "color") == 0) { // (ddd)
  324. if (dbus_message_iter_get_arg_type(&var_iter) == DBUS_TYPE_STRUCT) {
  325. DBusMessageIter struct_iter;
  326. dbus_message_iter_recurse(&var_iter, &struct_iter);
  327. int idx = 0;
  328. while (dbus_message_iter_get_arg_type(&struct_iter) == DBUS_TYPE_DOUBLE) {
  329. double value = 0.0;
  330. dbus_message_iter_get_basic(&struct_iter, &value);
  331. if (idx == 0) {
  332. r_color.r = value;
  333. } else if (idx == 1) {
  334. r_color.g = value;
  335. } else if (idx == 2) {
  336. r_color.b = value;
  337. }
  338. idx++;
  339. if (!dbus_message_iter_next(&struct_iter)) {
  340. break;
  341. }
  342. }
  343. }
  344. }
  345. }
  346. if (!dbus_message_iter_next(&dict_iter)) {
  347. break;
  348. }
  349. }
  350. }
  351. return true;
  352. }
  353. bool FreeDesktopPortalDesktop::file_chooser_parse_response(DBusMessageIter *p_iter, const Vector<String> &p_names, const HashMap<String, String> &p_ids, bool &r_cancel, Vector<String> &r_urls, int &r_index, Dictionary &r_options) {
  354. ERR_FAIL_COND_V(dbus_message_iter_get_arg_type(p_iter) != DBUS_TYPE_UINT32, false);
  355. dbus_uint32_t resp_code;
  356. dbus_message_iter_get_basic(p_iter, &resp_code);
  357. if (resp_code != 0) {
  358. r_cancel = true;
  359. } else {
  360. r_cancel = false;
  361. ERR_FAIL_COND_V(!dbus_message_iter_next(p_iter), false);
  362. ERR_FAIL_COND_V(dbus_message_iter_get_arg_type(p_iter) != DBUS_TYPE_ARRAY, false);
  363. DBusMessageIter dict_iter;
  364. dbus_message_iter_recurse(p_iter, &dict_iter);
  365. while (dbus_message_iter_get_arg_type(&dict_iter) == DBUS_TYPE_DICT_ENTRY) {
  366. DBusMessageIter iter;
  367. dbus_message_iter_recurse(&dict_iter, &iter);
  368. if (dbus_message_iter_get_arg_type(&iter) == DBUS_TYPE_STRING) {
  369. const char *key;
  370. dbus_message_iter_get_basic(&iter, &key);
  371. dbus_message_iter_next(&iter);
  372. DBusMessageIter var_iter;
  373. dbus_message_iter_recurse(&iter, &var_iter);
  374. if (strcmp(key, "current_filter") == 0) { // (sa(us))
  375. if (dbus_message_iter_get_arg_type(&var_iter) == DBUS_TYPE_STRUCT) {
  376. DBusMessageIter struct_iter;
  377. dbus_message_iter_recurse(&var_iter, &struct_iter);
  378. while (dbus_message_iter_get_arg_type(&struct_iter) == DBUS_TYPE_STRING) {
  379. const char *value;
  380. dbus_message_iter_get_basic(&struct_iter, &value);
  381. String name = String::utf8(value);
  382. r_index = p_names.find(name);
  383. if (!dbus_message_iter_next(&struct_iter)) {
  384. break;
  385. }
  386. }
  387. }
  388. } else if (strcmp(key, "choices") == 0) { // a(ss) {
  389. if (dbus_message_iter_get_arg_type(&var_iter) == DBUS_TYPE_ARRAY) {
  390. DBusMessageIter struct_iter;
  391. dbus_message_iter_recurse(&var_iter, &struct_iter);
  392. while (dbus_message_iter_get_arg_type(&struct_iter) == DBUS_TYPE_STRUCT) {
  393. DBusMessageIter opt_iter;
  394. dbus_message_iter_recurse(&struct_iter, &opt_iter);
  395. const char *opt_key = nullptr;
  396. dbus_message_iter_get_basic(&opt_iter, &opt_key);
  397. String opt_skey = String::utf8(opt_key);
  398. dbus_message_iter_next(&opt_iter);
  399. const char *opt_val = nullptr;
  400. dbus_message_iter_get_basic(&opt_iter, &opt_val);
  401. String opt_sval = String::utf8(opt_val);
  402. if (p_ids.has(opt_skey)) {
  403. opt_skey = p_ids[opt_skey];
  404. if (opt_sval == "true") {
  405. r_options[opt_skey] = true;
  406. } else if (opt_sval == "false") {
  407. r_options[opt_skey] = false;
  408. } else {
  409. r_options[opt_skey] = opt_sval.to_int();
  410. }
  411. }
  412. if (!dbus_message_iter_next(&struct_iter)) {
  413. break;
  414. }
  415. }
  416. }
  417. } else if (strcmp(key, "uris") == 0) { // as
  418. if (dbus_message_iter_get_arg_type(&var_iter) == DBUS_TYPE_ARRAY) {
  419. DBusMessageIter uri_iter;
  420. dbus_message_iter_recurse(&var_iter, &uri_iter);
  421. while (dbus_message_iter_get_arg_type(&uri_iter) == DBUS_TYPE_STRING) {
  422. const char *value;
  423. dbus_message_iter_get_basic(&uri_iter, &value);
  424. r_urls.push_back(String::utf8(value).trim_prefix("file://").uri_file_decode());
  425. if (!dbus_message_iter_next(&uri_iter)) {
  426. break;
  427. }
  428. }
  429. }
  430. }
  431. }
  432. if (!dbus_message_iter_next(&dict_iter)) {
  433. break;
  434. }
  435. }
  436. }
  437. return true;
  438. }
  439. bool FreeDesktopPortalDesktop::color_picker(const String &p_xid, const Callable &p_callback) {
  440. if (unsupported) {
  441. return false;
  442. }
  443. DBusError err;
  444. dbus_error_init(&err);
  445. // Open connection and add signal handler.
  446. ColorPickerData cd;
  447. cd.callback = p_callback;
  448. CryptoCore::RandomGenerator rng;
  449. ERR_FAIL_COND_V_MSG(rng.init(), false, "Failed to initialize random number generator.");
  450. uint8_t uuid[64];
  451. Error rng_err = rng.get_random_bytes(uuid, 64);
  452. ERR_FAIL_COND_V_MSG(rng_err, false, "Failed to generate unique token.");
  453. String dbus_unique_name = String::utf8(dbus_bus_get_unique_name(monitor_connection));
  454. String token = String::hex_encode_buffer(uuid, 64);
  455. String path = vformat("/org/freedesktop/portal/desktop/request/%s/%s", dbus_unique_name.replace(".", "_").replace(":", ""), token);
  456. cd.path = path;
  457. cd.filter = vformat("type='signal',sender='org.freedesktop.portal.Desktop',path='%s',interface='org.freedesktop.portal.Request',member='Response',destination='%s'", path, dbus_unique_name);
  458. dbus_bus_add_match(monitor_connection, cd.filter.utf8().get_data(), &err);
  459. if (dbus_error_is_set(&err)) {
  460. ERR_PRINT(vformat("Failed to add DBus match: %s", err.message));
  461. dbus_error_free(&err);
  462. return false;
  463. }
  464. DBusMessage *message = dbus_message_new_method_call(BUS_OBJECT_NAME, BUS_OBJECT_PATH, BUS_INTERFACE_SCREENSHOT, "PickColor");
  465. {
  466. DBusMessageIter iter;
  467. dbus_message_iter_init_append(message, &iter);
  468. append_dbus_string(&iter, p_xid);
  469. DBusMessageIter arr_iter;
  470. dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "{sv}", &arr_iter);
  471. append_dbus_dict_string(&arr_iter, "handle_token", token);
  472. dbus_message_iter_close_container(&iter, &arr_iter);
  473. }
  474. DBusMessage *reply = dbus_connection_send_with_reply_and_block(monitor_connection, message, DBUS_TIMEOUT_INFINITE, &err);
  475. dbus_message_unref(message);
  476. if (!reply || dbus_error_is_set(&err)) {
  477. ERR_PRINT(vformat("Failed to send DBus message: %s", err.message));
  478. dbus_error_free(&err);
  479. dbus_bus_remove_match(monitor_connection, cd.filter.utf8().get_data(), &err);
  480. return false;
  481. }
  482. // Update signal path.
  483. {
  484. DBusMessageIter iter;
  485. if (dbus_message_iter_init(reply, &iter)) {
  486. if (dbus_message_iter_get_arg_type(&iter) == DBUS_TYPE_OBJECT_PATH) {
  487. const char *new_path = nullptr;
  488. dbus_message_iter_get_basic(&iter, &new_path);
  489. if (String::utf8(new_path) != path) {
  490. dbus_bus_remove_match(monitor_connection, cd.filter.utf8().get_data(), &err);
  491. if (dbus_error_is_set(&err)) {
  492. ERR_PRINT(vformat("Failed to remove DBus match: %s", err.message));
  493. dbus_error_free(&err);
  494. return false;
  495. }
  496. cd.filter = String::utf8(new_path);
  497. dbus_bus_add_match(monitor_connection, cd.filter.utf8().get_data(), &err);
  498. if (dbus_error_is_set(&err)) {
  499. ERR_PRINT(vformat("Failed to add DBus match: %s", err.message));
  500. dbus_error_free(&err);
  501. return false;
  502. }
  503. }
  504. }
  505. }
  506. }
  507. dbus_message_unref(reply);
  508. MutexLock lock(color_picker_mutex);
  509. color_pickers.push_back(cd);
  510. return true;
  511. }
  512. bool FreeDesktopPortalDesktop::_is_interface_supported(const char *p_iface) {
  513. bool supported = false;
  514. DBusError err;
  515. dbus_error_init(&err);
  516. DBusConnection *bus = dbus_bus_get(DBUS_BUS_SESSION, &err);
  517. if (dbus_error_is_set(&err)) {
  518. dbus_error_free(&err);
  519. } else {
  520. DBusMessage *message = dbus_message_new_method_call(BUS_OBJECT_NAME, BUS_OBJECT_PATH, BUS_INTERFACE_PROPERTIES, "Get");
  521. if (message) {
  522. const char *name_space = p_iface;
  523. const char *key = "version";
  524. dbus_message_append_args(
  525. message,
  526. DBUS_TYPE_STRING, &name_space,
  527. DBUS_TYPE_STRING, &key,
  528. DBUS_TYPE_INVALID);
  529. DBusMessage *reply = dbus_connection_send_with_reply_and_block(bus, message, 250, &err);
  530. if (dbus_error_is_set(&err)) {
  531. dbus_error_free(&err);
  532. } else if (reply) {
  533. DBusMessageIter iter;
  534. if (dbus_message_iter_init(reply, &iter)) {
  535. DBusMessageIter iter_ver;
  536. dbus_message_iter_recurse(&iter, &iter_ver);
  537. dbus_uint32_t ver_code;
  538. dbus_message_iter_get_basic(&iter_ver, &ver_code);
  539. print_verbose(vformat("PortalDesktop: %s version %d detected.", p_iface, ver_code));
  540. supported = true;
  541. }
  542. dbus_message_unref(reply);
  543. }
  544. dbus_message_unref(message);
  545. }
  546. dbus_connection_unref(bus);
  547. }
  548. return supported;
  549. }
  550. bool FreeDesktopPortalDesktop::is_file_chooser_supported() {
  551. static int supported = -1;
  552. if (supported == -1) {
  553. supported = _is_interface_supported(BUS_INTERFACE_FILE_CHOOSER);
  554. }
  555. return supported;
  556. }
  557. bool FreeDesktopPortalDesktop::is_settings_supported() {
  558. static int supported = -1;
  559. if (supported == -1) {
  560. supported = _is_interface_supported(BUS_INTERFACE_SETTINGS);
  561. }
  562. return supported;
  563. }
  564. bool FreeDesktopPortalDesktop::is_screenshot_supported() {
  565. static int supported = -1;
  566. if (supported == -1) {
  567. supported = _is_interface_supported(BUS_INTERFACE_SCREENSHOT);
  568. }
  569. return supported;
  570. }
  571. Error FreeDesktopPortalDesktop::file_dialog_show(DisplayServer::WindowID p_window_id, const String &p_xid, const String &p_title, const String &p_current_directory, const String &p_root, const String &p_filename, DisplayServer::FileDialogMode p_mode, const Vector<String> &p_filters, const TypedArray<Dictionary> &p_options, const Callable &p_callback, bool p_options_in_cb) {
  572. if (unsupported) {
  573. return FAILED;
  574. }
  575. ERR_FAIL_INDEX_V(int(p_mode), DisplayServer::FILE_DIALOG_MODE_SAVE_MAX, FAILED);
  576. ERR_FAIL_NULL_V(monitor_connection, FAILED);
  577. Vector<String> filter_names;
  578. Vector<String> filter_exts;
  579. Vector<String> filter_mimes;
  580. for (int i = 0; i < p_filters.size(); i++) {
  581. Vector<String> tokens = p_filters[i].split(";");
  582. if (tokens.size() >= 1) {
  583. String flt = tokens[0].strip_edges();
  584. String mime = (tokens.size() >= 2) ? tokens[2].strip_edges() : String();
  585. if (!flt.is_empty() || !mime.is_empty()) {
  586. if (tokens.size() >= 2) {
  587. if (flt == "*.*") {
  588. filter_exts.push_back("*");
  589. } else {
  590. filter_exts.push_back(flt);
  591. }
  592. filter_mimes.push_back(mime);
  593. filter_names.push_back(tokens[1]);
  594. } else {
  595. if (flt == "*.*") {
  596. filter_exts.push_back("*");
  597. filter_names.push_back(RTR("All Files") + " (*.*)");
  598. } else {
  599. filter_exts.push_back(flt);
  600. filter_names.push_back(flt);
  601. }
  602. filter_mimes.push_back(mime);
  603. }
  604. }
  605. }
  606. }
  607. if (filter_names.is_empty()) {
  608. filter_exts.push_back("*");
  609. filter_mimes.push_back("");
  610. filter_names.push_back(RTR("All Files") + " (*.*)");
  611. }
  612. DBusError err;
  613. dbus_error_init(&err);
  614. // Open connection and add signal handler.
  615. FileDialogData fd;
  616. fd.callback = p_callback;
  617. fd.prev_focus = p_window_id;
  618. fd.filter_names = filter_names;
  619. fd.opt_in_cb = p_options_in_cb;
  620. CryptoCore::RandomGenerator rng;
  621. ERR_FAIL_COND_V_MSG(rng.init(), FAILED, "Failed to initialize random number generator.");
  622. uint8_t uuid[64];
  623. Error rng_err = rng.get_random_bytes(uuid, 64);
  624. ERR_FAIL_COND_V_MSG(rng_err, rng_err, "Failed to generate unique token.");
  625. String dbus_unique_name = String::utf8(dbus_bus_get_unique_name(monitor_connection));
  626. String token = String::hex_encode_buffer(uuid, 64);
  627. String path = vformat("/org/freedesktop/portal/desktop/request/%s/%s", dbus_unique_name.replace(".", "_").remove_char(':'), token);
  628. fd.path = path;
  629. fd.filter = vformat("type='signal',sender='org.freedesktop.portal.Desktop',path='%s',interface='org.freedesktop.portal.Request',member='Response',destination='%s'", path, dbus_unique_name);
  630. dbus_bus_add_match(monitor_connection, fd.filter.utf8().get_data(), &err);
  631. if (dbus_error_is_set(&err)) {
  632. ERR_PRINT(vformat("Failed to add DBus match: %s", err.message));
  633. dbus_error_free(&err);
  634. return FAILED;
  635. }
  636. // Generate FileChooser message.
  637. const char *method = nullptr;
  638. if (p_mode == DisplayServer::FILE_DIALOG_MODE_SAVE_FILE) {
  639. method = "SaveFile";
  640. } else {
  641. method = "OpenFile";
  642. }
  643. DBusMessage *message = dbus_message_new_method_call(BUS_OBJECT_NAME, BUS_OBJECT_PATH, BUS_INTERFACE_FILE_CHOOSER, method);
  644. {
  645. DBusMessageIter iter;
  646. dbus_message_iter_init_append(message, &iter);
  647. append_dbus_string(&iter, p_xid);
  648. append_dbus_string(&iter, p_title);
  649. DBusMessageIter arr_iter;
  650. dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "{sv}", &arr_iter);
  651. append_dbus_dict_string(&arr_iter, "handle_token", token);
  652. append_dbus_dict_bool(&arr_iter, "multiple", p_mode == DisplayServer::FILE_DIALOG_MODE_OPEN_FILES);
  653. append_dbus_dict_bool(&arr_iter, "directory", p_mode == DisplayServer::FILE_DIALOG_MODE_OPEN_DIR);
  654. append_dbus_dict_filters(&arr_iter, filter_names, filter_exts, filter_mimes);
  655. append_dbus_dict_options(&arr_iter, p_options, fd.option_ids);
  656. append_dbus_dict_string(&arr_iter, "current_folder", p_current_directory, true);
  657. if (p_mode == DisplayServer::FILE_DIALOG_MODE_SAVE_FILE) {
  658. append_dbus_dict_string(&arr_iter, "current_name", p_filename);
  659. }
  660. dbus_message_iter_close_container(&iter, &arr_iter);
  661. }
  662. DBusMessage *reply = dbus_connection_send_with_reply_and_block(monitor_connection, message, DBUS_TIMEOUT_INFINITE, &err);
  663. dbus_message_unref(message);
  664. if (!reply || dbus_error_is_set(&err)) {
  665. ERR_PRINT(vformat("Failed to send DBus message: %s", err.message));
  666. dbus_error_free(&err);
  667. dbus_bus_remove_match(monitor_connection, fd.filter.utf8().get_data(), &err);
  668. return FAILED;
  669. }
  670. // Update signal path.
  671. {
  672. DBusMessageIter iter;
  673. if (dbus_message_iter_init(reply, &iter)) {
  674. if (dbus_message_iter_get_arg_type(&iter) == DBUS_TYPE_OBJECT_PATH) {
  675. const char *new_path = nullptr;
  676. dbus_message_iter_get_basic(&iter, &new_path);
  677. if (String::utf8(new_path) != path) {
  678. dbus_bus_remove_match(monitor_connection, fd.filter.utf8().get_data(), &err);
  679. if (dbus_error_is_set(&err)) {
  680. ERR_PRINT(vformat("Failed to remove DBus match: %s", err.message));
  681. dbus_error_free(&err);
  682. return FAILED;
  683. }
  684. fd.filter = String::utf8(new_path);
  685. dbus_bus_add_match(monitor_connection, fd.filter.utf8().get_data(), &err);
  686. if (dbus_error_is_set(&err)) {
  687. ERR_PRINT(vformat("Failed to add DBus match: %s", err.message));
  688. dbus_error_free(&err);
  689. return FAILED;
  690. }
  691. }
  692. }
  693. }
  694. }
  695. dbus_message_unref(reply);
  696. MutexLock lock(file_dialog_mutex);
  697. file_dialogs.push_back(fd);
  698. return OK;
  699. }
  700. void FreeDesktopPortalDesktop::process_callbacks() {
  701. {
  702. MutexLock lock(file_dialog_mutex);
  703. while (!pending_file_cbs.is_empty()) {
  704. FileDialogCallback cb = pending_file_cbs.front()->get();
  705. pending_file_cbs.pop_front();
  706. if (cb.opt_in_cb) {
  707. Variant ret;
  708. Callable::CallError ce;
  709. const Variant *args[4] = { &cb.status, &cb.files, &cb.index, &cb.options };
  710. cb.callback.callp(args, 4, ret, ce);
  711. if (ce.error != Callable::CallError::CALL_OK) {
  712. ERR_PRINT(vformat("Failed to execute file dialog callback: %s.", Variant::get_callable_error_text(cb.callback, args, 4, ce)));
  713. }
  714. } else {
  715. Variant ret;
  716. Callable::CallError ce;
  717. const Variant *args[3] = { &cb.status, &cb.files, &cb.index };
  718. cb.callback.callp(args, 3, ret, ce);
  719. if (ce.error != Callable::CallError::CALL_OK) {
  720. ERR_PRINT(vformat("Failed to execute file dialog callback: %s.", Variant::get_callable_error_text(cb.callback, args, 3, ce)));
  721. }
  722. }
  723. }
  724. }
  725. {
  726. MutexLock lock(color_picker_mutex);
  727. while (!pending_color_cbs.is_empty()) {
  728. ColorPickerCallback cb = pending_color_cbs.front()->get();
  729. pending_color_cbs.pop_front();
  730. Variant ret;
  731. Callable::CallError ce;
  732. const Variant *args[2] = { &cb.status, &cb.color };
  733. cb.callback.callp(args, 2, ret, ce);
  734. if (ce.error != Callable::CallError::CALL_OK) {
  735. ERR_PRINT(vformat("Failed to execute color picker callback: %s.", Variant::get_callable_error_text(cb.callback, args, 2, ce)));
  736. }
  737. }
  738. }
  739. }
  740. void FreeDesktopPortalDesktop::_thread_monitor(void *p_ud) {
  741. FreeDesktopPortalDesktop *portal = (FreeDesktopPortalDesktop *)p_ud;
  742. while (!portal->monitor_thread_abort.is_set()) {
  743. if (portal->monitor_connection) {
  744. while (true) {
  745. DBusMessage *msg = dbus_connection_pop_message(portal->monitor_connection);
  746. if (!msg) {
  747. break;
  748. } else if (dbus_message_is_signal(msg, "org.freedesktop.portal.Settings", "SettingChanged")) {
  749. DBusMessageIter iter;
  750. if (dbus_message_iter_init(msg, &iter)) {
  751. const char *value;
  752. dbus_message_iter_get_basic(&iter, &value);
  753. String name_space = String::utf8(value);
  754. dbus_message_iter_next(&iter);
  755. dbus_message_iter_get_basic(&iter, &value);
  756. String key = String::utf8(value);
  757. if (name_space == "org.freedesktop.appearance" && (key == "color-scheme" || key == "accent-color")) {
  758. callable_mp(portal, &FreeDesktopPortalDesktop::_system_theme_changed_callback).call_deferred();
  759. }
  760. }
  761. } else if (dbus_message_is_signal(msg, "org.freedesktop.portal.Request", "Response")) {
  762. String path = String::utf8(dbus_message_get_path(msg));
  763. {
  764. MutexLock lock(portal->file_dialog_mutex);
  765. for (int i = 0; i < portal->file_dialogs.size(); i++) {
  766. FreeDesktopPortalDesktop::FileDialogData &fd = portal->file_dialogs.write[i];
  767. if (fd.path == path) {
  768. DBusMessageIter iter;
  769. if (dbus_message_iter_init(msg, &iter)) {
  770. bool cancel = false;
  771. Vector<String> uris;
  772. Dictionary options;
  773. int index = 0;
  774. file_chooser_parse_response(&iter, fd.filter_names, fd.option_ids, cancel, uris, index, options);
  775. if (fd.callback.is_valid()) {
  776. FileDialogCallback cb;
  777. cb.callback = fd.callback;
  778. cb.status = !cancel;
  779. cb.files = uris;
  780. cb.index = index;
  781. cb.options = options;
  782. cb.opt_in_cb = fd.opt_in_cb;
  783. portal->pending_file_cbs.push_back(cb);
  784. }
  785. if (fd.prev_focus != DisplayServer::INVALID_WINDOW_ID) {
  786. callable_mp(DisplayServer::get_singleton(), &DisplayServer::window_move_to_foreground).call_deferred(fd.prev_focus);
  787. }
  788. }
  789. DBusError err;
  790. dbus_error_init(&err);
  791. dbus_bus_remove_match(portal->monitor_connection, fd.filter.utf8().get_data(), &err);
  792. dbus_error_free(&err);
  793. portal->file_dialogs.remove_at(i);
  794. break;
  795. }
  796. }
  797. }
  798. {
  799. MutexLock lock(portal->color_picker_mutex);
  800. for (int i = 0; i < portal->color_pickers.size(); i++) {
  801. FreeDesktopPortalDesktop::ColorPickerData &cd = portal->color_pickers.write[i];
  802. if (cd.path == path) {
  803. DBusMessageIter iter;
  804. if (dbus_message_iter_init(msg, &iter)) {
  805. bool cancel = false;
  806. Color c;
  807. color_picker_parse_response(&iter, cancel, c);
  808. if (cd.callback.is_valid()) {
  809. ColorPickerCallback cb;
  810. cb.callback = cd.callback;
  811. cb.color = c;
  812. cb.status = !cancel;
  813. portal->pending_color_cbs.push_back(cb);
  814. }
  815. }
  816. DBusError err;
  817. dbus_error_init(&err);
  818. dbus_bus_remove_match(portal->monitor_connection, cd.filter.utf8().get_data(), &err);
  819. dbus_error_free(&err);
  820. portal->color_pickers.remove_at(i);
  821. break;
  822. }
  823. }
  824. }
  825. }
  826. dbus_message_unref(msg);
  827. }
  828. dbus_connection_read_write(portal->monitor_connection, 0);
  829. }
  830. OS::get_singleton()->delay_usec(50'000);
  831. }
  832. }
  833. void FreeDesktopPortalDesktop::_system_theme_changed_callback() {
  834. if (system_theme_changed.is_valid()) {
  835. Variant ret;
  836. Callable::CallError ce;
  837. system_theme_changed.callp(nullptr, 0, ret, ce);
  838. if (ce.error != Callable::CallError::CALL_OK) {
  839. ERR_PRINT(vformat("Failed to execute system theme changed callback: %s.", Variant::get_callable_error_text(system_theme_changed, nullptr, 0, ce)));
  840. }
  841. }
  842. }
  843. FreeDesktopPortalDesktop::FreeDesktopPortalDesktop() {
  844. #ifdef SOWRAP_ENABLED
  845. #ifdef DEBUG_ENABLED
  846. int dylibloader_verbose = 1;
  847. #else
  848. int dylibloader_verbose = 0;
  849. #endif
  850. unsupported = (initialize_dbus(dylibloader_verbose) != 0);
  851. #else
  852. unsupported = false;
  853. #endif
  854. if (unsupported) {
  855. return;
  856. }
  857. bool ver_ok = false;
  858. int version_major = 0;
  859. int version_minor = 0;
  860. int version_rev = 0;
  861. dbus_get_version(&version_major, &version_minor, &version_rev);
  862. ver_ok = (version_major == 1 && version_minor >= 10) || (version_major > 1); // 1.10.0
  863. print_verbose(vformat("PortalDesktop: DBus %d.%d.%d detected.", version_major, version_minor, version_rev));
  864. if (!ver_ok) {
  865. print_verbose("PortalDesktop: Unsupported DBus library version!");
  866. unsupported = true;
  867. }
  868. DBusError err;
  869. dbus_error_init(&err);
  870. monitor_connection = dbus_bus_get(DBUS_BUS_SESSION, &err);
  871. if (dbus_error_is_set(&err)) {
  872. dbus_error_free(&err);
  873. } else {
  874. theme_path = "type='signal',sender='org.freedesktop.portal.Desktop',interface='org.freedesktop.portal.Settings',member='SettingChanged'";
  875. dbus_bus_add_match(monitor_connection, theme_path.utf8().get_data(), &err);
  876. if (dbus_error_is_set(&err)) {
  877. dbus_error_free(&err);
  878. dbus_connection_unref(monitor_connection);
  879. monitor_connection = nullptr;
  880. }
  881. dbus_connection_read_write(monitor_connection, 0);
  882. }
  883. if (!unsupported) {
  884. monitor_thread_abort.clear();
  885. monitor_thread.start(FreeDesktopPortalDesktop::_thread_monitor, this);
  886. }
  887. }
  888. FreeDesktopPortalDesktop::~FreeDesktopPortalDesktop() {
  889. monitor_thread_abort.set();
  890. if (monitor_thread.is_started()) {
  891. monitor_thread.wait_to_finish();
  892. }
  893. if (monitor_connection) {
  894. DBusError err;
  895. for (FreeDesktopPortalDesktop::FileDialogData &fd : file_dialogs) {
  896. dbus_error_init(&err);
  897. dbus_bus_remove_match(monitor_connection, fd.filter.utf8().get_data(), &err);
  898. dbus_error_free(&err);
  899. }
  900. dbus_error_init(&err);
  901. dbus_bus_remove_match(monitor_connection, theme_path.utf8().get_data(), &err);
  902. dbus_error_free(&err);
  903. dbus_connection_unref(monitor_connection);
  904. }
  905. }
  906. #endif // DBUS_ENABLED