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