a3b6dde99ee494da28931b1688c15d3af7559c5a
[platform/upstream/glib.git] / gio / gcontenttype.c
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2
3 /* GIO - GLib Input, Output and Streaming Library
4  *
5  * Copyright (C) 2006-2007 Red Hat, Inc.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library 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 GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General
18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19  *
20  * Author: Alexander Larsson <alexl@redhat.com>
21  */
22
23 #include "config.h"
24 #include <sys/types.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <stdio.h>
28 #include "gcontenttypeprivate.h"
29 #include "gthemedicon.h"
30 #include "gicon.h"
31 #include "gfile.h"
32 #include "gfileenumerator.h"
33 #include "gfileinfo.h"
34 #include "glibintl.h"
35
36
37 /**
38  * SECTION:gcontenttype
39  * @short_description: Platform-specific content typing
40  * @include: gio/gio.h
41  *
42  * A content type is a platform specific string that defines the type
43  * of a file. On UNIX it is a <ulink url="http://www.wikipedia.org/wiki/Internet_media_type">mime type</ulink> like "text/plain" or "image/png".
44  * On Win32 it is an extension string like ".doc", ".txt" or a perceived
45  * string like "audio". Such strings can be looked up in the registry at
46  * HKEY_CLASSES_ROOT.
47  **/
48
49 #include <dirent.h>
50
51 #define XDG_PREFIX _gio_xdg
52 #include "xdgmime/xdgmime.h"
53
54 /* We lock this mutex whenever we modify global state in this module.  */
55 G_LOCK_DEFINE_STATIC (gio_xdgmime);
56
57 gsize
58 _g_unix_content_type_get_sniff_len (void)
59 {
60   gsize size;
61
62   G_LOCK (gio_xdgmime);
63   size = xdg_mime_get_max_buffer_extents ();
64   G_UNLOCK (gio_xdgmime);
65
66   return size;
67 }
68
69 gchar *
70 _g_unix_content_type_unalias (const gchar *type)
71 {
72   gchar *res;
73
74   G_LOCK (gio_xdgmime);
75   res = g_strdup (xdg_mime_unalias_mime_type (type));
76   G_UNLOCK (gio_xdgmime);
77
78   return res;
79 }
80
81 gchar **
82 _g_unix_content_type_get_parents (const gchar *type)
83 {
84   const gchar *umime;
85   gchar **parents;
86   GPtrArray *array;
87   int i;
88
89   array = g_ptr_array_new ();
90
91   G_LOCK (gio_xdgmime);
92
93   umime = xdg_mime_unalias_mime_type (type);
94
95   g_ptr_array_add (array, g_strdup (umime));
96
97   parents = xdg_mime_list_mime_parents (umime);
98   for (i = 0; parents && parents[i] != NULL; i++)
99     g_ptr_array_add (array, g_strdup (parents[i]));
100
101   free (parents);
102
103   G_UNLOCK (gio_xdgmime);
104
105   g_ptr_array_add (array, NULL);
106
107   return (gchar **)g_ptr_array_free (array, FALSE);
108 }
109
110 /**
111  * g_content_type_equals:
112  * @type1: a content type string
113  * @type2: a content type string
114  *
115  * Compares two content types for equality.
116  *
117  * Returns: %TRUE if the two strings are identical or equivalent,
118  *     %FALSE otherwise.
119  */
120 gboolean
121 g_content_type_equals (const gchar *type1,
122                        const gchar *type2)
123 {
124   gboolean res;
125
126   g_return_val_if_fail (type1 != NULL, FALSE);
127   g_return_val_if_fail (type2 != NULL, FALSE);
128
129   G_LOCK (gio_xdgmime);
130   res = xdg_mime_mime_type_equal (type1, type2);
131   G_UNLOCK (gio_xdgmime);
132
133   return res;
134 }
135
136 /**
137  * g_content_type_is_a:
138  * @type: a content type string
139  * @supertype: a content type string
140  *
141  * Determines if @type is a subset of @supertype.
142  *
143  * Returns: %TRUE if @type is a kind of @supertype,
144  *     %FALSE otherwise.
145  */
146 gboolean
147 g_content_type_is_a (const gchar *type,
148                      const gchar *supertype)
149 {
150   gboolean res;
151
152   g_return_val_if_fail (type != NULL, FALSE);
153   g_return_val_if_fail (supertype != NULL, FALSE);
154
155   G_LOCK (gio_xdgmime);
156   res = xdg_mime_mime_type_subclass (type, supertype);
157   G_UNLOCK (gio_xdgmime);
158
159   return res;
160 }
161
162 /**
163  * g_content_type_is_unknown:
164  * @type: a content type string
165  *
166  * Checks if the content type is the generic "unknown" type.
167  * On UNIX this is the "application/octet-stream" mimetype,
168  * while on win32 it is "*".
169  *
170  * Returns: %TRUE if the type is the unknown type.
171  */
172 gboolean
173 g_content_type_is_unknown (const gchar *type)
174 {
175   g_return_val_if_fail (type != NULL, FALSE);
176
177   return strcmp (XDG_MIME_TYPE_UNKNOWN, type) == 0;
178 }
179
180
181 typedef enum {
182   MIME_TAG_TYPE_OTHER,
183   MIME_TAG_TYPE_COMMENT
184 } MimeTagType;
185
186 typedef struct {
187   int current_type;
188   int current_lang_level;
189   int comment_lang_level;
190   char *comment;
191 } MimeParser;
192
193
194 static int
195 language_level (const char *lang)
196 {
197   const char * const *lang_list;
198   int i;
199
200   /* The returned list is sorted from most desirable to least
201      desirable and always contains the default locale "C". */
202   lang_list = g_get_language_names ();
203
204   for (i = 0; lang_list[i]; i++)
205     if (strcmp (lang_list[i], lang) == 0)
206       return 1000-i;
207
208   return 0;
209 }
210
211 static void
212 mime_info_start_element (GMarkupParseContext  *context,
213                          const gchar          *element_name,
214                          const gchar         **attribute_names,
215                          const gchar         **attribute_values,
216                          gpointer              user_data,
217                          GError              **error)
218 {
219   int i;
220   const char *lang;
221   MimeParser *parser = user_data;
222
223   if (strcmp (element_name, "comment") == 0)
224     {
225       lang = "C";
226       for (i = 0; attribute_names[i]; i++)
227         if (strcmp (attribute_names[i], "xml:lang") == 0)
228           {
229             lang = attribute_values[i];
230             break;
231           }
232
233       parser->current_lang_level = language_level (lang);
234       parser->current_type = MIME_TAG_TYPE_COMMENT;
235     }
236   else
237     parser->current_type = MIME_TAG_TYPE_OTHER;
238 }
239
240 static void
241 mime_info_end_element (GMarkupParseContext  *context,
242                        const gchar          *element_name,
243                        gpointer              user_data,
244                        GError              **error)
245 {
246   MimeParser *parser = user_data;
247
248   parser->current_type = MIME_TAG_TYPE_OTHER;
249 }
250
251 static void
252 mime_info_text (GMarkupParseContext  *context,
253                 const gchar          *text,
254                 gsize                 text_len,
255                 gpointer              user_data,
256                 GError              **error)
257 {
258   MimeParser *parser = user_data;
259
260   if (parser->current_type == MIME_TAG_TYPE_COMMENT &&
261       parser->current_lang_level > parser->comment_lang_level)
262     {
263       g_free (parser->comment);
264       parser->comment = g_strndup (text, text_len);
265       parser->comment_lang_level = parser->current_lang_level;
266     }
267 }
268
269 static char *
270 load_comment_for_mime_helper (const char *dir,
271                               const char *basename)
272 {
273   GMarkupParseContext *context;
274   char *filename, *data;
275   gsize len;
276   gboolean res;
277   MimeParser parse_data = {0};
278   GMarkupParser parser = {
279     mime_info_start_element,
280     mime_info_end_element,
281     mime_info_text
282   };
283
284   filename = g_build_filename (dir, "mime", basename, NULL);
285
286   res = g_file_get_contents (filename,  &data,  &len,  NULL);
287   g_free (filename);
288   if (!res)
289     return NULL;
290
291   context = g_markup_parse_context_new   (&parser, 0, &parse_data, NULL);
292   res = g_markup_parse_context_parse (context, data, len, NULL);
293   g_free (data);
294   g_markup_parse_context_free (context);
295
296   if (!res)
297     return NULL;
298
299   return parse_data.comment;
300 }
301
302
303 static char *
304 load_comment_for_mime (const char *mimetype)
305 {
306   const char * const* dirs;
307   char *basename;
308   char *comment;
309   int i;
310
311   basename = g_strdup_printf ("%s.xml", mimetype);
312
313   comment = load_comment_for_mime_helper (g_get_user_data_dir (), basename);
314   if (comment)
315     {
316       g_free (basename);
317       return comment;
318     }
319
320   dirs = g_get_system_data_dirs ();
321
322   for (i = 0; dirs[i] != NULL; i++)
323     {
324       comment = load_comment_for_mime_helper (dirs[i], basename);
325       if (comment)
326         {
327           g_free (basename);
328           return comment;
329         }
330     }
331   g_free (basename);
332
333   return g_strdup_printf (_("%s type"), mimetype);
334 }
335
336 /**
337  * g_content_type_get_description:
338  * @type: a content type string
339  *
340  * Gets the human readable description of the content type.
341  *
342  * Returns: a short description of the content type @type. Free the
343  *     returned string with g_free()
344  */
345 gchar *
346 g_content_type_get_description (const gchar *type)
347 {
348   static GHashTable *type_comment_cache = NULL;
349   gchar *comment;
350
351   g_return_val_if_fail (type != NULL, NULL);
352
353   G_LOCK (gio_xdgmime);
354   type = xdg_mime_unalias_mime_type (type);
355
356   if (type_comment_cache == NULL)
357     type_comment_cache = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
358
359   comment = g_hash_table_lookup (type_comment_cache, type);
360   comment = g_strdup (comment);
361   G_UNLOCK (gio_xdgmime);
362
363   if (comment != NULL)
364     return comment;
365
366   comment = load_comment_for_mime (type);
367
368   G_LOCK (gio_xdgmime);
369   g_hash_table_insert (type_comment_cache,
370                        g_strdup (type),
371                        g_strdup (comment));
372   G_UNLOCK (gio_xdgmime);
373
374   return comment;
375 }
376
377 /**
378  * g_content_type_get_mime_type:
379  * @type: a content type string
380  *
381  * Gets the mime type for the content type, if one is registered.
382  *
383  * Returns: (allow-none): the registered mime type for the given @type,
384  *     or %NULL if unknown.
385  */
386 char *
387 g_content_type_get_mime_type (const char *type)
388 {
389   g_return_val_if_fail (type != NULL, NULL);
390
391   return g_strdup (type);
392 }
393
394 #pragma GCC diagnostic push
395 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
396
397 static GIcon *
398 g_content_type_get_icon_internal (const gchar *type,
399                                   gboolean     symbolic)
400 {
401   char *mimetype_icon;
402   char *generic_mimetype_icon = NULL;
403   char *q;
404   char *xdg_mimetype_icon = NULL;
405   char *xdg_mimetype_generic_icon;
406   char *icon_names[3];
407   int n = 0;
408   GIcon *themed_icon;
409   const char  *xdg_icon;
410   const char *suffix;
411
412   g_return_val_if_fail (type != NULL, NULL);
413
414   if (symbolic)
415     suffix = "-symbolic";
416   else
417     suffix = "";
418
419   G_LOCK (gio_xdgmime);
420   xdg_icon = xdg_mime_get_icon (type);
421   G_UNLOCK (gio_xdgmime);
422    if (xdg_icon != NULL)
423     xdg_mimetype_icon = g_strconcat (xdg_icon, suffix, NULL);
424
425   if (xdg_mimetype_icon)
426     icon_names[n++] = xdg_mimetype_icon;
427
428   mimetype_icon = g_strconcat (type, suffix, NULL);
429   while ((q = strchr (mimetype_icon, '/')) != NULL)
430     *q = '-';
431
432   icon_names[n++] = mimetype_icon;
433
434   xdg_mimetype_generic_icon = g_content_type_get_generic_icon_name (type);
435   if (xdg_mimetype_generic_icon)
436     generic_mimetype_icon = g_strconcat (xdg_mimetype_generic_icon, suffix, NULL);
437   if (generic_mimetype_icon)
438     icon_names[n++] = generic_mimetype_icon;
439
440   themed_icon = g_themed_icon_new_from_names (icon_names, n);
441
442   g_free (xdg_mimetype_icon);
443   g_free (xdg_mimetype_generic_icon);
444   g_free (mimetype_icon);
445   g_free (generic_mimetype_icon);
446
447   return themed_icon;
448 }
449 #pragma GCC diagnostic pop
450
451 /**
452  * g_content_type_get_icon:
453  * @type: a content type string
454  *
455  * Gets the icon for a content type.
456  *
457  * Returns: (transfer full): #GIcon corresponding to the content type. Free the returned
458  *     object with g_object_unref()
459  */
460 GIcon *
461 g_content_type_get_icon (const gchar *type)
462 {
463   return g_content_type_get_icon_internal (type, FALSE);
464 }
465
466 /**
467  * g_content_type_get_symbolic_icon:
468  * @type: a content type string
469  *
470  * Gets the symbolic icon for a content type.
471  *
472  * Returns: (transfer full): symbolic #GIcon corresponding to the content type.
473  *     Free the returned object with g_object_unref()
474  *
475  * Since: 2.34
476  */
477 GIcon *
478 g_content_type_get_symbolic_icon (const gchar *type)
479 {
480   return g_content_type_get_icon_internal (type, TRUE);
481 }
482
483 /**
484  * g_content_type_get_generic_icon_name:
485  * @type: a content type string
486  *
487  * Gets the generic icon name for a content type.
488  *
489  * See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
490  * specification for more on the generic icon name.
491  *
492  * Returns: (allow-none): the registered generic icon name for the given @type,
493  *     or %NULL if unknown. Free with g_free()
494  *
495  * Since: 2.34
496  */
497 gchar *
498 g_content_type_get_generic_icon_name (const gchar *type)
499 {
500   const gchar *xdg_icon_name;
501   gchar *icon_name;
502
503   G_LOCK (gio_xdgmime);
504   xdg_icon_name = xdg_mime_get_generic_icon (type);
505   G_UNLOCK (gio_xdgmime);
506
507   if (!xdg_icon_name)
508     {
509       const char *p;
510       const char *suffix = "-x-generic";
511
512       p = strchr (type, '/');
513       if (p == NULL)
514         p = type + strlen (type);
515
516       icon_name = g_malloc (p - type + strlen (suffix) + 1);
517       memcpy (icon_name, type, p - type);
518       memcpy (icon_name + (p - type), suffix, strlen (suffix));
519       icon_name[(p - type) + strlen (suffix)] = 0;
520     }
521   else
522     {
523       icon_name = g_strdup (xdg_icon_name);
524     }
525
526   return icon_name;
527 }
528
529 /**
530  * g_content_type_can_be_executable:
531  * @type: a content type string
532  *
533  * Checks if a content type can be executable. Note that for instance
534  * things like text files can be executables (i.e. scripts and batch files).
535  *
536  * Returns: %TRUE if the file type corresponds to a type that
537  *     can be executable, %FALSE otherwise.
538  */
539 gboolean
540 g_content_type_can_be_executable (const gchar *type)
541 {
542   g_return_val_if_fail (type != NULL, FALSE);
543
544   if (g_content_type_is_a (type, "application/x-executable")  ||
545       g_content_type_is_a (type, "text/plain"))
546     return TRUE;
547
548   return FALSE;
549 }
550
551 static gboolean
552 looks_like_text (const guchar *data, gsize data_size)
553 {
554   gsize i;
555   char c;
556
557   for (i = 0; i < data_size; i++)
558     {
559       c = data[i];
560
561       if (g_ascii_iscntrl (c) &&
562           !g_ascii_isspace (c) &&
563           c != '\b')
564         return FALSE;
565     }
566   return TRUE;
567 }
568
569 /**
570  * g_content_type_from_mime_type:
571  * @mime_type: a mime type string
572  *
573  * Tries to find a content type based on the mime type name.
574  *
575  * Returns: (allow-none): Newly allocated string with content type
576  *     or %NULL. Free with g_free()
577  *
578  * Since: 2.18
579  **/
580 gchar *
581 g_content_type_from_mime_type (const gchar *mime_type)
582 {
583   char *umime;
584
585   g_return_val_if_fail (mime_type != NULL, NULL);
586
587   G_LOCK (gio_xdgmime);
588   /* mime type and content type are same on unixes */
589   umime = g_strdup (xdg_mime_unalias_mime_type (mime_type));
590   G_UNLOCK (gio_xdgmime);
591
592   return umime;
593 }
594
595 /**
596  * g_content_type_guess:
597  * @filename: (allow-none): a string, or %NULL
598  * @data: (allow-none) (array length=data_size): a stream of data, or %NULL
599  * @data_size: the size of @data
600  * @result_uncertain: (allow-none) (out): return location for the certainty
601  *     of the result, or %NULL
602  *
603  * Guesses the content type based on example data. If the function is
604  * uncertain, @result_uncertain will be set to %TRUE. Either @filename
605  * or @data may be %NULL, in which case the guess will be based solely
606  * on the other argument.
607  *
608  * Returns: a string indicating a guessed content type for the
609  *     given data. Free with g_free()
610  */
611 gchar *
612 g_content_type_guess (const gchar  *filename,
613                       const guchar *data,
614                       gsize         data_size,
615                       gboolean     *result_uncertain)
616 {
617   char *basename;
618   const char *name_mimetypes[10], *sniffed_mimetype;
619   char *mimetype;
620   int i;
621   int n_name_mimetypes;
622   int sniffed_prio;
623
624   sniffed_prio = 0;
625   n_name_mimetypes = 0;
626   sniffed_mimetype = XDG_MIME_TYPE_UNKNOWN;
627
628   if (result_uncertain)
629     *result_uncertain = FALSE;
630
631   /* our test suite and potentially other code used -1 in the past, which is
632    * not documented and not allowed; guard against that */
633   g_return_val_if_fail (data_size != (gsize) -1, g_strdup (XDG_MIME_TYPE_UNKNOWN));
634
635   G_LOCK (gio_xdgmime);
636
637   if (filename)
638     {
639       i = strlen (filename);
640       if (filename[i - 1] == '/')
641         {
642           name_mimetypes[0] = "inode/directory";
643           name_mimetypes[1] = NULL;
644           n_name_mimetypes = 1;
645           if (result_uncertain)
646             *result_uncertain = TRUE;
647         }
648       else
649         {
650           basename = g_path_get_basename (filename);
651           n_name_mimetypes = xdg_mime_get_mime_types_from_file_name (basename, name_mimetypes, 10);
652           g_free (basename);
653         }
654     }
655
656   /* Got an extension match, and no conflicts. This is it. */
657   if (n_name_mimetypes == 1)
658     {
659       gchar *s = g_strdup (name_mimetypes[0]);
660       G_UNLOCK (gio_xdgmime);
661       return s;
662     }
663
664   if (data)
665     {
666       sniffed_mimetype = xdg_mime_get_mime_type_for_data (data, data_size, &sniffed_prio);
667       if (sniffed_mimetype == XDG_MIME_TYPE_UNKNOWN &&
668           data &&
669           looks_like_text (data, data_size))
670         sniffed_mimetype = "text/plain";
671
672       /* For security reasons we don't ever want to sniff desktop files
673        * where we know the filename and it doesn't have a .desktop extension.
674        * This is because desktop files allow executing any application and
675        * we don't want to make it possible to hide them looking like something
676        * else.
677        */
678       if (filename != NULL &&
679           strcmp (sniffed_mimetype, "application/x-desktop") == 0)
680         sniffed_mimetype = "text/plain";
681     }
682
683   if (n_name_mimetypes == 0)
684     {
685       if (sniffed_mimetype == XDG_MIME_TYPE_UNKNOWN &&
686           result_uncertain)
687         *result_uncertain = TRUE;
688
689       mimetype = g_strdup (sniffed_mimetype);
690     }
691   else
692     {
693       mimetype = NULL;
694       if (sniffed_mimetype != XDG_MIME_TYPE_UNKNOWN)
695         {
696           if (sniffed_prio >= 80) /* High priority sniffing match, use that */
697             mimetype = g_strdup (sniffed_mimetype);
698           else
699             {
700               /* There are conflicts between the name matches and we
701                * have a sniffed type, use that as a tie breaker.
702                */
703               for (i = 0; i < n_name_mimetypes; i++)
704                 {
705                   if ( xdg_mime_mime_type_subclass (name_mimetypes[i], sniffed_mimetype))
706                     {
707                       /* This nametype match is derived from (or the same as)
708                        * the sniffed type). This is probably it.
709                        */
710                       mimetype = g_strdup (name_mimetypes[i]);
711                       break;
712                     }
713                 }
714             }
715         }
716
717       if (mimetype == NULL)
718         {
719           /* Conflicts, and sniffed type was no help or not there.
720            * Guess on the first one
721            */
722           mimetype = g_strdup (name_mimetypes[0]);
723           if (result_uncertain)
724             *result_uncertain = TRUE;
725         }
726     }
727
728   G_UNLOCK (gio_xdgmime);
729
730   return mimetype;
731 }
732
733 static void
734 enumerate_mimetypes_subdir (const char *dir,
735                             const char *prefix,
736                             GHashTable *mimetypes)
737 {
738   DIR *d;
739   struct dirent *ent;
740   char *mimetype;
741
742   d = opendir (dir);
743   if (d)
744     {
745       while ((ent = readdir (d)) != NULL)
746         {
747           if (g_str_has_suffix (ent->d_name, ".xml"))
748             {
749               mimetype = g_strdup_printf ("%s/%.*s", prefix, (int) strlen (ent->d_name) - 4, ent->d_name);
750               g_hash_table_replace (mimetypes, mimetype, NULL);
751             }
752         }
753       closedir (d);
754     }
755 }
756
757 static void
758 enumerate_mimetypes_dir (const char *dir,
759                          GHashTable *mimetypes)
760 {
761   DIR *d;
762   struct dirent *ent;
763   char *mimedir;
764   char *name;
765
766   mimedir = g_build_filename (dir, "mime", NULL);
767
768   d = opendir (mimedir);
769   if (d)
770     {
771       while ((ent = readdir (d)) != NULL)
772         {
773           if (strcmp (ent->d_name, "packages") != 0)
774             {
775               name = g_build_filename (mimedir, ent->d_name, NULL);
776               if (g_file_test (name, G_FILE_TEST_IS_DIR))
777                 enumerate_mimetypes_subdir (name, ent->d_name, mimetypes);
778               g_free (name);
779             }
780         }
781       closedir (d);
782     }
783
784   g_free (mimedir);
785 }
786
787 /**
788  * g_content_types_get_registered:
789  *
790  * Gets a list of strings containing all the registered content types
791  * known to the system. The list and its data should be freed using
792  * g_list_free_full (list, g_free).
793  *
794  * Returns: (element-type utf8) (transfer full): list of the registered
795  *     content types
796  */
797 GList *
798 g_content_types_get_registered (void)
799 {
800   const char * const* dirs;
801   GHashTable *mimetypes;
802   GHashTableIter iter;
803   gpointer key;
804   int i;
805   GList *l;
806
807   mimetypes = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
808
809   enumerate_mimetypes_dir (g_get_user_data_dir (), mimetypes);
810   dirs = g_get_system_data_dirs ();
811
812   for (i = 0; dirs[i] != NULL; i++)
813     enumerate_mimetypes_dir (dirs[i], mimetypes);
814
815   l = NULL;
816   g_hash_table_iter_init (&iter, mimetypes);
817   while (g_hash_table_iter_next (&iter, &key, NULL))
818     {
819       l = g_list_prepend (l, key);
820       g_hash_table_iter_steal (&iter);
821     }
822
823   g_hash_table_destroy (mimetypes);
824
825   return l;
826 }
827
828
829 /* tree magic data */
830 static GList *tree_matches = NULL;
831 static gboolean need_reload = FALSE;
832
833 G_LOCK_DEFINE_STATIC (gio_treemagic);
834
835 typedef struct
836 {
837   gchar *path;
838   GFileType type;
839   guint match_case : 1;
840   guint executable : 1;
841   guint non_empty  : 1;
842   guint on_disc    : 1;
843   gchar *mimetype;
844   GList *matches;
845 } TreeMatchlet;
846
847 typedef struct
848 {
849   gchar *contenttype;
850   gint priority;
851   GList *matches;
852 } TreeMatch;
853
854
855 static void
856 tree_matchlet_free (TreeMatchlet *matchlet)
857 {
858   g_list_free_full (matchlet->matches, (GDestroyNotify) tree_matchlet_free);
859   g_free (matchlet->path);
860   g_free (matchlet->mimetype);
861   g_slice_free (TreeMatchlet, matchlet);
862 }
863
864 static void
865 tree_match_free (TreeMatch *match)
866 {
867   g_list_free_full (match->matches, (GDestroyNotify) tree_matchlet_free);
868   g_free (match->contenttype);
869   g_slice_free (TreeMatch, match);
870 }
871
872 static TreeMatch *
873 parse_header (gchar *line)
874 {
875   gint len;
876   gchar *s;
877   TreeMatch *match;
878
879   len = strlen (line);
880
881   if (line[0] != '[' || line[len - 1] != ']')
882     return NULL;
883
884   line[len - 1] = 0;
885   s = strchr (line, ':');
886
887   match = g_slice_new0 (TreeMatch);
888   match->priority = atoi (line + 1);
889   match->contenttype = g_strdup (s + 1);
890
891   return match;
892 }
893
894 static TreeMatchlet *
895 parse_match_line (gchar *line,
896                   gint  *depth)
897 {
898   gchar *s, *p;
899   TreeMatchlet *matchlet;
900   gchar **parts;
901   gint i;
902
903   matchlet = g_slice_new0 (TreeMatchlet);
904
905   if (line[0] == '>')
906     {
907       *depth = 0;
908       s = line;
909     }
910   else
911     {
912       *depth = atoi (line);
913       s = strchr (line, '>');
914     }
915   s += 2;
916   p = strchr (s, '"');
917   *p = 0;
918
919   matchlet->path = g_strdup (s);
920   s = p + 1;
921   parts = g_strsplit (s, ",", 0);
922   if (strcmp (parts[0], "=file") == 0)
923     matchlet->type = G_FILE_TYPE_REGULAR;
924   else if (strcmp (parts[0], "=directory") == 0)
925     matchlet->type = G_FILE_TYPE_DIRECTORY;
926   else if (strcmp (parts[0], "=link") == 0)
927     matchlet->type = G_FILE_TYPE_SYMBOLIC_LINK;
928   else
929     matchlet->type = G_FILE_TYPE_UNKNOWN;
930   for (i = 1; parts[i]; i++)
931     {
932       if (strcmp (parts[i], "executable") == 0)
933         matchlet->executable = 1;
934       else if (strcmp (parts[i], "match-case") == 0)
935         matchlet->match_case = 1;
936       else if (strcmp (parts[i], "non-empty") == 0)
937         matchlet->non_empty = 1;
938       else if (strcmp (parts[i], "on-disc") == 0)
939         matchlet->on_disc = 1;
940       else
941         matchlet->mimetype = g_strdup (parts[i]);
942     }
943
944   g_strfreev (parts);
945
946   return matchlet;
947 }
948
949 static gint
950 cmp_match (gconstpointer a, gconstpointer b)
951 {
952   const TreeMatch *aa = (const TreeMatch *)a;
953   const TreeMatch *bb = (const TreeMatch *)b;
954
955   return bb->priority - aa->priority;
956 }
957
958 static void
959 insert_match (TreeMatch *match)
960 {
961   tree_matches = g_list_insert_sorted (tree_matches, match, cmp_match);
962 }
963
964 static void
965 insert_matchlet (TreeMatch    *match,
966                  TreeMatchlet *matchlet,
967                  gint          depth)
968 {
969   if (depth == 0)
970     match->matches = g_list_append (match->matches, matchlet);
971   else
972     {
973       GList *last;
974       TreeMatchlet *m;
975
976       last = g_list_last (match->matches);
977       if (!last)
978         {
979           tree_matchlet_free (matchlet);
980           g_warning ("can't insert tree matchlet at depth %d", depth);
981           return;
982         }
983
984       m = (TreeMatchlet *) last->data;
985       while (--depth > 0)
986         {
987           last = g_list_last (m->matches);
988           if (!last)
989             {
990               tree_matchlet_free (matchlet);
991               g_warning ("can't insert tree matchlet at depth %d", depth);
992               return;
993             }
994
995           m = (TreeMatchlet *) last->data;
996         }
997       m->matches = g_list_append (m->matches, matchlet);
998     }
999 }
1000
1001 static void
1002 read_tree_magic_from_directory (const gchar *prefix)
1003 {
1004   gchar *filename;
1005   gchar *text;
1006   gsize len;
1007   gchar **lines;
1008   gint i;
1009   TreeMatch *match;
1010   TreeMatchlet *matchlet;
1011   gint depth;
1012
1013   filename = g_build_filename (prefix, "mime", "treemagic", NULL);
1014
1015   if (g_file_get_contents (filename, &text, &len, NULL))
1016     {
1017       if (strcmp (text, "MIME-TreeMagic") == 0)
1018         {
1019           lines = g_strsplit (text + strlen ("MIME-TreeMagic") + 2, "\n", 0);
1020           match = NULL;
1021           for (i = 0; lines[i] && lines[i][0]; i++)
1022             {
1023               if (lines[i][0] == '[')
1024                 {
1025                   match = parse_header (lines[i]);
1026                   insert_match (match);
1027                 }
1028               else if (match != NULL)
1029                 {
1030                   matchlet = parse_match_line (lines[i], &depth);
1031                   insert_matchlet (match, matchlet, depth);
1032                 }
1033               else
1034                 {
1035                   g_warning ("%s: header corrupt; skipping\n", filename);
1036                   break;
1037                 }
1038             }
1039
1040           g_strfreev (lines);
1041         }
1042       else
1043         g_warning ("%s: header not found, skipping\n", filename);
1044
1045       g_free (text);
1046     }
1047
1048   g_free (filename);
1049 }
1050
1051
1052 static void
1053 xdg_mime_reload (void *user_data)
1054 {
1055   need_reload = TRUE;
1056 }
1057
1058 static void
1059 tree_magic_shutdown (void)
1060 {
1061   g_list_free_full (tree_matches, (GDestroyNotify) tree_match_free);
1062   tree_matches = NULL;
1063 }
1064
1065 static void
1066 tree_magic_init (void)
1067 {
1068   static gboolean initialized = FALSE;
1069   const gchar *dir;
1070   const gchar * const * dirs;
1071   int i;
1072
1073   if (!initialized)
1074     {
1075       initialized = TRUE;
1076
1077       xdg_mime_register_reload_callback (xdg_mime_reload, NULL, NULL);
1078       need_reload = TRUE;
1079     }
1080
1081   if (need_reload)
1082     {
1083       need_reload = FALSE;
1084
1085       tree_magic_shutdown ();
1086
1087       dir = g_get_user_data_dir ();
1088       read_tree_magic_from_directory (dir);
1089       dirs = g_get_system_data_dirs ();
1090       for (i = 0; dirs[i]; i++)
1091         read_tree_magic_from_directory (dirs[i]);
1092     }
1093 }
1094
1095 /* a filtering enumerator */
1096
1097 typedef struct
1098 {
1099   gchar *path;
1100   gint depth;
1101   gboolean ignore_case;
1102   gchar **components;
1103   gchar **case_components;
1104   GFileEnumerator **enumerators;
1105   GFile **children;
1106 } Enumerator;
1107
1108 static gboolean
1109 component_match (Enumerator  *e,
1110                  gint         depth,
1111                  const gchar *name)
1112 {
1113   gchar *case_folded, *key;
1114   gboolean found;
1115
1116   if (strcmp (name, e->components[depth]) == 0)
1117     return TRUE;
1118
1119   if (!e->ignore_case)
1120     return FALSE;
1121
1122   case_folded = g_utf8_casefold (name, -1);
1123   key = g_utf8_collate_key (case_folded, -1);
1124
1125   found = strcmp (key, e->case_components[depth]) == 0;
1126
1127   g_free (case_folded);
1128   g_free (key);
1129
1130   return found;
1131 }
1132
1133 static GFile *
1134 next_match_recurse (Enumerator *e,
1135                     gint        depth)
1136 {
1137   GFile *file;
1138   GFileInfo *info;
1139   const gchar *name;
1140
1141   while (TRUE)
1142     {
1143       if (e->enumerators[depth] == NULL)
1144         {
1145           if (depth > 0)
1146             {
1147               file = next_match_recurse (e, depth - 1);
1148               if (file)
1149                 {
1150                   e->children[depth] = file;
1151                   e->enumerators[depth] = g_file_enumerate_children (file,
1152                                                                      G_FILE_ATTRIBUTE_STANDARD_NAME,
1153                                                                      G_FILE_QUERY_INFO_NONE,
1154                                                                      NULL,
1155                                                                      NULL);
1156                 }
1157             }
1158           if (e->enumerators[depth] == NULL)
1159             return NULL;
1160         }
1161
1162       while ((info = g_file_enumerator_next_file (e->enumerators[depth], NULL, NULL)))
1163         {
1164           name = g_file_info_get_name (info);
1165           if (component_match (e, depth, name))
1166             {
1167               file = g_file_get_child (e->children[depth], name);
1168               g_object_unref (info);
1169               return file;
1170             }
1171           g_object_unref (info);
1172         }
1173
1174       g_object_unref (e->enumerators[depth]);
1175       e->enumerators[depth] = NULL;
1176       g_object_unref (e->children[depth]);
1177       e->children[depth] = NULL;
1178     }
1179 }
1180
1181 static GFile *
1182 enumerator_next (Enumerator *e)
1183 {
1184   return next_match_recurse (e, e->depth - 1);
1185 }
1186
1187 static Enumerator *
1188 enumerator_new (GFile      *root,
1189                 const char *path,
1190                 gboolean    ignore_case)
1191 {
1192   Enumerator *e;
1193   gint i;
1194   gchar *case_folded;
1195
1196   e = g_new0 (Enumerator, 1);
1197   e->path = g_strdup (path);
1198   e->ignore_case = ignore_case;
1199
1200   e->components = g_strsplit (e->path, G_DIR_SEPARATOR_S, -1);
1201   e->depth = g_strv_length (e->components);
1202   if (e->ignore_case)
1203     {
1204       e->case_components = g_new0 (char *, e->depth + 1);
1205       for (i = 0; e->components[i]; i++)
1206         {
1207           case_folded = g_utf8_casefold (e->components[i], -1);
1208           e->case_components[i] = g_utf8_collate_key (case_folded, -1);
1209           g_free (case_folded);
1210         }
1211     }
1212
1213   e->children = g_new0 (GFile *, e->depth);
1214   e->children[0] = g_object_ref (root);
1215   e->enumerators = g_new0 (GFileEnumerator *, e->depth);
1216   e->enumerators[0] = g_file_enumerate_children (root,
1217                                                  G_FILE_ATTRIBUTE_STANDARD_NAME,
1218                                                  G_FILE_QUERY_INFO_NONE,
1219                                                  NULL,
1220                                                  NULL);
1221
1222   return e;
1223 }
1224
1225 static void
1226 enumerator_free (Enumerator *e)
1227 {
1228   gint i;
1229
1230   for (i = 0; i < e->depth; i++)
1231     {
1232       if (e->enumerators[i])
1233         g_object_unref (e->enumerators[i]);
1234       if (e->children[i])
1235         g_object_unref (e->children[i]);
1236     }
1237
1238   g_free (e->enumerators);
1239   g_free (e->children);
1240   g_strfreev (e->components);
1241   if (e->case_components)
1242     g_strfreev (e->case_components);
1243   g_free (e->path);
1244   g_free (e);
1245 }
1246
1247 static gboolean
1248 matchlet_match (TreeMatchlet *matchlet,
1249                 GFile        *root)
1250 {
1251   GFile *file;
1252   GFileInfo *info;
1253   gboolean result;
1254   const gchar *attrs;
1255   Enumerator *e;
1256   GList *l;
1257
1258   e = enumerator_new (root, matchlet->path, !matchlet->match_case);
1259
1260   do
1261     {
1262       file = enumerator_next (e);
1263       if (!file)
1264         {
1265           enumerator_free (e);
1266           return FALSE;
1267         }
1268
1269       if (matchlet->mimetype)
1270         attrs = G_FILE_ATTRIBUTE_STANDARD_TYPE ","
1271                 G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE ","
1272                 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE;
1273       else
1274         attrs = G_FILE_ATTRIBUTE_STANDARD_TYPE ","
1275                 G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE;
1276       info = g_file_query_info (file,
1277                                 attrs,
1278                                 G_FILE_QUERY_INFO_NONE,
1279                                 NULL,
1280                                 NULL);
1281       if (info)
1282         {
1283           result = TRUE;
1284
1285           if (matchlet->type != G_FILE_TYPE_UNKNOWN &&
1286               g_file_info_get_file_type (info) != matchlet->type)
1287             result = FALSE;
1288
1289           if (matchlet->executable &&
1290               !g_file_info_get_attribute_boolean (info, G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE))
1291             result = FALSE;
1292         }
1293       else
1294         result = FALSE;
1295
1296       if (result && matchlet->non_empty)
1297         {
1298           GFileEnumerator *child_enum;
1299           GFileInfo *child_info;
1300
1301           child_enum = g_file_enumerate_children (file,
1302                                                   G_FILE_ATTRIBUTE_STANDARD_NAME,
1303                                                   G_FILE_QUERY_INFO_NONE,
1304                                                   NULL,
1305                                                   NULL);
1306
1307           if (child_enum)
1308             {
1309               child_info = g_file_enumerator_next_file (child_enum, NULL, NULL);
1310               if (child_info)
1311                 g_object_unref (child_info);
1312               else
1313                 result = FALSE;
1314               g_object_unref (child_enum);
1315             }
1316           else
1317             result = FALSE;
1318         }
1319
1320       if (result && matchlet->mimetype)
1321         {
1322           if (strcmp (matchlet->mimetype, g_file_info_get_content_type (info)) != 0)
1323             result = FALSE;
1324         }
1325
1326       if (info)
1327         g_object_unref (info);
1328       g_object_unref (file);
1329     }
1330   while (!result);
1331
1332   enumerator_free (e);
1333
1334   if (!matchlet->matches)
1335     return TRUE;
1336
1337   for (l = matchlet->matches; l; l = l->next)
1338     {
1339       TreeMatchlet *submatchlet;
1340
1341       submatchlet = l->data;
1342       if (matchlet_match (submatchlet, root))
1343         return TRUE;
1344     }
1345
1346   return FALSE;
1347 }
1348
1349 static void
1350 match_match (TreeMatch    *match,
1351              GFile        *root,
1352              GPtrArray    *types)
1353 {
1354   GList *l;
1355
1356   for (l = match->matches; l; l = l->next)
1357     {
1358       TreeMatchlet *matchlet = l->data;
1359       if (matchlet_match (matchlet, root))
1360         {
1361           g_ptr_array_add (types, g_strdup (match->contenttype));
1362           break;
1363         }
1364     }
1365 }
1366
1367 /**
1368  * g_content_type_guess_for_tree:
1369  * @root: the root of the tree to guess a type for
1370  *
1371  * Tries to guess the type of the tree with root @root, by
1372  * looking at the files it contains. The result is an array
1373  * of content types, with the best guess coming first.
1374  *
1375  * The types returned all have the form x-content/foo, e.g.
1376  * x-content/audio-cdda (for audio CDs) or x-content/image-dcf
1377  * (for a camera memory card). See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
1378  * specification for more on x-content types.
1379  *
1380  * This function is useful in the implementation of
1381  * g_mount_guess_content_type().
1382  *
1383  * Returns: (transfer full) (array zero-terminated=1): an %NULL-terminated
1384  *     array of zero or more content types. Free with g_strfreev()
1385  *
1386  * Since: 2.18
1387  */
1388 gchar **
1389 g_content_type_guess_for_tree (GFile *root)
1390 {
1391   GPtrArray *types;
1392   GList *l;
1393
1394   types = g_ptr_array_new ();
1395
1396   G_LOCK (gio_treemagic);
1397
1398   tree_magic_init ();
1399   for (l = tree_matches; l; l = l->next)
1400     {
1401       TreeMatch *match = l->data;
1402       match_match (match, root, types);
1403     }
1404
1405   G_UNLOCK (gio_treemagic);
1406
1407   g_ptr_array_add (types, NULL);
1408
1409   return (gchar **)g_ptr_array_free (types, FALSE);
1410 }