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