src/thumb_standard.c

   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 = NULL;
 114
 115         file_data_unref(tl->fd);
 116         tl->fd = NULL;
 117
 118         g_free(tl->thumb_path);
 119         tl->thumb_path = NULL;
 120
 121         g_free(tl->thumb_uri);
 122         tl->thumb_uri = NULL;
 123         tl->local_uri = NULL;
 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 = NULL;
 140         gchar *md5_text;
 141         guchar digest[16];
 142         gchar *name;
 143
 144         if (!path || !uri || !cache_subfolder) return NULL;
 145
 146         md5_get_digest((guchar *)uri, strlen(uri), digest);
 147         md5_text = md5_digest_to_text(digest);
 148
 149         if (!md5_text) return NULL;
 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 NULL;
 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, NULL, TRUE);
 214         if (isfile(fail_path))
 215                 {
 216                 GdkPixbuf *pixbuf;
 217
 218                 if (tl->cache_retry)
 219                         {
 220                         pixbuf = NULL;
 221                         }
 222                 else
 223                         {
 224                         gchar *pathl;
 225
 226                         pathl = path_from_utf8(fail_path);
 227                         pixbuf = gdk_pixbuf_new_from_file(pathl, NULL);
 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, NULL, 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, NULL, 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", (unsigned long long)tl->source_mtime);
 354                 pathl = path_from_utf8(tmp_path);
 355                 success = gdk_pixbuf_save(pixbuf, pathl, "png", NULL,
 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 = NULL;
 392         ExifData *exif = NULL;
 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 = NULL;
 397         guchar *profile = NULL;
 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                 profile = exif_get_color_profile(exif, &profile_len);
 414                 if (profile)
 415                         {
 416                         DEBUG_1("Found embedded color profile");
 417                         color_profile_from_image = COLOR_PROFILE_MEM;
 418                         }
 419                 else
 420                         {
 421                         gchar *interop_index = exif_get_data_as_text(exif, "Exif.Iop.InteroperabilityIndex");
 422
 423                         if (interop_index)
 424                                 {
 425                                 /* Exif 2.21 specification */
 426                                 if (!strcmp(interop_index, "R98"))
 427                                         {
 428                                         color_profile_from_image = COLOR_PROFILE_SRGB;
 429                                         DEBUG_1("Found EXIF 2.21 ColorSpace of sRGB");
 430                                         }
 431                                 else if (!strcmp(interop_index, "R03"))
 432                                         {
 433                                         color_profile_from_image = COLOR_PROFILE_ADOBERGB;
 434                                         DEBUG_1("Found EXIF 2.21 ColorSpace of AdobeRGB");
 435                                         }
 436                                 g_free(interop_index);
 437                                 }
 438                         else
 439                                 {
 440                                 gint cs;
 441
 442                                 /* ColorSpace == 1 specifies sRGB per EXIF 2.2 */
 443                                 if (!exif_get_integer(exif, "Exif.Photo.ColorSpace", &cs)) cs = 0;
 444                                 if (cs == 1)
 445                                         {
 446                                         color_profile_from_image = COLOR_PROFILE_SRGB;
 447                                         DEBUG_1("Found EXIF 2.2 ColorSpace of sRGB");
 448                                         }
 449                                 else if (cs == 2)
 450                                         {
 451                                         /* non-standard way of specifying AdobeRGB (used by some software) */
 452                                         color_profile_from_image = COLOR_PROFILE_ADOBERGB;
 453                                         DEBUG_1("Found EXIF 2.2 ColorSpace of AdobeRGB");
 454                                         }
 455                                 }
 456                         }
 457
 458                 if(color_profile_from_image != COLOR_PROFILE_NONE)
 459                         {
 460                                 // transform image, we always use sRGB as target for thumbnails
 461                                 screen_type = COLOR_PROFILE_SRGB;
 462
 463                                 if (profile)
 464                                         {
 465                                         cm = color_man_new_embedded(NULL, pixbuf,
 466                                                                         profile, profile_len,
 467                                                                         screen_type, NULL, NULL, 0);
 468                                         g_free(profile);
 469                                         }
 470                                 else
 471                                         {
 472                                         cm = color_man_new(NULL, pixbuf,
 473                                                         input_type, input_file,
 474                                                         screen_type, NULL, NULL, 0);
 475                                         }
 476
 477                                 if(cm) {
 478                                         color_man_correct_region(cm, cm->pixbuf, 0, 0, sw, sh);
 479                                         g_free(cm);
 480                                 }
 481
 482                         }
 483                 exif_free_fd(fd, exif);
 484                 }
 485 }
 486
 487 static GdkPixbuf *thumb_loader_std_finish(ThumbLoaderStd *tl, GdkPixbuf *pixbuf, gboolean shrunk)
 488 {
 489         GdkPixbuf *pixbuf_thumb = NULL;
 490         GdkPixbuf *result;
 491         GdkPixbuf *rotated = NULL;
 492         gint sw, sh;
 493
 494
 495         if (!tl->cache_hit && options->image.exif_rotate_enable)
 496                 {
 497                 if (!tl->fd->exif_orientation)
 498                         {
 499                         if (g_strcmp0(tl->fd->format_name, "heif") != 0)
 500                                 {
 501                                 tl->fd->exif_orientation = metadata_read_int(tl->fd, ORIENTATION_KEY, EXIF_ORIENTATION_TOP_LEFT);
 502                                 }
 503                         else
 504                                 {
 505                                 tl->fd->exif_orientation = EXIF_ORIENTATION_TOP_LEFT;
 506                                 }
 507                         }
 508
 509                 if (tl->fd->exif_orientation != EXIF_ORIENTATION_TOP_LEFT)
 510                         {
 511                         rotated = pixbuf_apply_orientation(pixbuf, tl->fd->exif_orientation);
 512                         pixbuf = rotated;
 513                         }
 514                 }
 515
 516         sw = gdk_pixbuf_get_width(pixbuf);
 517         sh = gdk_pixbuf_get_height(pixbuf);
 518
 519         if (tl->cache_enable)
 520                 {
 521                 if (!tl->cache_hit)
 522                         {
 523                         gint cache_w, cache_h;
 524
 525                         if (tl->requested_width > THUMB_SIZE_NORMAL || tl->requested_height > THUMB_SIZE_NORMAL)
 526                                 {
 527                                 cache_w = cache_h = THUMB_SIZE_LARGE;
 528                                 }
 529                         else
 530                                 {
 531                                 cache_w = cache_h = THUMB_SIZE_NORMAL;
 532                                 }
 533
 534                         if (sw > cache_w || sh > cache_h || shrunk)
 535                                 {
 536                                 gint thumb_w, thumb_h;
 537                                 struct stat st;
 538
 539                                 if (pixbuf_scale_aspect(cache_w, cache_h, sw, sh,
 540                                                                   &thumb_w, &thumb_h))
 541                                         {
 542                                         pixbuf_thumb = gdk_pixbuf_scale_simple(pixbuf, thumb_w, thumb_h,
 543                                                                                (GdkInterpType)options->thumbnails.quality);
 544                                         }
 545                                 else
 546                                         {
 547                                         pixbuf_thumb = pixbuf;
 548                                         g_object_ref(G_OBJECT(pixbuf_thumb));
 549                                         }
 550
 551                                 /* do not save the thumbnail if the source file has changed meanwhile -
 552                                    the thumbnail is most probably broken */
 553                                 if (stat_utf8(tl->fd->path, &st) &&
 554                                     tl->source_mtime == st.st_mtime &&
 555                                     tl->source_size == st.st_size)
 556                                         {
 557                                         thumb_loader_std_save(tl, pixbuf_thumb);
 558                                         }
 559                                 }
 560                         }
 561                 else if (tl->cache_hit &&
 562                          tl->cache_local && !tl->thumb_path_local)
 563                         {
 564                         /* A local cache save was requested, but a valid thumb is in $HOME,
 565                          * so specifically save as a local thumbnail.
 566                          */
 567                         g_free(tl->thumb_path);
 568                         tl->thumb_path = NULL;
 569
 570                         tl->cache_hit = FALSE;
 571
 572                         DEBUG_1("thumb copied: %s", tl->fd->path);
 573
 574                         thumb_loader_std_save(tl, pixbuf);
 575                         }
 576                 }
 577
 578         if (sw <= tl->requested_width && sh <= tl->requested_height)
 579                 {
 580                 result = pixbuf;
 581                 g_object_ref(result);
 582                 }
 583         else
 584                 {
 585                 gint thumb_w, thumb_h;
 586
 587                 if (pixbuf_thumb)
 588                         {
 589                         pixbuf = pixbuf_thumb;
 590                         sw = gdk_pixbuf_get_width(pixbuf);
 591                         sh = gdk_pixbuf_get_height(pixbuf);
 592                         }
 593
 594                 if (pixbuf_scale_aspect(tl->requested_width, tl->requested_height, sw, sh,
 595                                                   &thumb_w, &thumb_h))
 596                         {
 597                         result = gdk_pixbuf_scale_simple(pixbuf, thumb_w, thumb_h,
 598                                                          (GdkInterpType)options->thumbnails.quality);
 599                         }
 600                 else
 601                         {
 602                         result = pixbuf;
 603                         g_object_ref(result);
 604                         }
 605                 }
 606
 607         // apply color correction, if required
 608         thumb_loader_std_calibrate_pixbuf(tl->fd, result);
 609
 610         if (pixbuf_thumb) g_object_unref(pixbuf_thumb);
 611         if (rotated) g_object_unref(rotated);
 612
 613         return result;
 614 }
 615
 616 static gboolean thumb_loader_std_next_source(ThumbLoaderStd *tl, gboolean remove_broken)
 617 {
 618         image_loader_free(tl->il);
 619         tl->il = NULL;
 620
 621         if (tl->thumb_path)
 622                 {
 623                 if (!tl->thumb_path_local && remove_broken)
 624                         {
 625                         DEBUG_1("thumb broken, unlinking: %s", tl->thumb_path);
 626                         unlink_file(tl->thumb_path);
 627                         }
 628
 629                 g_free(tl->thumb_path);
 630                 tl->thumb_path = NULL;
 631
 632                 if (!tl->thumb_path_local)
 633                         {
 634                         tl->thumb_path = thumb_loader_std_cache_path(tl, TRUE, NULL, FALSE);
 635                         if (isfile(tl->thumb_path))
 636                                 {
 637                                 FileData *fd = file_data_new_no_grouping(tl->thumb_path);
 638                                 if (thumb_loader_std_setup(tl, fd))
 639                                         {
 640                                         file_data_unref(fd);
 641                                         tl->thumb_path_local = TRUE;
 642                                         return TRUE;
 643                                         }
 644                                 file_data_unref(fd);
 645                                 }
 646
 647                         g_free(tl->thumb_path);
 648                         tl->thumb_path = NULL;
 649                         }
 650
 651                 if (thumb_loader_std_setup(tl, tl->fd)) return TRUE;
 652                 }
 653
 654         thumb_loader_std_save(tl, NULL);
 655         return FALSE;
 656 }
 657
 658 static void thumb_loader_std_done_cb(ImageLoader *il, gpointer data)
 659 {
 660         ThumbLoaderStd *tl = data;
 661         GdkPixbuf *pixbuf;
 662
 663         DEBUG_1("thumb image done: %s", tl->fd ? tl->fd->path : "???");
 664         DEBUG_1("            from: %s", image_loader_get_fd(tl->il)->path);
 665
 666         pixbuf = image_loader_get_pixbuf(tl->il);
 667         if (!pixbuf)
 668                 {
 669                 DEBUG_1("...but no pixbuf");
 670                 thumb_loader_std_error_cb(il, data);
 671                 return;
 672                 }
 673
 674         if (tl->thumb_path && !thumb_loader_std_validate(tl, pixbuf))
 675                 {
 676                 if (thumb_loader_std_next_source(tl, TRUE)) return;
 677
 678                 if (tl->func_error) tl->func_error(tl, tl->data);
 679                 return;
 680                 }
 681
 682         tl->cache_hit = (tl->thumb_path != NULL);
 683
 684         if (tl->fd)
 685                 {
 686                 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 687                 tl->fd->thumb_pixbuf = thumb_loader_std_finish(tl, pixbuf, image_loader_get_shrunk(il));
 688                 }
 689
 690         if (tl->func_done) tl->func_done(tl, tl->data);
 691 }
 692
 693 static void thumb_loader_std_error_cb(ImageLoader *il, gpointer data)
 694 {
 695         ThumbLoaderStd *tl = data;
 696
 697         /* if at least some of the image is available, go to done */
 698         if (image_loader_get_pixbuf(tl->il) != NULL)
 699                 {
 700                 thumb_loader_std_done_cb(il, data);
 701                 return;
 702                 }
 703
 704         DEBUG_1("thumb image error: %s", tl->fd->path);
 705         DEBUG_1("             from: %s", image_loader_get_fd(tl->il)->path);
 706
 707         if (thumb_loader_std_next_source(tl, TRUE)) return;
 708
 709         thumb_loader_std_set_fallback(tl);
 710
 711         if (tl->func_error) tl->func_error(tl, tl->data);
 712 }
 713
 714 static void thumb_loader_std_progress_cb(ImageLoader *il, gdouble percent, gpointer data)
 715 {
 716         ThumbLoaderStd *tl = data;
 717
 718         tl->progress = (gdouble)percent;
 719
 720         if (tl->func_progress) tl->func_progress(tl, tl->data);
 721 }
 722
 723 static gboolean thumb_loader_std_setup(ThumbLoaderStd *tl, FileData *fd)
 724 {
 725         tl->il = image_loader_new(fd);
 726         image_loader_set_priority(tl->il, G_PRIORITY_LOW);
 727
 728         /* this will speed up jpegs by up to 3x in some cases */
 729         if (tl->requested_width <= THUMB_SIZE_NORMAL &&
 730             tl->requested_height <= THUMB_SIZE_NORMAL)
 731                 {
 732                 image_loader_set_requested_size(tl->il, THUMB_SIZE_NORMAL, THUMB_SIZE_NORMAL);
 733                 }
 734         else
 735                 {
 736                 image_loader_set_requested_size(tl->il, THUMB_SIZE_LARGE, THUMB_SIZE_LARGE);
 737                 }
 738
 739         g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_std_error_cb, tl);
 740         if (tl->func_progress)
 741                 {
 742                 g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_std_progress_cb, tl);
 743                 }
 744         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_std_done_cb, tl);
 745
 746         if (image_loader_start(tl->il))
 747                 {
 748                 return TRUE;
 749                 }
 750
 751         image_loader_free(tl->il);
 752         tl->il = NULL;
 753         return FALSE;
 754 }
 755
 756 /*
 757  * Note: Currently local_cache only specifies where to save a _new_ thumb, if
 758  *       a valid existing thumb is found anywhere the local thumb will not be created.
 759  */
 760 void thumb_loader_std_set_cache(ThumbLoaderStd *tl, gboolean enable_cache, gboolean local, gboolean retry_failed)
 761 {
 762         if (!tl) return;
 763
 764         tl->cache_enable = enable_cache;
 765         tl->cache_local = local;
 766         tl->cache_retry = retry_failed;
 767 }
 768
 769 gboolean thumb_loader_std_start(ThumbLoaderStd *tl, FileData *fd)
 770 {
 771         static gchar *thumb_cache = NULL;
 772         struct stat st;
 773
 774         if (!tl || !fd) return FALSE;
 775
 776         thumb_loader_std_reset(tl);
 777
 778
 779         tl->fd = file_data_ref(fd);
 780         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))
 781                 {
 782                 thumb_loader_std_set_fallback(tl);
 783                 return FALSE;
 784                 }
 785         tl->source_mtime = st.st_mtime;
 786         tl->source_size = st.st_size;
 787         tl->source_mode = st.st_mode;
 788
 789         if (!thumb_cache)
 790                 {
 791                 thumb_cache = g_strdup(get_thumbnails_standard_cache_dir());
 792                 }
 793
 794         if (strncmp(tl->fd->path, thumb_cache, strlen(thumb_cache)) != 0)
 795                 {
 796                 gchar *pathl;
 797
 798                 pathl = path_from_utf8(fd->path);
 799                 tl->thumb_uri = g_filename_to_uri(pathl, NULL, NULL);
 800                 tl->local_uri = filename_from_path(tl->thumb_uri);
 801                 g_free(pathl);
 802                 }
 803
 804         if (tl->cache_enable)
 805                 {
 806                 gint found;
 807
 808                 tl->thumb_path = thumb_loader_std_cache_path(tl, FALSE, NULL, FALSE);
 809                 tl->thumb_path_local = FALSE;
 810
 811                 found = isfile(tl->thumb_path);
 812                 if (found)
 813                         {
 814                         FileData *fd = file_data_new_no_grouping(tl->thumb_path);
 815                         if (thumb_loader_std_setup(tl, fd))
 816                                 {
 817                                 file_data_unref(fd);
 818                                 return TRUE;
 819                                 }
 820                         file_data_unref(fd);
 821                         }
 822
 823                 if (thumb_loader_std_fail_check(tl) ||
 824                     !thumb_loader_std_next_source(tl, found))
 825                         {
 826                         thumb_loader_std_set_fallback(tl);
 827                         return FALSE;
 828                         }
 829                 return TRUE;
 830                 }
 831
 832         if (!thumb_loader_std_setup(tl, tl->fd))
 833                 {
 834                 thumb_loader_std_save(tl, NULL);
 835                 thumb_loader_std_set_fallback(tl);
 836                 return FALSE;
 837                 }
 838
 839         return TRUE;
 840 }
 841
 842 void thumb_loader_std_free(ThumbLoaderStd *tl)
 843 {
 844         if (!tl) return;
 845
 846         thumb_loader_std_reset(tl);
 847         g_free(tl);
 848 }
 849
 850 GdkPixbuf *thumb_loader_std_get_pixbuf(ThumbLoaderStd *tl)
 851 {
 852         GdkPixbuf *pixbuf;
 853
 854         if (tl && tl->fd && tl->fd->thumb_pixbuf)
 855                 {
 856                 pixbuf = tl->fd->thumb_pixbuf;
 857                 g_object_ref(pixbuf);
 858                 }
 859         else
 860                 {
 861                 pixbuf = pixbuf_fallback(NULL, tl->requested_width, tl->requested_height);
 862                 }
 863
 864         return pixbuf;
 865 }
 866
 867
 868 typedef struct _ThumbValidate ThumbValidate;
 869 struct _ThumbValidate
 870 {
 871         ThumbLoaderStd *tl;
 872         gchar *path;
 873         gint days;
 874
 875         void (*func_valid)(const gchar *path, gboolean valid, gpointer data);
 876         gpointer data;
 877
 878         guint idle_id; /* event source id */
 879 };
 880
 881 static void thumb_loader_std_thumb_file_validate_free(ThumbValidate *tv)
 882 {
 883         thumb_loader_std_free(tv->tl);
 884         g_free(tv->path);
 885         g_free(tv);
 886 }
 887
 888 void thumb_loader_std_thumb_file_validate_cancel(ThumbLoaderStd *tl)
 889 {
 890         ThumbValidate *tv;
 891
 892         if (!tl) return;
 893
 894         tv = tl->data;
 895
 896         if (tv->idle_id)
 897                 {
 898                 g_source_remove(tv->idle_id);
 899                 tv->idle_id = 0;
 900                 }
 901
 902         thumb_loader_std_thumb_file_validate_free(tv);
 903 }
 904
 905 static void thumb_loader_std_thumb_file_validate_finish(ThumbValidate *tv, gboolean valid)
 906 {
 907         if (tv->func_valid) tv->func_valid(tv->path, valid, tv->data);
 908
 909         thumb_loader_std_thumb_file_validate_free(tv);
 910 }
 911
 912 static void thumb_loader_std_thumb_file_validate_done_cb(ThumbLoaderStd *tl, gpointer data)
 913 {
 914         ThumbValidate *tv = data;
 915         GdkPixbuf *pixbuf;
 916         gboolean valid = FALSE;
 917
 918         /* get the original thumbnail pixbuf (unrotated, with original options)
 919            this is called from image_loader done callback, so tv->tl->il must exist*/
 920         pixbuf = image_loader_get_pixbuf(tv->tl->il);
 921         if (pixbuf)
 922                 {
 923                 const gchar *uri;
 924                 const gchar *mtime_str;
 925
 926                 uri = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_URI);
 927                 mtime_str = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_MTIME);
 928                 if (uri && mtime_str)
 929                         {
 930                         if (strncmp(uri, "file:", strlen("file:")) == 0)
 931                                 {
 932                                 struct stat st;
 933                                 gchar *target;
 934
 935                                 target = g_filename_from_uri(uri, NULL, NULL);
 936                                 if (stat(target, &st) == 0 &&
 937                                     st.st_mtime == strtol(mtime_str, NULL, 10))
 938                                         {
 939                                         valid = TRUE;
 940                                         }
 941                                 g_free(target);
 942                                 }
 943                         else
 944                                 {
 945                                 struct stat st;
 946
 947                                 DEBUG_1("thumb uri foreign, doing day check: %s", uri);
 948
 949                                 if (stat_utf8(tv->path, &st))
 950                                         {
 951                                         time_t now;
 952
 953                                         now = time(NULL);
 954                                         if (st.st_atime >= now - (time_t)tv->days * 24 * 60 * 60)
 955                                                 {
 956                                                 valid = TRUE;
 957                                                 }
 958                                         }
 959                                 }
 960                         }
 961                 else
 962                         {
 963                         DEBUG_1("invalid image found in std cache: %s", tv->path);
 964                         }
 965                 }
 966
 967         thumb_loader_std_thumb_file_validate_finish(tv, valid);
 968 }
 969
 970 static void thumb_loader_std_thumb_file_validate_error_cb(ThumbLoaderStd *tl, gpointer data)
 971 {
 972         ThumbValidate *tv = data;
 973
 974         thumb_loader_std_thumb_file_validate_finish(tv, FALSE);
 975 }
 976
 977 static gboolean thumb_loader_std_thumb_file_validate_idle_cb(gpointer data)
 978 {
 979         ThumbValidate *tv = data;
 980
 981         tv->idle_id = 0;
 982         thumb_loader_std_thumb_file_validate_finish(tv, FALSE);
 983
 984         return FALSE;
 985 }
 986
 987 ThumbLoaderStd *thumb_loader_std_thumb_file_validate(const gchar *thumb_path, gint allowed_days,
 988                                                      void (*func_valid)(const gchar *path, gboolean valid, gpointer data),
 989                                                      gpointer data)
 990 {
 991         ThumbValidate *tv;
 992
 993         tv = g_new0(ThumbValidate, 1);
 994
 995         tv->tl = thumb_loader_std_new(THUMB_SIZE_LARGE, THUMB_SIZE_LARGE);
 996         thumb_loader_std_set_callbacks(tv->tl,
 997                                        thumb_loader_std_thumb_file_validate_done_cb,
 998                                        thumb_loader_std_thumb_file_validate_error_cb,
 999                                        NULL,
1000                                        tv);
1001         thumb_loader_std_reset(tv->tl);
1002
1003         tv->path = g_strdup(thumb_path);
1004         tv->days = allowed_days;
1005         tv->func_valid = func_valid;
1006         tv->data = data;
1007
1008         FileData *fd = file_data_new_no_grouping(thumb_path);
1009         if (!thumb_loader_std_setup(tv->tl, fd))
1010                 {
1011                 tv->idle_id = g_idle_add(thumb_loader_std_thumb_file_validate_idle_cb, tv);
1012                 }
1013         else
1014                 {
1015                 tv->idle_id = 0;
1016                 }
1017
1018         file_data_unref(fd);
1019         return tv->tl;
1020 }
1021
1022 static void thumb_std_maint_remove_one(const gchar *source, const gchar *uri, gboolean local,
1023                                        const gchar *subfolder)
1024 {
1025         gchar *thumb_path;
1026
1027         thumb_path = thumb_std_cache_path(source,
1028                                           (local) ? filename_from_path(uri) : uri,
1029                                           local, subfolder);
1030         if (isfile(thumb_path))
1031                 {
1032                 DEBUG_1("thumb removing: %s", thumb_path);
1033                 unlink_file(thumb_path);
1034                 }
1035         g_free(thumb_path);
1036 }
1037
1038 /* this also removes local thumbnails (the source is gone so it makes sense) */
1039 void thumb_std_maint_removed(const gchar *source)
1040 {
1041         gchar *uri;
1042         gchar *sourcel;
1043
1044         sourcel = path_from_utf8(source);
1045         uri = g_filename_to_uri(sourcel, NULL, NULL);
1046         g_free(sourcel);
1047
1048         /* all this to remove a thumbnail? */
1049
1050         thumb_std_maint_remove_one(source, uri, FALSE, THUMB_FOLDER_NORMAL);
1051         thumb_std_maint_remove_one(source, uri, FALSE, THUMB_FOLDER_LARGE);
1052         thumb_std_maint_remove_one(source, uri, FALSE, THUMB_FOLDER_FAIL);
1053         thumb_std_maint_remove_one(source, uri, TRUE, THUMB_FOLDER_NORMAL);
1054         thumb_std_maint_remove_one(source, uri, TRUE, THUMB_FOLDER_LARGE);
1055
1056         g_free(uri);
1057 }
1058
1059 typedef struct _TMaintMove TMaintMove;
1060 struct _TMaintMove
1061 {
1062         gchar *source;
1063         gchar *dest;
1064
1065         ThumbLoaderStd *tl;
1066         gchar *source_uri;
1067         gchar *thumb_path;
1068
1069         gint pass;
1070 };
1071
1072 static GList *thumb_std_maint_move_list = NULL;
1073 static GList *thumb_std_maint_move_tail = NULL;
1074
1075
1076 static void thumb_std_maint_move_step(TMaintMove *tm);
1077 static gboolean thumb_std_maint_move_idle(gpointer data);
1078
1079
1080 static void thumb_std_maint_move_validate_cb(const gchar *path, gboolean valid, gpointer data)
1081 {
1082         TMaintMove *tm = data;
1083         GdkPixbuf *pixbuf;
1084
1085         /* get the original thumbnail pixbuf (unrotated, with original options)
1086            this is called from image_loader done callback, so tm->tl->il must exist*/
1087         pixbuf = image_loader_get_pixbuf(tm->tl->il);
1088         if (pixbuf)
1089                 {
1090                 const gchar *uri;
1091                 const gchar *mtime_str;
1092
1093                 uri = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_URI);
1094                 mtime_str = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_MTIME);
1095
1096                 if (uri && mtime_str && strcmp(uri, tm->source_uri) == 0)
1097                         {
1098                         gchar *pathl;
1099
1100                         /* The validation utility abuses ThumbLoader, and we
1101                          * abuse the utility just to load the thumbnail,
1102                          * but the loader needs to look sane for the save to complete.
1103                          */
1104
1105                         tm->tl->cache_enable = TRUE;
1106                         tm->tl->cache_hit = FALSE;
1107                         tm->tl->cache_local = FALSE;
1108                         file_data_unref(tm->tl->fd);
1109                         tm->tl->fd = file_data_new_group(tm->dest);
1110                         tm->tl->source_mtime = strtol(mtime_str, NULL, 10);
1111
1112                         pathl = path_from_utf8(tm->tl->fd->path);
1113                         g_free(tm->tl->thumb_uri);
1114                         tm->tl->thumb_uri = g_filename_to_uri(pathl, NULL, NULL);
1115                         tm->tl->local_uri = filename_from_path(tm->tl->thumb_uri);
1116                         g_free(pathl);
1117
1118                         g_free(tm->tl->thumb_path);
1119                         tm->tl->thumb_path = NULL;
1120                         tm->tl->thumb_path_local = FALSE;
1121
1122                         DEBUG_1("thumb move attempting save:");
1123
1124                         thumb_loader_std_save(tm->tl, pixbuf);
1125                         }
1126
1127                 DEBUG_1("thumb move unlink: %s", tm->thumb_path);
1128                 unlink_file(tm->thumb_path);
1129                 }
1130
1131         thumb_std_maint_move_step(tm);
1132 }
1133
1134 static void thumb_std_maint_move_step(TMaintMove *tm)
1135 {
1136         const gchar *folder;
1137
1138         tm->pass++;
1139         if (tm->pass > 2)
1140                 {
1141                 g_free(tm->source);
1142                 g_free(tm->dest);
1143                 g_free(tm->source_uri);
1144                 g_free(tm->thumb_path);
1145                 g_free(tm);
1146
1147                 if (thumb_std_maint_move_list)
1148                         {
1149                         g_idle_add_full(G_PRIORITY_LOW, thumb_std_maint_move_idle, NULL, NULL);
1150                         }
1151
1152                 return;
1153                 }
1154
1155         folder = (tm->pass == 1) ? THUMB_FOLDER_NORMAL : THUMB_FOLDER_LARGE;
1156
1157         g_free(tm->thumb_path);
1158         tm->thumb_path = thumb_std_cache_path(tm->source, tm->source_uri, FALSE, folder);
1159         tm->tl = thumb_loader_std_thumb_file_validate(tm->thumb_path, 0,
1160                                                       thumb_std_maint_move_validate_cb, tm);
1161 }
1162
1163 static gboolean thumb_std_maint_move_idle(gpointer data)
1164 {
1165         TMaintMove *tm;
1166         gchar *pathl;
1167
1168         if (!thumb_std_maint_move_list) return FALSE;
1169
1170         tm = thumb_std_maint_move_list->data;
1171
1172         thumb_std_maint_move_list = g_list_remove(thumb_std_maint_move_list, tm);
1173         if (!thumb_std_maint_move_list) thumb_std_maint_move_tail = NULL;
1174
1175         pathl = path_from_utf8(tm->source);
1176         tm->source_uri = g_filename_to_uri(pathl, NULL, NULL);
1177         g_free(pathl);
1178
1179         tm->pass = 0;
1180
1181         thumb_std_maint_move_step(tm);
1182
1183         return FALSE;
1184 }
1185
1186 /* This will schedule a move of the thumbnail for source image to dest when idle.
1187  * We do this so that file renaming or moving speed is not sacrificed by
1188  * moving the thumbnails at the same time because:
1189  *
1190  * This cache design requires the tedious task of loading the png thumbnails and saving them.
1191  *
1192  * The thumbnails are processed when the app is idle. If the app
1193  * exits early well too bad - they can simply be regenerated from scratch.
1194  */
1195 /** @FIXME This does not manage local thumbnails (fixme ?)
1196  */
1197 void thumb_std_maint_moved(const gchar *source, const gchar *dest)
1198 {
1199         TMaintMove *tm;
1200
1201         tm = g_new0(TMaintMove, 1);
1202         tm->source = g_strdup(source);
1203         tm->dest = g_strdup(dest);
1204
1205         if (!thumb_std_maint_move_list)
1206                 {
1207                 g_idle_add_full(G_PRIORITY_LOW, thumb_std_maint_move_idle, NULL, NULL);
1208                 }
1209
1210         if (thumb_std_maint_move_tail)
1211                 {
1212                 thumb_std_maint_move_tail = g_list_append(thumb_std_maint_move_tail, tm);
1213                 thumb_std_maint_move_tail = thumb_std_maint_move_tail->next;
1214                 }
1215         else
1216                 {
1217                 thumb_std_maint_move_list = g_list_append(thumb_std_maint_move_list, tm);
1218                 thumb_std_maint_move_tail = thumb_std_maint_move_list;
1219                 }
1220 }
1221 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */