src/thumb-standard.cc

   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 "main.h"
  23 #include "thumb-standard.h"
  24
  25 #include "cache.h"
  26 #include "image-load.h"
  27 #include "md5-util.h"
  28 #include "pixbuf-util.h"
  29 #include "ui-fileops.h"
  30 #include "filedata.h"
  31 #include "exif.h"
  32 #include "metadata.h"
  33 #include "color-man.h"
  34
  35
  36 /**
  37  * @file
  38  *
  39  * This thumbnail caching implementation attempts to conform
  40  * to the Thumbnail Managing Standard proposed on freedesktop.org
  41  * The standard is documented here: \n
  42  *   https://www.freedesktop.org/wiki/Specifications/thumbnails/ \n
  43  *
  44  * This code attempts to conform to version 0.7.0 of the standard.
  45  *
  46  * Notes:
  47  *   > Validation of the thumb's embedded uri is a simple strcmp between our
  48  *   > version of the escaped uri and the thumb's escaped uri. But not all uri
  49  *   > escape functions escape the same set of chars, comparing the unescaped
  50  *   > versions may be more accurate. \n
  51  *   > Only Thumb::URI and Thumb::MTime are stored in a thumb at this time.
  52  *     Storing the Size, Width, Height should probably be implemented.
  53  */
  54
  55
  56 #define THUMB_SIZE_NORMAL 128
  57 #define THUMB_SIZE_LARGE  256
  58
  59 #define THUMB_MARKER_URI    "tEXt::Thumb::URI"
  60 #define THUMB_MARKER_MTIME  "tEXt::Thumb::MTime"
  61 #define THUMB_MARKER_SIZE   "tEXt::Thumb::Size"
  62 #define THUMB_MARKER_WIDTH  "tEXt::Thumb::Image::Width"
  63 #define THUMB_MARKER_HEIGHT "tEXt::Thumb::Image::Height"
  64 #define THUMB_MARKER_APP    "tEXt::Software"
  65
  66 #define THUMB_PERMS_FOLDER 0700
  67 #define THUMB_PERMS_THUMB  0600
  68
  69
  70
  71 /*
  72  *-----------------------------------------------------------------------------
  73  * thumbnail loader
  74  *-----------------------------------------------------------------------------
  75  */
  76
  77
  78 static void thumb_loader_std_error_cb(ImageLoader *il, gpointer data);
  79 static gint thumb_loader_std_setup(ThumbLoaderStd *tl, FileData *fd);
  80
  81
  82 ThumbLoaderStd *thumb_loader_std_new(gint width, gint height)
  83 {
  84         ThumbLoaderStd *tl;
  85
  86         tl = g_new0(ThumbLoaderStd, 1);
  87
  88         tl->standard_loader = TRUE;
  89         tl->requested_width = width;
  90         tl->requested_height = height;
  91         tl->cache_enable = options->thumbnails.enable_caching;
  92
  93         return tl;
  94 }
  95
  96 void thumb_loader_std_set_callbacks(ThumbLoaderStd *tl,
  97                                     ThumbLoaderStdFunc func_done,
  98                                     ThumbLoaderStdFunc func_error,
  99                                     ThumbLoaderStdFunc func_progress,
 100                                     gpointer data)
 101 {
 102         if (!tl) return;
 103
 104         tl->func_done = func_done;
 105         tl->func_error = func_error;
 106         tl->func_progress = func_progress;
 107         tl->data = data;
 108 }
 109
 110 static void thumb_loader_std_reset(ThumbLoaderStd *tl)
 111 {
 112         image_loader_free(tl->il);
 113         tl->il = nullptr;
 114
 115         file_data_unref(tl->fd);
 116         tl->fd = nullptr;
 117
 118         g_free(tl->thumb_path);
 119         tl->thumb_path = nullptr;
 120
 121         g_free(tl->thumb_uri);
 122         tl->thumb_uri = nullptr;
 123         tl->local_uri = nullptr;
 124
 125         tl->thumb_path_local = FALSE;
 126
 127         tl->cache_hit = FALSE;
 128
 129         tl->source_mtime = 0;
 130         tl->source_size = 0;
 131         tl->source_mode = 0;
 132
 133         tl->progress = 0.0;
 134 }
 135
 136 static gchar *thumb_std_cache_path(const gchar *path, const gchar *uri, gboolean local,
 137                                    const gchar *cache_subfolder)
 138 {
 139         gchar *result = nullptr;
 140         gchar *md5_text;
 141         guchar digest[16];
 142         gchar *name;
 143
 144         if (!path || !uri || !cache_subfolder) return nullptr;
 145
 146         md5_get_digest(reinterpret_cast<const guchar *>(uri), strlen(uri), digest);
 147         md5_text = md5_digest_to_text(digest);
 148
 149         if (!md5_text) return nullptr;
 150
 151         name = g_strconcat(md5_text, THUMB_NAME_EXTENSION, NULL);
 152
 153         if (local)
 154                 {
 155                 gchar *base = remove_level_from_path(path);
 156
 157                 result = g_build_filename(base, THUMB_FOLDER_LOCAL, cache_subfolder, name, NULL);
 158                 g_free(base);
 159                 }
 160         else
 161                 {
 162                 result = g_build_filename(get_thumbnails_standard_cache_dir(),
 163                                                                                                         cache_subfolder, name, NULL);
 164                 }
 165
 166         g_free(name);
 167         g_free(md5_text);
 168
 169         return result;
 170 }
 171
 172 static gchar *thumb_loader_std_cache_path(ThumbLoaderStd *tl, gboolean local, GdkPixbuf *pixbuf, gboolean fail)
 173 {
 174         const gchar *folder;
 175         gint w, h;
 176
 177         if (!tl->fd || !tl->thumb_uri) return nullptr;
 178
 179         if (pixbuf)
 180                 {
 181                 w = gdk_pixbuf_get_width(pixbuf);
 182                 h = gdk_pixbuf_get_height(pixbuf);
 183                 }
 184         else
 185                 {
 186                 w = tl->requested_width;
 187                 h = tl->requested_height;
 188                 }
 189
 190         if (fail)
 191                 {
 192                 folder = THUMB_FOLDER_FAIL;
 193                 }
 194         else if (w > THUMB_SIZE_NORMAL || h > THUMB_SIZE_NORMAL)
 195                 {
 196                 folder = THUMB_FOLDER_LARGE;
 197                 }
 198         else
 199                 {
 200                 folder = THUMB_FOLDER_NORMAL;
 201                 }
 202
 203         return thumb_std_cache_path(tl->fd->path,
 204                                     (local) ?  tl->local_uri : tl->thumb_uri,
 205                                     local, folder);
 206 }
 207
 208 static gboolean thumb_loader_std_fail_check(ThumbLoaderStd *tl)
 209 {
 210         gchar *fail_path;
 211         gboolean result = FALSE;
 212
 213         fail_path = thumb_loader_std_cache_path(tl, FALSE, nullptr, TRUE);
 214         if (isfile(fail_path))
 215                 {
 216                 GdkPixbuf *pixbuf;
 217
 218                 if (tl->cache_retry)
 219                         {
 220                         pixbuf = nullptr;
 221                         }
 222                 else
 223                         {
 224                         gchar *pathl;
 225
 226                         pathl = path_from_utf8(fail_path);
 227                         pixbuf = gdk_pixbuf_new_from_file(pathl, nullptr);
 228                         g_free(pathl);
 229                         }
 230
 231                 if (pixbuf)
 232                         {
 233                         const gchar *mtime_str;
 234
 235                         mtime_str = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_MTIME);
 236                         if (mtime_str && strtol(mtime_str, nullptr, 10) == tl->source_mtime)
 237                                 {
 238                                 result = TRUE;
 239                                 DEBUG_1("thumb fail valid: %s", tl->fd->path);
 240                                 DEBUG_1("           thumb: %s", fail_path);
 241                                 }
 242
 243                         g_object_unref(G_OBJECT(pixbuf));
 244                         }
 245
 246                 if (!result) unlink_file(fail_path);
 247                 }
 248         g_free(fail_path);
 249
 250         return result;
 251 }
 252
 253 static gboolean thumb_loader_std_validate(ThumbLoaderStd *tl, GdkPixbuf *pixbuf)
 254 {
 255         const gchar *valid_uri;
 256         const gchar *uri;
 257         const gchar *mtime_str;
 258         time_t mtime;
 259         gint w, h;
 260
 261         if (!pixbuf) return FALSE;
 262
 263         w = gdk_pixbuf_get_width(pixbuf);
 264         h = gdk_pixbuf_get_height(pixbuf);
 265
 266         if (w != THUMB_SIZE_NORMAL && w != THUMB_SIZE_LARGE &&
 267             h != THUMB_SIZE_NORMAL && h != THUMB_SIZE_LARGE) return FALSE;
 268
 269         valid_uri = (tl->thumb_path_local) ? tl->local_uri : tl->thumb_uri;
 270
 271         uri = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_URI);
 272         mtime_str = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_MTIME);
 273
 274         if (!mtime_str || !uri || !valid_uri) return FALSE;
 275         if (strcmp(uri, valid_uri) != 0) return FALSE;
 276
 277         mtime = strtol(mtime_str, nullptr, 10);
 278         if (tl->source_mtime != mtime) return FALSE;
 279
 280         return TRUE;
 281 }
 282
 283 static void thumb_loader_std_save(ThumbLoaderStd *tl, GdkPixbuf *pixbuf)
 284 {
 285         gchar *base_path;
 286         gchar *tmp_path;
 287         gboolean fail;
 288
 289         if (!tl->cache_enable || tl->cache_hit) return;
 290         if (tl->thumb_path) return;
 291
 292         if (!pixbuf)
 293                 {
 294                 /* local failures are not stored */
 295                 if (tl->cache_local) return;
 296
 297                 pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, 1, 1);
 298                 fail = TRUE;
 299                 }
 300         else
 301                 {
 302                 g_object_ref(G_OBJECT(pixbuf));
 303                 fail = FALSE;
 304                 }
 305
 306         tl->thumb_path = thumb_loader_std_cache_path(tl, tl->cache_local, pixbuf, fail);
 307         if (!tl->thumb_path)
 308                 {
 309                 g_object_unref(G_OBJECT(pixbuf));
 310                 return;
 311                 }
 312         tl->thumb_path_local = tl->cache_local;
 313
 314         /* create thumbnail dir if needed */
 315         base_path = remove_level_from_path(tl->thumb_path);
 316         if (tl->cache_local)
 317                 {
 318                 if (!isdir(base_path))
 319                         {
 320                         struct stat st;
 321                         gchar *source_base;
 322
 323                         source_base = remove_level_from_path(tl->fd->path);
 324                         if (stat_utf8(source_base, &st))
 325                                 {
 326                                 recursive_mkdir_if_not_exists(base_path, st.st_mode);
 327                                 }
 328                         g_free(source_base);
 329                         }
 330                 }
 331         else
 332                 {
 333                 recursive_mkdir_if_not_exists(base_path, THUMB_PERMS_FOLDER);
 334                 }
 335         g_free(base_path);
 336
 337         DEBUG_1("thumb saving: %s", tl->fd->path);
 338         DEBUG_1("       saved: %s", tl->thumb_path);
 339
 340         /* save thumb, using a temp file then renaming into place */
 341         tmp_path = unique_filename(tl->thumb_path, ".tmp", "_", 2);
 342         if (tmp_path)
 343                 {
 344                 const gchar *mark_uri;
 345                 gchar *mark_app;
 346                 gchar *mark_mtime;
 347                 gchar *pathl;
 348                 gboolean success;
 349
 350                 mark_uri = (tl->cache_local) ? tl->local_uri :tl->thumb_uri;
 351
 352                 mark_app = g_strdup_printf("%s %s", GQ_APPNAME, VERSION);
 353                 mark_mtime = g_strdup_printf("%llu", static_cast<unsigned long long>(tl->source_mtime));
 354                 pathl = path_from_utf8(tmp_path);
 355                 success = gdk_pixbuf_save(pixbuf, pathl, "png", nullptr,
 356                                           THUMB_MARKER_URI, mark_uri,
 357                                           THUMB_MARKER_MTIME, mark_mtime,
 358                                           THUMB_MARKER_APP, mark_app,
 359                                           NULL);
 360                 if (success)
 361                         {
 362                         chmod(pathl, (tl->cache_local) ? tl->source_mode : THUMB_PERMS_THUMB);
 363                         success = rename_file(tmp_path, tl->thumb_path);
 364                         }
 365
 366                 g_free(pathl);
 367
 368                 g_free(mark_mtime);
 369                 g_free(mark_app);
 370
 371                 g_free(tmp_path);
 372                 if (!success)
 373                         {
 374                         DEBUG_1("thumb save failed: %s", tl->fd->path);
 375                         DEBUG_1("            thumb: %s", tl->thumb_path);
 376                         }
 377
 378                 }
 379
 380         g_object_unref(G_OBJECT(pixbuf));
 381 }
 382
 383 static void thumb_loader_std_set_fallback(ThumbLoaderStd *tl)
 384 {
 385         if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 386         tl->fd->thumb_pixbuf = pixbuf_fallback(tl->fd, tl->requested_width, tl->requested_height);
 387 }
 388
 389
 390 void thumb_loader_std_calibrate_pixbuf(FileData *fd, GdkPixbuf *pixbuf) {
 391         ColorMan *cm = nullptr;
 392         ExifData *exif = nullptr;
 393         gint color_profile_from_image = COLOR_PROFILE_NONE;
 394         ColorManProfileType input_type = COLOR_PROFILE_MEM;
 395         ColorManProfileType screen_type;
 396         const gchar *input_file = nullptr;
 397         guchar *profile = nullptr;
 398         guint profile_len;
 399         gint sw, sh;
 400
 401         if (!options->thumbnails.use_color_management)
 402                 {
 403                 return;
 404                 }
 405
 406         sw = gdk_pixbuf_get_width(pixbuf);
 407         sh = gdk_pixbuf_get_height(pixbuf);
 408
 409         exif = exif_read_fd(fd);
 410
 411         if (exif)
 412                 {
 413                 if (g_strcmp0(fd->format_name, "heif") == 0)
 414                         {
 415                         profile = heif_color_profile(fd, &profile_len);
 416                         }
 417
 418                 if (!profile)
 419                         {
 420                         profile = exif_get_color_profile(exif, &profile_len);
 421                         }
 422
 423                 if (profile)
 424                         {
 425                         DEBUG_1("Found embedded color profile");
 426                         color_profile_from_image = COLOR_PROFILE_MEM;
 427                         }
 428                 else
 429                         {
 430                         gchar *interop_index = exif_get_data_as_text(exif, "Exif.Iop.InteroperabilityIndex");
 431
 432                         if (interop_index)
 433                                 {
 434                                 /* Exif 2.21 specification */
 435                                 if (!strcmp(interop_index, "R98"))
 436                                         {
 437                                         color_profile_from_image = COLOR_PROFILE_SRGB;
 438                                         DEBUG_1("Found EXIF 2.21 ColorSpace of sRGB");
 439                                         }
 440                                 else if (!strcmp(interop_index, "R03"))
 441                                         {
 442                                         color_profile_from_image = COLOR_PROFILE_ADOBERGB;
 443                                         DEBUG_1("Found EXIF 2.21 ColorSpace of AdobeRGB");
 444                                         }
 445                                 g_free(interop_index);
 446                                 }
 447                         else
 448                                 {
 449                                 gint cs;
 450
 451                                 /* ColorSpace == 1 specifies sRGB per EXIF 2.2 */
 452                                 if (!exif_get_integer(exif, "Exif.Photo.ColorSpace", &cs)) cs = 0;
 453                                 if (cs == 1)
 454                                         {
 455                                         color_profile_from_image = COLOR_PROFILE_SRGB;
 456                                         DEBUG_1("Found EXIF 2.2 ColorSpace of sRGB");
 457                                         }
 458                                 else if (cs == 2)
 459                                         {
 460                                         /* non-standard way of specifying AdobeRGB (used by some software) */
 461                                         color_profile_from_image = COLOR_PROFILE_ADOBERGB;
 462                                         DEBUG_1("Found EXIF 2.2 ColorSpace of AdobeRGB");
 463                                         }
 464                                 }
 465                         }
 466
 467                 if(color_profile_from_image != COLOR_PROFILE_NONE)
 468                         {
 469                                 // transform image, we always use sRGB as target for thumbnails
 470                                 screen_type = COLOR_PROFILE_SRGB;
 471
 472                                 if (profile)
 473                                         {
 474                                         cm = color_man_new_embedded(nullptr, pixbuf,
 475                                                                         profile, profile_len,
 476                                                                         screen_type, nullptr, nullptr, 0);
 477                                         g_free(profile);
 478                                         }
 479                                 else
 480                                         {
 481                                         cm = color_man_new(nullptr, pixbuf,
 482                                                         input_type, input_file,
 483                                                         screen_type, nullptr, nullptr, 0);
 484                                         }
 485
 486                                 if(cm) {
 487                                         color_man_correct_region(cm, cm->pixbuf, 0, 0, sw, sh);
 488                                         g_free(cm);
 489                                 }
 490
 491                         }
 492                 exif_free_fd(fd, exif);
 493                 }
 494 }
 495
 496 static GdkPixbuf *thumb_loader_std_finish(ThumbLoaderStd *tl, GdkPixbuf *pixbuf, gboolean shrunk)
 497 {
 498         GdkPixbuf *pixbuf_thumb = nullptr;
 499         GdkPixbuf *result;
 500         GdkPixbuf *rotated = nullptr;
 501         gint sw, sh;
 502
 503
 504         if (!tl->cache_hit && options->image.exif_rotate_enable)
 505                 {
 506                 if (!tl->fd->exif_orientation)
 507                         {
 508                         if (g_strcmp0(tl->fd->format_name, "heif") != 0)
 509                                 {
 510                                 tl->fd->exif_orientation = metadata_read_int(tl->fd, ORIENTATION_KEY, EXIF_ORIENTATION_TOP_LEFT);
 511                                 }
 512                         else
 513                                 {
 514                                 tl->fd->exif_orientation = EXIF_ORIENTATION_TOP_LEFT;
 515                                 }
 516                         }
 517
 518                 if (tl->fd->exif_orientation != EXIF_ORIENTATION_TOP_LEFT)
 519                         {
 520                         rotated = pixbuf_apply_orientation(pixbuf, tl->fd->exif_orientation);
 521                         pixbuf = rotated;
 522                         }
 523                 }
 524
 525         sw = gdk_pixbuf_get_width(pixbuf);
 526         sh = gdk_pixbuf_get_height(pixbuf);
 527
 528         if (tl->cache_enable)
 529                 {
 530                 if (!tl->cache_hit)
 531                         {
 532                         gint cache_w, cache_h;
 533
 534                         if (tl->requested_width > THUMB_SIZE_NORMAL || tl->requested_height > THUMB_SIZE_NORMAL)
 535                                 {
 536                                 cache_w = cache_h = THUMB_SIZE_LARGE;
 537                                 }
 538                         else
 539                                 {
 540                                 cache_w = cache_h = THUMB_SIZE_NORMAL;
 541                                 }
 542
 543                         if (sw > cache_w || sh > cache_h || shrunk)
 544                                 {
 545                                 gint thumb_w, thumb_h;
 546                                 struct stat st;
 547
 548                                 if (pixbuf_scale_aspect(cache_w, cache_h, sw, sh,
 549                                                                   &thumb_w, &thumb_h))
 550                                         {
 551                                         pixbuf_thumb = gdk_pixbuf_scale_simple(pixbuf, thumb_w, thumb_h,
 552                                                                                static_cast<GdkInterpType>(options->thumbnails.quality));
 553                                         }
 554                                 else
 555                                         {
 556                                         pixbuf_thumb = pixbuf;
 557                                         g_object_ref(G_OBJECT(pixbuf_thumb));
 558                                         }
 559
 560                                 /* do not save the thumbnail if the source file has changed meanwhile -
 561                                    the thumbnail is most probably broken */
 562                                 if (stat_utf8(tl->fd->path, &st) &&
 563                                     tl->source_mtime == st.st_mtime &&
 564                                     tl->source_size == st.st_size)
 565                                         {
 566                                         thumb_loader_std_save(tl, pixbuf_thumb);
 567                                         }
 568                                 }
 569                         }
 570                 else if (tl->cache_hit &&
 571                          tl->cache_local && !tl->thumb_path_local)
 572                         {
 573                         /* A local cache save was requested, but a valid thumb is in $HOME,
 574                          * so specifically save as a local thumbnail.
 575                          */
 576                         g_free(tl->thumb_path);
 577                         tl->thumb_path = nullptr;
 578
 579                         tl->cache_hit = FALSE;
 580
 581                         DEBUG_1("thumb copied: %s", tl->fd->path);
 582
 583                         thumb_loader_std_save(tl, pixbuf);
 584                         }
 585                 }
 586
 587         if (sw <= tl->requested_width && sh <= tl->requested_height)
 588                 {
 589                 result = pixbuf;
 590                 g_object_ref(result);
 591                 }
 592         else
 593                 {
 594                 gint thumb_w, thumb_h;
 595
 596                 if (pixbuf_thumb)
 597                         {
 598                         pixbuf = pixbuf_thumb;
 599                         sw = gdk_pixbuf_get_width(pixbuf);
 600                         sh = gdk_pixbuf_get_height(pixbuf);
 601                         }
 602
 603                 if (pixbuf_scale_aspect(tl->requested_width, tl->requested_height, sw, sh,
 604                                                   &thumb_w, &thumb_h))
 605                         {
 606                         result = gdk_pixbuf_scale_simple(pixbuf, thumb_w, thumb_h,
 607                                                          static_cast<GdkInterpType>(options->thumbnails.quality));
 608                         }
 609                 else
 610                         {
 611                         result = pixbuf;
 612                         g_object_ref(result);
 613                         }
 614                 }
 615
 616         // apply color correction, if required
 617         thumb_loader_std_calibrate_pixbuf(tl->fd, result);
 618
 619         if (pixbuf_thumb) g_object_unref(pixbuf_thumb);
 620         if (rotated) g_object_unref(rotated);
 621
 622         return result;
 623 }
 624
 625 static gboolean thumb_loader_std_next_source(ThumbLoaderStd *tl, gboolean remove_broken)
 626 {
 627         image_loader_free(tl->il);
 628         tl->il = nullptr;
 629
 630         if (tl->thumb_path)
 631                 {
 632                 if (!tl->thumb_path_local && remove_broken)
 633                         {
 634                         DEBUG_1("thumb broken, unlinking: %s", tl->thumb_path);
 635                         unlink_file(tl->thumb_path);
 636                         }
 637
 638                 g_free(tl->thumb_path);
 639                 tl->thumb_path = nullptr;
 640
 641                 if (!tl->thumb_path_local)
 642                         {
 643                         tl->thumb_path = thumb_loader_std_cache_path(tl, TRUE, nullptr, FALSE);
 644                         if (isfile(tl->thumb_path))
 645                                 {
 646                                 FileData *fd = file_data_new_no_grouping(tl->thumb_path);
 647                                 if (thumb_loader_std_setup(tl, fd))
 648                                         {
 649                                         file_data_unref(fd);
 650                                         tl->thumb_path_local = TRUE;
 651                                         return TRUE;
 652                                         }
 653                                 file_data_unref(fd);
 654                                 }
 655
 656                         g_free(tl->thumb_path);
 657                         tl->thumb_path = nullptr;
 658                         }
 659
 660                 if (thumb_loader_std_setup(tl, tl->fd)) return TRUE;
 661                 }
 662
 663         thumb_loader_std_save(tl, nullptr);
 664         return FALSE;
 665 }
 666
 667 static void thumb_loader_std_done_cb(ImageLoader *il, gpointer data)
 668 {
 669         auto tl = static_cast<ThumbLoaderStd *>(data);
 670         GdkPixbuf *pixbuf;
 671
 672         DEBUG_1("thumb image done: %s", tl->fd ? tl->fd->path : "???");
 673         DEBUG_1("            from: %s", image_loader_get_fd(tl->il)->path);
 674
 675         pixbuf = image_loader_get_pixbuf(tl->il);
 676         if (!pixbuf)
 677                 {
 678                 DEBUG_1("...but no pixbuf");
 679                 thumb_loader_std_error_cb(il, data);
 680                 return;
 681                 }
 682
 683         if (tl->thumb_path && !thumb_loader_std_validate(tl, pixbuf))
 684                 {
 685                 if (thumb_loader_std_next_source(tl, TRUE)) return;
 686
 687                 if (tl->func_error) tl->func_error(tl, tl->data);
 688                 return;
 689                 }
 690
 691         tl->cache_hit = (tl->thumb_path != nullptr);
 692
 693         if (tl->fd)
 694                 {
 695                 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 696                 tl->fd->thumb_pixbuf = thumb_loader_std_finish(tl, pixbuf, image_loader_get_shrunk(il));
 697                 }
 698
 699         if (tl->func_done) tl->func_done(tl, tl->data);
 700 }
 701
 702 static void thumb_loader_std_error_cb(ImageLoader *il, gpointer data)
 703 {
 704         auto tl = static_cast<ThumbLoaderStd *>(data);
 705
 706         /* if at least some of the image is available, go to done */
 707         if (image_loader_get_pixbuf(tl->il) != nullptr)
 708                 {
 709                 thumb_loader_std_done_cb(il, data);
 710                 return;
 711                 }
 712
 713         DEBUG_1("thumb image error: %s", tl->fd->path);
 714         DEBUG_1("             from: %s", image_loader_get_fd(tl->il)->path);
 715
 716         if (thumb_loader_std_next_source(tl, TRUE)) return;
 717
 718         thumb_loader_std_set_fallback(tl);
 719
 720         if (tl->func_error) tl->func_error(tl, tl->data);
 721 }
 722
 723 static void thumb_loader_std_progress_cb(ImageLoader *UNUSED(il), gdouble percent, gpointer data)
 724 {
 725         auto tl = static_cast<ThumbLoaderStd *>(data);
 726
 727         tl->progress = percent;
 728
 729         if (tl->func_progress) tl->func_progress(tl, tl->data);
 730 }
 731
 732 static gboolean thumb_loader_std_setup(ThumbLoaderStd *tl, FileData *fd)
 733 {
 734         tl->il = image_loader_new(fd);
 735         image_loader_set_priority(tl->il, G_PRIORITY_LOW);
 736
 737         /* this will speed up jpegs by up to 3x in some cases */
 738         if (tl->requested_width <= THUMB_SIZE_NORMAL &&
 739             tl->requested_height <= THUMB_SIZE_NORMAL)
 740                 {
 741                 image_loader_set_requested_size(tl->il, THUMB_SIZE_NORMAL, THUMB_SIZE_NORMAL);
 742                 }
 743         else
 744                 {
 745                 image_loader_set_requested_size(tl->il, THUMB_SIZE_LARGE, THUMB_SIZE_LARGE);
 746                 }
 747
 748         g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_std_error_cb, tl);
 749         if (tl->func_progress)
 750                 {
 751                 g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_std_progress_cb, tl);
 752                 }
 753         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_std_done_cb, tl);
 754
 755         if (image_loader_start(tl->il))
 756                 {
 757                 return TRUE;
 758                 }
 759
 760         image_loader_free(tl->il);
 761         tl->il = nullptr;
 762         return FALSE;
 763 }
 764
 765 /*
 766  * Note: Currently local_cache only specifies where to save a _new_ thumb, if
 767  *       a valid existing thumb is found anywhere the local thumb will not be created.
 768  */
 769 void thumb_loader_std_set_cache(ThumbLoaderStd *tl, gboolean enable_cache, gboolean local, gboolean retry_failed)
 770 {
 771         if (!tl) return;
 772
 773         tl->cache_enable = enable_cache;
 774         tl->cache_local = local;
 775         tl->cache_retry = retry_failed;
 776 }
 777
 778 gboolean thumb_loader_std_start(ThumbLoaderStd *tl, FileData *fd)
 779 {
 780         static gchar *thumb_cache = nullptr;
 781         struct stat st;
 782
 783         if (!tl || !fd) return FALSE;
 784
 785         thumb_loader_std_reset(tl);
 786
 787
 788         tl->fd = file_data_ref(fd);
 789         if (!stat_utf8(fd->path, &st) || (tl->fd->format_class != FORMAT_CLASS_IMAGE && tl->fd->format_class != FORMAT_CLASS_RAWIMAGE && tl->fd->format_class != FORMAT_CLASS_VIDEO && tl->fd->format_class != FORMAT_CLASS_COLLECTION && tl->fd->format_class != FORMAT_CLASS_DOCUMENT && !options->file_filter.disable))
 790                 {
 791                 thumb_loader_std_set_fallback(tl);
 792                 return FALSE;
 793                 }
 794         tl->source_mtime = st.st_mtime;
 795         tl->source_size = st.st_size;
 796         tl->source_mode = st.st_mode;
 797
 798         if (!thumb_cache)
 799                 {
 800                 thumb_cache = g_strdup(get_thumbnails_standard_cache_dir());
 801                 }
 802
 803         if (strncmp(tl->fd->path, thumb_cache, strlen(thumb_cache)) != 0)
 804                 {
 805                 gchar *pathl;
 806
 807                 pathl = path_from_utf8(fd->path);
 808                 tl->thumb_uri = g_filename_to_uri(pathl, nullptr, nullptr);
 809                 tl->local_uri = filename_from_path(tl->thumb_uri);
 810                 g_free(pathl);
 811                 }
 812
 813         if (tl->cache_enable)
 814                 {
 815                 gint found;
 816
 817                 tl->thumb_path = thumb_loader_std_cache_path(tl, FALSE, nullptr, FALSE);
 818                 tl->thumb_path_local = FALSE;
 819
 820                 found = isfile(tl->thumb_path);
 821                 if (found)
 822                         {
 823                         FileData *fd = file_data_new_no_grouping(tl->thumb_path);
 824                         if (thumb_loader_std_setup(tl, fd))
 825                                 {
 826                                 file_data_unref(fd);
 827                                 return TRUE;
 828                                 }
 829                         file_data_unref(fd);
 830                         }
 831
 832                 if (thumb_loader_std_fail_check(tl) ||
 833                     !thumb_loader_std_next_source(tl, found))
 834                         {
 835                         thumb_loader_std_set_fallback(tl);
 836                         return FALSE;
 837                         }
 838                 return TRUE;
 839                 }
 840
 841         if (!thumb_loader_std_setup(tl, tl->fd))
 842                 {
 843                 thumb_loader_std_save(tl, nullptr);
 844                 thumb_loader_std_set_fallback(tl);
 845                 return FALSE;
 846                 }
 847
 848         return TRUE;
 849 }
 850
 851 void thumb_loader_std_free(ThumbLoaderStd *tl)
 852 {
 853         if (!tl) return;
 854
 855         thumb_loader_std_reset(tl);
 856         g_free(tl);
 857 }
 858
 859 GdkPixbuf *thumb_loader_std_get_pixbuf(ThumbLoaderStd *tl)
 860 {
 861         GdkPixbuf *pixbuf;
 862
 863         if (tl && tl->fd && tl->fd->thumb_pixbuf)
 864                 {
 865                 pixbuf = tl->fd->thumb_pixbuf;
 866                 g_object_ref(pixbuf);
 867                 }
 868         else
 869                 {
 870                 pixbuf = pixbuf_fallback(nullptr, tl->requested_width, tl->requested_height);
 871                 }
 872
 873         return pixbuf;
 874 }
 875
 876
 877 struct ThumbValidate
 878 {
 879         ThumbLoaderStd *tl;
 880         gchar *path;
 881         gint days;
 882
 883         void (*func_valid)(const gchar *path, gboolean valid, gpointer data);
 884         gpointer data;
 885
 886         guint idle_id; /* event source id */
 887 };
 888
 889 static void thumb_loader_std_thumb_file_validate_free(ThumbValidate *tv)
 890 {
 891         thumb_loader_std_free(tv->tl);
 892         g_free(tv->path);
 893         g_free(tv);
 894 }
 895
 896 void thumb_loader_std_thumb_file_validate_cancel(ThumbLoaderStd *tl)
 897 {
 898         ThumbValidate *tv;
 899
 900         if (!tl) return;
 901
 902         tv = static_cast<ThumbValidate *>(tl->data);
 903
 904         if (tv->idle_id)
 905                 {
 906                 g_source_remove(tv->idle_id);
 907                 tv->idle_id = 0;
 908                 }
 909
 910         thumb_loader_std_thumb_file_validate_free(tv);
 911 }
 912
 913 static void thumb_loader_std_thumb_file_validate_finish(ThumbValidate *tv, gboolean valid)
 914 {
 915         if (tv->func_valid) tv->func_valid(tv->path, valid, tv->data);
 916
 917         thumb_loader_std_thumb_file_validate_free(tv);
 918 }
 919
 920 static void thumb_loader_std_thumb_file_validate_done_cb(ThumbLoaderStd *UNUSED(tl), gpointer data)
 921 {
 922         auto tv = static_cast<ThumbValidate *>(data);
 923         GdkPixbuf *pixbuf;
 924         gboolean valid = FALSE;
 925
 926         /* get the original thumbnail pixbuf (unrotated, with original options)
 927            this is called from image_loader done callback, so tv->tl->il must exist*/
 928         pixbuf = image_loader_get_pixbuf(tv->tl->il);
 929         if (pixbuf)
 930                 {
 931                 const gchar *uri;
 932                 const gchar *mtime_str;
 933
 934                 uri = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_URI);
 935                 mtime_str = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_MTIME);
 936                 if (uri && mtime_str)
 937                         {
 938                         if (strncmp(uri, "file:", strlen("file:")) == 0)
 939                                 {
 940                                 struct stat st;
 941                                 gchar *target;
 942
 943                                 target = g_filename_from_uri(uri, nullptr, nullptr);
 944                                 if (stat(target, &st) == 0 &&
 945                                     st.st_mtime == strtol(mtime_str, nullptr, 10))
 946                                         {
 947                                         valid = TRUE;
 948                                         }
 949                                 g_free(target);
 950                                 }
 951                         else
 952                                 {
 953                                 struct stat st;
 954
 955                                 DEBUG_1("thumb uri foreign, doing day check: %s", uri);
 956
 957                                 if (stat_utf8(tv->path, &st))
 958                                         {
 959                                         time_t now;
 960
 961                                         now = time(nullptr);
 962                                         if (st.st_atime >= now - static_cast<time_t>(tv->days) * 24 * 60 * 60)
 963                                                 {
 964                                                 valid = TRUE;
 965                                                 }
 966                                         }
 967                                 }
 968                         }
 969                 else
 970                         {
 971                         DEBUG_1("invalid image found in std cache: %s", tv->path);
 972                         }
 973                 }
 974
 975         thumb_loader_std_thumb_file_validate_finish(tv, valid);
 976 }
 977
 978 static void thumb_loader_std_thumb_file_validate_error_cb(ThumbLoaderStd *UNUSED(tl), gpointer data)
 979 {
 980         auto tv = static_cast<ThumbValidate *>(data);
 981
 982         thumb_loader_std_thumb_file_validate_finish(tv, FALSE);
 983 }
 984
 985 static gboolean thumb_loader_std_thumb_file_validate_idle_cb(gpointer data)
 986 {
 987         auto tv = static_cast<ThumbValidate *>(data);
 988
 989         tv->idle_id = 0;
 990         thumb_loader_std_thumb_file_validate_finish(tv, FALSE);
 991
 992         return G_SOURCE_REMOVE;
 993 }
 994
 995 ThumbLoaderStd *thumb_loader_std_thumb_file_validate(const gchar *thumb_path, gint allowed_days,
 996                                                      void (*func_valid)(const gchar *path, gboolean valid, gpointer data),
 997                                                      gpointer data)
 998 {
 999         ThumbValidate *tv;
1000
1001         tv = g_new0(ThumbValidate, 1);
1002
1003         tv->tl = thumb_loader_std_new(THUMB_SIZE_LARGE, THUMB_SIZE_LARGE);
1004         thumb_loader_std_set_callbacks(tv->tl,
1005                                        thumb_loader_std_thumb_file_validate_done_cb,
1006                                        thumb_loader_std_thumb_file_validate_error_cb,
1007                                        nullptr,
1008                                        tv);
1009         thumb_loader_std_reset(tv->tl);
1010
1011         tv->path = g_strdup(thumb_path);
1012         tv->days = allowed_days;
1013         tv->func_valid = func_valid;
1014         tv->data = data;
1015
1016         FileData *fd = file_data_new_no_grouping(thumb_path);
1017         if (!thumb_loader_std_setup(tv->tl, fd))
1018                 {
1019                 tv->idle_id = g_idle_add(thumb_loader_std_thumb_file_validate_idle_cb, tv);
1020                 }
1021         else
1022                 {
1023                 tv->idle_id = 0;
1024                 }
1025
1026         file_data_unref(fd);
1027         return tv->tl;
1028 }
1029
1030 static void thumb_std_maint_remove_one(const gchar *source, const gchar *uri, gboolean local,
1031                                        const gchar *subfolder)
1032 {
1033         gchar *thumb_path;
1034
1035         thumb_path = thumb_std_cache_path(source,
1036                                           (local) ? filename_from_path(uri) : uri,
1037                                           local, subfolder);
1038         if (isfile(thumb_path))
1039                 {
1040                 DEBUG_1("thumb removing: %s", thumb_path);
1041                 unlink_file(thumb_path);
1042                 }
1043         g_free(thumb_path);
1044 }
1045
1046 /* this also removes local thumbnails (the source is gone so it makes sense) */
1047 void thumb_std_maint_removed(const gchar *source)
1048 {
1049         gchar *uri;
1050         gchar *sourcel;
1051
1052         sourcel = path_from_utf8(source);
1053         uri = g_filename_to_uri(sourcel, nullptr, nullptr);
1054         g_free(sourcel);
1055
1056         /* all this to remove a thumbnail? */
1057
1058         thumb_std_maint_remove_one(source, uri, FALSE, THUMB_FOLDER_NORMAL);
1059         thumb_std_maint_remove_one(source, uri, FALSE, THUMB_FOLDER_LARGE);
1060         thumb_std_maint_remove_one(source, uri, FALSE, THUMB_FOLDER_FAIL);
1061         thumb_std_maint_remove_one(source, uri, TRUE, THUMB_FOLDER_NORMAL);
1062         thumb_std_maint_remove_one(source, uri, TRUE, THUMB_FOLDER_LARGE);
1063
1064         g_free(uri);
1065 }
1066
1067 struct TMaintMove
1068 {
1069         gchar *source;
1070         gchar *dest;
1071
1072         ThumbLoaderStd *tl;
1073         gchar *source_uri;
1074         gchar *thumb_path;
1075
1076         gint pass;
1077 };
1078
1079 static GList *thumb_std_maint_move_list = nullptr;
1080 static GList *thumb_std_maint_move_tail = nullptr;
1081
1082
1083 static void thumb_std_maint_move_step(TMaintMove *tm);
1084 static gboolean thumb_std_maint_move_idle(gpointer data);
1085
1086
1087 static void thumb_std_maint_move_validate_cb(const gchar *UNUSED(path), gboolean UNUSED(valid), gpointer data)
1088 {
1089         auto tm = static_cast<TMaintMove *>(data);
1090         GdkPixbuf *pixbuf;
1091
1092         /* get the original thumbnail pixbuf (unrotated, with original options)
1093            this is called from image_loader done callback, so tm->tl->il must exist*/
1094         pixbuf = image_loader_get_pixbuf(tm->tl->il);
1095         if (pixbuf)
1096                 {
1097                 const gchar *uri;
1098                 const gchar *mtime_str;
1099
1100                 uri = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_URI);
1101                 mtime_str = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_MTIME);
1102
1103                 if (uri && mtime_str && strcmp(uri, tm->source_uri) == 0)
1104                         {
1105                         gchar *pathl;
1106
1107                         /* The validation utility abuses ThumbLoader, and we
1108                          * abuse the utility just to load the thumbnail,
1109                          * but the loader needs to look sane for the save to complete.
1110                          */
1111
1112                         tm->tl->cache_enable = TRUE;
1113                         tm->tl->cache_hit = FALSE;
1114                         tm->tl->cache_local = FALSE;
1115                         file_data_unref(tm->tl->fd);
1116                         tm->tl->fd = file_data_new_group(tm->dest);
1117                         tm->tl->source_mtime = strtol(mtime_str, nullptr, 10);
1118
1119                         pathl = path_from_utf8(tm->tl->fd->path);
1120                         g_free(tm->tl->thumb_uri);
1121                         tm->tl->thumb_uri = g_filename_to_uri(pathl, nullptr, nullptr);
1122                         tm->tl->local_uri = filename_from_path(tm->tl->thumb_uri);
1123                         g_free(pathl);
1124
1125                         g_free(tm->tl->thumb_path);
1126                         tm->tl->thumb_path = nullptr;
1127                         tm->tl->thumb_path_local = FALSE;
1128
1129                         DEBUG_1("thumb move attempting save:");
1130
1131                         thumb_loader_std_save(tm->tl, pixbuf);
1132                         }
1133
1134                 DEBUG_1("thumb move unlink: %s", tm->thumb_path);
1135                 unlink_file(tm->thumb_path);
1136                 }
1137
1138         thumb_std_maint_move_step(tm);
1139 }
1140
1141 static void thumb_std_maint_move_step(TMaintMove *tm)
1142 {
1143         const gchar *folder;
1144
1145         tm->pass++;
1146         if (tm->pass > 2)
1147                 {
1148                 g_free(tm->source);
1149                 g_free(tm->dest);
1150                 g_free(tm->source_uri);
1151                 g_free(tm->thumb_path);
1152                 g_free(tm);
1153
1154                 if (thumb_std_maint_move_list)
1155                         {
1156                         g_idle_add_full(G_PRIORITY_LOW, thumb_std_maint_move_idle, nullptr, nullptr);
1157                         }
1158
1159                 return;
1160                 }
1161
1162         folder = (tm->pass == 1) ? THUMB_FOLDER_NORMAL : THUMB_FOLDER_LARGE;
1163
1164         g_free(tm->thumb_path);
1165         tm->thumb_path = thumb_std_cache_path(tm->source, tm->source_uri, FALSE, folder);
1166         tm->tl = thumb_loader_std_thumb_file_validate(tm->thumb_path, 0,
1167                                                       thumb_std_maint_move_validate_cb, tm);
1168 }
1169
1170 static gboolean thumb_std_maint_move_idle(gpointer UNUSED(data))
1171 {
1172         TMaintMove *tm;
1173         gchar *pathl;
1174
1175         if (!thumb_std_maint_move_list) return G_SOURCE_REMOVE;
1176
1177         tm = static_cast<TMaintMove *>(thumb_std_maint_move_list->data);
1178
1179         thumb_std_maint_move_list = g_list_remove(thumb_std_maint_move_list, tm);
1180         if (!thumb_std_maint_move_list) thumb_std_maint_move_tail = nullptr;
1181
1182         pathl = path_from_utf8(tm->source);
1183         tm->source_uri = g_filename_to_uri(pathl, nullptr, nullptr);
1184         g_free(pathl);
1185
1186         tm->pass = 0;
1187
1188         thumb_std_maint_move_step(tm);
1189
1190         return G_SOURCE_REMOVE;
1191 }
1192
1193 /* This will schedule a move of the thumbnail for source image to dest when idle.
1194  * We do this so that file renaming or moving speed is not sacrificed by
1195  * moving the thumbnails at the same time because:
1196  *
1197  * This cache design requires the tedious task of loading the png thumbnails and saving them.
1198  *
1199  * The thumbnails are processed when the app is idle. If the app
1200  * exits early well too bad - they can simply be regenerated from scratch.
1201  */
1202 /** @FIXME This does not manage local thumbnails (fixme ?)
1203  */
1204 void thumb_std_maint_moved(const gchar *source, const gchar *dest)
1205 {
1206         TMaintMove *tm;
1207
1208         tm = g_new0(TMaintMove, 1);
1209         tm->source = g_strdup(source);
1210         tm->dest = g_strdup(dest);
1211
1212         if (!thumb_std_maint_move_list)
1213                 {
1214                 g_idle_add_full(G_PRIORITY_LOW, thumb_std_maint_move_idle, nullptr, nullptr);
1215                 }
1216
1217         if (thumb_std_maint_move_tail)
1218                 {
1219                 thumb_std_maint_move_tail = g_list_append(thumb_std_maint_move_tail, tm);
1220                 thumb_std_maint_move_tail = thumb_std_maint_move_tail->next;
1221                 }
1222         else
1223                 {
1224                 thumb_std_maint_move_list = g_list_append(thumb_std_maint_move_list, tm);
1225                 thumb_std_maint_move_tail = thumb_std_maint_move_list;
1226                 }
1227 }
1228 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */