2 * Copyright (C) 2006 John Ellis
3 * Copyright (C) 2008 - 2016 The Geeqie Team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include "filefilter.h"
26 #include "ui-fileops.h"
30 *-----------------------------------------------------------------------------
32 *-----------------------------------------------------------------------------
35 static GList *filter_list = nullptr;
36 static GList *extension_list = nullptr;
37 static GList *sidecar_ext_list = nullptr;
39 static GList *file_class_extension_list[FILE_FORMAT_CLASSES];
41 static GList *file_writable_list = nullptr; /* writable files */
42 static GList *file_sidecar_list = nullptr; /* files with allowed sidecar */
45 static FilterEntry *filter_entry_new(const gchar *key, const gchar *description,
46 const gchar *extensions, FileFormatClass file_class,
47 gboolean writable, gboolean allow_sidecar, gboolean enabled)
51 fe = g_new0(FilterEntry, 1);
52 fe->key = g_strdup(key);
53 fe->description = g_strdup(description);
54 fe->extensions = g_strdup(extensions);
55 fe->enabled = enabled;
56 fe->file_class = file_class;
57 fe->writable = writable;
58 fe->allow_sidecar = allow_sidecar;
63 static void filter_entry_free(FilterEntry *fe)
68 g_free(fe->description);
69 g_free(fe->extensions);
73 GList *filter_get_list()
78 void filter_remove_entry(FilterEntry *fe)
80 if (!g_list_find(filter_list, fe)) return;
82 filter_list = g_list_remove(filter_list, fe);
83 filter_entry_free(fe);
86 static FilterEntry *filter_get_by_key(const gchar *key)
90 if (!key) return nullptr;
95 auto fe = static_cast<FilterEntry *>(work->data);
98 if (strcmp(fe->key, key) == 0) return fe;
104 static gboolean filter_key_exists(const gchar *key)
106 return (filter_get_by_key(key) != nullptr);
109 void filter_add(const gchar *key, const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gboolean enabled)
111 filter_list = g_list_append(filter_list, filter_entry_new(key, description, extensions, file_class, writable, allow_sidecar, enabled));
114 void filter_add_unique(const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gboolean enabled)
119 key = g_strdup("user0");
121 while (filter_key_exists(key))
125 key = g_strdup_printf("user%d", n);
129 filter_add(key, description, extensions, file_class, writable, allow_sidecar, enabled);
133 static void filter_add_if_missing(const gchar *key, const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gboolean enabled)
142 auto fe = static_cast<FilterEntry *>(work->data);
144 if (fe->key && strcmp(fe->key, key) == 0)
146 if (fe->file_class == FORMAT_CLASS_UNKNOWN)
147 fe->file_class = file_class; /* for compatibility */
149 if (fe->writable && fe->allow_sidecar)
151 fe->writable = writable;
152 fe->allow_sidecar = allow_sidecar;
158 filter_add(key, description, extensions, file_class, writable, allow_sidecar, enabled);
168 auto fe = static_cast<FilterEntry *>(work->data);
170 filter_entry_free(fe);
173 g_list_free(filter_list);
174 filter_list = nullptr;
177 void filter_add_defaults()
179 /* formats supported by custom loaders */
180 filter_add_if_missing("dds", "DirectDraw Surface", ".dds", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
182 filter_add_if_missing("pdf", "Portable Document Format", ".pdf", FORMAT_CLASS_DOCUMENT, FALSE, FALSE, TRUE);
185 filter_add_if_missing("heif/avif", "HEIF/AVIF Image", ".heif;.heic;.avif", FORMAT_CLASS_IMAGE, FALSE, TRUE, TRUE);
188 filter_add_if_missing("webp", "WebP Format", ".webp", FORMAT_CLASS_IMAGE, TRUE, FALSE, TRUE);
191 filter_add_if_missing("djvu", "DjVu Format", ".djvu;.djv", FORMAT_CLASS_DOCUMENT, FALSE, FALSE, TRUE);
194 filter_add_if_missing("jxl", "JXL", ".jxl", FORMAT_CLASS_IMAGE, FALSE, TRUE, TRUE);
197 filter_add_if_missing("jp2", "JPEG 2000", ".jp2", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
200 filter_add_if_missing("zip", "Archive files", ".zip;.rar;.tar;.tar.gz;.tar.bz2;.tar.xz;.tgz;.tbz;.txz;.cbr;.cbz;.gz;.bz2;.xz;.lzh;.lza;.7z", FORMAT_CLASS_ARCHIVE, FALSE, FALSE, TRUE);
202 filter_add_if_missing("scr", "ZX Spectrum screen Format", ".scr", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
203 filter_add_if_missing("psd", "Adobe Photoshop Document", ".psd", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
204 filter_add_if_missing("apng", "Animated Portable Network Graphic", ".apng", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
206 /* formats supported by gdk-pixbuf */
209 list = gdk_pixbuf_get_formats();
213 GdkPixbufFormat *format;
217 GString *filter = nullptr;
220 format = static_cast<GdkPixbufFormat *>(work->data);
223 name = gdk_pixbuf_format_get_name(format);
225 if (strcmp(name, "Digital camera RAW") == 0)
227 DEBUG_1("Skipped '%s' from loader", name);
232 desc = gdk_pixbuf_format_get_description(format);
233 extensions = gdk_pixbuf_format_get_extensions(format);
236 while (extensions[i])
240 filter = g_string_new(".");
241 filter = g_string_append(filter, extensions[i]);
245 filter = g_string_append(filter, ";.");
246 filter = g_string_append(filter, extensions[i]);
251 DEBUG_1("loader reported [%s] [%s] [%s]", name, desc, filter->str);
253 filter_add_if_missing(name, desc, filter->str, FORMAT_CLASS_IMAGE, TRUE, FALSE, TRUE);
257 g_strfreev(extensions);
258 g_string_free(filter, TRUE);
262 /* add defaults even if gdk-pixbuf does not have them, but disabled */
263 filter_add_if_missing("jpeg", "JPEG group", ".jpg;.jpeg;.jpe", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
264 filter_add_if_missing("png", "Portable Network Graphic", ".png", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
265 filter_add_if_missing("tiff", "Tiff", ".tif;.tiff", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
266 filter_add_if_missing("pnm", "Packed Pixel formats", ".pbm;.pgm;.pnm;.ppm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
267 filter_add_if_missing("gif", "Graphics Interchange Format", ".gif", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
268 filter_add_if_missing("xbm", "X bitmap", ".xbm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
269 filter_add_if_missing("xpm", "X pixmap", ".xpm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
270 filter_add_if_missing("bmp", "Bitmap", ".bmp", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
271 filter_add_if_missing("ico", "Icon file", ".ico;.cur", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
272 filter_add_if_missing("ras", "Raster", ".ras", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
273 filter_add_if_missing("svg", "Scalable Vector Graphics", ".svg", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
275 /* special formats for stereo */
276 filter_add_if_missing("jps", "Stereo side-by-side jpeg", ".jps", FORMAT_CLASS_IMAGE, TRUE, FALSE, TRUE);
277 filter_add_if_missing("mpo", "Stereo multi-image jpeg", ".mpo", FORMAT_CLASS_IMAGE, FALSE, TRUE, TRUE);
279 /* non-image files that might be desirable to show */
280 filter_add_if_missing("xmp", "XMP sidecar", ".xmp", FORMAT_CLASS_META, TRUE, FALSE, TRUE);
281 filter_add_if_missing("meta", "GQview legacy metadata", GQ_CACHE_EXT_METADATA, FORMAT_CLASS_META, TRUE, FALSE, TRUE);
282 filter_add_if_missing("gqv", GQ_APPNAME " image collection", GQ_COLLECTION_EXT, FORMAT_CLASS_COLLECTION, FALSE, TRUE, TRUE);
283 filter_add_if_missing("pto", "Panorama script file", ".pto", FORMAT_CLASS_META, FALSE, FALSE, TRUE);
285 /* These are the raw camera formats with embedded jpeg/exif.
286 * (see format-raw.cc and/or exiv2.cc)
288 filter_add_if_missing("arw", "Sony raw format", ".arw;.srf;.sr2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
289 filter_add_if_missing("crw", "Canon raw format", ".crw;.cr2;.cr3", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
290 filter_add_if_missing("kdc", "Kodak raw format", ".kdc;.dcr;.k25", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
291 filter_add_if_missing("raf", "Fujifilm raw format", ".raf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
292 filter_add_if_missing("mef", "Mamiya raw format", ".mef;.mos", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
293 filter_add_if_missing("mrw", "Minolta raw format", ".mrw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
294 filter_add_if_missing("nef", "Nikon raw format", ".nef", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
295 filter_add_if_missing("orf", "Olympus raw format", ".orf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
296 filter_add_if_missing("pef", "Pentax or Samsung raw format", ".pef", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
297 filter_add_if_missing("dng", "Adobe Digital Negative raw format", ".dng", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
298 filter_add_if_missing("raw", "Panasonic raw format", ".raw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
299 filter_add_if_missing("r3d", "Red raw format", ".r3d", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
300 filter_add_if_missing("3fr", "Hasselblad raw format", ".3fr", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
301 filter_add_if_missing("erf", "Epson raw format", ".erf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
302 filter_add_if_missing("srw", "Samsung raw format", ".srw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
303 filter_add_if_missing("rw2", "Panasonic raw format", ".rw2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
306 filter_add_if_missing("mp4", "MP4 video file", ".mp4;.m4v;.3gp;.3g2", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
307 filter_add_if_missing("3gp", "3GP video file", ".3gp;.3g2", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
308 filter_add_if_missing("mov", "MOV video file", ".mov;.qt", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
309 filter_add_if_missing("avi", "AVI video file", ".avi", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
310 filter_add_if_missing("mpg", "MPG video file", ".mpg;.mpeg;.mts;.m2ts", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
311 filter_add_if_missing("mkv", "Matroska video file", ".mkv;.webm", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
312 filter_add_if_missing("wmv", "Windows Media Video file", ".wmv;.asf", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
313 filter_add_if_missing("flv", "Flash Video file", ".flv", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
316 GList *filter_to_list(const gchar *extensions)
318 GList *list = nullptr;
321 if (!extensions) return nullptr;
328 gint file_class = -1;
332 while (*p != '\0' && *p != ';')
338 ext = g_strndup(b, l);
340 if (g_ascii_strcasecmp(ext, "%image") == 0) file_class = FORMAT_CLASS_IMAGE;
341 else if (g_ascii_strcasecmp(ext, "%raw") == 0) file_class = FORMAT_CLASS_RAWIMAGE;
342 else if (g_ascii_strcasecmp(ext, "%meta") == 0) file_class = FORMAT_CLASS_META;
343 else if (g_ascii_strcasecmp(ext, "%unknown") == 0) file_class = FORMAT_CLASS_UNKNOWN;
345 if (file_class == -1)
347 list = g_list_append(list, ext);
351 list = g_list_concat(list, string_list_copy(file_class_extension_list[file_class]));
361 static gint filter_sort_ext_len_cb(gconstpointer a, gconstpointer b)
363 auto sa = static_cast<const gchar *>(a);
364 auto sb = static_cast<const gchar *>(b);
366 gint len_a = strlen(sa);
367 gint len_b = strlen(sb);
369 if (len_a > len_b) return -1;
370 if (len_a < len_b) return 1;
375 void filter_rebuild()
380 string_list_free(extension_list);
381 extension_list = nullptr;
383 string_list_free(file_writable_list);
384 file_writable_list = nullptr;
386 string_list_free(file_sidecar_list);
387 file_sidecar_list = nullptr;
389 for (i = 0; i < FILE_FORMAT_CLASSES; i++)
391 string_list_free(file_class_extension_list[i]);
392 file_class_extension_list[i] = nullptr;
400 fe = static_cast<FilterEntry *>(work->data);
407 ext = filter_to_list(fe->extensions);
408 if (ext) extension_list = g_list_concat(extension_list, ext);
410 if (fe->file_class < FILE_FORMAT_CLASSES)
412 ext = filter_to_list(fe->extensions);
413 if (ext) file_class_extension_list[fe->file_class] = g_list_concat(file_class_extension_list[fe->file_class], ext);
417 log_printf("WARNING: invalid file class %d\n", fe->file_class);
422 ext = filter_to_list(fe->extensions);
423 if (ext) file_writable_list = g_list_concat(file_writable_list, ext);
426 if (fe->allow_sidecar)
428 ext = filter_to_list(fe->extensions);
429 if (ext) file_sidecar_list = g_list_concat(file_sidecar_list, ext);
435 /* make sure registered_extension_from_path finds the longer match first */
436 extension_list = g_list_sort(extension_list, filter_sort_ext_len_cb);
437 sidecar_ext_parse(options->sidecar.ext); /* this must be updated after changed file extensions */
440 /* return the extension part of the name or NULL */
441 static const gchar *filter_name_find(GList *filter, const gchar *name)
450 auto filter = static_cast<gchar *>(work->data);
451 guint lf = strlen(filter);
456 if (g_ascii_strncasecmp(name + ln - lf, filter, lf) == 0) return name + ln - lf;
463 const gchar *registered_extension_from_path(const gchar *name)
465 return filter_name_find(extension_list, name);
468 gboolean filter_name_exists(const gchar *name)
470 if (!extension_list || options->file_filter.disable) return TRUE;
472 return !!filter_name_find(extension_list, name);
475 gboolean filter_file_class(const gchar *name, FileFormatClass file_class)
477 if (file_class >= FILE_FORMAT_CLASSES)
479 log_printf("WARNING: invalid file class %d\n", file_class);
483 return !!filter_name_find(file_class_extension_list[file_class], name);
486 FileFormatClass filter_file_get_class(const gchar *name)
488 if (filter_file_class(name, FORMAT_CLASS_IMAGE)) return FORMAT_CLASS_IMAGE;
489 if (filter_file_class(name, FORMAT_CLASS_RAWIMAGE)) return FORMAT_CLASS_RAWIMAGE;
490 if (filter_file_class(name, FORMAT_CLASS_META)) return FORMAT_CLASS_META;
491 if (filter_file_class(name, FORMAT_CLASS_VIDEO)) return FORMAT_CLASS_VIDEO;
492 if (filter_file_class(name, FORMAT_CLASS_COLLECTION)) return FORMAT_CLASS_COLLECTION;
493 if (filter_file_class(name, FORMAT_CLASS_DOCUMENT)) return FORMAT_CLASS_DOCUMENT;
494 if (filter_file_class(name, FORMAT_CLASS_ARCHIVE)) return FORMAT_CLASS_ARCHIVE;
495 return FORMAT_CLASS_UNKNOWN;
498 gboolean filter_name_is_writable(const gchar *name)
500 return !!filter_name_find(file_writable_list, name);
503 gboolean filter_name_allow_sidecar(const gchar *name)
505 return !!filter_name_find(file_sidecar_list, name);
508 void filter_write_list(GString *outstr, gint indent)
512 WRITE_NL(); WRITE_STRING("<filter>");
518 auto fe = static_cast<FilterEntry *>(work->data);
521 WRITE_NL(); WRITE_STRING("<file_type ");
522 WRITE_CHAR(*fe, key);
523 WRITE_BOOL(*fe, enabled);
524 WRITE_CHAR(*fe, extensions);
525 WRITE_CHAR(*fe, description);
526 WRITE_UINT(*fe, file_class);
527 WRITE_BOOL(*fe, writable);
528 WRITE_BOOL(*fe, allow_sidecar);
532 WRITE_NL(); WRITE_STRING("</filter>");
535 void filter_load_file_type(const gchar **attribute_names, const gchar **attribute_values)
539 memset(&fe, 0, sizeof(fe));
540 while (*attribute_names)
542 const gchar *option = *attribute_names++;
543 const gchar *value = *attribute_values++;
545 if (READ_CHAR(fe, key)) continue;
546 if (READ_BOOL(fe, enabled)) continue;
547 if (READ_CHAR(fe, extensions)) continue;
548 if (READ_CHAR(fe, description)) continue;
549 if (READ_UINT_ENUM(fe, file_class)) continue;
550 if (READ_BOOL(fe, writable)) continue;
551 if (READ_BOOL(fe, allow_sidecar)) continue;
553 log_printf("unknown attribute %s = %s\n", option, value);
555 if (fe.file_class >= FILE_FORMAT_CLASSES) fe.file_class = FORMAT_CLASS_UNKNOWN;
557 if (fe.key && fe.key[0] != 0)
559 old_fe = filter_get_by_key(fe.key);
561 if (old_fe != nullptr) filter_remove_entry(old_fe);
562 filter_add(fe.key, fe.description, fe.extensions, fe.file_class, fe.writable, fe.allow_sidecar, fe.enabled);
565 g_free(fe.extensions);
566 g_free(fe.description);
571 *-----------------------------------------------------------------------------
572 * sidecar extension list
573 *-----------------------------------------------------------------------------
576 GList *sidecar_ext_get_list()
578 return sidecar_ext_list;
581 static void sidecar_ext_free_list()
585 work = sidecar_ext_list;
588 auto ext = static_cast<gchar *>(work->data);
592 g_list_free(sidecar_ext_list);
593 sidecar_ext_list = nullptr;
596 void sidecar_ext_parse(const gchar *text)
598 sidecar_ext_free_list();
599 if (text == nullptr) return;
601 sidecar_ext_list = filter_to_list(text);
605 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */