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