7 * This software is released under the GNU General Public License (GNU GPL).
8 * Please read the included file COPYING for more information.
9 * This software comes with no warranty of any kind, use at your own risk!
14 #include "collect-io.h"
18 #include "layout_util.h"
20 #include "secure_save.h"
22 #include "ui_fileops.h"
25 #define GQ_COLLECTION_MARKER "#" GQ_APPNAME
27 #define GQ_COLLECTION_FAIL_MIN 300
28 #define GQ_COLLECTION_FAIL_PERCENT 98
29 #define GQ_COLLECTION_READ_BUFSIZE 4096
31 typedef struct _CollectManagerEntry CollectManagerEntry;
33 static void collection_load_thumb_step(CollectionData *cd);
34 static gint collection_save_private(CollectionData *cd, const gchar *path);
36 static CollectManagerEntry *collect_manager_get_entry(const gchar *path);
37 static void collect_manager_entry_reset(CollectManagerEntry *entry);
38 static gint collect_manager_process_action(CollectManagerEntry *entry, gchar **path_ptr);
41 static gint scan_geometry(gchar *buffer, gint *x, gint *y, gint *w, gint *h)
45 if(sscanf(buffer, "%d %d %d %d", &nx, &ny, &nw, &nh) != 4) return FALSE;
55 static gint collection_load_private(CollectionData *cd, const gchar *path, CollectionLoadFlags flags)
57 gchar s_buf[GQ_COLLECTION_READ_BUFSIZE];
60 gint limit_failures = TRUE;
62 gint has_official_header = FALSE;
63 gint has_geometry_header = FALSE;
64 gint has_gqview_header = FALSE;
65 gint need_header = TRUE;
68 gboolean changed = FALSE;
69 CollectManagerEntry *entry = NULL;
70 guint flush = !!(flags & COLLECTION_LOAD_FLUSH);
71 guint append = !!(flags & COLLECTION_LOAD_APPEND);
72 guint only_geometry = !!(flags & COLLECTION_LOAD_GEOMETRY);
76 collection_load_stop(cd);
79 collect_manager_flush();
81 entry = collect_manager_get_entry(path);
85 collection_list_free(cd->list);
90 if (!path && !cd->path) return FALSE;
92 if (!path) path = cd->path;
94 if (debug) printf("collection load: append=%d flush=%d only_geometry=%d path=%s\n",
95 append, flush, only_geometry, path);
98 pathl = path_from_utf8(path);
99 f = fopen(pathl, "r");
103 printf("Failed to open collection file: \"%s\"\n", path);
107 while (fgets(s_buf, sizeof(s_buf), f))
112 /* Skip whitespaces and empty lines */
113 while (*p && g_ascii_isspace(*p)) p++;
114 if (*p == '\n' || *p == '\r') continue;
119 if (!need_header) continue;
120 if (strncasecmp(p, GQ_COLLECTION_MARKER, strlen(GQ_COLLECTION_MARKER)) == 0)
122 /* Looks like an official collection, allow unchecked input.
123 * All this does is allow adding files that may not exist,
124 * which is needed for the collection manager to work.
125 * Also unofficial files abort after too many invalid entries.
127 has_official_header = TRUE;
128 limit_failures = FALSE;
130 else if (strncmp(p, "#geometry:", 10 ) == 0 &&
131 scan_geometry(p + 10, &cd->window_x, &cd->window_y, &cd->window_w, &cd->window_h))
133 has_geometry_header = TRUE;
134 cd->window_read = TRUE;
135 if (only_geometry) break;
137 else if (strncasecmp(p, "#GQview collection", strlen("#GQview collection")) == 0)
139 /* As 2008/04/15 there is no difference between our collection file format
140 * and GQview 2.1.5 collection file format so ignore failures as well. */
141 has_gqview_header = TRUE;
142 limit_failures = FALSE;
144 need_header = (!has_official_header && !has_gqview_header) || !has_geometry_header;
149 buf = quoted_value(p, NULL);
155 changed |= collect_manager_process_action(entry, &buf);
157 valid = (buf[0] == '/' && collection_add_check(cd, file_data_new_simple(buf), FALSE, TRUE));
158 if (debug && !valid) printf("collection invalid file: %s\n", buf);
165 if (limit_failures &&
166 fail > GQ_COLLECTION_FAIL_MIN &&
167 fail * 100 / total > GQ_COLLECTION_FAIL_PERCENT)
169 printf("%d invalid filenames in unoffical collection file, closing: %s\n", fail, path);
177 if (debug) printf("collection files: total = %d fail = %d official=%d gqview=%d geometry=%d\n",
178 total, fail, has_official_header, has_gqview_header, has_geometry_header);
181 if (only_geometry) return has_geometry_header;
186 while (collect_manager_process_action(entry, &buf))
188 collection_add_check(cd, file_data_new_simple(buf), FALSE, TRUE);
194 cd->list = collection_list_sort(cd->list, cd->sort_method);
196 if (!flush && changed && success)
197 collection_save_private(cd, path);
200 collect_manager_entry_reset(entry);
202 if (!append) cd->changed = FALSE;
207 gint collection_load(CollectionData *cd, const gchar *path, CollectionLoadFlags flags)
209 if (collection_load_private(cd, path, flags | COLLECTION_LOAD_FLUSH))
211 layout_recent_add_path(cd->path);
218 static void collection_load_thumb_do(CollectionData *cd)
222 if (!cd->thumb_loader || !g_list_find(cd->list, cd->thumb_info)) return;
224 pixbuf = thumb_loader_get_pixbuf(cd->thumb_loader, TRUE);
225 collection_info_set_thumb(cd->thumb_info, pixbuf);
226 g_object_unref(pixbuf);
228 if (cd->info_updated_func) cd->info_updated_func(cd, cd->thumb_info, cd->info_updated_data);
231 static void collection_load_thumb_error_cb(ThumbLoader *tl, gpointer data)
233 CollectionData *cd = data;
235 collection_load_thumb_do(cd);
236 collection_load_thumb_step(cd);
239 static void collection_load_thumb_done_cb(ThumbLoader *tl, gpointer data)
241 CollectionData *cd = data;
243 collection_load_thumb_do(cd);
244 collection_load_thumb_step(cd);
247 static void collection_load_thumb_step(CollectionData *cd)
254 collection_load_stop(cd);
261 /* find first unloaded thumb */
262 while (work && ci->pixbuf)
268 if (!ci || ci->pixbuf)
271 collection_load_stop(cd);
273 /* send a NULL CollectInfo to notify end */
274 if (cd->info_updated_func) cd->info_updated_func(cd, NULL, cd->info_updated_data);
279 /* setup loader and call it */
281 thumb_loader_free(cd->thumb_loader);
282 cd->thumb_loader = thumb_loader_new(options->thumbnails.max_width, options->thumbnails.max_height);
283 thumb_loader_set_callbacks(cd->thumb_loader,
284 collection_load_thumb_done_cb,
285 collection_load_thumb_error_cb,
290 if (!thumb_loader_start(cd->thumb_loader, ci->fd->path))
292 /* error, handle it, do next */
293 if (debug) printf("error loading thumb for %s\n", ci->fd->path);
294 collection_load_thumb_do(cd);
295 collection_load_thumb_step(cd);
299 void collection_load_thumb_idle(CollectionData *cd)
301 if (!cd->thumb_loader) collection_load_thumb_step(cd);
304 gint collection_load_begin(CollectionData *cd, const gchar *path, CollectionLoadFlags flags)
306 if (!collection_load(cd, path, flags)) return FALSE;
308 collection_load_thumb_idle(cd);
313 void collection_load_stop(CollectionData *cd)
315 if (!cd->thumb_loader) return;
317 thumb_loader_free(cd->thumb_loader);
318 cd->thumb_loader = NULL;
321 static gint collection_save_private(CollectionData *cd, const gchar *path)
327 if (!path && !cd->path) return FALSE;
335 pathl = path_from_utf8(path);
336 ssi = secure_open(pathl);
340 printf_term(_("failed to open collection (write) \"%s\"\n"), path);
344 secure_fprintf(ssi, "%s collection\n", GQ_COLLECTION_MARKER);
345 secure_fprintf(ssi, "#created with %s version %s\n", GQ_APPNAME, VERSION);
347 collection_update_geometry(cd);
350 secure_fprintf(ssi, "#geometry: %d %d %d %d\n", cd->window_x, cd->window_y, cd->window_w, cd->window_h);
354 while (work && secsave_errno == SS_ERR_NONE)
356 CollectInfo *ci = work->data;
357 secure_fprintf(ssi, "\"%s\"\n", ci->fd->path);
361 secure_fprintf(ssi, "#end\n");
363 if (secure_close(ssi))
365 printf_term(_("error saving collection file: %s\nerror: %s\n"), path,
366 secsave_strerror(secsave_errno));
370 if (!cd->path || strcmp(path, cd->path) != 0)
372 gchar *buf = cd->path;
373 cd->path = g_strdup(path);
378 cd->name = g_strdup(filename_from_path(cd->path));
380 collection_path_changed(cd);
388 gint collection_save(CollectionData *cd, const gchar *path)
390 if (collection_save_private(cd, path))
392 layout_recent_add_path(cd->path);
399 gint collection_load_only_geometry(CollectionData *cd, const gchar *path)
401 return collection_load(cd, path, COLLECTION_LOAD_GEOMETRY);
406 *-------------------------------------------------------------------
408 *-------------------------------------------------------------------
411 #define COLLECT_MANAGER_ACTIONS_PER_IDLE 1000
412 #define COLLECT_MANAGER_FLUSH_DELAY 10000
414 struct _CollectManagerEntry
418 GHashTable *oldpath_hash;
419 GHashTable *newpath_hash;
424 COLLECTION_MANAGER_UPDATE,
425 COLLECTION_MANAGER_ADD,
426 COLLECTION_MANAGER_REMOVE
427 } CollectManagerType;
429 typedef struct _CollectManagerAction CollectManagerAction;
430 struct _CollectManagerAction
435 CollectManagerType type;
441 static GList *collection_manager_entry_list = NULL;
442 static GList *collection_manager_action_list = NULL;
443 static GList *collection_manager_action_tail = NULL;
444 static gint collection_manager_timer_id = -1;
447 static CollectManagerAction *collect_manager_action_new(const gchar *oldpath, const gchar *newpath,
448 CollectManagerType type)
450 CollectManagerAction *action;
452 action = g_new0(CollectManagerAction, 1);
455 action->oldpath = g_strdup(oldpath);
456 action->newpath = g_strdup(newpath);
463 static void collect_manager_action_ref(CollectManagerAction *action)
468 static void collect_manager_action_unref(CollectManagerAction *action)
472 if (action->ref > 0) return;
474 g_free(action->oldpath);
475 g_free(action->newpath);
479 static void collect_manager_entry_free_data(CollectManagerEntry *entry)
483 work = entry->add_list;
486 CollectManagerAction *action;
491 collect_manager_action_unref(action);
493 g_list_free(entry->add_list);
494 g_hash_table_destroy(entry->oldpath_hash);
495 g_hash_table_destroy(entry->newpath_hash);
498 static void collect_manager_entry_init_data(CollectManagerEntry *entry)
500 entry->add_list = NULL;
501 entry->oldpath_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, (GDestroyNotify) collect_manager_action_unref);
502 entry->newpath_hash = g_hash_table_new(g_str_hash, g_str_equal);
507 static CollectManagerEntry *collect_manager_entry_new(const gchar *path)
509 CollectManagerEntry *entry;
511 entry = g_new0(CollectManagerEntry, 1);
512 entry->path = g_strdup(path);
513 collect_manager_entry_init_data(entry);
515 collection_manager_entry_list = g_list_append(collection_manager_entry_list, entry);
521 static void collect_manager_entry_free(CollectManagerEntry *entry)
523 collection_manager_entry_list = g_list_remove(collection_manager_entry_list, entry);
525 collect_manager_entry_free_data(entry);
531 static void collect_manager_entry_reset(CollectManagerEntry *entry)
533 collect_manager_entry_free_data(entry);
534 collect_manager_entry_init_data(entry);
537 static CollectManagerEntry *collect_manager_get_entry(const gchar *path)
541 work = collection_manager_entry_list;
544 CollectManagerEntry *entry;
548 if (strcmp(entry->path, path) == 0)
557 static void collect_manager_entry_add_action(CollectManagerEntry *entry, CollectManagerAction *action)
560 CollectManagerAction *orig_action;
562 entry->empty = FALSE;
564 if (action->oldpath == NULL)
567 if (action->newpath == NULL)
572 orig_action = g_hash_table_lookup(entry->newpath_hash, action->newpath);
575 /* target already exists */
576 printf("collection manager failed to add another action for target %s in collection %s\n",
577 action->newpath, entry->path);
580 entry->add_list = g_list_append(entry->add_list, action);
581 g_hash_table_insert(entry->newpath_hash, action->newpath, action);
582 collect_manager_action_ref(action);
586 orig_action = g_hash_table_lookup(entry->newpath_hash, action->oldpath);
589 /* new action with the same file */
590 CollectManagerAction *new_action = collect_manager_action_new(orig_action->oldpath, action->newpath, action->type);
592 if (new_action->oldpath)
594 g_hash_table_steal(entry->oldpath_hash, orig_action->oldpath);
595 g_hash_table_insert(entry->oldpath_hash, new_action->oldpath, new_action);
599 GList *work = g_list_find(entry->add_list, orig_action);
600 work->data = new_action;
603 g_hash_table_steal(entry->newpath_hash, orig_action->newpath);
604 if (new_action->newpath)
606 g_hash_table_insert(entry->newpath_hash, new_action->newpath, new_action);
608 collect_manager_action_unref(orig_action);
613 orig_action = g_hash_table_lookup(entry->oldpath_hash, action->oldpath);
616 /* another action for the same source, ignore */
617 printf("collection manager failed to add another action for source %s in collection %s\n",
618 action->oldpath, entry->path);
622 g_hash_table_insert(entry->oldpath_hash, action->oldpath, action);
625 g_hash_table_insert(entry->newpath_hash, action->newpath, action);
627 collect_manager_action_ref(action);
630 static gint collect_manager_process_action(CollectManagerEntry *entry, gchar **path_ptr)
632 gchar *path = *path_ptr;
633 CollectManagerAction *action;
640 action = entry->add_list->data;
641 g_assert(action->oldpath == NULL);
642 entry->add_list = g_list_remove(entry->add_list, action);
643 path = g_strdup(action->newpath);
644 g_hash_table_remove(entry->newpath_hash, path);
645 collect_manager_action_unref(action);
648 return (path != NULL);
651 action = g_hash_table_lookup(entry->oldpath_hash, path);
656 path = g_strdup(action->newpath);
661 return FALSE; /* no change */
664 static void collect_manager_refresh(void)
670 base = g_strconcat(homedir(), "/", GQ_RC_DIR_COLLECTIONS, NULL);
671 path_list(base, &list, NULL);
674 work = collection_manager_entry_list;
677 CollectManagerEntry *entry;
684 while (list_step && entry)
688 path = list_step->data;
689 list_step = list_step->next;
691 if (strcmp(path, entry->path) == 0)
693 list = g_list_remove(list, path);
700 collect_manager_entry_free(entry);
713 collect_manager_entry_new(path);
720 static void collect_manager_process_actions(gint max)
722 if (debug && collection_manager_action_list)
724 printf("collection manager processing actions\n");
727 while (collection_manager_action_list != NULL && max > 0)
729 CollectManagerAction *action;
732 action = collection_manager_action_list->data;
733 work = collection_manager_entry_list;
736 CollectManagerEntry *entry;
741 if (action->type == COLLECTION_MANAGER_UPDATE)
743 collect_manager_entry_add_action(entry, action);
745 else if (action->oldpath && action->newpath &&
746 strcmp(action->newpath, entry->path) == 0)
748 /* convert action to standard add format */
749 g_free(action->newpath);
750 if (action->type == COLLECTION_MANAGER_ADD)
752 action->newpath = action->oldpath;
753 action->oldpath = NULL;
755 else if (action->type == COLLECTION_MANAGER_REMOVE)
757 action->newpath = NULL;
759 collect_manager_entry_add_action(entry, action);
765 if (action->type != COLLECTION_MANAGER_UPDATE &&
766 action->oldpath && action->newpath)
768 printf("collection manager failed to %s %s for collection %s\n",
769 (action->type == COLLECTION_MANAGER_ADD) ? "add" : "remove",
770 action->oldpath, action->newpath);
773 if (collection_manager_action_tail == collection_manager_action_list)
775 collection_manager_action_tail = NULL;
777 collection_manager_action_list = g_list_remove(collection_manager_action_list, action);
778 collect_manager_action_unref(action);
782 static gint collect_manager_process_entry(CollectManagerEntry *entry)
787 if (entry->empty) return FALSE;
789 cd = collection_new(entry->path);
790 success = collection_load_private(cd, entry->path, COLLECTION_LOAD_NONE);
792 collection_unref(cd);
797 static gint collect_manager_process_entry_list(void)
801 work = collection_manager_entry_list;
804 CollectManagerEntry *entry;
808 if (collect_manager_process_entry(entry)) return TRUE;
816 static gint collect_manager_process_cb(gpointer data)
818 if (collection_manager_action_list) collect_manager_refresh();
819 collect_manager_process_actions(COLLECT_MANAGER_ACTIONS_PER_IDLE);
820 if (collection_manager_action_list) return TRUE;
822 if (collect_manager_process_entry_list()) return TRUE;
824 if (debug) printf("collection manager is up to date\n");
828 static gint collect_manager_timer_cb(gpointer data)
830 if (debug) printf("collection manager timer expired\n");
832 g_idle_add_full(G_PRIORITY_LOW, collect_manager_process_cb, NULL, NULL);
834 collection_manager_timer_id = -1;
838 static void collect_manager_timer_push(gint stop)
840 if (collection_manager_timer_id != -1)
844 g_source_remove(collection_manager_timer_id);
845 collection_manager_timer_id = -1;
850 collection_manager_timer_id = g_timeout_add(COLLECT_MANAGER_FLUSH_DELAY,
851 collect_manager_timer_cb, NULL);
852 if (debug) printf("collection manager timer started\n");
856 static void collect_manager_add_action(CollectManagerAction *action)
860 /* we keep track of the list's tail to keep this a n(1) operation */
862 if (collection_manager_action_tail)
864 collection_manager_action_tail = g_list_append(collection_manager_action_tail, action);
865 collection_manager_action_tail = collection_manager_action_tail->next;
869 collection_manager_action_list = g_list_append(collection_manager_action_list, action);
870 collection_manager_action_tail = collection_manager_action_list;
873 collect_manager_timer_push(FALSE);
876 void collect_manager_moved(FileData *fd)
878 CollectManagerAction *action;
879 const gchar *oldpath = fd->change->source;
880 const gchar *newpath = fd->change->dest;
882 action = collect_manager_action_new(oldpath, newpath, COLLECTION_MANAGER_UPDATE);
883 collect_manager_add_action(action);
886 void collect_manager_add(FileData *fd, const gchar *collection)
888 CollectManagerAction *action;
891 if (!fd || !collection) return;
893 cw = collection_window_find_by_path(collection);
896 if (collection_list_find(cw->cd->list, fd->path) == NULL)
898 collection_add(cw->cd, fd, FALSE);
903 action = collect_manager_action_new(fd->path, collection, COLLECTION_MANAGER_ADD);
904 collect_manager_add_action(action);
907 void collect_manager_remove(FileData *fd, const gchar *collection)
909 CollectManagerAction *action;
912 if (!fd || !collection) return;
914 cw = collection_window_find_by_path(collection);
917 while (collection_remove(cw->cd, fd));
921 action = collect_manager_action_new(fd->path, collection, COLLECTION_MANAGER_REMOVE);
922 collect_manager_add_action(action);
925 void collect_manager_flush(void)
927 collect_manager_timer_push(TRUE);
929 if (debug) printf("collection manager flushing\n");
930 while (collect_manager_process_cb(NULL));