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