36 #include "gnc-prefs-p.h" 38 #include <boost/property_tree/ptree.hpp> 39 #include <boost/property_tree/xml_parser.hpp> 42 #include <unordered_map> 44 namespace bpt = boost::property_tree;
46 #define GSET_SCHEMA_PREFIX "org.gnucash.GnuCash" 47 #define GSET_SCHEMA_OLD_PREFIX "org.gnucash" 51 void operator()(GSettings* gsp)
59 using GSettingsPtr = std::unique_ptr<GSettings, GSettingsDeleter>;
61 static std::unordered_map<std::string,GSettingsPtr> schema_hash;
64 static QofLogModule log_module =
"gnc.app-utils.gsettings";
69 static bool gnc_gsettings_is_valid_key(GSettings *settings,
const gchar *key)
72 if (!G_IS_SETTINGS(settings))
75 GSettingsSchema *schema;
76 g_object_get (settings,
"settings-schema", &schema,
nullptr);
80 auto keys = g_settings_schema_list_keys (schema);
81 auto found = (keys && g_strv_contains(keys, key));
83 g_settings_schema_unref (schema);
89 normalize_schema_name (
const gchar *name)
92 return GSET_SCHEMA_PREFIX;
94 if (g_str_has_prefix (name, GSET_SCHEMA_PREFIX) ||
95 (g_str_has_prefix (name, GSET_SCHEMA_OLD_PREFIX)))
98 return std::string{GSET_SCHEMA_PREFIX} +
'.' + name;
101 static GSettings * gnc_gsettings_get_settings_obj (
const gchar *schema_str)
105 auto full_name_str = normalize_schema_name (schema_str);
106 auto full_name = full_name_str.c_str();
107 auto schema_source {g_settings_schema_source_get_default()};
108 auto schema {g_settings_schema_source_lookup(schema_source, full_name,
true)};
109 auto gset = g_settings_new_full (schema,
nullptr,
nullptr);
110 DEBUG (
"Created gsettings object %p for schema %s", gset, full_name);
112 if (!G_IS_SETTINGS(gset))
113 PWARN (
"Ignoring attempt to access unknown gsettings schema %s", full_name);
116 g_settings_schema_unref (schema);
121 schema_to_gsettings (
const char *schema,
bool can_retrieve)
123 auto full_name = normalize_schema_name (schema);
124 auto iter = schema_hash.find (full_name);
125 if (iter != schema_hash.end())
126 return iter->second.get();
131 auto gs_obj = gnc_gsettings_get_settings_obj (schema);
132 if (!G_IS_SETTINGS (gs_obj))
134 PWARN (
"Ignoring attempt to access unknown gsettings schema %s", full_name.c_str());
138 schema_hash[full_name] = GSettingsPtr (gs_obj, g_settings_deleter);
149 return GSET_SCHEMA_PREFIX;
162 g_return_val_if_fail (func, 0);
164 auto gs_obj = schema_to_gsettings (schema,
true);
165 g_return_val_if_fail (G_IS_SETTINGS (gs_obj), 0);
167 auto signal =
static_cast<char *
> (
nullptr);
169 signal = g_strdup (
"changed");
170 else if (gnc_gsettings_is_valid_key(gs_obj, key))
171 signal = g_strconcat (
"changed::", key,
nullptr);
173 auto handlerid = g_signal_connect (gs_obj, signal, G_CALLBACK (func), user_data);
176 g_object_ref (gs_obj);
178 PINFO(
"schema: %s, key: %s, gs_obj: %p, handler_id: %ld",
179 schema, key, gs_obj, handlerid);
189 gnc_gsettings_remove_cb_by_id_internal (GSettings *gs_obj, guint handlerid)
192 g_return_if_fail (G_IS_SETTINGS (gs_obj));
194 g_signal_handler_disconnect (gs_obj, handlerid);
195 g_object_unref (gs_obj);
197 LEAVE (
"Schema: %p, handlerid: %d - removed for handler",
204 gpointer func, gpointer user_data)
207 g_return_if_fail (func);
209 auto gs_obj = schema_to_gsettings (schema,
false);
211 if (!G_IS_SETTINGS (gs_obj))
213 LEAVE (
"No valid GSettings object retrieved from hash table");
217 auto match_type =
static_cast<GSignalMatchType
> (G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA);
218 auto changed_signal = g_signal_lookup (
"changed", G_TYPE_SETTINGS);
219 auto quark = g_quark_from_string (key);
222 guint handler_id = 0;
225 handler_id = g_signal_handler_find (gs_obj, match_type,
226 changed_signal, quark,
nullptr,
231 gnc_gsettings_remove_cb_by_id_internal (gs_obj, handler_id);
234 if (!G_IS_SETTINGS (gs_obj))
237 }
while (handler_id);
239 LEAVE (
"Schema: %s, key: %s - removed %d handlers for 'changed' signal",
240 schema, key, matched);
249 auto gs_obj = schema_to_gsettings (schema,
false);
251 if (!G_IS_SETTINGS (gs_obj))
253 LEAVE (
"No valid GSettings object retrieved from hash table");
257 gnc_gsettings_remove_cb_by_id_internal (gs_obj, handlerid);
259 LEAVE (
"Schema: %p, handlerid: %d - removed for handler",
285 const gchar *property)
287 auto gs_obj = gnc_gsettings_get_settings_obj (schema);
288 g_return_if_fail (G_IS_SETTINGS (gs_obj));
290 if (gnc_gsettings_is_valid_key (gs_obj, key))
291 g_settings_bind (gs_obj, key,
object, property, G_SETTINGS_BIND_DEFAULT);
293 PERR (
"Invalid key %s for schema %s", key, schema);
298 gs_obj_block_handlers ([[maybe_unused]] gpointer key, gpointer gs_obj,
299 [[maybe_unused]] gpointer pointer)
301 g_signal_handlers_block_matched (gs_obj, G_SIGNAL_MATCH_CLOSURE, 0, 0,
nullptr,
nullptr,
nullptr);
302 PINFO(
"Block all handlers for GSettings object %p", gs_obj);
306 gs_obj_unblock_handlers ([[maybe_unused]] gpointer key, gpointer gs_obj,
307 [[maybe_unused]] gpointer pointer)
309 g_signal_handlers_unblock_matched (gs_obj, G_SIGNAL_MATCH_CLOSURE, 0, 0,
nullptr,
nullptr,
nullptr);
310 PINFO(
"Unblock all handlers for GSettings object %p", gs_obj);
316 for (
const auto& it : schema_hash)
317 gs_obj_block_handlers (
nullptr, it.second.get(),
nullptr);
325 for (
const auto& it : schema_hash)
326 gs_obj_unblock_handlers (
nullptr, it.second.get(),
nullptr);
335 T gnc_gsettings_get(
const char *schema,
const char *key,
336 auto getter(GSettings*,
const char *)->T, T default_val)
338 auto gs_obj = gnc_gsettings_get_settings_obj (schema);
339 g_return_val_if_fail (G_IS_SETTINGS (gs_obj), default_val);
342 if (gnc_gsettings_is_valid_key (gs_obj, key))
343 val = getter (gs_obj, key);
345 PERR (
"Invalid key %s for schema %s", key, schema);
347 g_object_unref (gs_obj);
354 return gnc_gsettings_get (schema, key, g_settings_get_boolean,
355 static_cast<gboolean>(
false));
361 return gnc_gsettings_get (schema, key, g_settings_get_int, 0);
367 return gnc_gsettings_get (schema, key, g_settings_get_double, 0.0);
373 return gnc_gsettings_get (schema, key, g_settings_get_string,
374 static_cast<gchar *> (
nullptr));
380 return gnc_gsettings_get (schema, key, g_settings_get_enum, 0);
386 return gnc_gsettings_get (schema, key, g_settings_get_value,
387 static_cast<GVariant *> (
nullptr));
393 template<
typename T> gboolean
394 gnc_gsettings_set (
const gchar *schema,
397 gboolean setter(GSettings*,
const char *, T))
399 ENTER(
"schema: %s, key: %s", schema, key);
401 auto gs_obj = gnc_gsettings_get_settings_obj (schema);
402 g_return_val_if_fail (G_IS_SETTINGS (gs_obj),
false);
405 if (gnc_gsettings_is_valid_key (gs_obj, key))
407 result = setter (gs_obj, key, value);
409 PERR (
"Unable to set value for key %s in schema %s", key, schema);
412 PERR (
"Invalid key %s for schema %s", key, schema);
414 g_object_unref (gs_obj);
415 LEAVE(
"result %i", result);
422 return gnc_gsettings_set (schema, key, value, g_settings_set_boolean);
428 return gnc_gsettings_set (schema, key, value, g_settings_set_int);
434 return gnc_gsettings_set (schema, key, value, g_settings_set_double);
440 return gnc_gsettings_set (schema, key, value, g_settings_set_string);
446 return gnc_gsettings_set (schema, key, value, g_settings_set_enum);
452 return gnc_gsettings_set (schema, key, value, g_settings_set_value);
459 auto gs_obj = gnc_gsettings_get_settings_obj (schema);
460 g_return_if_fail (G_IS_SETTINGS (gs_obj));
462 if (gnc_gsettings_is_valid_key (gs_obj, key))
463 g_settings_reset (gs_obj, key);
465 PERR (
"Invalid key %s for schema %s", key, schema);
467 g_object_unref (gs_obj);
473 auto gs_obj = gnc_gsettings_get_settings_obj (schema_str);
478 GSettingsSchema *schema;
479 g_object_get (gs_obj,
"settings-schema", &schema,
nullptr);
482 g_object_unref (gs_obj);
486 auto keys = g_settings_schema_list_keys (schema);
490 for (
auto key = *fkeys; key; key = *++fkeys)
494 g_object_unref (gs_obj);
495 g_settings_schema_unref (schema);
500 gnc_settings_dump_schema_paths (
void)
502 gchar **non_relocatable;
504 auto schema_source {g_settings_schema_source_get_default()};
505 g_settings_schema_source_list_schemas (schema_source,
true,
506 &non_relocatable,
nullptr);
508 for (gint i = 0; non_relocatable[i] !=
nullptr; i++)
509 PINFO(
"Schema entry %d is '%s'", i, non_relocatable[i]);
511 g_strfreev (non_relocatable);
522 if (g_strcmp0 (g_getenv (
"GNC_UNINSTALLED"),
"1") == 0)
525 g_free (prefsbackend);
552 gnc_settings_dump_schema_paths ();
558 LEAVE(
"Prefsbackend bind = %p", prefsbackend->bind);
565 g_free (prefsbackend);
570 gnc_gsettings_get_user_value (
const gchar *schema,
573 auto gs_obj = gnc_gsettings_get_settings_obj (schema);
574 g_return_val_if_fail (G_IS_SETTINGS (gs_obj),
nullptr);
576 auto val =
static_cast<GVariant *
> (
nullptr);
577 if (gnc_gsettings_is_valid_key (gs_obj, key))
578 val = g_settings_get_user_value (gs_obj, key);
580 PERR (
"Invalid key %s for schema %s", key, schema);
582 g_object_unref (gs_obj);
586 using opt_str_vec = boost::optional<std::string>;
589 deprecate_one_key (
const opt_str_vec &oldpath,
const opt_str_vec &oldkey)
591 if (!oldpath || !oldkey )
593 DEBUG (
"Skipping <deprecate> node - missing attribute (old-path or old-key)");
597 PINFO (
"'%s:%s' has been marked deprecated", oldpath->c_str(), oldkey->c_str());
603 migrate_one_key (
const opt_str_vec &oldpath,
const opt_str_vec &oldkey,
604 const opt_str_vec &newpath,
const opt_str_vec &newkey)
606 if (!oldpath || !oldkey || !newpath || !newkey)
608 DEBUG (
"Skipping <migrate> node - missing attribute (old-path, old-key, new-path or new-key)");
612 PINFO (
"Migrating '%s:%s' to '%s:%s'", oldpath->c_str(), oldkey->c_str(),
613 newpath->c_str(), newkey->c_str());
615 auto user_value = gnc_gsettings_get_user_value (oldpath->c_str(), oldkey->c_str());
621 obsolete_one_key (
const opt_str_vec &oldpath,
const opt_str_vec &oldkey)
623 if (!oldpath || !oldkey )
625 DEBUG (
"Skipping <obsolete> node - missing attribute (old-path or old-key)");
629 PINFO (
"Resetting obsolete '%s:%s'", oldpath->c_str(), oldkey->c_str());
634 parse_one_release_node (bpt::ptree &pt)
637 std::for_each (pt.begin(), pt.end(),
638 [] (std::pair<bpt::ptree::key_type, bpt::ptree> node)
640 if (node.first ==
"<xmlattr>")
642 else if (node.first ==
"deprecate")
643 deprecate_one_key (node.second.get_optional<std::string> (
"<xmlattr>.old-path"),
644 node.second.get_optional<std::string> (
"<xmlattr>.old-key"));
645 else if (node.first ==
"migrate")
646 migrate_one_key (node.second.get_optional<std::string> (
"<xmlattr>.old-path"),
647 node.second.get_optional<std::string> (
"<xmlattr>.old-key"),
648 node.second.get_optional<std::string> (
"<xmlattr>.new-path"),
649 node.second.get_optional<std::string> (
"<xmlattr>.new-key"));
650 else if (node.first ==
"obsolete")
651 obsolete_one_key (node.second.get_optional<std::string> (
"<xmlattr>.old-path"),
652 node.second.get_optional<std::string> (
"<xmlattr>.old-key"));
655 DEBUG (
"Skipping unknown node <%s>", node.first.c_str());
662 transform_settings (
int old_maj_min,
int cur_maj_min)
666 auto pkg_data_dir = gnc_path_get_pkgdatadir();
667 auto transform_file = std::string (pkg_data_dir) +
"/pref_transformations.xml";
668 g_free (pkg_data_dir);
670 std::ifstream transform_stream {transform_file};
671 if (!transform_stream.is_open())
673 PWARN(
"Failed to load preferences transformation file '%s'", transform_file.c_str());
679 bpt::read_xml (transform_stream, pt);
681 catch (bpt::xml_parser_error &e) {
682 PWARN (
"Failed to parse GnuCash preferences transformation file.\n");
683 PWARN (
"Error message:\n");
684 PWARN (
"%s\n", e.what());
688 PWARN (
"Unknown error while parsing GnuCash preferences transformation file.\n");
693 std::for_each (pt.begin(), pt.end(),
694 [&old_maj_min, &cur_maj_min] (std::pair<bpt::ptree::key_type, bpt::ptree> node)
696 if (node.first !=
"release")
698 DEBUG (
"Skipping non-<release> node <%s>", node.first.c_str());
701 auto version = node.second.get_optional<
int> (
"<xmlattr>.version");
704 DEBUG (
"Skipping <release> node - no version attribute found");
707 if (*version <= old_maj_min)
709 DEBUG (
"Skipping <release> node - version %i is less than current compatibility level %i", *version, old_maj_min);
712 if (*version > cur_maj_min)
714 DEBUG (
"Skipping <release> node - version %i is greater than current version level %i", *version, cur_maj_min);
717 DEBUG (
"Retrieved version value '%i'", *version);
719 parse_one_release_node (node.second);
748 ENTER(
"Start of settings transform routine.");
750 auto ogG_maj_min = gnc_gsettings_get_user_value (GNC_PREFS_GROUP_GENERAL, GNC_PREF_VERSION);
751 auto og_maj_min = gnc_gsettings_get_user_value (GSET_SCHEMA_OLD_PREFIX
"." GNC_PREFS_GROUP_GENERAL, GNC_PREF_VERSION);
753 auto cur_maj_min = PROJECT_VERSION_MAJOR * 1000 + PROJECT_VERSION_MINOR;
755 if (!ogG_maj_min && !og_maj_min)
758 LEAVE (
"Setting Previous compatibility level to current version: %i", cur_maj_min);
762 auto old_maj_min = 0;
764 old_maj_min =
gnc_gsettings_get_int (GSET_SCHEMA_OLD_PREFIX
"." GNC_PREFS_GROUP_GENERAL, GNC_PREF_VERSION);
767 g_variant_unref (ogG_maj_min);
771 g_variant_unref (og_maj_min);
773 PINFO (
"Previous setting compatibility level: %i, Current version: %i", old_maj_min, cur_maj_min);
775 transform_settings (old_maj_min, cur_maj_min);
778 if (cur_maj_min > old_maj_min)
gboolean gnc_gsettings_set_int(const gchar *schema, const gchar *key, gint value)
Store an integer value into GSettings.
gboolean gnc_gsettings_set_float(const gchar *schema, const gchar *key, gdouble value)
Store a float value into GSettings.
#define PINFO(format, args...)
Print an informational note.
gint gnc_gsettings_get_int(const gchar *schema, const gchar *key)
Get an integer value from GSettings.
#define DEBUG(format, args...)
Print a debugging message.
void gnc_gsettings_bind(const gchar *schema, const gchar *key, gpointer object, const gchar *property)
Bind a setting to a g_object property.
#define PERR(format, args...)
Log a serious error.
#define ENTER(format, args...)
Print a function entry debugging message.
void gnc_gsettings_remove_any_cb_by_func(const gchar *schema, gpointer func, gpointer user_data)
Remove a function that was registered for a callback when any key in the given settings schema change...
gboolean gnc_gsettings_set_enum(const gchar *schema, const gchar *key, gint value)
Store an enum value into GSettings.
#define PWARN(format, args...)
Log a warning.
gboolean qof_log_check(QofLogModule domain, QofLogLevel level)
Check to see if the given log_module is configured to log at the given log_level. ...
GVariant * gnc_gsettings_get_value(const gchar *schema, const gchar *key)
Get an arbitrary combination of values from GSettings.
guint gnc_gsettings_register_any_cb(const gchar *schema, gpointer func, gpointer user_data)
Register a callback for when any key in the settings schema is changed.
void gnc_gsettings_unblock_all(void)
UnBlock all prefs callbacks, used while preference dialog is loaded.
void gnc_gsettings_reset_schema(const gchar *schema_str)
Reset all keys in a schema to their default values in GSettings.
void gnc_gsettings_shutdown(void)
Free the GSettings resources.
gdouble gnc_gsettings_get_float(const gchar *schema, const gchar *key)
Get an float value from GSettings.
void gnc_gsettings_reset(const gchar *schema, const gchar *key)
Reset a key to its default value in GSettings.
gchar * gnc_gsettings_get_string(const gchar *schema, const gchar *key)
Get a string value from GSettings.
gint gnc_gsettings_get_enum(const gchar *schema, const gchar *key)
Get an enum value from GSettings.
gboolean gnc_gsettings_set_bool(const gchar *schema, const gchar *key, gboolean value)
Store a boolean value into GSettings.
void gnc_gsettings_load_backend(void)
Configure gsettings as the backend for the gnucash preferences api.
void gnc_gsettings_version_upgrade(void)
Check whether we need to adjust the user settings to a newer version.
void gnc_gsettings_block_all(void)
Block all prefs callbacks, used while preference dialog is loaded.
#define LEAVE(format, args...)
Print a function exit debugging message.
gboolean gnc_gsettings_get_bool(const gchar *schema, const gchar *key)
Get a boolean value from GSettings.
const gchar * gnc_gsettings_get_prefix(void)
Get the default gsettings schema prefix.
void gnc_gsettings_remove_cb_by_id(const gchar *schema, guint handlerid)
Remove a function that was registered for a callback when a specific key in the settings schema chang...
gboolean gnc_gsettings_set_value(const gchar *schema, const gchar *key, GVariant *value)
Store an arbitrary combination of values into GSettings.
gulong gnc_gsettings_register_cb(const char *schema, const gchar *key, gpointer func, gpointer user_data)
Register a callback for when a specific key in the settings schema is changed.
GSettings helper routines.
gboolean gnc_gsettings_set_string(const gchar *schema, const gchar *key, const gchar *value)
Store a string into GSettings.
void gnc_gsettings_remove_cb_by_func(const gchar *schema, const gchar *key, gpointer func, gpointer user_data)
Remove a function that was registered for a callback when a specific key in the settings schema chang...