[rygel] core: Add config file monitoring to UserConfig.
- From: Jens Georg <jensgeorg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [rygel] core: Add config file monitoring to UserConfig.
- Date: Wed, 26 Sep 2012 18:00:35 +0000 (UTC)
commit ccbf40f116052efd7121807b590de3b08a3df29a
Author: Krzesimir Nowak <krnowak openismus com>
Date: Tue Sep 18 12:59:08 2012 +0200
core: Add config file monitoring to UserConfig.
There are two monitors actually - one for system config and one for
local config. RygelUserConfig emit changes signals only when actual
gotten value is different. For example if local config has a setting
for interface and a change of interface value happens in system
config, then signal is not emitted - local config has precendence over
system config.
src/rygel/rygel-user-config.vala | 539 +++++++++++++++++++++++++++++++++++---
1 files changed, 504 insertions(+), 35 deletions(-)
---
diff --git a/src/rygel/rygel-user-config.vala b/src/rygel/rygel-user-config.vala
index a77bc67..672afe9 100644
--- a/src/rygel/rygel-user-config.vala
+++ b/src/rygel/rygel-user-config.vala
@@ -1,9 +1,11 @@
/*
* Copyright (C) 2008,2009 Nokia Corporation.
* Copyright (C) 2008,2009 Zeeshan Ali (Khattak) <zeeshanak gnome org>.
+ * Copyright (C) 2012 Intel Corporation
*
* Author: Zeeshan Ali (Khattak) <zeeshanak gnome org>
* <zeeshan ali nokia com>
+ * Krzesimir Nowak <krnowak openismus com>
*
* This file is part of Rygel.
*
@@ -22,6 +24,13 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
+using Gee;
+
+private enum Rygel.EntryType {
+ STRING,
+ BOOL,
+ INT
+}
/**
* Manages the user configuration for Rygel.
@@ -56,8 +65,92 @@ public class Rygel.UserConfig : GLib.Object, Configuration {
// Our singleton
private static UserConfig config;
+ private class ConfigPair {
+ public ConfigurationEntry entry;
+ public EntryType type;
+
+ public ConfigPair (ConfigurationEntry entry,
+ EntryType type) {
+ this.entry = entry;
+ this.type = type;
+ }
+ }
+
+ private class SectionPair {
+ public SectionEntry entry;
+ public EntryType type;
+
+ public SectionPair (SectionEntry entry,
+ EntryType type) {
+ this.entry = entry;
+ this.type = type;
+ }
+ }
+
+ private static HashMap<string, HashMap<string, ConfigPair> > config_keys;
+ private static HashMap<string, SectionPair> section_keys;
+
protected KeyFile key_file;
protected KeyFile sys_key_file;
+ protected FileMonitor key_file_monitor;
+ protected FileMonitor sys_key_file_monitor;
+
+ static construct {
+ var general_config_keys = new HashMap<string, ConfigPair> ();
+
+ UserConfig.config_keys =
+ new HashMap<string, HashMap<string, ConfigPair> > ();
+ UserConfig.section_keys = new HashMap<string, SectionPair> ();
+
+ general_config_keys.set (IFACE_KEY,
+ new ConfigPair (ConfigurationEntry.INTERFACE,
+ EntryType.STRING));
+ general_config_keys.set (PORT_KEY,
+ new ConfigPair (ConfigurationEntry.PORT,
+ EntryType.INT));
+ general_config_keys.set (UPNP_ENABLED_KEY,
+ new ConfigPair
+ (ConfigurationEntry.UPNP_ENABLED,
+ EntryType.BOOL));
+ general_config_keys.set (TRANSCODING_KEY,
+ new ConfigPair (ConfigurationEntry.TRANSCODING,
+ EntryType.BOOL));
+ general_config_keys.set (ALLOW_UPLOAD_KEY,
+ new ConfigPair
+ (ConfigurationEntry.ALLOW_UPLOAD,
+ EntryType.BOOL));
+ general_config_keys.set (ALLOW_DELETION_KEY,
+ new ConfigPair
+ (ConfigurationEntry.ALLOW_DELETION,
+ EntryType.BOOL));
+ general_config_keys.set (LOG_LEVELS_KEY,
+ new ConfigPair (ConfigurationEntry.LOG_LEVELS,
+ EntryType.STRING));
+ general_config_keys.set (PLUGIN_PATH_KEY,
+ new ConfigPair (ConfigurationEntry.PLUGIN_PATH,
+ EntryType.STRING));
+ general_config_keys.set (VIDEO_UPLOAD_DIR_PATH_KEY,
+ new ConfigPair
+ (ConfigurationEntry.VIDEO_UPLOAD_FOLDER,
+ EntryType.STRING));
+ general_config_keys.set (MUSIC_UPLOAD_DIR_PATH_KEY,
+ new ConfigPair
+ (ConfigurationEntry.MUSIC_UPLOAD_FOLDER,
+ EntryType.STRING));
+ general_config_keys.set (PICTURE_UPLOAD_DIR_PATH_KEY,
+ new ConfigPair
+ (ConfigurationEntry.PICTURE_UPLOAD_FOLDER,
+ EntryType.STRING));
+
+ UserConfig.config_keys.set (GENERAL_SECTION, general_config_keys);
+
+ section_keys.set (ENABLED_KEY,
+ new SectionPair (SectionEntry.ENABLED,
+ EntryType.BOOL));
+ section_keys.set (TITLE_KEY,
+ new SectionPair (SectionEntry.TITLE,
+ EntryType.STRING));
+ }
public bool get_upnp_enabled () throws GLib.Error {
return this.get_bool (GENERAL_SECTION, UPNP_ENABLED_KEY);
@@ -150,6 +243,14 @@ public class Rygel.UserConfig : GLib.Object, Configuration {
KeyFileFlags.KEEP_TRANSLATIONS);
debug ("Loaded system configuration from file '%s'", path);
+ var sys_key_g_file = File.new_for_path (path);
+ this.sys_key_file_monitor = sys_key_g_file.monitor_file
+ (FileMonitorFlags.NONE,
+ null);
+
+ this.sys_key_file_monitor.changed.connect
+ (this.on_system_config_changed);
+
try {
this.key_file.load_from_file (file,
KeyFileFlags.KEEP_COMMENTS |
@@ -160,14 +261,14 @@ public class Rygel.UserConfig : GLib.Object, Configuration {
debug ("Failed to load user configuration from file '%s': %s",
file,
error.message);
- size_t size;
-
- var data = this.sys_key_file.to_data (out size);
- this.key_file.load_from_data (data,
- size,
- KeyFileFlags.KEEP_COMMENTS |
- KeyFileFlags.KEEP_TRANSLATIONS);
+ this.key_file = new KeyFile ();
}
+
+ var key_g_file = File.new_for_path (file);
+
+ this.key_file_monitor = key_g_file.monitor_file (FileMonitorFlags.NONE,
+ null);
+ this.key_file_monitor.changed.connect (this.on_local_config_changed);
}
public bool get_enabled (string section) throws GLib.Error {
@@ -178,16 +279,19 @@ public class Rygel.UserConfig : GLib.Object, Configuration {
return this.get_string (section, TITLE_KEY);
}
- public string get_string (string section,
- string key) throws GLib.Error {
+ private static string get_string_from_keyfiles (string section,
+ string key,
+ KeyFile key_file,
+ KeyFile sys_key_file)
+ throws GLib.Error {
string val;
try {
- val = this.key_file.get_string (section, key);
+ val = key_file.get_string (section, key);
} catch (KeyFileError error) {
if (error is KeyFileError.KEY_NOT_FOUND ||
error is KeyFileError.GROUP_NOT_FOUND) {
- val = this.sys_key_file.get_string (section, key);
+ val = sys_key_file.get_string (section, key);
} else {
throw error;
}
@@ -201,18 +305,29 @@ public class Rygel.UserConfig : GLib.Object, Configuration {
return val;
}
- public Gee.ArrayList<string> get_string_list (string section,
- string key)
- throws GLib.Error {
- var str_list = new Gee.ArrayList<string> ();
+ public string get_string (string section,
+ string key) throws GLib.Error {
+ return UserConfig.get_string_from_keyfiles (section,
+ key,
+ this.key_file,
+ this.sys_key_file);
+ }
+
+ private static ArrayList<string> get_string_list_from_keyfiles
+ (string section,
+ string key,
+ KeyFile key_file,
+ KeyFile sys_key_file)
+ throws GLib.Error {
+ var str_list = new ArrayList<string> ();
string[] strings;
try {
- strings = this.key_file.get_string_list (section, key);
+ strings = key_file.get_string_list (section, key);
} catch (KeyFileError error) {
if (error is KeyFileError.KEY_NOT_FOUND ||
error is KeyFileError.GROUP_NOT_FOUND) {
- strings = this.sys_key_file.get_string_list (section, key);
+ strings = sys_key_file.get_string_list (section, key);
} else {
throw error;
}
@@ -225,19 +340,29 @@ public class Rygel.UserConfig : GLib.Object, Configuration {
return str_list;
}
- public int get_int (string section,
- string key,
- int min,
- int max)
- throws GLib.Error {
+ public ArrayList<string> get_string_list (string section,
+ string key) throws GLib.Error {
+ return UserConfig.get_string_list_from_keyfiles (section,
+ key,
+ this.key_file,
+ this.sys_key_file);
+ }
+
+ private static int get_int_from_keyfiles (string section,
+ string key,
+ int min,
+ int max,
+ KeyFile key_file,
+ KeyFile sys_key_file)
+ throws GLib.Error {
int val;
try {
- val = this.key_file.get_integer (section, key);
+ val = key_file.get_integer (section, key);
} catch (KeyFileError error) {
if (error is KeyFileError.KEY_NOT_FOUND ||
error is KeyFileError.GROUP_NOT_FOUND) {
- val = this.sys_key_file.get_integer (section, key);
+ val = sys_key_file.get_integer (section, key);
} else {
throw error;
}
@@ -251,18 +376,33 @@ public class Rygel.UserConfig : GLib.Object, Configuration {
return val;
}
- public Gee.ArrayList<int> get_int_list (string section,
- string key)
- throws GLib.Error {
- var int_list = new Gee.ArrayList<int> ();
+ public int get_int (string section,
+ string key,
+ int min,
+ int max) throws GLib.Error {
+ return UserConfig.get_int_from_keyfiles (section,
+ key,
+ min,
+ max,
+ this.key_file,
+ this.sys_key_file);
+ }
+
+ private static ArrayList<int> get_int_list_from_keyfiles
+ (string section,
+ string key,
+ KeyFile key_file,
+ KeyFile sys_key_file)
+ throws GLib.Error {
+ var int_list = new ArrayList<int> ();
int[] ints;
try {
- ints = this.key_file.get_integer_list (section, key);
+ ints = key_file.get_integer_list (section, key);
} catch (KeyFileError error) {
if (error is KeyFileError.KEY_NOT_FOUND ||
error is KeyFileError.GROUP_NOT_FOUND) {
- ints = this.sys_key_file.get_integer_list (section, key);
+ ints = sys_key_file.get_integer_list (section, key);
} else {
throw error;
}
@@ -275,17 +415,56 @@ public class Rygel.UserConfig : GLib.Object, Configuration {
return int_list;
}
- public bool get_bool (string section,
- string key)
- throws GLib.Error {
+ public ArrayList<int> get_int_list (string section,
+ string key) throws GLib.Error {
+ return UserConfig.get_int_list_from_keyfiles (section,
+ key,
+ this.key_file,
+ this.sys_key_file);
+ }
+
+ private static bool get_bool_from_keyfiles (string section,
+ string key,
+ KeyFile key_file,
+ KeyFile sys_key_file)
+ throws GLib.Error {
bool val;
try {
- val = this.key_file.get_boolean (section, key);
+ val = key_file.get_boolean (section, key);
+ } catch (KeyFileError error) {
+ if (error is KeyFileError.KEY_NOT_FOUND ||
+ error is KeyFileError.GROUP_NOT_FOUND) {
+ val = sys_key_file.get_boolean (section, key);
+ } else {
+ throw error;
+ }
+ }
+
+ return val;
+ }
+
+ public bool get_bool (string section,
+ string key) throws GLib.Error {
+ return UserConfig.get_bool_from_keyfiles (section,
+ key,
+ key_file,
+ sys_key_file);
+ }
+
+ private static string get_value_from_keyfiles (string section,
+ string key,
+ KeyFile key_file,
+ KeyFile sys_key_file)
+ throws GLib.Error {
+ string val;
+
+ try {
+ val = key_file.get_value (section, key);
} catch (KeyFileError error) {
if (error is KeyFileError.KEY_NOT_FOUND ||
error is KeyFileError.GROUP_NOT_FOUND) {
- val = this.sys_key_file.get_boolean (section, key);
+ val = sys_key_file.get_value (section, key);
} else {
throw error;
}
@@ -293,4 +472,294 @@ public class Rygel.UserConfig : GLib.Object, Configuration {
return val;
}
+
+ private static HashSet<string> get_sections (KeyFile key_file,
+ KeyFile sys_key_file) {
+ var sections = new HashSet<string> ();
+
+ foreach (var section in key_file.get_groups ()) {
+ sections.add (section);
+ }
+
+ foreach (var section in sys_key_file.get_groups ()) {
+ sections.add (section);
+ }
+
+ return sections;
+ }
+
+ private static HashSet<string> get_keys (string section,
+ KeyFile key_file,
+ KeyFile sys_key_file) {
+ var keys = new HashSet<string> ();
+
+ try {
+ foreach (var key in key_file.get_keys (section)) {
+ keys.add (key);
+ }
+ } catch (GLib.Error e) {}
+
+ try {
+ foreach (var key in sys_key_file.get_keys (section)) {
+ keys.add (key);
+ }
+ } catch (GLib.Error e) {}
+
+ return keys;
+ }
+
+ private static bool are_values_different (string section,
+ string key,
+ KeyFile old_key_file,
+ KeyFile old_sys_key_file,
+ KeyFile new_key_file,
+ KeyFile new_sys_key_file,
+ EntryType type) {
+ try {
+ switch (type) {
+ case EntryType.STRING:
+ var old_value = UserConfig.get_string_from_keyfiles
+ (section,
+ key,
+ old_key_file,
+ old_sys_key_file);
+ var new_value = UserConfig.get_string_from_keyfiles
+ (section,
+ key,
+ new_key_file,
+ new_sys_key_file);
+
+ return (old_value != new_value);
+
+ case EntryType.BOOL:
+ var old_value = UserConfig.get_bool_from_keyfiles
+ (section,
+ key,
+ old_key_file,
+ old_sys_key_file);
+ var new_value = UserConfig.get_bool_from_keyfiles
+ (section,
+ key,
+ new_key_file,
+ new_sys_key_file);
+
+ return (old_value != new_value);
+
+ case EntryType.INT:
+ var old_value = UserConfig.get_int_from_keyfiles
+ (section,
+ key,
+ int.MIN,
+ int.MAX,
+ old_key_file,
+ old_sys_key_file);
+ var new_value = UserConfig.get_int_from_keyfiles
+ (section,
+ key,
+ int.MIN,
+ int.MAX,
+ new_key_file,
+ new_sys_key_file);
+
+ return (old_value != new_value);
+
+ default:
+ assert_not_reached ();
+ }
+ } catch (GLib.Error e) {
+ // should not happen, because we check for existence
+ // of the keys in both keyfile pairs beforehand.
+ return true;
+ }
+ }
+
+ private void emit_conditionally (string section,
+ string key,
+ KeyFile old_key_file,
+ KeyFile old_sys_key_file,
+ KeyFile key_file,
+ KeyFile sys_key_file,
+ HashMap<string, ConfigPair> config_keys) {
+ if (UserConfig.section_keys.has_key (key)) {
+ // known section key
+ var pair = UserConfig.section_keys.get (key);
+ var emit = UserConfig.are_values_different (section,
+ key,
+ old_key_file,
+ old_sys_key_file,
+ key_file,
+ sys_key_file,
+ pair.type);
+
+ if (emit) {
+ this.section_changed (section, pair.entry);
+ }
+ } else if (config_keys.has_key (key)) {
+ var pair = config_keys.get (key);
+ var emit = UserConfig.are_values_different (section,
+ key,
+ old_key_file,
+ old_sys_key_file,
+ key_file,
+ sys_key_file,
+ pair.type);
+
+ if (emit) {
+ this.configuration_changed (pair.entry);
+ }
+ } else {
+ // here we compare raw values - we have no
+ // knowledge about type of the setting.
+ var emit = false;
+
+ try {
+ var old_value = UserConfig.get_value_from_keyfiles
+ (section,
+ key,
+ old_key_file,
+ old_sys_key_file);
+ var new_value = UserConfig.get_value_from_keyfiles
+ (section,
+ key,
+ key_file,
+ sys_key_file);
+
+ emit = old_value != new_value;
+ } catch (GLib.Error e) {
+ // should not happen, because we check for existence
+ // of the keys in both keyfile pairs beforehand.
+ emit = true;
+ }
+
+ if (emit) {
+ this.setting_changed (section, key);
+ }
+ }
+ }
+
+ private void emit_unconditionally
+ (string section,
+ string key,
+ HashMap<string, ConfigPair> config_keys) {
+ if (UserConfig.section_keys.has_key (key)) {
+ var pair = UserConfig.section_keys.get (key);
+
+ this.section_changed (section, pair.entry);
+ } else if (config_keys.has_key (key)) {
+ var pair = config_keys.get (key);
+
+ this.configuration_changed (pair.entry);
+ } else {
+ this.setting_changed (section, key);
+ }
+ }
+
+ private void compare_and_notify (KeyFile key_file,
+ KeyFile sys_key_file) {
+ var old_key_file = this.key_file;
+ var old_sys_key_file = this.sys_key_file;
+ var old_sections = UserConfig.get_sections (old_key_file,
+ old_sys_key_file);
+ var new_sections = UserConfig.get_sections (key_file, sys_key_file);
+
+ this.key_file = key_file;
+ this.sys_key_file = sys_key_file;
+
+ foreach (var section in old_sections) {
+ var old_keys = UserConfig.get_keys (section,
+ old_key_file,
+ old_sys_key_file);
+ var config_keys = (UserConfig.config_keys.has_key (section) ?
+ UserConfig.config_keys.get (section) :
+ new HashMap<string, ConfigPair> ());
+
+ if (new_sections.remove (section)) {
+ // section exists in old and new configuration
+ var new_keys = UserConfig.get_keys (section,
+ key_file,
+ sys_key_file);
+
+ foreach (var key in old_keys) {
+ if (new_keys.remove (key)) {
+ // key exists in old and new configuration
+ this.emit_conditionally (section,
+ key,
+ old_key_file,
+ old_sys_key_file,
+ key_file,
+ sys_key_file,
+ config_keys);
+ } else {
+ // key disappeared in new configuration
+ this.emit_unconditionally (section, key, config_keys);
+ }
+ }
+ foreach (var key in new_keys) {
+ // keys here didn't exist in old and appeared in
+ // new one
+ this.emit_unconditionally (section,
+ key,
+ config_keys);
+ }
+ } else {
+ // section disappeared in new configuration
+ foreach (var key in old_keys) {
+ this.emit_unconditionally (section, key, config_keys);
+ }
+ }
+ }
+
+ foreach (var section in new_sections) {
+ // sections here didn't exist in old configuration and
+ // appeared in new one
+ var keys = UserConfig.get_keys (section, sys_key_file, key_file);
+ var config_keys = (UserConfig.config_keys.has_key (section) ?
+ UserConfig.config_keys.get (section) :
+ new HashMap<string, ConfigPair> ());
+
+ foreach (var key in keys) {
+ this.emit_unconditionally (section, key, config_keys);
+ }
+ }
+ }
+
+ private void reload_compare_and_notify_system (File system) {
+ var sys_key_file = new KeyFile ();
+
+ try {
+ sys_key_file.load_from_file (system.get_path (),
+ KeyFileFlags.KEEP_COMMENTS |
+ KeyFileFlags.KEEP_TRANSLATIONS);
+
+ } catch (GLib.Error e) {}
+
+ this.compare_and_notify (this.key_file, sys_key_file);
+ }
+
+ private void reload_compare_and_notify_local (File local) {
+ var key_file = new KeyFile ();
+
+ try {
+ key_file.load_from_file (local.get_path (),
+ KeyFileFlags.KEEP_COMMENTS |
+ KeyFileFlags.KEEP_TRANSLATIONS);
+
+ } catch (GLib.Error e) {}
+
+ this.compare_and_notify (key_file, this.sys_key_file);
+ }
+
+ private void on_system_config_changed (FileMonitor monitor,
+ File file,
+ File? other_file,
+ FileMonitorEvent event_type) {
+ this.reload_compare_and_notify_system (file);
+ }
+
+ private void on_local_config_changed (FileMonitor monitor,
+ File file,
+ File? other_file,
+ FileMonitorEvent event_type) {
+ this.reload_compare_and_notify_local (file);
+ }
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
