freedesktop_portal_desktop.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820
  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. bool FreeDesktopPortalDesktop::try_parse_variant(DBusMessage *p_reply_message, ReadVariantType p_type, void *r_value) {
  49. DBusMessageIter iter[3];
  50. dbus_message_iter_init(p_reply_message, &iter[0]);
  51. if (dbus_message_iter_get_arg_type(&iter[0]) != DBUS_TYPE_VARIANT) {
  52. return false;
  53. }
  54. dbus_message_iter_recurse(&iter[0], &iter[1]);
  55. if (dbus_message_iter_get_arg_type(&iter[1]) != DBUS_TYPE_VARIANT) {
  56. return false;
  57. }
  58. dbus_message_iter_recurse(&iter[1], &iter[2]);
  59. if (p_type == VAR_TYPE_COLOR) {
  60. if (dbus_message_iter_get_arg_type(&iter[2]) != DBUS_TYPE_STRUCT) {
  61. return false;
  62. }
  63. DBusMessageIter struct_iter;
  64. dbus_message_iter_recurse(&iter[2], &struct_iter);
  65. int idx = 0;
  66. while (dbus_message_iter_get_arg_type(&struct_iter) == DBUS_TYPE_DOUBLE) {
  67. double value = 0.0;
  68. dbus_message_iter_get_basic(&struct_iter, &value);
  69. if (value < 0.0 || value > 1.0) {
  70. return false;
  71. }
  72. if (idx == 0) {
  73. static_cast<Color *>(r_value)->r = value;
  74. } else if (idx == 1) {
  75. static_cast<Color *>(r_value)->g = value;
  76. } else if (idx == 2) {
  77. static_cast<Color *>(r_value)->b = value;
  78. }
  79. idx++;
  80. if (!dbus_message_iter_next(&struct_iter)) {
  81. break;
  82. }
  83. }
  84. if (idx != 3) {
  85. return false;
  86. }
  87. } else if (p_type == VAR_TYPE_UINT32) {
  88. if (dbus_message_iter_get_arg_type(&iter[2]) != DBUS_TYPE_UINT32) {
  89. return false;
  90. }
  91. dbus_message_iter_get_basic(&iter[2], r_value);
  92. }
  93. return true;
  94. }
  95. bool FreeDesktopPortalDesktop::read_setting(const char *p_namespace, const char *p_key, ReadVariantType p_type, void *r_value) {
  96. if (unsupported) {
  97. return false;
  98. }
  99. DBusError error;
  100. dbus_error_init(&error);
  101. DBusConnection *bus = dbus_bus_get(DBUS_BUS_SESSION, &error);
  102. if (dbus_error_is_set(&error)) {
  103. if (OS::get_singleton()->is_stdout_verbose()) {
  104. ERR_PRINT(vformat("Error opening D-Bus connection: %s", error.message));
  105. }
  106. dbus_error_free(&error);
  107. unsupported = true;
  108. return false;
  109. }
  110. DBusMessage *message = dbus_message_new_method_call(
  111. BUS_OBJECT_NAME, BUS_OBJECT_PATH, BUS_INTERFACE_SETTINGS,
  112. "Read");
  113. dbus_message_append_args(
  114. message,
  115. DBUS_TYPE_STRING, &p_namespace,
  116. DBUS_TYPE_STRING, &p_key,
  117. DBUS_TYPE_INVALID);
  118. DBusMessage *reply = dbus_connection_send_with_reply_and_block(bus, message, 50, &error);
  119. dbus_message_unref(message);
  120. if (dbus_error_is_set(&error)) {
  121. if (OS::get_singleton()->is_stdout_verbose()) {
  122. ERR_PRINT(vformat("Error on D-Bus communication: %s", error.message));
  123. }
  124. dbus_error_free(&error);
  125. dbus_connection_unref(bus);
  126. return false;
  127. }
  128. bool success = try_parse_variant(reply, p_type, r_value);
  129. dbus_message_unref(reply);
  130. dbus_connection_unref(bus);
  131. return success;
  132. }
  133. uint32_t FreeDesktopPortalDesktop::get_appearance_color_scheme() {
  134. if (unsupported) {
  135. return 0;
  136. }
  137. uint32_t value = 0;
  138. if (read_setting("org.freedesktop.appearance", "color-scheme", VAR_TYPE_UINT32, &value)) {
  139. return value;
  140. } else {
  141. return 0;
  142. }
  143. }
  144. Color FreeDesktopPortalDesktop::get_appearance_accent_color() {
  145. if (unsupported) {
  146. return Color(0, 0, 0, 0);
  147. }
  148. Color value;
  149. if (read_setting("org.freedesktop.appearance", "accent-color", VAR_TYPE_COLOR, &value)) {
  150. return value;
  151. } else {
  152. return Color(0, 0, 0, 0);
  153. }
  154. }
  155. static const char *cs_empty = "";
  156. void FreeDesktopPortalDesktop::append_dbus_string(DBusMessageIter *p_iter, const String &p_string) {
  157. CharString cs = p_string.utf8();
  158. const char *cs_ptr = cs.ptr();
  159. if (cs_ptr) {
  160. dbus_message_iter_append_basic(p_iter, DBUS_TYPE_STRING, &cs_ptr);
  161. } else {
  162. dbus_message_iter_append_basic(p_iter, DBUS_TYPE_STRING, &cs_empty);
  163. }
  164. }
  165. void FreeDesktopPortalDesktop::append_dbus_dict_options(DBusMessageIter *p_iter, const TypedArray<Dictionary> &p_options, HashMap<String, String> &r_ids) {
  166. DBusMessageIter dict_iter;
  167. DBusMessageIter var_iter;
  168. DBusMessageIter arr_iter;
  169. const char *choices_key = "choices";
  170. dbus_message_iter_open_container(p_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &dict_iter);
  171. dbus_message_iter_append_basic(&dict_iter, DBUS_TYPE_STRING, &choices_key);
  172. dbus_message_iter_open_container(&dict_iter, DBUS_TYPE_VARIANT, "a(ssa(ss)s)", &var_iter);
  173. dbus_message_iter_open_container(&var_iter, DBUS_TYPE_ARRAY, "(ss(ss)s)", &arr_iter);
  174. r_ids.clear();
  175. for (int i = 0; i < p_options.size(); i++) {
  176. const Dictionary &item = p_options[i];
  177. if (!item.has("name") || !item.has("values") || !item.has("default")) {
  178. continue;
  179. }
  180. const String &name = item["name"];
  181. const Vector<String> &options = item["values"];
  182. int default_idx = item["default"];
  183. DBusMessageIter struct_iter;
  184. DBusMessageIter array_iter;
  185. DBusMessageIter array_struct_iter;
  186. dbus_message_iter_open_container(&arr_iter, DBUS_TYPE_STRUCT, nullptr, &struct_iter);
  187. append_dbus_string(&struct_iter, "option_" + itos(i)); // ID.
  188. append_dbus_string(&struct_iter, name); // User visible name.
  189. r_ids["option_" + itos(i)] = name;
  190. dbus_message_iter_open_container(&struct_iter, DBUS_TYPE_ARRAY, "(ss)", &array_iter);
  191. for (int j = 0; j < options.size(); j++) {
  192. dbus_message_iter_open_container(&array_iter, DBUS_TYPE_STRUCT, nullptr, &array_struct_iter);
  193. append_dbus_string(&array_struct_iter, itos(j));
  194. append_dbus_string(&array_struct_iter, options[j]);
  195. dbus_message_iter_close_container(&array_iter, &array_struct_iter);
  196. }
  197. dbus_message_iter_close_container(&struct_iter, &array_iter);
  198. if (options.is_empty()) {
  199. append_dbus_string(&struct_iter, (default_idx) ? "true" : "false"); // Default selection.
  200. } else {
  201. append_dbus_string(&struct_iter, itos(default_idx)); // Default selection.
  202. }
  203. dbus_message_iter_close_container(&arr_iter, &struct_iter);
  204. }
  205. dbus_message_iter_close_container(&var_iter, &arr_iter);
  206. dbus_message_iter_close_container(&dict_iter, &var_iter);
  207. dbus_message_iter_close_container(p_iter, &dict_iter);
  208. }
  209. 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) {
  210. DBusMessageIter dict_iter;
  211. DBusMessageIter var_iter;
  212. DBusMessageIter arr_iter;
  213. const char *filters_key = "filters";
  214. ERR_FAIL_COND(p_filter_names.size() != p_filter_exts.size());
  215. ERR_FAIL_COND(p_filter_names.size() != p_filter_mimes.size());
  216. dbus_message_iter_open_container(p_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &dict_iter);
  217. dbus_message_iter_append_basic(&dict_iter, DBUS_TYPE_STRING, &filters_key);
  218. dbus_message_iter_open_container(&dict_iter, DBUS_TYPE_VARIANT, "a(sa(us))", &var_iter);
  219. dbus_message_iter_open_container(&var_iter, DBUS_TYPE_ARRAY, "(sa(us))", &arr_iter);
  220. for (int i = 0; i < p_filter_names.size(); i++) {
  221. DBusMessageIter struct_iter;
  222. DBusMessageIter array_iter;
  223. DBusMessageIter array_struct_iter;
  224. dbus_message_iter_open_container(&arr_iter, DBUS_TYPE_STRUCT, nullptr, &struct_iter);
  225. append_dbus_string(&struct_iter, p_filter_names[i]);
  226. dbus_message_iter_open_container(&struct_iter, DBUS_TYPE_ARRAY, "(us)", &array_iter);
  227. const String &flt_orig = p_filter_exts[i];
  228. String flt;
  229. for (int j = 0; j < flt_orig.length(); j++) {
  230. if (is_unicode_letter(flt_orig[j])) {
  231. flt += vformat("[%c%c]", String::char_lowercase(flt_orig[j]), String::char_uppercase(flt_orig[j]));
  232. } else {
  233. flt += flt_orig[j];
  234. }
  235. }
  236. int filter_slice_count = flt.get_slice_count(",");
  237. for (int j = 0; j < filter_slice_count; j++) {
  238. dbus_message_iter_open_container(&array_iter, DBUS_TYPE_STRUCT, nullptr, &array_struct_iter);
  239. String str = (flt.get_slicec(',', j).strip_edges());
  240. {
  241. const unsigned flt_type = 0;
  242. dbus_message_iter_append_basic(&array_struct_iter, DBUS_TYPE_UINT32, &flt_type);
  243. }
  244. append_dbus_string(&array_struct_iter, str);
  245. dbus_message_iter_close_container(&array_iter, &array_struct_iter);
  246. }
  247. const String &mime = p_filter_mimes[i];
  248. filter_slice_count = mime.get_slice_count(",");
  249. for (int j = 0; j < filter_slice_count; j++) {
  250. dbus_message_iter_open_container(&array_iter, DBUS_TYPE_STRUCT, nullptr, &array_struct_iter);
  251. String str = mime.get_slicec(',', j).strip_edges();
  252. {
  253. const unsigned flt_type = 1;
  254. dbus_message_iter_append_basic(&array_struct_iter, DBUS_TYPE_UINT32, &flt_type);
  255. }
  256. append_dbus_string(&array_struct_iter, str);
  257. dbus_message_iter_close_container(&array_iter, &array_struct_iter);
  258. }
  259. dbus_message_iter_close_container(&struct_iter, &array_iter);
  260. dbus_message_iter_close_container(&arr_iter, &struct_iter);
  261. }
  262. dbus_message_iter_close_container(&var_iter, &arr_iter);
  263. dbus_message_iter_close_container(&dict_iter, &var_iter);
  264. dbus_message_iter_close_container(p_iter, &dict_iter);
  265. }
  266. void FreeDesktopPortalDesktop::append_dbus_dict_string(DBusMessageIter *p_iter, const String &p_key, const String &p_value, bool p_as_byte_array) {
  267. DBusMessageIter dict_iter;
  268. DBusMessageIter var_iter;
  269. dbus_message_iter_open_container(p_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &dict_iter);
  270. append_dbus_string(&dict_iter, p_key);
  271. if (p_as_byte_array) {
  272. DBusMessageIter arr_iter;
  273. dbus_message_iter_open_container(&dict_iter, DBUS_TYPE_VARIANT, "ay", &var_iter);
  274. dbus_message_iter_open_container(&var_iter, DBUS_TYPE_ARRAY, "y", &arr_iter);
  275. CharString cs = p_value.utf8();
  276. const char *cs_ptr = cs.get_data();
  277. do {
  278. dbus_message_iter_append_basic(&arr_iter, DBUS_TYPE_BYTE, cs_ptr);
  279. } while (*cs_ptr++);
  280. dbus_message_iter_close_container(&var_iter, &arr_iter);
  281. } else {
  282. dbus_message_iter_open_container(&dict_iter, DBUS_TYPE_VARIANT, "s", &var_iter);
  283. append_dbus_string(&var_iter, p_value);
  284. }
  285. dbus_message_iter_close_container(&dict_iter, &var_iter);
  286. dbus_message_iter_close_container(p_iter, &dict_iter);
  287. }
  288. void FreeDesktopPortalDesktop::append_dbus_dict_bool(DBusMessageIter *p_iter, const String &p_key, bool p_value) {
  289. DBusMessageIter dict_iter;
  290. DBusMessageIter var_iter;
  291. dbus_message_iter_open_container(p_iter, DBUS_TYPE_DICT_ENTRY, nullptr, &dict_iter);
  292. append_dbus_string(&dict_iter, p_key);
  293. dbus_message_iter_open_container(&dict_iter, DBUS_TYPE_VARIANT, "b", &var_iter);
  294. {
  295. int val = p_value;
  296. dbus_message_iter_append_basic(&var_iter, DBUS_TYPE_BOOLEAN, &val);
  297. }
  298. dbus_message_iter_close_container(&dict_iter, &var_iter);
  299. dbus_message_iter_close_container(p_iter, &dict_iter);
  300. }
  301. 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) {
  302. ERR_FAIL_COND_V(dbus_message_iter_get_arg_type(p_iter) != DBUS_TYPE_UINT32, false);
  303. dbus_uint32_t resp_code;
  304. dbus_message_iter_get_basic(p_iter, &resp_code);
  305. if (resp_code != 0) {
  306. r_cancel = true;
  307. } else {
  308. r_cancel = false;
  309. ERR_FAIL_COND_V(!dbus_message_iter_next(p_iter), false);
  310. ERR_FAIL_COND_V(dbus_message_iter_get_arg_type(p_iter) != DBUS_TYPE_ARRAY, false);
  311. DBusMessageIter dict_iter;
  312. dbus_message_iter_recurse(p_iter, &dict_iter);
  313. while (dbus_message_iter_get_arg_type(&dict_iter) == DBUS_TYPE_DICT_ENTRY) {
  314. DBusMessageIter iter;
  315. dbus_message_iter_recurse(&dict_iter, &iter);
  316. if (dbus_message_iter_get_arg_type(&iter) == DBUS_TYPE_STRING) {
  317. const char *key;
  318. dbus_message_iter_get_basic(&iter, &key);
  319. dbus_message_iter_next(&iter);
  320. DBusMessageIter var_iter;
  321. dbus_message_iter_recurse(&iter, &var_iter);
  322. if (strcmp(key, "current_filter") == 0) { // (sa(us))
  323. if (dbus_message_iter_get_arg_type(&var_iter) == DBUS_TYPE_STRUCT) {
  324. DBusMessageIter struct_iter;
  325. dbus_message_iter_recurse(&var_iter, &struct_iter);
  326. while (dbus_message_iter_get_arg_type(&struct_iter) == DBUS_TYPE_STRING) {
  327. const char *value;
  328. dbus_message_iter_get_basic(&struct_iter, &value);
  329. String name = String::utf8(value);
  330. r_index = p_names.find(name);
  331. if (!dbus_message_iter_next(&struct_iter)) {
  332. break;
  333. }
  334. }
  335. }
  336. } else if (strcmp(key, "choices") == 0) { // a(ss) {
  337. if (dbus_message_iter_get_arg_type(&var_iter) == DBUS_TYPE_ARRAY) {
  338. DBusMessageIter struct_iter;
  339. dbus_message_iter_recurse(&var_iter, &struct_iter);
  340. while (dbus_message_iter_get_arg_type(&struct_iter) == DBUS_TYPE_STRUCT) {
  341. DBusMessageIter opt_iter;
  342. dbus_message_iter_recurse(&struct_iter, &opt_iter);
  343. const char *opt_key = nullptr;
  344. dbus_message_iter_get_basic(&opt_iter, &opt_key);
  345. String opt_skey = String::utf8(opt_key);
  346. dbus_message_iter_next(&opt_iter);
  347. const char *opt_val = nullptr;
  348. dbus_message_iter_get_basic(&opt_iter, &opt_val);
  349. String opt_sval = String::utf8(opt_val);
  350. if (p_ids.has(opt_skey)) {
  351. opt_skey = p_ids[opt_skey];
  352. if (opt_sval == "true") {
  353. r_options[opt_skey] = true;
  354. } else if (opt_sval == "false") {
  355. r_options[opt_skey] = false;
  356. } else {
  357. r_options[opt_skey] = opt_sval.to_int();
  358. }
  359. }
  360. if (!dbus_message_iter_next(&struct_iter)) {
  361. break;
  362. }
  363. }
  364. }
  365. } else if (strcmp(key, "uris") == 0) { // as
  366. if (dbus_message_iter_get_arg_type(&var_iter) == DBUS_TYPE_ARRAY) {
  367. DBusMessageIter uri_iter;
  368. dbus_message_iter_recurse(&var_iter, &uri_iter);
  369. while (dbus_message_iter_get_arg_type(&uri_iter) == DBUS_TYPE_STRING) {
  370. const char *value;
  371. dbus_message_iter_get_basic(&uri_iter, &value);
  372. r_urls.push_back(String::utf8(value).trim_prefix("file://").uri_decode());
  373. if (!dbus_message_iter_next(&uri_iter)) {
  374. break;
  375. }
  376. }
  377. }
  378. }
  379. }
  380. if (!dbus_message_iter_next(&dict_iter)) {
  381. break;
  382. }
  383. }
  384. }
  385. return true;
  386. }
  387. bool FreeDesktopPortalDesktop::_is_interface_supported(const char *p_iface) {
  388. bool supported = false;
  389. DBusError err;
  390. dbus_error_init(&err);
  391. DBusConnection *bus = dbus_bus_get(DBUS_BUS_SESSION, &err);
  392. if (dbus_error_is_set(&err)) {
  393. dbus_error_free(&err);
  394. } else {
  395. DBusMessage *message = dbus_message_new_method_call(BUS_OBJECT_NAME, BUS_OBJECT_PATH, BUS_INTERFACE_PROPERTIES, "Get");
  396. if (message) {
  397. const char *name_space = p_iface;
  398. const char *key = "version";
  399. dbus_message_append_args(
  400. message,
  401. DBUS_TYPE_STRING, &name_space,
  402. DBUS_TYPE_STRING, &key,
  403. DBUS_TYPE_INVALID);
  404. DBusMessage *reply = dbus_connection_send_with_reply_and_block(bus, message, 250, &err);
  405. if (dbus_error_is_set(&err)) {
  406. dbus_error_free(&err);
  407. } else if (reply) {
  408. DBusMessageIter iter;
  409. if (dbus_message_iter_init(reply, &iter)) {
  410. DBusMessageIter iter_ver;
  411. dbus_message_iter_recurse(&iter, &iter_ver);
  412. dbus_uint32_t ver_code;
  413. dbus_message_iter_get_basic(&iter_ver, &ver_code);
  414. print_verbose(vformat("PortalDesktop: %s version %d detected.", p_iface, ver_code));
  415. supported = true;
  416. }
  417. dbus_message_unref(reply);
  418. }
  419. dbus_message_unref(message);
  420. }
  421. dbus_connection_unref(bus);
  422. }
  423. return supported;
  424. }
  425. bool FreeDesktopPortalDesktop::is_file_chooser_supported() {
  426. static int supported = -1;
  427. if (supported == -1) {
  428. supported = _is_interface_supported(BUS_INTERFACE_FILE_CHOOSER);
  429. }
  430. return supported;
  431. }
  432. bool FreeDesktopPortalDesktop::is_settings_supported() {
  433. static int supported = -1;
  434. if (supported == -1) {
  435. supported = _is_interface_supported(BUS_INTERFACE_SETTINGS);
  436. }
  437. return supported;
  438. }
  439. 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) {
  440. if (unsupported) {
  441. return FAILED;
  442. }
  443. ERR_FAIL_INDEX_V(int(p_mode), DisplayServer::FILE_DIALOG_MODE_SAVE_MAX, FAILED);
  444. ERR_FAIL_NULL_V(monitor_connection, FAILED);
  445. Vector<String> filter_names;
  446. Vector<String> filter_exts;
  447. Vector<String> filter_mimes;
  448. for (int i = 0; i < p_filters.size(); i++) {
  449. Vector<String> tokens = p_filters[i].split(";");
  450. if (tokens.size() >= 1) {
  451. String flt = tokens[0].strip_edges();
  452. String mime = (tokens.size() >= 2) ? tokens[2].strip_edges() : String();
  453. if (!flt.is_empty() || !mime.is_empty()) {
  454. if (tokens.size() >= 2) {
  455. if (flt == "*.*") {
  456. filter_exts.push_back("*");
  457. } else {
  458. filter_exts.push_back(flt);
  459. }
  460. filter_mimes.push_back(mime);
  461. filter_names.push_back(tokens[1]);
  462. } else {
  463. if (flt == "*.*") {
  464. filter_exts.push_back("*");
  465. filter_names.push_back(RTR("All Files") + " (*.*)");
  466. } else {
  467. filter_exts.push_back(flt);
  468. filter_names.push_back(flt);
  469. }
  470. filter_mimes.push_back(mime);
  471. }
  472. }
  473. }
  474. }
  475. if (filter_names.is_empty()) {
  476. filter_exts.push_back("*");
  477. filter_mimes.push_back("");
  478. filter_names.push_back(RTR("All Files") + " (*.*)");
  479. }
  480. DBusError err;
  481. dbus_error_init(&err);
  482. // Open connection and add signal handler.
  483. FileDialogData fd;
  484. fd.callback = p_callback;
  485. fd.prev_focus = p_window_id;
  486. fd.filter_names = filter_names;
  487. fd.opt_in_cb = p_options_in_cb;
  488. CryptoCore::RandomGenerator rng;
  489. ERR_FAIL_COND_V_MSG(rng.init(), FAILED, "Failed to initialize random number generator.");
  490. uint8_t uuid[64];
  491. Error rng_err = rng.get_random_bytes(uuid, 64);
  492. ERR_FAIL_COND_V_MSG(rng_err, rng_err, "Failed to generate unique token.");
  493. String dbus_unique_name = String::utf8(dbus_bus_get_unique_name(monitor_connection));
  494. String token = String::hex_encode_buffer(uuid, 64);
  495. String path = vformat("/org/freedesktop/portal/desktop/request/%s/%s", dbus_unique_name.replace(".", "_").remove_char(':'), token);
  496. fd.path = path;
  497. 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);
  498. dbus_bus_add_match(monitor_connection, fd.filter.utf8().get_data(), &err);
  499. if (dbus_error_is_set(&err)) {
  500. ERR_PRINT(vformat("Failed to add DBus match: %s", err.message));
  501. dbus_error_free(&err);
  502. return FAILED;
  503. }
  504. // Generate FileChooser message.
  505. const char *method = nullptr;
  506. if (p_mode == DisplayServer::FILE_DIALOG_MODE_SAVE_FILE) {
  507. method = "SaveFile";
  508. } else {
  509. method = "OpenFile";
  510. }
  511. DBusMessage *message = dbus_message_new_method_call(BUS_OBJECT_NAME, BUS_OBJECT_PATH, BUS_INTERFACE_FILE_CHOOSER, method);
  512. {
  513. DBusMessageIter iter;
  514. dbus_message_iter_init_append(message, &iter);
  515. append_dbus_string(&iter, p_xid);
  516. append_dbus_string(&iter, p_title);
  517. DBusMessageIter arr_iter;
  518. dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "{sv}", &arr_iter);
  519. append_dbus_dict_string(&arr_iter, "handle_token", token);
  520. append_dbus_dict_bool(&arr_iter, "multiple", p_mode == DisplayServer::FILE_DIALOG_MODE_OPEN_FILES);
  521. append_dbus_dict_bool(&arr_iter, "directory", p_mode == DisplayServer::FILE_DIALOG_MODE_OPEN_DIR);
  522. append_dbus_dict_filters(&arr_iter, filter_names, filter_exts, filter_mimes);
  523. append_dbus_dict_options(&arr_iter, p_options, fd.option_ids);
  524. append_dbus_dict_string(&arr_iter, "current_folder", p_current_directory, true);
  525. if (p_mode == DisplayServer::FILE_DIALOG_MODE_SAVE_FILE) {
  526. append_dbus_dict_string(&arr_iter, "current_name", p_filename);
  527. }
  528. dbus_message_iter_close_container(&iter, &arr_iter);
  529. }
  530. DBusMessage *reply = dbus_connection_send_with_reply_and_block(monitor_connection, message, DBUS_TIMEOUT_INFINITE, &err);
  531. dbus_message_unref(message);
  532. if (!reply || dbus_error_is_set(&err)) {
  533. ERR_PRINT(vformat("Failed to send DBus message: %s", err.message));
  534. dbus_error_free(&err);
  535. dbus_bus_remove_match(monitor_connection, fd.filter.utf8().get_data(), &err);
  536. return FAILED;
  537. }
  538. // Update signal path.
  539. {
  540. DBusMessageIter iter;
  541. if (dbus_message_iter_init(reply, &iter)) {
  542. if (dbus_message_iter_get_arg_type(&iter) == DBUS_TYPE_OBJECT_PATH) {
  543. const char *new_path = nullptr;
  544. dbus_message_iter_get_basic(&iter, &new_path);
  545. if (String::utf8(new_path) != path) {
  546. dbus_bus_remove_match(monitor_connection, fd.filter.utf8().get_data(), &err);
  547. if (dbus_error_is_set(&err)) {
  548. ERR_PRINT(vformat("Failed to remove DBus match: %s", err.message));
  549. dbus_error_free(&err);
  550. return FAILED;
  551. }
  552. fd.filter = String::utf8(new_path);
  553. dbus_bus_add_match(monitor_connection, fd.filter.utf8().get_data(), &err);
  554. if (dbus_error_is_set(&err)) {
  555. ERR_PRINT(vformat("Failed to add DBus match: %s", err.message));
  556. dbus_error_free(&err);
  557. return FAILED;
  558. }
  559. }
  560. }
  561. }
  562. }
  563. dbus_message_unref(reply);
  564. MutexLock lock(file_dialog_mutex);
  565. file_dialogs.push_back(fd);
  566. return OK;
  567. }
  568. void FreeDesktopPortalDesktop::process_file_dialog_callbacks() {
  569. MutexLock lock(file_dialog_mutex);
  570. while (!pending_cbs.is_empty()) {
  571. FileDialogCallback cb = pending_cbs.front()->get();
  572. pending_cbs.pop_front();
  573. if (cb.opt_in_cb) {
  574. Variant ret;
  575. Callable::CallError ce;
  576. const Variant *args[4] = { &cb.status, &cb.files, &cb.index, &cb.options };
  577. cb.callback.callp(args, 4, ret, ce);
  578. if (ce.error != Callable::CallError::CALL_OK) {
  579. ERR_PRINT(vformat("Failed to execute file dialog callback: %s.", Variant::get_callable_error_text(cb.callback, args, 4, ce)));
  580. }
  581. } else {
  582. Variant ret;
  583. Callable::CallError ce;
  584. const Variant *args[3] = { &cb.status, &cb.files, &cb.index };
  585. cb.callback.callp(args, 3, ret, ce);
  586. if (ce.error != Callable::CallError::CALL_OK) {
  587. ERR_PRINT(vformat("Failed to execute file dialog callback: %s.", Variant::get_callable_error_text(cb.callback, args, 3, ce)));
  588. }
  589. }
  590. }
  591. }
  592. void FreeDesktopPortalDesktop::_thread_monitor(void *p_ud) {
  593. FreeDesktopPortalDesktop *portal = (FreeDesktopPortalDesktop *)p_ud;
  594. while (!portal->monitor_thread_abort.is_set()) {
  595. if (portal->monitor_connection) {
  596. while (true) {
  597. DBusMessage *msg = dbus_connection_pop_message(portal->monitor_connection);
  598. if (!msg) {
  599. break;
  600. } else if (dbus_message_is_signal(msg, "org.freedesktop.portal.Settings", "SettingChanged")) {
  601. DBusMessageIter iter;
  602. if (dbus_message_iter_init(msg, &iter)) {
  603. const char *value;
  604. dbus_message_iter_get_basic(&iter, &value);
  605. String name_space = String::utf8(value);
  606. dbus_message_iter_next(&iter);
  607. dbus_message_iter_get_basic(&iter, &value);
  608. String key = String::utf8(value);
  609. if (name_space == "org.freedesktop.appearance" && (key == "color-scheme" || key == "accent-color")) {
  610. callable_mp(portal, &FreeDesktopPortalDesktop::_system_theme_changed_callback).call_deferred();
  611. }
  612. }
  613. } else if (dbus_message_is_signal(msg, "org.freedesktop.portal.Request", "Response")) {
  614. String path = String::utf8(dbus_message_get_path(msg));
  615. MutexLock lock(portal->file_dialog_mutex);
  616. for (int i = 0; i < portal->file_dialogs.size(); i++) {
  617. FreeDesktopPortalDesktop::FileDialogData &fd = portal->file_dialogs.write[i];
  618. if (fd.path == path) {
  619. DBusMessageIter iter;
  620. if (dbus_message_iter_init(msg, &iter)) {
  621. bool cancel = false;
  622. Vector<String> uris;
  623. Dictionary options;
  624. int index = 0;
  625. file_chooser_parse_response(&iter, fd.filter_names, fd.option_ids, cancel, uris, index, options);
  626. if (fd.callback.is_valid()) {
  627. FileDialogCallback cb;
  628. cb.callback = fd.callback;
  629. cb.status = !cancel;
  630. cb.files = uris;
  631. cb.index = index;
  632. cb.options = options;
  633. cb.opt_in_cb = fd.opt_in_cb;
  634. portal->pending_cbs.push_back(cb);
  635. }
  636. if (fd.prev_focus != DisplayServer::INVALID_WINDOW_ID) {
  637. callable_mp(DisplayServer::get_singleton(), &DisplayServer::window_move_to_foreground).call_deferred(fd.prev_focus);
  638. }
  639. }
  640. DBusError err;
  641. dbus_error_init(&err);
  642. dbus_bus_remove_match(portal->monitor_connection, fd.filter.utf8().get_data(), &err);
  643. dbus_error_free(&err);
  644. portal->file_dialogs.remove_at(i);
  645. break;
  646. }
  647. }
  648. }
  649. dbus_message_unref(msg);
  650. }
  651. dbus_connection_read_write(portal->monitor_connection, 0);
  652. }
  653. OS::get_singleton()->delay_usec(50'000);
  654. }
  655. }
  656. void FreeDesktopPortalDesktop::_system_theme_changed_callback() {
  657. if (system_theme_changed.is_valid()) {
  658. Variant ret;
  659. Callable::CallError ce;
  660. system_theme_changed.callp(nullptr, 0, ret, ce);
  661. if (ce.error != Callable::CallError::CALL_OK) {
  662. ERR_PRINT(vformat("Failed to execute system theme changed callback: %s.", Variant::get_callable_error_text(system_theme_changed, nullptr, 0, ce)));
  663. }
  664. }
  665. }
  666. FreeDesktopPortalDesktop::FreeDesktopPortalDesktop() {
  667. #ifdef SOWRAP_ENABLED
  668. #ifdef DEBUG_ENABLED
  669. int dylibloader_verbose = 1;
  670. #else
  671. int dylibloader_verbose = 0;
  672. #endif
  673. unsupported = (initialize_dbus(dylibloader_verbose) != 0);
  674. #else
  675. unsupported = false;
  676. #endif
  677. if (unsupported) {
  678. return;
  679. }
  680. bool ver_ok = false;
  681. int version_major = 0;
  682. int version_minor = 0;
  683. int version_rev = 0;
  684. dbus_get_version(&version_major, &version_minor, &version_rev);
  685. ver_ok = (version_major == 1 && version_minor >= 10) || (version_major > 1); // 1.10.0
  686. print_verbose(vformat("PortalDesktop: DBus %d.%d.%d detected.", version_major, version_minor, version_rev));
  687. if (!ver_ok) {
  688. print_verbose("PortalDesktop: Unsupported DBus library version!");
  689. unsupported = true;
  690. }
  691. DBusError err;
  692. dbus_error_init(&err);
  693. monitor_connection = dbus_bus_get(DBUS_BUS_SESSION, &err);
  694. if (dbus_error_is_set(&err)) {
  695. dbus_error_free(&err);
  696. } else {
  697. theme_path = "type='signal',sender='org.freedesktop.portal.Desktop',interface='org.freedesktop.portal.Settings',member='SettingChanged'";
  698. dbus_bus_add_match(monitor_connection, theme_path.utf8().get_data(), &err);
  699. if (dbus_error_is_set(&err)) {
  700. dbus_error_free(&err);
  701. dbus_connection_unref(monitor_connection);
  702. monitor_connection = nullptr;
  703. }
  704. dbus_connection_read_write(monitor_connection, 0);
  705. }
  706. if (!unsupported) {
  707. monitor_thread_abort.clear();
  708. monitor_thread.start(FreeDesktopPortalDesktop::_thread_monitor, this);
  709. }
  710. }
  711. FreeDesktopPortalDesktop::~FreeDesktopPortalDesktop() {
  712. monitor_thread_abort.set();
  713. if (monitor_thread.is_started()) {
  714. monitor_thread.wait_to_finish();
  715. }
  716. if (monitor_connection) {
  717. DBusError err;
  718. for (FreeDesktopPortalDesktop::FileDialogData &fd : file_dialogs) {
  719. dbus_error_init(&err);
  720. dbus_bus_remove_match(monitor_connection, fd.filter.utf8().get_data(), &err);
  721. dbus_error_free(&err);
  722. }
  723. dbus_error_init(&err);
  724. dbus_bus_remove_match(monitor_connection, theme_path.utf8().get_data(), &err);
  725. dbus_error_free(&err);
  726. dbus_connection_unref(monitor_connection);
  727. }
  728. }
  729. #endif // DBUS_ENABLED