src/filefilter.c

   1 /*
   2  * Geeqie
   3  * (C) 2006 John Ellis
   4  * Copyright (C) 2008 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 "filefilter.h"
  16
  17 #include "cache.h"
  18 #include "misc.h"
  19 #include "secure_save.h"
  20 #include "thumb_standard.h"
  21 #include "ui_fileops.h"
  22
  23 /*
  24  *-----------------------------------------------------------------------------
  25  * file filtering
  26  *-----------------------------------------------------------------------------
  27  */
  28
  29 static GList *filter_list = NULL;
  30 static GList *extension_list = NULL;
  31 static GList *sidecar_ext_list = NULL;
  32
  33 static GList *file_class_extension_list[FILE_FORMAT_CLASSES];
  34
  35 static GList *file_writable_list = NULL; /* writable files */
  36 static GList *file_sidecar_list = NULL; /* files with allowed sidecar */
  37
  38
  39 gint ishidden(const gchar *name)
  40 {
  41         if (name[0] != '.') return FALSE;
  42         if (name[1] == '\0' || (name[1] == '.' && name[2] == '\0')) return FALSE;
  43         return TRUE;
  44 }
  45
  46 static FilterEntry *filter_entry_new(const gchar *key, const gchar *description,
  47                                      const gchar *extensions, FileFormatClass file_class,
  48                                      gboolean writable, gboolean allow_sidecar, gboolean enabled)
  49 {
  50         FilterEntry *fe;
  51
  52         fe = g_new0(FilterEntry, 1);
  53         fe->key = g_strdup(key);
  54         fe->description = g_strdup(description);
  55         fe->extensions = g_strdup(extensions);
  56         fe->enabled = enabled;
  57         fe->file_class = file_class;
  58         fe->writable = writable;
  59         fe->allow_sidecar = allow_sidecar;
  60
  61         return fe;
  62 }
  63
  64 static void filter_entry_free(FilterEntry *fe)
  65 {
  66         if (!fe) return;
  67
  68         g_free(fe->key);
  69         g_free(fe->description);
  70         g_free(fe->extensions);
  71         g_free(fe);
  72 }
  73
  74 GList *filter_get_list(void)
  75 {
  76         return filter_list;
  77 }
  78
  79 void filter_remove_entry(FilterEntry *fe)
  80 {
  81         if (!g_list_find(filter_list, fe)) return;
  82
  83         filter_list = g_list_remove(filter_list, fe);
  84         filter_entry_free(fe);
  85 }
  86
  87 static FilterEntry *filter_get_by_key(const gchar *key)
  88 {
  89         GList *work;
  90
  91         if (!key) return NULL;
  92
  93         work = filter_list;
  94         while (work)
  95                 {
  96                 FilterEntry *fe = work->data;
  97                 work = work->next;
  98
  99                 if (strcmp(fe->key, key) == 0) return fe;
 100                 }
 101
 102         return NULL;
 103 }
 104
 105 static gint filter_key_exists(const gchar *key)
 106 {
 107         return (filter_get_by_key(key) == NULL ? FALSE : TRUE);
 108 }
 109
 110 void filter_add(const gchar *key, const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gint enabled)
 111 {
 112         filter_list = g_list_append(filter_list, filter_entry_new(key, description, extensions, file_class, writable, allow_sidecar, enabled));
 113 }
 114
 115 void filter_add_unique(const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gint enabled)
 116 {
 117         gchar *key;
 118         guint n;
 119
 120         key = g_strdup("user0");
 121         n = 1;
 122         while (filter_key_exists(key))
 123                 {
 124                 g_free(key);
 125                 if (n > 999) return;
 126                 key = g_strdup_printf("user%d", n);
 127                 n++;
 128                 }
 129
 130         filter_add(key, description, extensions, file_class, writable, allow_sidecar, enabled);
 131         g_free(key);
 132 }
 133
 134 static void filter_add_if_missing(const gchar *key, const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gint enabled)
 135 {
 136         GList *work;
 137
 138         if (!key) return;
 139
 140         work = filter_list;
 141         while (work)
 142                 {
 143                 FilterEntry *fe = work->data;
 144                 work = work->next;
 145                 if (fe->key && strcmp(fe->key, key) == 0)
 146                         {
 147                         if (fe->file_class == FORMAT_CLASS_UNKNOWN)
 148                                 fe->file_class = file_class;    /* for compatibility */
 149
 150                         if (fe->writable && fe->allow_sidecar)
 151                                 {
 152                                 fe->writable = writable;
 153                                 fe->allow_sidecar = allow_sidecar;
 154                                 }
 155                         return;
 156                         }
 157                 }
 158
 159         filter_add(key, description, extensions, file_class, writable, allow_sidecar, enabled);
 160 }
 161
 162 void filter_reset(void)
 163 {
 164         GList *work;
 165
 166         work = filter_list;
 167         while (work)
 168                 {
 169                 FilterEntry *fe = work->data;
 170                 work = work->next;
 171                 filter_entry_free(fe);
 172                 }
 173
 174         g_list_free(filter_list);
 175         filter_list = NULL;
 176 }
 177
 178 void filter_add_defaults(void)
 179 {
 180         GSList *list, *work;
 181
 182         list = gdk_pixbuf_get_formats();
 183         work = list;
 184         while (work)
 185                 {
 186                 GdkPixbufFormat *format;
 187                 gchar *name;
 188                 gchar *desc;
 189                 gchar **extensions;
 190                 GString *filter = NULL;
 191                 guint i;
 192
 193                 format = work->data;
 194                 work = work->next;
 195
 196                 name = gdk_pixbuf_format_get_name(format);
 197                 desc = gdk_pixbuf_format_get_description(format);
 198                 extensions = gdk_pixbuf_format_get_extensions(format);
 199
 200                 i = 0;
 201                 while (extensions[i])
 202                         {
 203                         if (!filter)
 204                                 {
 205                                 filter = g_string_new(".");
 206                                 filter = g_string_append(filter, extensions[i]);
 207                                 }
 208                         else
 209                                 {
 210                                 filter = g_string_append(filter, ";.");
 211                                 filter = g_string_append(filter, extensions[i]);
 212                                 }
 213                         i++;
 214                         }
 215
 216                 DEBUG_1("loader reported [%s] [%s] [%s]", name, desc, filter->str);
 217
 218                 filter_add_if_missing(name, desc, filter->str, FORMAT_CLASS_IMAGE, TRUE, FALSE, TRUE);
 219
 220                 g_free(name);
 221                 g_free(desc);
 222                 g_strfreev(extensions);
 223                 g_string_free(filter, TRUE);
 224                 }
 225         g_slist_free(list);
 226
 227         /* add defaults even if gdk-pixbuf does not have them, but disabled */
 228         filter_add_if_missing("jpeg", "JPEG group", ".jpg;.jpeg;.jpe", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 229         filter_add_if_missing("png", "Portable Network Graphic", ".png", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 230         filter_add_if_missing("tiff", "Tiff", ".tif;.tiff", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 231         filter_add_if_missing("pnm", "Packed Pixel formats", ".pbm;.pgm;.pnm;.ppm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 232         filter_add_if_missing("gif", "Graphics Interchange Format", ".gif", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 233         filter_add_if_missing("xbm", "X bitmap", ".xbm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 234         filter_add_if_missing("xpm", "X pixmap", ".xpm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 235         filter_add_if_missing("bmp", "Bitmap", ".bmp", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 236         filter_add_if_missing("ico", "Icon file", ".ico;.cur", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 237         filter_add_if_missing("ras", "Raster", ".ras", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 238         filter_add_if_missing("svg", "Scalable Vector Graphics", ".svg", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 239
 240         /* non-image files that might be desirable to show */
 241         filter_add_if_missing("xmp", "XMP sidecar", ".xmp", FORMAT_CLASS_META, TRUE, FALSE, TRUE);
 242         filter_add_if_missing("gqv", GQ_APPNAME " image collection", GQ_COLLECTION_EXT, FORMAT_CLASS_META, FALSE, FALSE, TRUE);
 243
 244         /* These are the raw camera formats with embedded jpeg/exif.
 245          * (see format_raw.c and/or exiv2.cc)
 246          */
 247         filter_add_if_missing("arw", "Sony raw format", ".arw;.srf;.sr2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 248         filter_add_if_missing("crw", "Canon raw format", ".crw;.cr2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 249         filter_add_if_missing("kdc", "Kodak raw format", ".kdc;.dcr;.k25", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 250         filter_add_if_missing("raf", "Fujifilm raw format", ".raf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 251         filter_add_if_missing("mef", "Mamiya raw format", ".mef;.mos", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 252         filter_add_if_missing("mrw", "Minolta raw format", ".mrw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 253         filter_add_if_missing("nef", "Nikon raw format", ".nef", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 254         filter_add_if_missing("orf", "Olympus raw format", ".orf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 255         filter_add_if_missing("pef", "Pentax or Samsung raw format", ".pef;.ptx", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 256         filter_add_if_missing("dng", "Adobe Digital Negative raw format", ".dng", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 257         filter_add_if_missing("x3f", "Sigma raw format", ".x3f", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 258         filter_add_if_missing("raw", "Panasonic raw format", ".raw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 259         filter_add_if_missing("r3d", "Red raw format", ".r3d", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 260         filter_add_if_missing("3fr", "Hasselblad raw format", ".3fr", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 261         filter_add_if_missing("erf", "Epson raw format", ".erf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 262 }
 263
 264 GList *filter_to_list(const gchar *extensions)
 265 {
 266         GList *list = NULL;
 267         const gchar *p;
 268
 269         if (!extensions) return NULL;
 270
 271         p = extensions;
 272         while (*p != '\0')
 273                 {
 274                 const gchar *b;
 275                 gchar *ext;
 276                 gint file_class = -1;
 277                 guint l = 0;
 278
 279                 b = p;
 280                 while (*p != '\0' && *p != ';')
 281                         {
 282                         p++;
 283                         l++;
 284                         }
 285
 286                 ext = g_strndup(b, l);
 287
 288                 if (strcasecmp(ext, "%image") == 0) file_class = FORMAT_CLASS_IMAGE;
 289                 else if (strcasecmp(ext, "%raw") == 0) file_class = FORMAT_CLASS_RAWIMAGE;
 290                 else if (strcasecmp(ext, "%meta") == 0) file_class = FORMAT_CLASS_META;
 291
 292                 if (file_class == -1)
 293                         {
 294                         list = g_list_append(list, ext);
 295                         }
 296                 else
 297                         {
 298                         list = g_list_concat(list, string_list_copy(file_class_extension_list[file_class]));
 299                         g_free(ext);
 300                         }
 301
 302                 if (*p == ';') p++;
 303                 }
 304
 305         return list;
 306 }
 307
 308 void filter_rebuild(void)
 309 {
 310         GList *work;
 311         guint i;
 312
 313         string_list_free(extension_list);
 314         extension_list = NULL;
 315
 316         string_list_free(file_writable_list);
 317         file_writable_list = NULL;
 318
 319         string_list_free(file_sidecar_list);
 320         file_sidecar_list = NULL;
 321
 322         for (i = 0; i < FILE_FORMAT_CLASSES; i++)
 323                 {
 324                 string_list_free(file_class_extension_list[i]);
 325                 file_class_extension_list[i] = NULL;
 326                 }
 327
 328         work = filter_list;
 329         while (work)
 330                 {
 331                 FilterEntry *fe;
 332
 333                 fe = work->data;
 334                 work = work->next;
 335
 336                 if (fe->enabled)
 337                         {
 338                         GList *ext;
 339
 340                         ext = filter_to_list(fe->extensions);
 341                         if (ext) extension_list = g_list_concat(extension_list, ext);
 342
 343                         if (fe->file_class < FILE_FORMAT_CLASSES)
 344                                 {
 345                                 ext = filter_to_list(fe->extensions);
 346                                 if (ext) file_class_extension_list[fe->file_class] = g_list_concat(file_class_extension_list[fe->file_class], ext);
 347                                 }
 348                         else
 349                                 {
 350                                 log_printf("WARNING: invalid file class %d\n", fe->file_class);
 351                                 }
 352
 353                         if (fe->writable)
 354                                 {
 355                                 ext = filter_to_list(fe->extensions);
 356                                 if (ext) file_writable_list = g_list_concat(file_writable_list, ext);
 357                                 }
 358
 359                         if (fe->allow_sidecar)
 360                                 {
 361                                 ext = filter_to_list(fe->extensions);
 362                                 if (ext) file_sidecar_list = g_list_concat(file_sidecar_list, ext);
 363                                 }
 364
 365                         }
 366                 }
 367
 368         sidecar_ext_parse(options->sidecar.ext, FALSE); /* this must be updated after changed file extensions */
 369 }
 370
 371 static gboolean filter_name_find(GList *filter, const gchar *name)
 372 {
 373         GList *work;
 374         guint ln;
 375
 376         ln = strlen(name);
 377         work = filter;
 378         while (work)
 379                 {
 380                 gchar *filter = work->data;
 381                 guint lf = strlen(filter);
 382
 383                 if (ln >= lf)
 384                         {
 385                         /* FIXME: utf8 */
 386                         if (strncasecmp(name + ln - lf, filter, lf) == 0) return TRUE;
 387                         }
 388                 work = work->next;
 389                 }
 390
 391         return FALSE;
 392 }
 393
 394
 395 gboolean filter_name_exists(const gchar *name)
 396 {
 397         if (!extension_list || options->file_filter.disable) return TRUE;
 398
 399         return filter_name_find(extension_list, name);
 400 }
 401
 402 gboolean filter_file_class(const gchar *name, FileFormatClass file_class)
 403 {
 404         if (file_class >= FILE_FORMAT_CLASSES)
 405                 {
 406                 log_printf("WARNING: invalid file class %d\n", file_class);
 407                 return FALSE;
 408                 }
 409
 410         return filter_name_find(file_class_extension_list[file_class], name);
 411 }
 412
 413 gboolean filter_name_is_writable(const gchar *name)
 414 {
 415         return filter_name_find(file_writable_list, name);
 416 }
 417
 418 gboolean filter_name_allow_sidecar(const gchar *name)
 419 {
 420         return filter_name_find(file_sidecar_list, name);
 421 }
 422
 423 void filter_write_list(SecureSaveInfo *ssi)
 424 {
 425         GList *work;
 426
 427         work = filter_list;
 428         while (work)
 429                 {
 430                 FilterEntry *fe = work->data;
 431                 work = work->next;
 432
 433                 gchar *extensions = escquote_value(fe->extensions);
 434                 gchar *description = escquote_value(fe->description);
 435
 436                 secure_fprintf(ssi, "file_filter.ext: \"%s%s\" %s %s %d %d %d\n",
 437                                (fe->enabled) ? "" : "#",
 438                                fe->key, extensions, description, fe->file_class, fe->writable, fe->allow_sidecar);
 439                 g_free(extensions);
 440                 g_free(description);
 441                 }
 442 }
 443
 444 void filter_parse(const gchar *text)
 445 {
 446         const gchar *p;
 447         gchar *key;
 448         gchar *ext;
 449         gchar *desc;
 450         gint enabled = TRUE;
 451         guint file_class = FORMAT_CLASS_UNKNOWN;
 452         gboolean writable = TRUE;
 453         gboolean allow_sidecar = TRUE;
 454
 455         if (!text || text[0] != '"') return;
 456
 457         key = quoted_value(text, &p);
 458         if (!key) return;
 459
 460         ext = quoted_value(p, &p);
 461         desc = quoted_value(p, &p);
 462
 463         sscanf(p, "%u %d %d", &file_class, &writable, &allow_sidecar);
 464
 465         if (file_class >= FILE_FORMAT_CLASSES) file_class = FORMAT_CLASS_UNKNOWN;
 466
 467         if (key && key[0] == '#')
 468                 {
 469                 gchar *tmp;
 470                 tmp = g_strdup(key + 1);
 471                 g_free(key);
 472                 key = tmp;
 473
 474                 enabled = FALSE;
 475                 }
 476
 477         if (key && strlen(key) > 0 && ext)
 478                 {
 479                 FilterEntry *fe = filter_get_by_key(key);
 480
 481                 if (fe != NULL) filter_remove_entry(fe);
 482                 filter_add(key, desc, ext, file_class, writable, allow_sidecar, enabled);
 483                 }
 484
 485         g_free(key);
 486         g_free(ext);
 487         g_free(desc);
 488 }
 489
 490 /*
 491  *-----------------------------------------------------------------------------
 492  * sidecar extension list
 493  *-----------------------------------------------------------------------------
 494  */
 495
 496 GList *sidecar_ext_get_list(void)
 497 {
 498         return sidecar_ext_list;
 499 }
 500
 501 static void sidecar_ext_free_list(void)
 502 {
 503         GList *work;
 504
 505         work = sidecar_ext_list;
 506         while (work)
 507                 {
 508                 gchar *ext = work->data;
 509                 work = work->next;
 510                 g_free(ext);
 511                 }
 512         g_list_free(sidecar_ext_list);
 513         sidecar_ext_list = NULL;
 514 }
 515
 516 void sidecar_ext_parse(const gchar *text, gboolean quoted)
 517 {
 518         gchar *value;
 519
 520         sidecar_ext_free_list();
 521
 522         if (quoted)
 523                 value = quoted_value(text, NULL);
 524         else
 525                 value = (gchar *) text;
 526
 527         if (value == NULL) return;
 528
 529         sidecar_ext_list = filter_to_list(value);
 530
 531         if (quoted) g_free(value);
 532 }
 533
 534
 535 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */