src/pan-view/pan-view-filter.c

   1 /*
   2  * Copyright (C) 2006 John Ellis
   3  * Copyright (C) 2008 - 2016 The Geeqie Team
   4  *
   5  * Author: John Ellis
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #include "pan-view-filter.h"
  23
  24 #include "image.h"
  25 #include "metadata.h"
  26 #include "pan-item.h"
  27 #include "pan-util.h"
  28 #include "pan-view.h"
  29 #include "ui_fileops.h"
  30 #include "ui_tabcomp.h"
  31 #include "ui_misc.h"
  32
  33 PanViewFilterUi *pan_filter_ui_new(PanWindow *pw)
  34 {
  35         PanViewFilterUi *ui = g_new0(PanViewFilterUi, 1);
  36         GtkWidget *combo;
  37         GtkWidget *hbox;
  38
  39         /* Since we're using the GHashTable as a HashSet (in which key and value pointers
  40          * are always identical), specifying key _and_ value destructor callbacks will
  41          * cause a double-free.
  42          */
  43         {
  44                 GtkTreeIter iter;
  45                 ui->filter_mode_model = gtk_list_store_new(3, G_TYPE_INT, G_TYPE_STRING, G_TYPE_STRING);
  46                 gtk_list_store_append(ui->filter_mode_model, &iter);
  47                 gtk_list_store_set(ui->filter_mode_model, &iter,
  48                                    0, PAN_VIEW_FILTER_REQUIRE, 1, _("Require"), 2, _("R"), -1);
  49                 gtk_list_store_append(ui->filter_mode_model, &iter);
  50                 gtk_list_store_set(ui->filter_mode_model, &iter,
  51                                    0, PAN_VIEW_FILTER_EXCLUDE, 1, _("Exclude"), 2, _("E"), -1);
  52                 gtk_list_store_append(ui->filter_mode_model, &iter);
  53                 gtk_list_store_set(ui->filter_mode_model, &iter,
  54                                    0, PAN_VIEW_FILTER_INCLUDE, 1, _("Include"), 2, _("I"), -1);
  55                 gtk_list_store_append(ui->filter_mode_model, &iter);
  56                 gtk_list_store_set(ui->filter_mode_model, &iter,
  57                                    0, PAN_VIEW_FILTER_GROUP, 1, _("Group"), 2, _("G"), -1);
  58
  59                 ui->filter_mode_combo = gtk_combo_box_new_with_model(GTK_TREE_MODEL(ui->filter_mode_model));
  60                 gtk_combo_box_set_focus_on_click(GTK_COMBO_BOX(ui->filter_mode_combo), FALSE);
  61                 gtk_combo_box_set_active(GTK_COMBO_BOX(ui->filter_mode_combo), 0);
  62
  63                 GtkCellRenderer *render = gtk_cell_renderer_text_new();
  64                 gtk_cell_layout_pack_start(GTK_CELL_LAYOUT(ui->filter_mode_combo), render, TRUE);
  65                 gtk_cell_layout_set_attributes(GTK_CELL_LAYOUT(ui->filter_mode_combo), render, "text", 1, NULL);
  66         }
  67
  68         // Build the actual filter UI.
  69         ui->filter_box = gtk_hbox_new(FALSE, PREF_PAD_SPACE);
  70         pref_spacer(ui->filter_box, 0);
  71         pref_label_new(ui->filter_box, _("Keyword Filter:"));
  72
  73         gtk_box_pack_start(GTK_BOX(ui->filter_box), ui->filter_mode_combo, TRUE, TRUE, 0);
  74         gtk_widget_show(ui->filter_mode_combo);
  75
  76         hbox = gtk_hbox_new(TRUE, PREF_PAD_SPACE);
  77         gtk_box_pack_start(GTK_BOX(ui->filter_box), hbox, TRUE, TRUE, 0);
  78         gtk_widget_show(hbox);
  79
  80         combo = tab_completion_new_with_history(&ui->filter_entry, "", "pan_view_filter", -1,
  81                                                 pan_filter_activate_cb, pw);
  82         gtk_box_pack_start(GTK_BOX(hbox), combo, TRUE, TRUE, 0);
  83         gtk_widget_show(combo);
  84
  85         // TODO(xsdg): Figure out whether it's useful to keep this label around.
  86         ui->filter_label = gtk_label_new("");
  87         //gtk_box_pack_start(GTK_BOX(hbox), ui->filter_label, FALSE, FALSE, 0);
  88         //gtk_widget_show(ui->filter_label);
  89
  90         ui->filter_kw_hbox = gtk_hbox_new(FALSE, PREF_PAD_SPACE);
  91         gtk_box_pack_start(GTK_BOX(hbox), ui->filter_kw_hbox, TRUE, TRUE, 0);
  92         gtk_widget_show(ui->filter_kw_hbox);
  93
  94         // Build the spin-button to show/hide the filter UI.
  95         ui->filter_button = gtk_toggle_button_new();
  96         gtk_button_set_relief(GTK_BUTTON(ui->filter_button), GTK_RELIEF_NONE);
  97         gtk_button_set_focus_on_click(GTK_BUTTON(ui->filter_button), FALSE);
  98         hbox = gtk_hbox_new(FALSE, PREF_PAD_GAP);
  99         gtk_container_add(GTK_CONTAINER(ui->filter_button), hbox);
 100         gtk_widget_show(hbox);
 101         ui->filter_button_arrow = gtk_arrow_new(GTK_ARROW_UP, GTK_SHADOW_NONE);
 102         gtk_box_pack_start(GTK_BOX(hbox), ui->filter_button_arrow, FALSE, FALSE, 0);
 103         gtk_widget_show(ui->filter_button_arrow);
 104         pref_label_new(hbox, _("Filter"));
 105
 106         g_signal_connect(G_OBJECT(ui->filter_button), "clicked",
 107                          G_CALLBACK(pan_filter_toggle_cb), pw);
 108
 109         return ui;
 110 }
 111
 112 void pan_filter_ui_destroy(PanViewFilterUi **ui_ptr)
 113 {
 114         if (ui_ptr == NULL || *ui_ptr == NULL) return;
 115
 116         // Note that g_clear_pointer handles already-NULL pointers.
 117         //g_clear_pointer(&(*ui_ptr)->filter_kw_table, g_hash_table_destroy);
 118
 119         g_free(*ui_ptr);
 120         *ui_ptr = NULL;
 121 }
 122
 123 static void pan_filter_status(PanWindow *pw, const gchar *text)
 124 {
 125         gtk_label_set_text(GTK_LABEL(pw->filter_ui->filter_label), (text) ? text : "");
 126 }
 127
 128 static void pan_filter_kw_button_cb(GtkButton *widget, gpointer data)
 129 {
 130         PanFilterCallbackState *cb_state = data;
 131         PanWindow *pw = cb_state->pw;
 132         PanViewFilterUi *ui = pw->filter_ui;
 133
 134         // TODO(xsdg): Fix filter element pointed object memory leak.
 135         ui->filter_elements = g_list_delete_link(ui->filter_elements, cb_state->filter_element);
 136         gtk_widget_destroy(GTK_WIDGET(widget));
 137         g_free(cb_state);
 138
 139         pan_filter_status(pw, _("Removed keyword…"));
 140         pan_layout_update(pw);
 141 }
 142
 143 void pan_filter_activate_cb(const gchar *text, gpointer data)
 144 {
 145         GtkWidget *kw_button;
 146         PanWindow *pw = data;
 147         PanViewFilterUi *ui = pw->filter_ui;
 148         GtkTreeIter iter;
 149
 150         if (!text) return;
 151
 152         // Get all relevant state and reset UI.
 153         gtk_combo_box_get_active_iter(GTK_COMBO_BOX(ui->filter_mode_combo), &iter);
 154         gtk_entry_set_text(GTK_ENTRY(ui->filter_entry), "");
 155         tab_completion_append_to_history(ui->filter_entry, text);
 156
 157         // Add new filter element.
 158         PanViewFilterElement *element = g_new0(PanViewFilterElement, 1);
 159         gtk_tree_model_get(GTK_TREE_MODEL(ui->filter_mode_model), &iter, 0, &element->mode, -1);
 160         element->keyword = g_strdup(text);
 161         if (g_strcmp0(text, g_regex_escape_string(text, -1)))
 162                 {
 163                 // It's an actual regex, so compile
 164                 element->kw_regex = g_regex_new(text, G_REGEX_ANCHORED | G_REGEX_OPTIMIZE, G_REGEX_MATCH_ANCHORED, NULL);
 165                 }
 166         ui->filter_elements = g_list_append(ui->filter_elements, element);
 167
 168         // Get the short version of the mode value.
 169         gchar *short_mode;
 170         gtk_tree_model_get(GTK_TREE_MODEL(ui->filter_mode_model), &iter, 2, &short_mode, -1);
 171
 172         // Create the button.
 173         // TODO(xsdg): Use MVC so that the button list is an actual representation of the GList
 174         gchar *label = g_strdup_printf("(%s) %s", short_mode, text);
 175         kw_button = gtk_button_new_with_label(label);
 176         g_clear_pointer(&label, g_free);
 177
 178         gtk_box_pack_start(GTK_BOX(ui->filter_kw_hbox), kw_button, FALSE, FALSE, 0);
 179         gtk_widget_show(kw_button);
 180
 181         PanFilterCallbackState *cb_state = g_new0(PanFilterCallbackState, 1);
 182         cb_state->pw = pw;
 183         cb_state->filter_element = g_list_last(ui->filter_elements);
 184
 185         g_signal_connect(G_OBJECT(kw_button), "clicked",
 186                          G_CALLBACK(pan_filter_kw_button_cb), cb_state);
 187
 188         pan_layout_update(pw);
 189 }
 190
 191 void pan_filter_activate(PanWindow *pw)
 192 {
 193         gchar *text;
 194
 195         text = g_strdup(gtk_entry_get_text(GTK_ENTRY(pw->filter_ui->filter_entry)));
 196         pan_filter_activate_cb(text, pw);
 197         g_free(text);
 198 }
 199
 200 void pan_filter_toggle_cb(GtkWidget *button, gpointer data)
 201 {
 202         PanWindow *pw = data;
 203         PanViewFilterUi *ui = pw->filter_ui;
 204         gboolean visible;
 205
 206         visible = gtk_widget_get_visible(ui->filter_box);
 207         if (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(button)) == visible) return;
 208
 209         if (visible)
 210                 {
 211                 gtk_widget_hide(ui->filter_box);
 212                 gtk_arrow_set(GTK_ARROW(ui->filter_button_arrow), GTK_ARROW_UP, GTK_SHADOW_NONE);
 213                 }
 214         else
 215                 {
 216                 gtk_widget_show(ui->filter_box);
 217                 gtk_arrow_set(GTK_ARROW(ui->filter_button_arrow), GTK_ARROW_DOWN, GTK_SHADOW_NONE);
 218                 gtk_widget_grab_focus(ui->filter_entry);
 219                 }
 220 }
 221
 222 void pan_filter_toggle_visible(PanWindow *pw, gboolean enable)
 223 {
 224         PanViewFilterUi *ui = pw->filter_ui;
 225         if (pw->fs) return;
 226
 227         if (enable)
 228                 {
 229                 if (gtk_widget_get_visible(ui->filter_box))
 230                         {
 231                         gtk_widget_grab_focus(ui->filter_entry);
 232                         }
 233                 else
 234                         {
 235                         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(ui->filter_button), TRUE);
 236                         }
 237                 }
 238         else
 239                 {
 240                 if (gtk_widget_get_visible(ui->filter_entry))
 241                         {
 242                         if (gtk_widget_has_focus(ui->filter_entry))
 243                                 {
 244                                 gtk_widget_grab_focus(GTK_WIDGET(pw->imd->widget));
 245                                 }
 246                         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(ui->filter_button), FALSE);
 247                         }
 248                 }
 249 }
 250
 251 static gboolean pan_view_list_contains_kw_pattern(GList *haystack, PanViewFilterElement *filter, gchar **found_kw)
 252 {
 253         if (filter->kw_regex)
 254                 {
 255                 // regex compile succeeded; attempt regex match.
 256                 GList *work = g_list_first(haystack);
 257                 while (work)
 258                         {
 259                         gchar *keyword = work->data;
 260                         work = work->next;
 261                         if (g_regex_match(filter->kw_regex, keyword, 0x0, NULL))
 262                                 {
 263                                 if (found_kw) *found_kw = keyword;
 264                                 return TRUE;
 265                                 }
 266                         }
 267                 return FALSE;
 268                 }
 269         else
 270                 {
 271                 // regex compile failed; fall back to exact string match.
 272                 GList *found_elem = g_list_find_custom(haystack, filter->keyword, (GCompareFunc)g_strcmp0);
 273                 if (found_elem && found_kw) *found_kw = found_elem->data;
 274                 return !!found_elem;
 275                 }
 276 }
 277
 278 gboolean pan_filter_fd_list(GList **fd_list, GList *filter_elements)
 279 {
 280         GList *work;
 281         gboolean modified = FALSE;
 282         GHashTable *seen_kw_table = NULL;
 283
 284         if (!fd_list || !*fd_list || !filter_elements) return modified;
 285
 286         // seen_kw_table is only valid in this scope, so don't take ownership of any strings.
 287         seen_kw_table = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, NULL);
 288
 289         work = *fd_list;
 290         while (work)
 291                 {
 292                 FileData *fd = work->data;
 293                 GList *last_work = work;
 294                 work = work->next;
 295
 296                 // TODO(xsdg): OPTIMIZATION Do the search inside of metadata.c to avoid a
 297                 // bunch of string list copies.
 298                 GList *img_keywords = metadata_read_list(fd, KEYWORD_KEY, METADATA_PLAIN);
 299
 300                 // TODO(xsdg): OPTIMIZATION Determine a heuristic for when to linear-search the
 301                 // keywords list, and when to build a hash table for the image's keywords.
 302                 gboolean should_reject = FALSE;
 303                 gchar *group_kw = NULL;
 304                 GList *filter_element = filter_elements;
 305                 while (filter_element)
 306                         {
 307                         PanViewFilterElement *filter = filter_element->data;
 308                         filter_element = filter_element->next;
 309                         gchar *found_kw = NULL;
 310                         gboolean has_kw = pan_view_list_contains_kw_pattern(img_keywords, filter, &found_kw);
 311
 312                         switch (filter->mode)
 313                                 {
 314                                 case PAN_VIEW_FILTER_REQUIRE:
 315                                         should_reject |= !has_kw;
 316                                         break;
 317                                 case PAN_VIEW_FILTER_EXCLUDE:
 318                                         should_reject |= has_kw;
 319                                         break;
 320                                 case PAN_VIEW_FILTER_INCLUDE:
 321                                         if (has_kw) should_reject = FALSE;
 322                                         break;
 323                                 case PAN_VIEW_FILTER_GROUP:
 324                                         if (has_kw)
 325                                                 {
 326                                                 if (g_hash_table_contains(seen_kw_table, found_kw))
 327                                                         {
 328                                                         should_reject = TRUE;
 329                                                         }
 330                                                 else if (group_kw == NULL)
 331                                                         {
 332                                                         group_kw = found_kw;
 333                                                         }
 334                                                 }
 335                                         break;
 336                                 }
 337                         }
 338
 339                 if (!should_reject && group_kw != NULL) g_hash_table_add(seen_kw_table, group_kw);
 340
 341                 group_kw = NULL;  // group_kw references an item from img_keywords.
 342                 string_list_free(img_keywords);
 343
 344                 if (should_reject)
 345                         {
 346                         *fd_list = g_list_delete_link(*fd_list, last_work);
 347                         modified = TRUE;
 348                         }
 349                 }
 350
 351         g_hash_table_destroy(seen_kw_table);
 352         return modified;
 353 }