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.
22 #include "filefilter.h"
28 #include "main-defines.h"
29 #include "ui-fileops.h"
33 *-----------------------------------------------------------------------------
35 *-----------------------------------------------------------------------------
38 static GList *filter_list = nullptr;
39 static GList *extension_list = nullptr;
40 static GList *sidecar_ext_list = nullptr;
42 static GList *file_class_extension_list[FILE_FORMAT_CLASSES];
44 static GList *file_writable_list = nullptr; /* writable files */
45 static GList *file_sidecar_list = nullptr; /* files with allowed sidecar */
48 static FilterEntry *filter_entry_new(const gchar *key, const gchar *description,
49 const gchar *extensions, FileFormatClass file_class,
50 gboolean writable, gboolean allow_sidecar, gboolean enabled)
54 fe = g_new0(FilterEntry, 1);
55 fe->key = g_strdup(key);
56 fe->description = g_strdup(description);
57 fe->extensions = g_strdup(extensions);
58 fe->enabled = enabled;
59 fe->file_class = file_class;
60 fe->writable = writable;
61 fe->allow_sidecar = allow_sidecar;
66 static void filter_entry_free(FilterEntry *fe)
71 g_free(fe->description);
72 g_free(fe->extensions);
76 GList *filter_get_list()
81 void filter_remove_entry(FilterEntry *fe)
83 if (!g_list_find(filter_list, fe)) return;
85 filter_list = g_list_remove(filter_list, fe);
86 filter_entry_free(fe);
89 static FilterEntry *filter_get_by_key(const gchar *key)
93 if (!key) return nullptr;
98 auto fe = static_cast<FilterEntry *>(work->data);
101 if (strcmp(fe->key, key) == 0) return fe;
107 static gboolean filter_key_exists(const gchar *key)
109 return (filter_get_by_key(key) != nullptr);
112 void filter_add(const gchar *key, const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gboolean enabled)
114 filter_list = g_list_append(filter_list, filter_entry_new(key, description, extensions, file_class, writable, allow_sidecar, enabled));
117 void filter_add_unique(const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gboolean enabled)
122 key = g_strdup("user0");
124 while (filter_key_exists(key))
128 key = g_strdup_printf("user%d", n);
132 filter_add(key, description, extensions, file_class, writable, allow_sidecar, enabled);
136 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)
145 auto fe = static_cast<FilterEntry *>(work->data);
147 if (fe->key && strcmp(fe->key, key) == 0)
149 if (fe->file_class == FORMAT_CLASS_UNKNOWN)
150 fe->file_class = file_class; /* for compatibility */
152 if (fe->writable && fe->allow_sidecar)
154 fe->writable = writable;
155 fe->allow_sidecar = allow_sidecar;
161 filter_add(key, description, extensions, file_class, writable, allow_sidecar, enabled);
166 g_list_free_full(filter_list, reinterpret_cast<GDestroyNotify>(filter_entry_free));
167 filter_list = nullptr;
170 void filter_add_defaults()
172 /* formats supported by custom loaders */
173 filter_add_if_missing("dds", "DirectDraw Surface", ".dds", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
175 filter_add_if_missing("pdf", "Portable Document Format", ".pdf", FORMAT_CLASS_DOCUMENT, FALSE, FALSE, TRUE);
178 filter_add_if_missing("heif/avif", "HEIF/AVIF Image", ".heif;.heic;.avif", FORMAT_CLASS_IMAGE, FALSE, TRUE, TRUE);
181 filter_add_if_missing("webp", "WebP Format", ".webp", FORMAT_CLASS_IMAGE, TRUE, FALSE, TRUE);
184 filter_add_if_missing("djvu", "DjVu Format", ".djvu;.djv", FORMAT_CLASS_DOCUMENT, FALSE, FALSE, TRUE);
187 filter_add_if_missing("jxl", "JXL", ".jxl", FORMAT_CLASS_IMAGE, FALSE, TRUE, TRUE);
190 filter_add_if_missing("jp2", "JPEG 2000", ".jp2", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
193 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);
195 filter_add_if_missing("scr", "ZX Spectrum screen Format", ".scr", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
196 filter_add_if_missing("psd", "Adobe Photoshop Document", ".psd", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
197 filter_add_if_missing("apng", "Animated Portable Network Graphic", ".apng", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
199 /* formats supported by gdk-pixbuf */
203 list = gdk_pixbuf_get_formats();
207 GdkPixbufFormat *format;
211 GString *filter = nullptr;
214 format = static_cast<GdkPixbufFormat *>(work->data);
217 name = gdk_pixbuf_format_get_name(format);
219 if (strcmp(name, "Digital camera RAW") == 0)
221 DEBUG_1("Skipped '%s' from loader", name);
226 desc = gdk_pixbuf_format_get_description(format);
227 extensions = gdk_pixbuf_format_get_extensions(format);
230 while (extensions[i])
234 filter = g_string_new(".");
235 filter = g_string_append(filter, extensions[i]);
239 filter = g_string_append(filter, ";.");
240 filter = g_string_append(filter, extensions[i]);
245 DEBUG_1("loader reported [%s] [%s] [%s]", name, desc, filter->str);
247 filter_add_if_missing(name, desc, filter->str, FORMAT_CLASS_IMAGE, TRUE, FALSE, TRUE);
251 g_strfreev(extensions);
252 g_string_free(filter, TRUE);
256 /* add defaults even if gdk-pixbuf does not have them, but disabled */
257 filter_add_if_missing("jpeg", "JPEG group", ".jpg;.jpeg;.jpe", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
258 filter_add_if_missing("png", "Portable Network Graphic", ".png", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
259 filter_add_if_missing("tiff", "Tiff", ".tif;.tiff", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
260 filter_add_if_missing("pnm", "Packed Pixel formats", ".pbm;.pgm;.pnm;.ppm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
261 filter_add_if_missing("gif", "Graphics Interchange Format", ".gif", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
262 filter_add_if_missing("xbm", "X bitmap", ".xbm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
263 filter_add_if_missing("xpm", "X pixmap", ".xpm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
264 filter_add_if_missing("bmp", "Bitmap", ".bmp", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
265 filter_add_if_missing("ico", "Icon file", ".ico;.cur", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
266 filter_add_if_missing("ras", "Raster", ".ras", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
267 filter_add_if_missing("svg", "Scalable Vector Graphics", ".svg", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
269 /* special formats for stereo */
270 filter_add_if_missing("jps", "Stereo side-by-side jpeg", ".jps", FORMAT_CLASS_IMAGE, TRUE, FALSE, TRUE);
271 filter_add_if_missing("mpo", "Stereo multi-image jpeg", ".mpo", FORMAT_CLASS_IMAGE, FALSE, TRUE, TRUE);
273 /* non-image files that might be desirable to show */
274 filter_add_if_missing("xmp", "XMP sidecar", ".xmp", FORMAT_CLASS_META, TRUE, FALSE, TRUE);
275 filter_add_if_missing("meta", "GQview legacy metadata", GQ_CACHE_EXT_METADATA, FORMAT_CLASS_META, TRUE, FALSE, TRUE);
276 filter_add_if_missing("gqv", GQ_APPNAME " image collection", GQ_COLLECTION_EXT, FORMAT_CLASS_COLLECTION, FALSE, TRUE, TRUE);
277 filter_add_if_missing("pto", "Panorama script file", ".pto", FORMAT_CLASS_META, FALSE, FALSE, TRUE);
279 /* These are the raw camera formats with embedded jpeg/exif.
280 * (see format-raw.cc and/or exiv2.cc)
282 filter_add_if_missing("arw", "Sony raw format", ".arw;.srf;.sr2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
283 filter_add_if_missing("crw", "Canon raw format", ".crw;.cr2;.cr3", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
284 filter_add_if_missing("kdc", "Kodak raw format", ".kdc;.dcr;.k25", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
285 filter_add_if_missing("raf", "Fujifilm raw format", ".raf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
286 filter_add_if_missing("mef", "Mamiya raw format", ".mef;.mos", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
287 filter_add_if_missing("mrw", "Minolta raw format", ".mrw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
288 filter_add_if_missing("nef", "Nikon raw format", ".nef", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
289 filter_add_if_missing("orf", "Olympus raw format", ".orf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
290 filter_add_if_missing("pef", "Pentax or Samsung raw format", ".pef", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
291 filter_add_if_missing("dng", "Adobe Digital Negative raw format", ".dng", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
292 filter_add_if_missing("raw", "Panasonic raw format", ".raw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
293 filter_add_if_missing("r3d", "Red raw format", ".r3d", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
294 filter_add_if_missing("3fr", "Hasselblad raw format", ".3fr", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
295 filter_add_if_missing("erf", "Epson raw format", ".erf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
296 filter_add_if_missing("srw", "Samsung raw format", ".srw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
297 filter_add_if_missing("rw2", "Panasonic raw format", ".rw2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
300 filter_add_if_missing("mp4", "MP4 video file", ".mp4;.m4v;.3gp;.3g2", FORMAT_CLASS_VIDEO, FALSE, FALSE, TRUE);
301 filter_add_if_missing("3gp", "3GP video file", ".3gp;.3g2", FORMAT_CLASS_VIDEO, FALSE, FALSE, TRUE);
302 filter_add_if_missing("mov", "MOV video file", ".mov;.qt", FORMAT_CLASS_VIDEO, FALSE, FALSE, TRUE);
303 filter_add_if_missing("avi", "AVI video file", ".avi", FORMAT_CLASS_VIDEO, FALSE, FALSE, TRUE);
304 filter_add_if_missing("mpg", "MPG video file", ".mpg;.mpeg;.mts;.m2ts", FORMAT_CLASS_VIDEO, FALSE, FALSE, TRUE);
305 filter_add_if_missing("mkv", "Matroska video file", ".mkv;.webm", FORMAT_CLASS_VIDEO, FALSE, FALSE, TRUE);
306 filter_add_if_missing("wmv", "Windows Media Video file", ".wmv;.asf", FORMAT_CLASS_VIDEO, FALSE, FALSE, TRUE);
307 filter_add_if_missing("flv", "Flash Video file", ".flv", FORMAT_CLASS_VIDEO, FALSE, FALSE, TRUE);
310 GList *filter_to_list(const gchar *extensions)
312 GList *list = nullptr;
315 if (!extensions) return nullptr;
322 gint file_class = -1;
326 while (*p != '\0' && *p != ';')
332 ext = g_strndup(b, l);
334 if (g_ascii_strcasecmp(ext, "%image") == 0) file_class = FORMAT_CLASS_IMAGE;
335 else if (g_ascii_strcasecmp(ext, "%raw") == 0) file_class = FORMAT_CLASS_RAWIMAGE;
336 else if (g_ascii_strcasecmp(ext, "%meta") == 0) file_class = FORMAT_CLASS_META;
337 else if (g_ascii_strcasecmp(ext, "%unknown") == 0) file_class = FORMAT_CLASS_UNKNOWN;
339 if (file_class == -1)
341 list = g_list_append(list, ext);
345 list = g_list_concat(list, string_list_copy(file_class_extension_list[file_class]));
355 static gint filter_sort_ext_len_cb(gconstpointer a, gconstpointer b)
357 auto sa = static_cast<const gchar *>(a);
358 auto sb = static_cast<const gchar *>(b);
360 gint len_a = strlen(sa);
361 gint len_b = strlen(sb);
363 if (len_a > len_b) return -1;
364 if (len_a < len_b) return 1;
369 void filter_rebuild()
374 g_list_free_full(extension_list, g_free);
375 extension_list = nullptr;
377 g_list_free_full(file_writable_list, g_free);
378 file_writable_list = nullptr;
380 g_list_free_full(file_sidecar_list, g_free);
381 file_sidecar_list = nullptr;
383 for (i = 0; i < FILE_FORMAT_CLASSES; i++)
385 g_list_free_full(file_class_extension_list[i], g_free);
386 file_class_extension_list[i] = nullptr;
394 fe = static_cast<FilterEntry *>(work->data);
401 ext = filter_to_list(fe->extensions);
402 if (ext) extension_list = g_list_concat(extension_list, ext);
404 if (fe->file_class < FILE_FORMAT_CLASSES)
406 ext = filter_to_list(fe->extensions);
407 if (ext) file_class_extension_list[fe->file_class] = g_list_concat(file_class_extension_list[fe->file_class], ext);
411 log_printf("WARNING: invalid file class %d\n", fe->file_class);
416 ext = filter_to_list(fe->extensions);
417 if (ext) file_writable_list = g_list_concat(file_writable_list, ext);
420 if (fe->allow_sidecar)
422 ext = filter_to_list(fe->extensions);
423 if (ext) file_sidecar_list = g_list_concat(file_sidecar_list, ext);
429 /* make sure registered_extension_from_path finds the longer match first */
430 extension_list = g_list_sort(extension_list, filter_sort_ext_len_cb);
431 sidecar_ext_parse(options->sidecar.ext); /* this must be updated after changed file extensions */
434 /* return the extension part of the name or NULL */
435 static const gchar *filter_name_find(GList *filter, const gchar *name)
444 auto filter = static_cast<gchar *>(work->data);
445 guint lf = strlen(filter);
450 if (g_ascii_strncasecmp(name + ln - lf, filter, lf) == 0) return name + ln - lf;
457 const gchar *registered_extension_from_path(const gchar *name)
459 return filter_name_find(extension_list, name);
462 gboolean filter_name_exists(const gchar *name)
464 if (!extension_list || options->file_filter.disable) return TRUE;
466 return !!filter_name_find(extension_list, name);
469 gboolean filter_file_class(const gchar *name, FileFormatClass file_class)
471 if (file_class >= FILE_FORMAT_CLASSES)
473 log_printf("WARNING: invalid file class %d\n", file_class);
477 return !!filter_name_find(file_class_extension_list[file_class], name);
480 FileFormatClass filter_file_get_class(const gchar *name)
482 if (filter_file_class(name, FORMAT_CLASS_IMAGE)) return FORMAT_CLASS_IMAGE;
483 if (filter_file_class(name, FORMAT_CLASS_RAWIMAGE)) return FORMAT_CLASS_RAWIMAGE;
484 if (filter_file_class(name, FORMAT_CLASS_META)) return FORMAT_CLASS_META;
485 if (filter_file_class(name, FORMAT_CLASS_VIDEO)) return FORMAT_CLASS_VIDEO;
486 if (filter_file_class(name, FORMAT_CLASS_COLLECTION)) return FORMAT_CLASS_COLLECTION;
487 if (filter_file_class(name, FORMAT_CLASS_DOCUMENT)) return FORMAT_CLASS_DOCUMENT;
488 if (filter_file_class(name, FORMAT_CLASS_ARCHIVE)) return FORMAT_CLASS_ARCHIVE;
489 return FORMAT_CLASS_UNKNOWN;
492 gboolean filter_name_is_writable(const gchar *name)
494 return !!filter_name_find(file_writable_list, name);
497 gboolean filter_name_allow_sidecar(const gchar *name)
499 return !!filter_name_find(file_sidecar_list, name);
502 void filter_write_list(GString *outstr, gint indent)
506 WRITE_NL(); WRITE_STRING("<filter>");
512 auto fe = static_cast<FilterEntry *>(work->data);
515 WRITE_NL(); WRITE_STRING("<file_type ");
516 WRITE_CHAR(*fe, key);
517 WRITE_BOOL(*fe, enabled);
518 WRITE_CHAR(*fe, extensions);
519 WRITE_CHAR(*fe, description);
520 WRITE_UINT(*fe, file_class);
521 WRITE_BOOL(*fe, writable);
522 WRITE_BOOL(*fe, allow_sidecar);
526 WRITE_NL(); WRITE_STRING("</filter>");
529 void filter_load_file_type(const gchar **attribute_names, const gchar **attribute_values)
533 memset(&fe, 0, sizeof(fe));
534 while (*attribute_names)
536 const gchar *option = *attribute_names++;
537 const gchar *value = *attribute_values++;
539 if (READ_CHAR(fe, key)) continue;
540 if (READ_BOOL(fe, enabled)) continue;
541 if (READ_CHAR(fe, extensions)) continue;
542 if (READ_CHAR(fe, description)) continue;
543 if (READ_UINT_ENUM(fe, file_class)) continue;
544 if (READ_BOOL(fe, writable)) continue;
545 if (READ_BOOL(fe, allow_sidecar)) continue;
547 log_printf("unknown attribute %s = %s\n", option, value);
549 if (fe.file_class >= FILE_FORMAT_CLASSES) fe.file_class = FORMAT_CLASS_UNKNOWN;
551 if (fe.key && fe.key[0] != 0)
553 old_fe = filter_get_by_key(fe.key);
555 if (old_fe != nullptr) filter_remove_entry(old_fe);
556 filter_add(fe.key, fe.description, fe.extensions, fe.file_class, fe.writable, fe.allow_sidecar, fe.enabled);
559 g_free(fe.extensions);
560 g_free(fe.description);
565 *-----------------------------------------------------------------------------
566 * sidecar extension list
567 *-----------------------------------------------------------------------------
570 GList *sidecar_ext_get_list()
572 return sidecar_ext_list;
575 static void sidecar_ext_free_list()
577 g_list_free_full(sidecar_ext_list, g_free);
578 sidecar_ext_list = nullptr;
581 void sidecar_ext_parse(const gchar *text)
583 sidecar_ext_free_list();
584 if (text == nullptr) return;
586 sidecar_ext_list = filter_to_list(text);
590 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */