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