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