Cleanup main.h header
[geeqie.git] / src / advanced-exif.cc
1 /*
2  * Copyright (C) 2004 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 "advanced-exif.h"
23
24 #include <config.h>
25
26 #include "compat.h"
27 #include "debug.h"
28 #include "dnd.h"
29 #include "exif.h"
30 #include "filedata.h"
31 #include "history-list.h"
32 #include "intl.h"
33 #include "layout-util.h"
34 #include "misc.h"
35 #include "ui-misc.h"
36 #include "window.h"
37
38 enum {
39         ADVANCED_EXIF_DATA_COLUMN_WIDTH = 200
40 };
41
42 /*
43  *-------------------------------------------------------------------
44  * EXIF window
45  *-------------------------------------------------------------------
46  */
47
48 struct ExifWin
49 {
50         GtkWidget *window;
51         GtkWidget *vbox;
52         GtkWidget *scrolled;
53         GtkWidget *listview;
54         GtkWidget *label_file_name;
55
56         FileData *fd;
57 };
58
59 enum {
60         EXIF_ADVCOL_ENABLED = 0,
61         EXIF_ADVCOL_TAG,
62         EXIF_ADVCOL_NAME,
63         EXIF_ADVCOL_VALUE,
64         EXIF_ADVCOL_FORMAT,
65         EXIF_ADVCOL_ELEMENTS,
66         EXIF_ADVCOL_DESCRIPTION,
67         EXIF_ADVCOL_COUNT
68 };
69
70 gint display_order [6] = {
71         EXIF_ADVCOL_DESCRIPTION,
72         EXIF_ADVCOL_VALUE,
73         EXIF_ADVCOL_NAME,
74         EXIF_ADVCOL_TAG,
75         EXIF_ADVCOL_FORMAT,
76         EXIF_ADVCOL_ELEMENTS
77 };
78
79 static gboolean advanced_exif_row_enabled(const gchar *name)
80 {
81         GList *list;
82
83         if (!name) return FALSE;
84
85         list = history_list_get_by_key("exif_extras");
86         while (list)
87                 {
88                 if (strcmp(name, static_cast<gchar *>(list->data)) == 0) return TRUE;
89                 list = list->next;
90         }
91
92         return FALSE;
93 }
94
95 static void advanced_exif_update(ExifWin *ew)
96 {
97         ExifData *exif;
98
99         GtkListStore *store;
100         GtkTreeIter iter;
101         ExifData *exif_original;
102         ExifItem *item;
103
104         exif = exif_read_fd(ew->fd);
105
106         gtk_widget_set_sensitive(ew->scrolled, !!exif);
107
108         if (!exif) return;
109
110         exif_original = exif_get_original(exif);
111
112         store = GTK_LIST_STORE(gtk_tree_view_get_model(GTK_TREE_VIEW(ew->listview)));
113         gtk_list_store_clear(store);
114
115         item = exif_get_first_item(exif_original);
116         while (item)
117                 {
118                 gchar *tag;
119                 gchar *tag_name;
120                 gchar *text;
121                 gchar *utf8_text;
122                 const gchar *format;
123                 gchar *elements;
124                 gchar *description;
125
126                 tag = g_strdup_printf("0x%04x", exif_item_get_tag_id(item));
127                 tag_name = exif_item_get_tag_name(item);
128                 format = exif_item_get_format_name(item, TRUE);
129                 text = exif_item_get_data_as_text(item, exif);
130                 utf8_text = utf8_validate_or_convert(text);
131                 g_free(text);
132                 elements = g_strdup_printf("%d", exif_item_get_elements(item));
133                 description = exif_item_get_description(item);
134                 if (!description || *description == '\0')
135                         {
136                         g_free(description);
137                         description = g_strdup(tag_name);
138                         }
139
140                 gtk_list_store_append(store, &iter);
141                 gtk_list_store_set(store, &iter,
142                                 EXIF_ADVCOL_ENABLED, advanced_exif_row_enabled(tag_name),
143                                 EXIF_ADVCOL_TAG, tag,
144                                 EXIF_ADVCOL_NAME, tag_name,
145                                 EXIF_ADVCOL_VALUE, utf8_text,
146                                 EXIF_ADVCOL_FORMAT, format,
147                                 EXIF_ADVCOL_ELEMENTS, elements,
148                                 EXIF_ADVCOL_DESCRIPTION, description, -1);
149                 g_free(tag);
150                 g_free(utf8_text);
151                 g_free(elements);
152                 g_free(description);
153                 g_free(tag_name);
154                 item = exif_get_next_item(exif_original);
155                 }
156         exif_free_fd(ew->fd, exif);
157
158 }
159
160 static void advanced_exif_clear(ExifWin *ew)
161 {
162         GtkListStore *store;
163
164         store = GTK_LIST_STORE(gtk_tree_view_get_model(GTK_TREE_VIEW(ew->listview)));
165         gtk_list_store_clear(store);
166 }
167
168 void advanced_exif_set_fd(GtkWidget *window, FileData *fd)
169 {
170         ExifWin *ew;
171
172         ew = static_cast<ExifWin *>(g_object_get_data(G_OBJECT(window), "advanced_exif_data"));
173         if (!ew) return;
174
175         /* store this, advanced view toggle needs to reload data */
176         file_data_unref(ew->fd);
177         ew->fd = file_data_ref(fd);
178
179         gtk_label_set_text(GTK_LABEL(ew->label_file_name), (ew->fd) ? ew->fd->path : "");
180
181         advanced_exif_clear(ew);
182         advanced_exif_update(ew);
183 }
184
185 static GtkTargetEntry advanced_exif_drag_types[] = {
186         { const_cast<gchar *>("text/plain"), 0, TARGET_TEXT_PLAIN }
187 };
188 static gint n_exif_drag_types = 1;
189
190
191 static void advanced_exif_dnd_get(GtkWidget *listview, GdkDragContext *,
192                                   GtkSelectionData *selection_data,
193                                   guint, guint, gpointer)
194 {
195         GtkTreeSelection *sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(listview));
196         GtkTreeIter iter;
197
198         if (gtk_tree_selection_get_selected(sel, nullptr, &iter))
199                 {
200                 GtkTreeModel *store = gtk_tree_view_get_model(GTK_TREE_VIEW(listview));
201                 gchar *key;
202
203                 gtk_tree_model_get(store, &iter, EXIF_ADVCOL_NAME, &key, -1);
204                 gtk_selection_data_set_text(selection_data, key, -1);
205                 g_free(key);
206                 }
207
208 }
209
210
211 static void advanced_exif_dnd_begin(GtkWidget *listview, GdkDragContext *context, gpointer)
212 {
213         GtkTreeSelection *sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(listview));
214         GtkTreeIter iter;
215
216         if (gtk_tree_selection_get_selected(sel, nullptr, &iter))
217                 {
218                 GtkTreeModel *store = gtk_tree_view_get_model(GTK_TREE_VIEW(listview));
219                 gchar *key;
220
221                 gtk_tree_model_get(store, &iter, EXIF_ADVCOL_NAME, &key, -1);
222
223                 dnd_set_drag_label(listview, context, key);
224                 g_free(key);
225                 }
226 }
227
228
229
230 static void advanced_exif_add_column(GtkWidget *listview, const gchar *title, gint n, gboolean sizable)
231 {
232         GtkTreeViewColumn *column;
233         GtkCellRenderer *renderer;
234
235         column = gtk_tree_view_column_new();
236         gtk_tree_view_column_set_title(column, title);
237
238         if (sizable)
239                 {
240                 gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_FIXED);
241                 gtk_tree_view_column_set_fixed_width(column, ADVANCED_EXIF_DATA_COLUMN_WIDTH);
242                 }
243         else
244                 {
245                 gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
246                 }
247
248         gtk_tree_view_column_set_resizable(column, TRUE);
249         gtk_tree_view_column_set_sort_column_id(column, n);
250
251         renderer = gtk_cell_renderer_text_new();
252         gtk_tree_view_column_pack_start(column, renderer, TRUE);
253         gtk_tree_view_column_add_attribute(column, renderer, "text", n);
254         gtk_tree_view_append_column(GTK_TREE_VIEW(listview), column);
255 }
256
257 static void advanced_exif_window_get_geometry(ExifWin *ew)
258 {
259         GdkWindow *window;
260         LayoutWindow *lw = nullptr;
261
262         layout_valid(&lw);
263
264         if (!ew || !lw) return;
265
266         window = gtk_widget_get_window(ew->window);
267         gdk_window_get_position(window, &lw->options.advanced_exif_window.x, &lw->options.advanced_exif_window.y);
268         lw->options.advanced_exif_window.w = gdk_window_get_width(window);
269         lw->options.advanced_exif_window.h = gdk_window_get_height(window);
270 }
271
272 void advanced_exif_close(ExifWin *ew)
273 {
274         if (!ew) return;
275
276         advanced_exif_window_get_geometry(ew);
277         file_data_unref(ew->fd);
278
279         gq_gtk_widget_destroy(ew->window);
280
281         g_free(ew);
282 }
283
284 static gboolean advanced_exif_delete_cb(GtkWidget *, GdkEvent *, gpointer data)
285 {
286         auto ew = static_cast<ExifWin *>(data);
287
288         if (!ew) return FALSE;
289
290         advanced_exif_window_get_geometry(ew);
291         file_data_unref(ew->fd);
292
293         g_free(ew);
294
295         return FALSE;
296 }
297
298 static gint advanced_exif_sort_cb(GtkTreeModel *model, GtkTreeIter *a, GtkTreeIter *b, gpointer data)
299 {
300         gint n = GPOINTER_TO_INT(data);
301         gint ret = 0;
302
303         switch (n)
304                 {
305                 case EXIF_ADVCOL_DESCRIPTION:
306                 case EXIF_ADVCOL_VALUE:
307                 case EXIF_ADVCOL_NAME:
308                 case EXIF_ADVCOL_TAG:
309                 case EXIF_ADVCOL_FORMAT:
310                 case EXIF_ADVCOL_ELEMENTS:
311                         {
312                         gchar *s1;
313                         gchar *s2;
314
315                         gtk_tree_model_get(model, a, n, &s1, -1);
316                         gtk_tree_model_get(model, b, n, &s2, -1);
317
318                         if (!s1 || !s2)
319                                 {
320                                 if (!s1 && !s2) break;
321                                 ret = s1 ? 1 : -1;
322                                 }
323                         else
324                                 {
325                                 ret = g_utf8_collate(s1, s2);
326                                 }
327
328                         g_free(s1);
329                         g_free(s2);
330                         }
331                         break;
332
333                 default:
334                         g_return_val_if_reached(0);
335                 }
336
337         return ret;
338 }
339
340 #ifdef HAVE_GTK4
341 static gboolean advanced_exif_mouseclick(GtkWidget *, GdkEventButton *, gpointer data)
342 {
343 /* @FIXME GTK4 stub */
344         return TRUE;
345 }
346 #else
347 static gboolean advanced_exif_mouseclick(GtkWidget *, GdkEventButton *, gpointer data)
348 {
349         auto ew = static_cast<ExifWin *>(data);
350         GtkTreePath *path;
351         GtkTreeViewColumn *column;
352         GtkTreeIter iter;
353         GtkTreeModel *store;
354         gchar *value;
355         GList *cols;
356         gint col_num;
357         GtkClipboard *clipboard;
358
359         gtk_tree_view_get_cursor(GTK_TREE_VIEW(ew->listview), &path, &column);
360         if (path && column)
361                 {
362                 store = gtk_tree_view_get_model(GTK_TREE_VIEW(ew->listview));
363                 gtk_tree_model_get_iter(store, &iter, path);
364
365                 cols = gtk_tree_view_get_columns(GTK_TREE_VIEW(ew->listview));
366                 col_num = g_list_index(cols, column);
367                 gtk_tree_model_get(store, &iter, display_order[col_num], &value, -1);
368
369                 clipboard = gtk_clipboard_get(GDK_SELECTION_PRIMARY);
370                 gtk_clipboard_set_text(clipboard, value, -1);
371
372                 g_list_free(cols);
373                 g_free(value);
374
375                 gtk_tree_view_set_search_column(GTK_TREE_VIEW(ew->listview), gtk_tree_view_column_get_sort_column_id(column));
376                 }
377
378         return TRUE;
379 }
380 #endif
381
382 static gboolean advanced_exif_keypress(GtkWidget *, GdkEventKey *event, gpointer data)
383 {
384         auto ew = static_cast<ExifWin *>(data);
385         gboolean stop_signal = FALSE;
386
387         if (event->state & GDK_CONTROL_MASK)
388                 {
389                 switch (event->keyval)
390                         {
391                         case 'W': case 'w':
392                                 advanced_exif_close(ew);
393                                 stop_signal = TRUE;
394                                 break;
395                         }
396                 } // if (event->state & GDK_CONTROL...
397         if (!stop_signal && is_help_key(event))
398                 {
399                 help_window_show("GuideOtherWindowsExif.html");
400                 stop_signal = TRUE;
401                 }
402
403         return stop_signal;
404 }
405
406 static gboolean search_function_cb(GtkTreeModel *model, gint column, const gchar *key, GtkTreeIter *iter, gpointer)
407 {
408         gboolean ret = TRUE;
409         gchar *field_contents;
410         gchar *field_contents_nocase;
411         gchar *key_nocase;
412
413         gtk_tree_model_get(model, iter, column, &field_contents, -1);
414
415         field_contents_nocase = g_utf8_casefold(field_contents, -1);
416         key_nocase = g_utf8_casefold(key, -1);
417
418         if (g_strstr_len(field_contents_nocase, -1, key_nocase))
419                 {
420                 ret = FALSE;
421                 }
422
423         g_free(field_contents);
424         g_free(field_contents_nocase);
425         g_free(key_nocase);
426
427         return ret;
428 }
429
430 GtkWidget *advanced_exif_new(LayoutWindow *lw)
431 {
432         ExifWin *ew;
433         GtkListStore *store;
434         GdkGeometry geometry;
435         GtkTreeSortable *sortable;
436         GtkWidget *box;
437         gint n;
438
439         ew = g_new0(ExifWin, 1);
440
441         ew->window = window_new("view", nullptr, nullptr, _("Metadata"));
442         DEBUG_NAME(ew->window);
443
444         geometry.min_width = 900;
445         geometry.min_height = 600;
446         gtk_window_set_geometry_hints(GTK_WINDOW(ew->window), nullptr, &geometry, GDK_HINT_MIN_SIZE);
447
448         gtk_window_set_resizable(GTK_WINDOW(ew->window), TRUE);
449
450         gtk_window_resize(GTK_WINDOW(ew->window), lw->options.advanced_exif_window.w, lw->options.advanced_exif_window.h);
451         if (lw->options.advanced_exif_window.x != 0 && lw->options.advanced_exif_window.y != 0)
452                 {
453                 gq_gtk_window_move(GTK_WINDOW(ew->window), lw->options.advanced_exif_window.x, lw->options.advanced_exif_window.y);
454                 }
455
456         g_object_set_data(G_OBJECT(ew->window), "advanced_exif_data", ew);
457         g_signal_connect(G_OBJECT(ew->window), "delete_event", G_CALLBACK(advanced_exif_delete_cb), ew);
458
459         ew->vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, PREF_PAD_GAP);
460         gq_gtk_container_add(GTK_WIDGET(ew->window), ew->vbox);
461         gtk_widget_show(ew->vbox);
462
463         box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
464
465         ew->label_file_name = gtk_label_new("");
466         gtk_label_set_ellipsize(GTK_LABEL(ew->label_file_name), PANGO_ELLIPSIZE_START);
467         gtk_label_set_selectable(GTK_LABEL(ew->label_file_name), TRUE);
468         gtk_label_set_xalign(GTK_LABEL(ew->label_file_name), 0.5);
469         gtk_label_set_yalign(GTK_LABEL(ew->label_file_name), 0.5);
470
471         gq_gtk_box_pack_start(GTK_BOX(box), ew->label_file_name, TRUE, TRUE, 0);
472         gtk_widget_show(ew->label_file_name);
473
474         gq_gtk_box_pack_start(GTK_BOX(ew->vbox), box, FALSE, FALSE, 0);
475         gtk_widget_show(box);
476
477
478         store = gtk_list_store_new(7, G_TYPE_BOOLEAN,
479                                       G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING,
480                                       G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING);
481
482         /* set up sorting */
483         sortable = GTK_TREE_SORTABLE(store);
484         for (n = EXIF_ADVCOL_DESCRIPTION; n <= EXIF_ADVCOL_ELEMENTS; n++)
485                 gtk_tree_sortable_set_sort_func(sortable, n, advanced_exif_sort_cb,
486                                                 GINT_TO_POINTER(n), nullptr);
487
488         /* set initial sort order */
489         gtk_tree_sortable_set_sort_column_id(sortable, EXIF_ADVCOL_NAME, GTK_SORT_ASCENDING);
490
491         ew->listview = gtk_tree_view_new_with_model(GTK_TREE_MODEL(store));
492         g_object_unref(store);
493
494         gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(ew->listview), TRUE);
495
496         advanced_exif_add_column(ew->listview, _("Description"), EXIF_ADVCOL_DESCRIPTION, FALSE);
497         advanced_exif_add_column(ew->listview, _("Value"), EXIF_ADVCOL_VALUE, TRUE);
498         advanced_exif_add_column(ew->listview, _("Name"), EXIF_ADVCOL_NAME, FALSE);
499         advanced_exif_add_column(ew->listview, _("Tag"), EXIF_ADVCOL_TAG, FALSE);
500         advanced_exif_add_column(ew->listview, _("Format"), EXIF_ADVCOL_FORMAT, FALSE);
501         advanced_exif_add_column(ew->listview, _("Elements"), EXIF_ADVCOL_ELEMENTS, FALSE);
502
503         gtk_tree_view_set_enable_search(GTK_TREE_VIEW(ew->listview), TRUE);
504         gtk_tree_view_set_search_column(GTK_TREE_VIEW(ew->listview), EXIF_ADVCOL_DESCRIPTION);
505         gtk_tree_view_set_search_equal_func(GTK_TREE_VIEW(ew->listview), search_function_cb, ew, nullptr);
506
507         gtk_drag_source_set(ew->listview,
508                            static_cast<GdkModifierType>(GDK_BUTTON1_MASK | GDK_BUTTON2_MASK),
509                            advanced_exif_drag_types, n_exif_drag_types,
510                            static_cast<GdkDragAction>(GDK_ACTION_COPY | GDK_ACTION_MOVE | GDK_ACTION_LINK));
511
512         g_signal_connect(G_OBJECT(ew->listview), "drag_data_get",
513                          G_CALLBACK(advanced_exif_dnd_get), ew);
514
515         g_signal_connect(G_OBJECT(ew->listview), "drag_begin",
516                          G_CALLBACK(advanced_exif_dnd_begin), ew);
517
518         g_signal_connect(G_OBJECT(ew->window), "key_press_event",
519                          G_CALLBACK(advanced_exif_keypress), ew);
520
521         g_signal_connect(G_OBJECT(ew->listview), "button_release_event",
522                         G_CALLBACK(advanced_exif_mouseclick), ew);
523
524         ew->scrolled = gq_gtk_scrolled_window_new(nullptr, nullptr);
525         gq_gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(ew->scrolled), GTK_SHADOW_IN);
526         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(ew->scrolled),
527                                        GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS);
528         gq_gtk_box_pack_start(GTK_BOX(ew->vbox), ew->scrolled, TRUE, TRUE, 0);
529         gq_gtk_container_add(GTK_WIDGET(ew->scrolled), ew->listview);
530         gtk_widget_show(ew->listview);
531         gtk_widget_show(ew->scrolled);
532
533         gtk_widget_show(ew->window);
534         return ew->window;
535 }
536 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */