src/thumb_standard.c

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