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