[tracker/tracker-0.12] tracker-preferences: Disable special user dir toggles if they duplicate others

[Martyn James Russell <mr src gnome org>]

commit 2afa2fb228a4fee3863a47e5b9894529f858dd53
Author: Martyn Russell <martyn lanedo com>
Date:   Mon Oct 3 12:46:56 2011 +0100

    tracker-preferences: Disable special user dir toggles if they duplicate others
    
    Fixes GB#660350.

 src/tracker-preferences/tracker-preferences.ui   |   39 ++++++++
 src/tracker-preferences/tracker-preferences.vala |  104 +++++++++++++++++++++-
 2 files changed, 141 insertions(+), 2 deletions(-)
---
diff --git a/src/tracker-preferences/tracker-preferences.ui b/src/tracker-preferences/tracker-preferences.ui
index 7cb072f..fc40b89 100644
--- a/src/tracker-preferences/tracker-preferences.ui
+++ b/src/tracker-preferences/tracker-preferences.ui
@@ -900,6 +900,45 @@ If a directory is toggled to &lt;b&gt;Recurse&lt;/b&gt;, it means that all sub-d
                                     <property name="position">1</property>
                                   </packing>
                                 </child>
+                                <child>
+                                  <object class="GtkHBox" id="hbox_duplicate_warning">
+                                    <property name="can_focus">False</property>
+                                    <property name="spacing">6</property>
+                                    <child>
+                                      <object class="GtkImage" id="image5">
+                                        <property name="visible">True</property>
+                                        <property name="can_focus">False</property>
+                                        <property name="stock">gtk-dialog-warning</property>
+                                      </object>
+                                      <packing>
+                                        <property name="expand">False</property>
+                                        <property name="fill">True</property>
+                                        <property name="position">0</property>
+                                      </packing>
+                                    </child>
+                                    <child>
+                                      <object class="GtkLabel" id="label14">
+                                        <property name="visible">True</property>
+                                        <property name="can_focus">False</property>
+                                        <property name="xalign">0</property>
+                                        <property name="label" translatable="yes">One or more special locations have the same path.
+Those which are the same are disabled!</property>
+                                        <property name="justify">fill</property>
+                                        <property name="wrap">True</property>
+                                      </object>
+                                      <packing>
+                                        <property name="expand">True</property>
+                                        <property name="fill">True</property>
+                                        <property name="position">1</property>
+                                      </packing>
+                                    </child>
+                                  </object>
+                                  <packing>
+                                    <property name="expand">False</property>
+                                    <property name="fill">True</property>
+                                    <property name="position">2</property>
+                                  </packing>
+                                </child>
                               </object>
                               <packing>
                                 <property name="expand">False</property>
diff --git a/src/tracker-preferences/tracker-preferences.vala b/src/tracker-preferences/tracker-preferences.vala
index 1b4b2da..c944ab7 100644
--- a/src/tracker-preferences/tracker-preferences.vala
+++ b/src/tracker-preferences/tracker-preferences.vala
@@ -36,6 +36,8 @@ public class Tracker.Preferences {
 	private const string HOME_STRING = "$HOME";
 	private string HOME_STRING_EVALUATED;
 
+	private UserDirectory[] ignored_user_directories = null;
+
 	private Window window;
 	private CheckButton checkbutton_enable_index_on_battery_first_time;
 	private CheckButton checkbutton_enable_index_on_battery;
@@ -65,6 +67,7 @@ public class Tracker.Preferences {
 	private ToggleButton togglebutton_pictures;
 	private ToggleButton togglebutton_videos;
 	private ToggleButton togglebutton_download;
+	private HBox hbox_duplicate_warning;
 	private Notebook notebook;
 
 	public Preferences () {
@@ -131,6 +134,7 @@ public class Tracker.Preferences {
 		togglebutton_pictures = builder.get_object ("togglebutton_pictures") as ToggleButton;
 		togglebutton_videos = builder.get_object ("togglebutton_videos") as ToggleButton;
 		togglebutton_download = builder.get_object ("togglebutton_download") as ToggleButton;
+		hbox_duplicate_warning = builder.get_object ("hbox_duplicate_warning") as HBox;
 
 		treeview_index = builder.get_object ("treeview_index") as TreeView;
 		treeviewcolumn_index1 = builder.get_object ("treeviewcolumn_index1") as TreeViewColumn;
@@ -179,12 +183,22 @@ public class Tracker.Preferences {
 			radiobutton_sched_idle_first_index.active = true;
 		}
 
+		// Evaluate any user directories which have same target directory
+		sanitize_user_dirs ();
+
+		// Populate and toggle user directories
 		model_populate (liststore_index, settings_miner_fs.get_strv ("index-recursive-directories"), true, true);
 		model_populate (liststore_index, settings_miner_fs.get_strv ("index-single-directories"), true, false);
 		model_populate (liststore_ignored_directories, settings_miner_fs.get_strv ("ignored-directories"), false, false);
 		model_populate (liststore_ignored_files, settings_miner_fs.get_strv ("ignored-files"), false, false);
 		model_populate (liststore_ignored_directories_with_content, settings_miner_fs.get_strv ("ignored-directories-with-content"), false, false);
 
+		if (ignored_user_directories.length > 0) {
+			hbox_duplicate_warning.show ();
+		} else {
+			hbox_duplicate_warning.hide ();
+		}
+
 		togglebutton_home.active = model_contains (liststore_index, HOME_STRING_EVALUATED);
 		togglebutton_desktop.active = model_contains (liststore_index, "&DESKTOP");
 		togglebutton_documents.active = model_contains (liststore_index, "&DOCUMENTS");
@@ -711,9 +725,27 @@ public class Tracker.Preferences {
 	private void model_populate (ListStore model, string[] list, bool have_recurse, bool recurse) {
 		int position = 0;
 
-		foreach (string str in list) {
+		foreach (string s in list) {
 			// Convert any dirs from config to real values
-			str = dir_from_config (str);
+			bool ignore = false;
+
+			// Don't insert configs if toggle is not sensitive
+			foreach (UserDirectory ud in ignored_user_directories) {
+				string ud_string = ud.to_string ();
+				string output = "&%s".printf (ud_string.substring (ud_string.last_index_of_char ('_') + 1, -1));
+
+				if (s == output) {
+					ignore = true;
+					break;
+				}
+			}
+
+			if (ignore) {
+				debug ("Ignoring '%s' (duplicates other entries in config)", s);
+				continue;
+			}
+
+			string str = dir_from_config (s);
 
 			try {
 				if (have_recurse)
@@ -779,6 +811,74 @@ public class Tracker.Preferences {
 			});
 		}
 	}
+
+	private void sanitize_user_dirs () {
+		string[] all_dirs = null;
+
+		all_dirs += HOME_STRING_EVALUATED;
+
+		for (int i = 0; i < UserDirectory.N_DIRECTORIES; i++) {
+			UserDirectory ud = (UserDirectory) i;
+
+			string dir = Environment.get_user_special_dir (ud);
+			if (dir == null) {
+				continue;
+			}
+
+			foreach (string d in all_dirs) {
+				if (d == dir) {
+					debug ("Directory '%s' duplicated in XDG dir %d", d, ud);
+
+					switch (ud) {
+					case UserDirectory.DESKTOP:
+					case UserDirectory.DOCUMENTS:
+					case UserDirectory.DOWNLOAD:
+					case UserDirectory.MUSIC:
+					case UserDirectory.PICTURES:
+					case UserDirectory.VIDEOS:
+						ignored_user_directories += ud;
+						break;
+
+					default:
+						// We don't care about others, we don't
+						// have toggle buttons for them
+						break;
+					}
+
+					break;
+				}
+			}
+
+			// Add dir to list of dirs we know about to filter
+			// out subsequent dirs
+			all_dirs += dir;
+		}
+
+		foreach (UserDirectory ud in ignored_user_directories) {
+			switch (ud) {
+			case UserDirectory.DESKTOP:
+				togglebutton_desktop.sensitive = false;
+				break;
+			case UserDirectory.DOCUMENTS:
+				togglebutton_documents.sensitive = false;
+				break;
+			case UserDirectory.DOWNLOAD:
+				togglebutton_download.sensitive = false;
+				break;
+			case UserDirectory.MUSIC:
+				togglebutton_music.sensitive = false;
+				break;
+			case UserDirectory.PICTURES:
+				togglebutton_pictures.sensitive = false;
+				break;
+			case UserDirectory.VIDEOS:
+				togglebutton_videos.sensitive = false;
+				break;
+			default:
+				break;
+			}
+		}
+	}
 }
 
 static bool print_version = false;