No space between function name and first parenthesis, it eases greping (see CODING).
[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
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                                 recursive_mkdir_if_not_exists(base_path, st.st_mode);
323                                 }
324                         g_free(source_base);
325                         }
326                 }
327         else
328                 {
329                 recursive_mkdir_if_not_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                         tl->fd->exif_orientation = metadata_read_int(tl->fd, "Exif.Image.Orientation", EXIF_ORIENTATION_TOP_LEFT);
399                         }
400                 
401                 if (tl->fd->exif_orientation != EXIF_ORIENTATION_TOP_LEFT)
402                         {
403                         rotated = pixbuf_apply_orientation(pixbuf, tl->fd->exif_orientation);
404                         pixbuf = rotated;
405                         }
406                 }
407
408         sw = gdk_pixbuf_get_width(pixbuf);
409         sh = gdk_pixbuf_get_height(pixbuf);
410
411         if (tl->cache_enable)
412                 {
413                 if (!tl->cache_hit)
414                         {
415                         gint cache_w, cache_h;
416
417                         if (tl->requested_width > THUMB_SIZE_NORMAL || tl->requested_height > THUMB_SIZE_NORMAL)
418                                 {
419                                 cache_w = cache_h = THUMB_SIZE_LARGE;
420                                 }
421                         else
422                                 {
423                                 cache_w = cache_h = THUMB_SIZE_NORMAL;
424                                 }
425
426                         if (sw > cache_w || sh > cache_h || shrunk)
427                                 {
428                                 gint thumb_w, thumb_h;
429
430                                 if (pixbuf_scale_aspect(cache_w, cache_h, sw, sh,
431                                                                   &thumb_w, &thumb_h))
432                                         {
433                                         pixbuf_thumb = gdk_pixbuf_scale_simple(pixbuf, thumb_w, thumb_h,
434                                                                                (GdkInterpType)options->thumbnails.quality);
435                                         }
436                                 else
437                                         {
438                                         pixbuf_thumb = pixbuf;
439                                         g_object_ref(G_OBJECT(pixbuf_thumb));
440                                         }
441
442                                 thumb_loader_std_save(tl, pixbuf_thumb);
443                                 }
444                         }
445                 else if (tl->cache_hit &&
446                          tl->cache_local && !tl->thumb_path_local)
447                         {
448                         /* A local cache save was requested, but a valid thumb is in $HOME,
449                          * so specifically save as a local thumbnail.
450                          */
451                         g_free(tl->thumb_path);
452                         tl->thumb_path = NULL;
453
454                         tl->cache_hit = FALSE;
455
456                         DEBUG_1("thumb copied: %s", tl->fd->path);
457
458                         thumb_loader_std_save(tl, pixbuf);
459                         }
460                 }
461
462         if (sw <= tl->requested_width && sh <= tl->requested_height)
463                 {
464                 result = pixbuf;
465                 g_object_ref(result);
466                 }
467         else
468                 {
469                 gint thumb_w, thumb_h;
470
471                 if (pixbuf_thumb)
472                         {
473                         pixbuf = pixbuf_thumb;
474                         sw = gdk_pixbuf_get_width(pixbuf);
475                         sh = gdk_pixbuf_get_height(pixbuf);
476                         }
477
478                 if (pixbuf_scale_aspect(tl->requested_width, tl->requested_height, sw, sh,
479                                                   &thumb_w, &thumb_h))
480                         {
481                         result = gdk_pixbuf_scale_simple(pixbuf, thumb_w, thumb_h,
482                                                          (GdkInterpType)options->thumbnails.quality);
483                         }
484                 else
485                         {
486                         result = pixbuf;
487                         g_object_ref(result);
488                         }
489                 }
490
491         if (pixbuf_thumb) g_object_unref(pixbuf_thumb);
492         if (rotated) g_object_unref(rotated);
493
494         return result;
495 }
496
497 static gint thumb_loader_std_next_source(ThumbLoaderStd *tl, gint remove_broken)
498 {
499         image_loader_free(tl->il);
500         tl->il = NULL;
501
502         if (tl->thumb_path)
503                 {
504                 if (!tl->thumb_path_local && remove_broken)
505                         {
506                         DEBUG_1("thumb broken, unlinking: %s", tl->thumb_path);
507                         unlink_file(tl->thumb_path);
508                         }
509
510                 g_free(tl->thumb_path);
511                 tl->thumb_path = NULL;
512
513                 if (!tl->thumb_path_local)
514                         {
515                         tl->thumb_path = thumb_loader_std_cache_path(tl, TRUE, NULL, FALSE);
516                         if (isfile(tl->thumb_path) && thumb_loader_std_setup_path(tl, tl->thumb_path))
517                                 {
518                                 tl->thumb_path_local = TRUE;
519                                 return TRUE;
520                                 }
521
522                         g_free(tl->thumb_path);
523                         tl->thumb_path = NULL;
524                         }
525
526                 if (thumb_loader_std_setup(tl, tl->fd)) return TRUE;
527                 }
528
529         thumb_loader_std_save(tl, NULL);
530         return FALSE;
531 }
532
533 static void thumb_loader_std_done_cb(ImageLoader *il, gpointer data)
534 {
535         ThumbLoaderStd *tl = data;
536         GdkPixbuf *pixbuf;
537
538         DEBUG_1("thumb image done: %s", tl->fd ? tl->fd->path : "???");
539         DEBUG_1("            from: %s", image_loader_get_fd(tl->il)->path);
540
541         pixbuf = image_loader_get_pixbuf(tl->il);
542         if (!pixbuf)
543                 {
544                 DEBUG_1("...but no pixbuf");
545                 thumb_loader_std_error_cb(il, data);
546                 return;
547                 }
548
549         if (tl->thumb_path && !thumb_loader_std_validate(tl, pixbuf))
550                 {
551                 if (thumb_loader_std_next_source(tl, TRUE)) return;
552
553                 if (tl->func_error) tl->func_error(tl, tl->data);
554                 return;
555                 }
556
557         tl->cache_hit = (tl->thumb_path != NULL);
558
559         if (tl->fd)
560                 {
561                 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
562                 tl->fd->thumb_pixbuf = thumb_loader_std_finish(tl, pixbuf, image_loader_get_shrunk(il));
563                 }
564
565         if (tl->func_done) tl->func_done(tl, tl->data);
566 }
567
568 static void thumb_loader_std_error_cb(ImageLoader *il, gpointer data)
569 {
570         ThumbLoaderStd *tl = data;
571
572         /* if at least some of the image is available, go to done */
573         if (image_loader_get_pixbuf(tl->il) != NULL)
574                 {
575                 thumb_loader_std_done_cb(il, data);
576                 return;
577                 }
578         
579         DEBUG_1("thumb image error: %s", tl->fd->path);
580         DEBUG_1("             from: %s", image_loader_get_fd(tl->il)->path);
581
582         if (thumb_loader_std_next_source(tl, TRUE)) return;
583
584         thumb_loader_std_set_fallback(tl);
585         
586         if (tl->func_error) tl->func_error(tl, tl->data);
587 }
588
589 static void thumb_loader_std_progress_cb(ImageLoader *il, gdouble percent, gpointer data)
590 {
591         ThumbLoaderStd *tl = data;
592
593         tl->progress = (gdouble)percent;
594
595         if (tl->func_progress) tl->func_progress(tl, tl->data);
596 }
597
598 static gint thumb_loader_std_setup(ThumbLoaderStd *tl, FileData *fd)
599 {
600         tl->il = image_loader_new(fd);
601         image_loader_set_priority(tl->il, G_PRIORITY_LOW);
602
603         if (options->thumbnails.fast)
604                 {
605                 /* this will speed up jpegs by up to 3x in some cases */
606                 if (tl->requested_width <= THUMB_SIZE_NORMAL &&
607                     tl->requested_height <= THUMB_SIZE_NORMAL)
608                         {
609                         image_loader_set_requested_size(tl->il, THUMB_SIZE_NORMAL, THUMB_SIZE_NORMAL);
610                         }
611                 else
612                         {
613                         image_loader_set_requested_size(tl->il, THUMB_SIZE_LARGE, THUMB_SIZE_LARGE);
614                         }
615                 }
616
617         g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_std_error_cb, tl);
618         if (tl->func_progress)
619                 {
620                 g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_std_progress_cb, tl);
621                 }
622         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_std_done_cb, tl);
623
624         if (image_loader_start(tl->il))
625                 {
626                 return TRUE;
627                 }
628
629         image_loader_free(tl->il);
630         tl->il = NULL;
631         return FALSE;
632 }
633
634 static gint thumb_loader_std_setup_path(ThumbLoaderStd *tl, const gchar *path)
635 {
636         FileData *fd = file_data_new_simple(path);
637         gint ret = thumb_loader_std_setup(tl, fd);
638         file_data_unref(fd);
639         return ret;
640 }
641
642 /*
643  * Note: Currently local_cache only specifies where to save a _new_ thumb, if
644  *       a valid existing thumb is found anywhere the local thumb will not be created.
645  */
646 void thumb_loader_std_set_cache(ThumbLoaderStd *tl, gint enable_cache, gint local, gint retry_failed)
647 {
648         if (!tl) return;
649
650         tl->cache_enable = enable_cache;
651         tl->cache_local = local;
652         tl->cache_retry = retry_failed;
653 }
654
655 gint thumb_loader_std_start(ThumbLoaderStd *tl, FileData *fd)
656 {
657         static gchar *thumb_cache = NULL;
658         struct stat st;
659
660         if (!tl || !fd) return FALSE;
661
662         thumb_loader_std_reset(tl);
663
664
665         tl->fd = file_data_ref(fd);
666         if (!stat_utf8(fd->path, &st))
667                 {
668                 thumb_loader_std_set_fallback(tl);
669                 return FALSE;
670                 }
671         tl->source_mtime = st.st_mtime;
672         tl->source_size = st.st_size;
673         tl->source_mode = st.st_mode;
674
675         if (!thumb_cache) thumb_cache = g_build_filename(homedir(), THUMB_FOLDER_GLOBAL, NULL);
676         if (strncmp(tl->fd->path, thumb_cache, strlen(thumb_cache)) != 0)
677                 {
678                 gchar *pathl;
679
680                 pathl = path_from_utf8(fd->path);
681                 tl->thumb_uri = g_filename_to_uri(pathl, NULL, NULL);
682                 tl->local_uri = filename_from_path(tl->thumb_uri);
683                 g_free(pathl);
684                 }
685
686         if (tl->cache_enable)
687                 {
688                 gint found;
689
690                 tl->thumb_path = thumb_loader_std_cache_path(tl, FALSE, NULL, FALSE);
691                 tl->thumb_path_local = FALSE;
692
693                 found = isfile(tl->thumb_path);
694                 if (found && thumb_loader_std_setup_path(tl, tl->thumb_path)) return TRUE;
695
696                 if (thumb_loader_std_fail_check(tl) ||
697                     !thumb_loader_std_next_source(tl, found))
698                         {
699                         thumb_loader_std_set_fallback(tl);
700                         return FALSE;
701                         }
702                 return TRUE;
703                 }
704
705         if (!thumb_loader_std_setup(tl, tl->fd))
706                 {
707                 thumb_loader_std_save(tl, NULL);
708                 thumb_loader_std_set_fallback(tl);
709                 return FALSE;
710                 }
711
712         return TRUE;
713 }
714
715 void thumb_loader_std_free(ThumbLoaderStd *tl)
716 {
717         if (!tl) return;
718
719         thumb_loader_std_reset(tl);
720         g_free(tl);
721 }
722
723 GdkPixbuf *thumb_loader_std_get_pixbuf(ThumbLoaderStd *tl)
724 {
725         GdkPixbuf *pixbuf;
726
727         if (tl && tl->fd && tl->fd->thumb_pixbuf)
728                 {
729                 pixbuf = tl->fd->thumb_pixbuf;
730                 g_object_ref(pixbuf);
731                 }
732         else
733                 {
734                 pixbuf = pixbuf_fallback(NULL, tl->requested_width, tl->requested_height);
735                 }
736
737         return pixbuf;
738 }
739
740
741 typedef struct _ThumbValidate ThumbValidate;
742 struct _ThumbValidate
743 {
744         ThumbLoaderStd *tl;
745         gchar *path;
746         gint days;
747
748         void (*func_valid)(const gchar *path, gint valid, gpointer data);
749         gpointer data;
750
751         gint idle_id;
752 };
753
754 static void thumb_loader_std_thumb_file_validate_free(ThumbValidate *tv)
755 {
756         thumb_loader_std_free(tv->tl);
757         g_free(tv->path);
758         g_free(tv);
759 }
760
761 void thumb_loader_std_thumb_file_validate_cancel(ThumbLoaderStd *tl)
762 {
763         ThumbValidate *tv;
764
765         if (!tl) return;
766
767         tv = tl->data;
768
769         if (tv->idle_id != -1) g_source_remove(tv->idle_id);
770         tv->idle_id = -1;
771
772         thumb_loader_std_thumb_file_validate_free(tv);
773 }
774
775 static void thumb_loader_std_thumb_file_validate_finish(ThumbValidate *tv, gint valid)
776 {
777         if (tv->func_valid) tv->func_valid(tv->path, valid, tv->data);
778
779         thumb_loader_std_thumb_file_validate_free(tv);
780 }
781
782 static void thumb_loader_std_thumb_file_validate_done_cb(ThumbLoaderStd *tl, gpointer data)
783 {
784         ThumbValidate *tv = data;
785         GdkPixbuf *pixbuf;
786         gint valid = FALSE;
787
788         /* this function is called on success, so the pixbuf should not be a fallback*/
789         pixbuf = thumb_loader_std_get_pixbuf(tv->tl);
790         if (pixbuf)
791                 {
792                 const gchar *uri;
793                 const gchar *mtime_str;
794
795                 uri = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_URI);
796                 mtime_str = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_MTIME);
797                 if (uri && mtime_str)
798                         {
799                         if (strncmp(uri, "file:", strlen("file:")) == 0)
800                                 {
801                                 struct stat st;
802                                 gchar *target;
803
804                                 target = g_filename_from_uri(uri, NULL, NULL);
805                                 if (stat(target, &st) == 0 &&
806                                     st.st_mtime == strtol(mtime_str, NULL, 10))
807                                         {
808                                         valid = TRUE;
809                                         }
810                                 g_free(target);
811                                 }
812                         else
813                                 {
814                                 struct stat st;
815
816                                 DEBUG_1("thumb uri foreign, doing day check: %s", uri);
817
818                                 if (stat_utf8(tv->path, &st))
819                                         {
820                                         time_t now;
821
822                                         now = time(NULL);
823                                         if (st.st_atime >= now - (time_t)tv->days * 24 * 60 * 60)
824                                                 {
825                                                 valid = TRUE;
826                                                 }
827                                         }
828                                 }
829                         }
830
831                 g_object_unref(pixbuf);
832                 }
833
834         thumb_loader_std_thumb_file_validate_finish(tv, valid);
835 }
836
837 static void thumb_loader_std_thumb_file_validate_error_cb(ThumbLoaderStd *tl, gpointer data)
838 {
839         ThumbValidate *tv = data;
840
841         thumb_loader_std_thumb_file_validate_finish(tv, FALSE);
842 }
843
844 static gint thumb_loader_std_thumb_file_validate_idle_cb(gpointer data)
845 {
846         ThumbValidate *tv = data;
847
848         tv->idle_id = -1;
849         thumb_loader_std_thumb_file_validate_finish(tv, FALSE);
850
851         return FALSE;
852 }
853
854 ThumbLoaderStd *thumb_loader_std_thumb_file_validate(const gchar *thumb_path, gint allowed_days,
855                                                      void (*func_valid)(const gchar *path, gint valid, gpointer data),
856                                                      gpointer data)
857 {
858         ThumbValidate *tv;
859
860         tv = g_new0(ThumbValidate, 1);
861
862         tv->tl = thumb_loader_std_new(THUMB_SIZE_LARGE, THUMB_SIZE_LARGE);
863         thumb_loader_std_set_callbacks(tv->tl,
864                                        thumb_loader_std_thumb_file_validate_done_cb,
865                                        thumb_loader_std_thumb_file_validate_error_cb,
866                                        NULL,
867                                        tv);
868         thumb_loader_std_reset(tv->tl);
869
870         tv->path = g_strdup(thumb_path);
871         tv->days = allowed_days;
872         tv->func_valid = func_valid;
873         tv->data = data;
874
875         if (!thumb_loader_std_setup_path(tv->tl, thumb_path))
876                 {
877                 tv->idle_id = g_idle_add(thumb_loader_std_thumb_file_validate_idle_cb, tv);
878                 }
879         else
880                 {
881                 tv->idle_id = -1;
882                 }
883
884         return tv->tl;
885 }
886
887 static void thumb_std_maint_remove_one(const gchar *source, const gchar *uri, gint local,
888                                        const gchar *subfolder)
889 {
890         gchar *thumb_path;
891
892         thumb_path = thumb_std_cache_path(source,
893                                           (local) ? filename_from_path(uri) : uri,
894                                           local, subfolder);
895         if (isfile(thumb_path))
896                 {
897                 DEBUG_1("thumb removing: %s", thumb_path);
898                 unlink_file(thumb_path);
899                 }
900         g_free(thumb_path);
901 }
902
903 /* this also removes local thumbnails (the source is gone so it makes sense) */
904 void thumb_std_maint_removed(const gchar *source)
905 {
906         gchar *uri;
907         gchar *sourcel;
908
909         sourcel = path_from_utf8(source);
910         uri = g_filename_to_uri(sourcel, NULL, NULL);
911         g_free(sourcel);
912
913         /* all this to remove a thumbnail? */
914
915         thumb_std_maint_remove_one(source, uri, FALSE, THUMB_FOLDER_NORMAL);
916         thumb_std_maint_remove_one(source, uri, FALSE, THUMB_FOLDER_LARGE);
917         thumb_std_maint_remove_one(source, uri, FALSE, THUMB_FOLDER_FAIL);
918         thumb_std_maint_remove_one(source, uri, TRUE, THUMB_FOLDER_NORMAL);
919         thumb_std_maint_remove_one(source, uri, TRUE, THUMB_FOLDER_LARGE);
920
921         g_free(uri);
922 }
923
924 typedef struct _TMaintMove TMaintMove;
925 struct _TMaintMove
926 {
927         gchar *source;
928         gchar *dest;
929
930         ThumbLoaderStd *tl;
931         gchar *source_uri;
932         gchar *thumb_path;
933
934         gint pass;
935 };
936
937 static GList *thumb_std_maint_move_list = NULL;
938 static GList *thumb_std_maint_move_tail = NULL;
939
940
941 static void thumb_std_maint_move_step(TMaintMove *tm);
942 static gint thumb_std_maint_move_idle(gpointer data);
943
944
945 static void thumb_std_maint_move_validate_cb(const gchar *path, gint valid, gpointer data)
946 {
947         TMaintMove *tm = data;
948         GdkPixbuf *pixbuf;
949
950         /* this function is called on success, so the pixbuf should not be a fallback*/
951         pixbuf = thumb_loader_std_get_pixbuf(tm->tl);
952         if (pixbuf)
953                 {
954                 const gchar *uri;
955                 const gchar *mtime_str;
956
957                 uri = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_URI);
958                 mtime_str = gdk_pixbuf_get_option(pixbuf, THUMB_MARKER_MTIME);
959
960                 if (uri && mtime_str && strcmp(uri, tm->source_uri) == 0)
961                         {
962                         gchar *pathl;
963
964                         /* The validation utility abuses ThumbLoader, and we
965                          * abuse the utility just to load the thumbnail,
966                          * but the loader needs to look sane for the save to complete.
967                          */
968
969                         tm->tl->cache_enable = TRUE;
970                         tm->tl->cache_hit = FALSE;
971                         tm->tl->cache_local = FALSE;
972
973                         file_data_unref(tm->tl->fd);
974                         tm->tl->fd = file_data_new_simple(tm->dest);
975                         tm->tl->source_mtime = strtol(mtime_str, NULL, 10);
976
977                         pathl = path_from_utf8(tm->tl->fd->path);
978                         g_free(tm->tl->thumb_uri);
979                         tm->tl->thumb_uri = g_filename_to_uri(pathl, NULL, NULL);
980                         tm->tl->local_uri = filename_from_path(tm->tl->thumb_uri);
981                         g_free(pathl);
982
983                         g_free(tm->tl->thumb_path);
984                         tm->tl->thumb_path = NULL;
985                         tm->tl->thumb_path_local = FALSE;
986
987                         DEBUG_1("thumb move attempting save:");
988
989                         thumb_loader_std_save(tm->tl, pixbuf);
990                         }
991
992                 DEBUG_1("thumb move unlink: %s", tm->thumb_path);
993                 unlink_file(tm->thumb_path);
994                 g_object_unref(pixbuf);
995                 }
996
997         thumb_std_maint_move_step(tm);
998 }
999
1000 static void thumb_std_maint_move_step(TMaintMove *tm)
1001 {
1002         const gchar *folder;
1003
1004         tm->pass++;
1005         if (tm->pass > 2)
1006                 {
1007                 g_free(tm->source);
1008                 g_free(tm->dest);
1009                 g_free(tm->source_uri);
1010                 g_free(tm->thumb_path);
1011                 g_free(tm);
1012
1013                 if (thumb_std_maint_move_list)
1014                         {
1015                         g_idle_add_full(G_PRIORITY_LOW, thumb_std_maint_move_idle, NULL, NULL);
1016                         }
1017
1018                 return;
1019                 }
1020
1021         folder = (tm->pass == 1) ? THUMB_FOLDER_NORMAL : THUMB_FOLDER_LARGE;
1022
1023         g_free(tm->thumb_path);
1024         tm->thumb_path = thumb_std_cache_path(tm->source, tm->source_uri, FALSE, folder);
1025         tm->tl = thumb_loader_std_thumb_file_validate(tm->thumb_path, 0,
1026                                                       thumb_std_maint_move_validate_cb, tm);
1027 }
1028
1029 static gint thumb_std_maint_move_idle(gpointer data)
1030 {
1031         TMaintMove *tm;
1032         gchar *pathl;
1033
1034         if (!thumb_std_maint_move_list) return FALSE;
1035
1036         tm = thumb_std_maint_move_list->data;
1037
1038         thumb_std_maint_move_list = g_list_remove(thumb_std_maint_move_list, tm);
1039         if (!thumb_std_maint_move_list) thumb_std_maint_move_tail = NULL;
1040
1041         pathl = path_from_utf8(tm->source);
1042         tm->source_uri = g_filename_to_uri(pathl, NULL, NULL);
1043         g_free(pathl);
1044
1045         tm->pass = 0;
1046
1047         thumb_std_maint_move_step(tm);
1048
1049         return FALSE;
1050 }
1051
1052 /* This will schedule a move of the thumbnail for source image to dest when idle.
1053  * We do this so that file renaming or moving speed is not sacrificed by
1054  * moving the thumbnails at the same time because:
1055  *
1056  * This cache design requires the tedious task of loading the png thumbnails and saving them.
1057  *
1058  * The thumbnails are processed when the app is idle. If the app
1059  * exits early well too bad - they can simply be regenerated from scratch.
1060  *
1061  * This does not manage local thumbnails (fixme ?)
1062  */
1063 void thumb_std_maint_moved(const gchar *source, const gchar *dest)
1064 {
1065         TMaintMove *tm;
1066
1067         tm = g_new0(TMaintMove, 1);
1068         tm->source = g_strdup(source);
1069         tm->dest = g_strdup(dest);
1070
1071         if (!thumb_std_maint_move_list)
1072                 {
1073                 g_idle_add_full(G_PRIORITY_LOW, thumb_std_maint_move_idle, NULL, NULL);
1074                 }
1075
1076         if (thumb_std_maint_move_tail)
1077                 {
1078                 thumb_std_maint_move_tail = g_list_append(thumb_std_maint_move_tail, tm);
1079                 thumb_std_maint_move_tail = thumb_std_maint_move_tail->next;
1080                 }
1081         else
1082                 {
1083                 thumb_std_maint_move_list = g_list_append(thumb_std_maint_move_list, tm);
1084                 thumb_std_maint_move_tail = thumb_std_maint_move_list;
1085                 }
1086 }
1087 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */