1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* xdgmime.c: XDG Mime Spec mime resolver. Based on version 0.11 of the spec.
4 * More info can be found at http://www.freedesktop.org/standards/
6 * Copyright (C) 2003,2004 Red Hat, Inc.
7 * Copyright (C) 2003,2004 Jonathan Blandford <jrb@alum.mit.edu>
9 * Licensed under the Academic Free License version 2.0
10 * Or under the following terms:
12 * This library is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public
14 * License as published by the Free Software Foundation; either
15 * version 2 of the License, or (at your option) any later version.
17 * This library is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this library; if not, write to the
24 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 * Boston, MA 02111-1307, USA.
33 #include "xdgmimeint.h"
34 #include "xdgmimeglob.h"
35 #include "xdgmimemagic.h"
36 #include "xdgmimealias.h"
37 #include "xdgmimeicon.h"
38 #include "xdgmimeparent.h"
39 #include "xdgmimecache.h"
43 #include <sys/types.h>
49 #define API __attribute__ ((visibility("default")))
52 typedef struct XdgDirTimeList XdgDirTimeList;
53 typedef struct XdgCallbackList XdgCallbackList;
55 static int need_reread = TRUE;
56 static time_t last_stat_time = 0;
58 static XdgGlobHash *global_hash = NULL;
59 static XdgMimeMagic *global_magic = NULL;
60 static XdgAliasList *alias_list = NULL;
61 static XdgParentList *parent_list = NULL;
62 static XdgDirTimeList *dir_time_list = NULL;
63 static XdgCallbackList *callback_list = NULL;
64 static XdgIconList *icon_list = NULL;
65 static XdgIconList *generic_icon_list = NULL;
67 XdgMimeCache **_caches = NULL;
68 static int n_caches = 0;
70 const char xdg_mime_type_unknown[] = "application/octet-stream";
75 XDG_CHECKED_UNCHECKED,
88 struct XdgCallbackList
90 XdgCallbackList *next;
91 XdgCallbackList *prev;
93 XdgMimeCallback callback;
95 XdgMimeDestroy destroy;
98 /* Function called by xdg_run_command_on_dirs. If it returns TRUE, further
99 * directories aren't looked at */
100 typedef int (*XdgDirectoryFunc) (const char *directory,
104 xdg_dir_time_list_add (char *file_name,
107 XdgDirTimeList *list;
109 for (list = dir_time_list; list; list = list->next)
111 if (strcmp (list->directory_name, file_name) == 0)
118 list = calloc (1, sizeof (XdgDirTimeList));
119 list->checked = XDG_CHECKED_UNCHECKED;
120 list->directory_name = file_name;
122 list->next = dir_time_list;
123 dir_time_list = list;
127 xdg_dir_time_list_free (XdgDirTimeList *list)
129 XdgDirTimeList *next;
134 free (list->directory_name);
141 xdg_mime_init_from_directory (const char *directory)
146 assert (directory != NULL);
148 file_name = malloc (strlen (directory) + strlen ("/mime/mime.cache") + 1);
149 if (file_name == NULL)
152 strcpy (file_name, directory); strcat (file_name, "/mime/mime.cache");
153 if (stat (file_name, &st) == 0)
155 XdgMimeCache *cache = _xdg_mime_cache_new_from_file (file_name);
159 xdg_dir_time_list_add (file_name, st.st_mtime);
161 XdgMimeCache **tmp_caches = realloc (_caches, sizeof (XdgMimeCache *) * (n_caches + 2));
162 if (tmp_caches != NULL)
164 _caches = tmp_caches;
165 _caches[n_caches] = cache;
166 _caches[n_caches + 1] = NULL;
175 file_name = malloc (strlen (directory) + strlen ("/mime/globs2") + 1);
176 if (file_name == NULL)
179 strcpy (file_name, directory); strcat (file_name, "/mime/globs2");
180 if (stat (file_name, &st) == 0)
182 _xdg_mime_glob_read_from_file (global_hash, file_name, TRUE);
183 xdg_dir_time_list_add (file_name, st.st_mtime);
188 file_name = malloc (strlen (directory) + strlen ("/mime/globs") + 1);
189 if (file_name == NULL)
192 strcpy (file_name, directory); strcat (file_name, "/mime/globs");
193 if (stat (file_name, &st) == 0)
195 _xdg_mime_glob_read_from_file (global_hash, file_name, FALSE);
196 xdg_dir_time_list_add (file_name, st.st_mtime);
204 file_name = malloc (strlen (directory) + strlen ("/mime/magic") + 1);
205 if (file_name == NULL)
208 strcpy (file_name, directory); strcat (file_name, "/mime/magic");
209 if (stat (file_name, &st) == 0)
211 _xdg_mime_magic_read_from_file (global_magic, file_name);
212 xdg_dir_time_list_add (file_name, st.st_mtime);
219 file_name = malloc (strlen (directory) + strlen ("/mime/aliases") + 1);
220 if (file_name == NULL)
223 strcpy (file_name, directory); strcat (file_name, "/mime/aliases");
224 _xdg_mime_alias_read_from_file (alias_list, file_name);
227 file_name = malloc (strlen (directory) + strlen ("/mime/subclasses") + 1);
228 if (file_name == NULL)
231 strcpy (file_name, directory); strcat (file_name, "/mime/subclasses");
232 _xdg_mime_parent_read_from_file (parent_list, file_name);
235 file_name = malloc (strlen (directory) + strlen ("/mime/icons") + 1);
236 if (file_name == NULL)
239 strcpy (file_name, directory); strcat (file_name, "/mime/icons");
240 _xdg_mime_icon_read_from_file (icon_list, file_name);
243 file_name = malloc (strlen (directory) + strlen ("/mime/generic-icons") + 1);
244 if (file_name == NULL)
247 strcpy (file_name, directory); strcat (file_name, "/mime/generic-icons");
248 _xdg_mime_icon_read_from_file (generic_icon_list, file_name);
251 return FALSE; /* Keep processing */
254 /* Runs a command on all the directories in the search path */
256 xdg_run_command_on_dirs (XdgDirectoryFunc func,
259 const char *xdg_data_home;
260 const char *xdg_data_dirs;
263 xdg_data_home = getenv ("XDG_DATA_HOME");
266 if ((func) (xdg_data_home, user_data))
273 home = getenv ("HOME");
276 char *guessed_xdg_home;
279 guessed_xdg_home = malloc (strlen (home) + strlen ("/.local/share/") + 1);
280 strcpy (guessed_xdg_home, home);
281 strcat (guessed_xdg_home, "/.local/share/");
282 stop_processing = (func) (guessed_xdg_home, user_data);
283 free (guessed_xdg_home);
290 xdg_data_dirs = getenv ("XDG_DATA_DIRS");
291 if (xdg_data_dirs == NULL)
292 xdg_data_dirs = "/usr/local/share/:/usr/share/";
296 while (*ptr != '\000')
304 while (*end_ptr != ':' && *end_ptr != '\000')
316 len = end_ptr - ptr + 1;
317 dir = malloc (len + 1);
318 strncpy (dir, ptr, len);
320 stop_processing = (func) (dir, user_data);
330 /* Checks file_path to make sure it has the same mtime as last time it was
331 * checked. If it has a different mtime, or if the file doesn't exist, it
334 * FIXME: This doesn't protect against permission changes.
337 xdg_check_file (const char *file_path,
342 /* If the file exists */
343 if (stat (file_path, &st) == 0)
345 XdgDirTimeList *list;
350 for (list = dir_time_list; list; list = list->next)
352 if (! strcmp (list->directory_name, file_path))
354 if (st.st_mtime == list->mtime)
355 list->checked = XDG_CHECKED_VALID;
357 list->checked = XDG_CHECKED_INVALID;
359 return (list->checked != XDG_CHECKED_VALID);
372 xdg_check_dir (const char *directory,
373 int *invalid_dir_list)
378 assert (directory != NULL);
380 /* Check the mime.cache file */
381 file_name = malloc (strlen (directory) + strlen ("/mime/mime.cache") + 1);
382 strcpy (file_name, directory); strcat (file_name, "/mime/mime.cache");
383 invalid = xdg_check_file (file_name, &exists);
387 *invalid_dir_list = TRUE;
395 /* Check the globs file */
396 file_name = malloc (strlen (directory) + strlen ("/mime/globs") + 1);
397 strcpy (file_name, directory); strcat (file_name, "/mime/globs");
398 invalid = xdg_check_file (file_name, NULL);
402 *invalid_dir_list = TRUE;
406 /* Check the magic file */
407 file_name = malloc (strlen (directory) + strlen ("/mime/magic") + 1);
408 strcpy (file_name, directory); strcat (file_name, "/mime/magic");
409 invalid = xdg_check_file (file_name, NULL);
413 *invalid_dir_list = TRUE;
417 return FALSE; /* Keep processing */
420 /* Walks through all the mime files stat()ing them to see if they've changed.
421 * Returns TRUE if they have. */
423 xdg_check_dirs (void)
425 XdgDirTimeList *list;
426 int invalid_dir_list = FALSE;
428 for (list = dir_time_list; list; list = list->next)
429 list->checked = XDG_CHECKED_UNCHECKED;
431 xdg_run_command_on_dirs ((XdgDirectoryFunc) xdg_check_dir,
434 if (invalid_dir_list)
437 for (list = dir_time_list; list; list = list->next)
439 if (list->checked != XDG_CHECKED_VALID)
446 /* We want to avoid stat()ing on every single mime call, so we only look for
447 * newer files every 5 seconds. This will return TRUE if we need to reread the
448 * mime data from disk.
451 xdg_check_time_and_dirs (void)
457 gettimeofday (&tv, NULL);
458 current_time = tv.tv_sec;
460 if (current_time >= last_stat_time + 5)
462 retval = xdg_check_dirs ();
463 last_stat_time = current_time;
469 /* Called in every public function. It reloads the hash function if need be.
474 if (xdg_check_time_and_dirs ())
476 xdg_mime_shutdown ();
481 global_hash = _xdg_glob_hash_new ();
482 global_magic = _xdg_mime_magic_new ();
483 alias_list = _xdg_mime_alias_list_new ();
484 parent_list = _xdg_mime_parent_list_new ();
485 icon_list = _xdg_mime_icon_list_new ();
486 generic_icon_list = _xdg_mime_icon_list_new ();
488 xdg_run_command_on_dirs ((XdgDirectoryFunc) xdg_mime_init_from_directory,
496 xdg_mime_get_mime_type_for_data (const void *data,
500 const char *mime_type;
505 return _xdg_mime_cache_get_mime_type_for_data (data, len, result_prio);
507 mime_type = _xdg_mime_magic_lookup_data (global_magic, data, len, result_prio, NULL, 0);
512 return XDG_MIME_TYPE_UNKNOWN;
516 xdg_mime_get_mime_type_for_file (const char *file_name,
517 struct stat *statbuf)
519 const char *mime_type;
520 /* currently, only a few globs occur twice, and none
521 * more often, so 5 seems plenty.
523 const char *mime_types[5];
529 const char *base_name;
532 if (file_name == NULL)
534 if (! _xdg_utf8_validate (file_name))
540 return _xdg_mime_cache_get_mime_type_for_file (file_name, statbuf);
542 base_name = _xdg_get_base_name (file_name);
543 n = _xdg_glob_hash_lookup_file_name (global_hash, base_name, mime_types, 5);
546 return mime_types[0];
550 if (stat (file_name, &buf) != 0)
551 return XDG_MIME_TYPE_UNKNOWN;
556 if (!S_ISREG (statbuf->st_mode))
557 return XDG_MIME_TYPE_UNKNOWN;
559 /* FIXME: Need to make sure that max_extent isn't totally broken. This could
560 * be large and need getting from a stream instead of just reading it all
562 max_extent = _xdg_mime_magic_get_buffer_extents (global_magic);
563 data = malloc (max_extent);
565 return XDG_MIME_TYPE_UNKNOWN;
567 file = fopen (file_name, "r");
571 return XDG_MIME_TYPE_UNKNOWN;
574 bytes_read = fread (data, 1, max_extent, file);
579 return XDG_MIME_TYPE_UNKNOWN;
582 mime_type = _xdg_mime_magic_lookup_data (global_magic, data, bytes_read, NULL,
591 return XDG_MIME_TYPE_UNKNOWN;
595 xdg_mime_get_mime_type_from_file_name (const char *file_name)
597 const char *mime_type;
602 return _xdg_mime_cache_get_mime_type_from_file_name (file_name);
604 if (_xdg_glob_hash_lookup_file_name (global_hash, file_name, &mime_type, 1))
607 return XDG_MIME_TYPE_UNKNOWN;
611 xdg_mime_get_mime_types_from_file_name (const char *file_name,
612 const char *mime_types[],
618 return _xdg_mime_cache_get_mime_types_from_file_name (file_name, mime_types, n_mime_types);
620 return _xdg_glob_hash_lookup_file_name (global_hash, file_name, mime_types, n_mime_types);
624 xdg_mime_is_valid_mime_type (const char *mime_type)
626 /* FIXME: We should make this a better test
628 return _xdg_utf8_validate (mime_type);
632 xdg_mime_shutdown (void)
634 XdgCallbackList *list;
636 /* FIXME: Need to make this (and the whole library) thread safe */
639 xdg_dir_time_list_free (dir_time_list);
640 dir_time_list = NULL;
645 _xdg_glob_hash_free (global_hash);
650 _xdg_mime_magic_free (global_magic);
656 _xdg_mime_alias_list_free (alias_list);
662 _xdg_mime_parent_list_free (parent_list);
668 _xdg_mime_icon_list_free (icon_list);
672 if (generic_icon_list)
674 _xdg_mime_icon_list_free (generic_icon_list);
675 generic_icon_list = NULL;
682 for (i = 0; i < n_caches; i++)
683 _xdg_mime_cache_unref (_caches[i]);
689 for (list = callback_list; list; list = list->next)
690 (list->callback) (list->data);
696 xdg_mime_get_max_buffer_extents (void)
701 return _xdg_mime_cache_get_max_buffer_extents ();
703 return _xdg_mime_magic_get_buffer_extents (global_magic);
707 _xdg_mime_unalias_mime_type (const char *mime_type)
712 return _xdg_mime_cache_unalias_mime_type (mime_type);
714 if ((lookup = _xdg_mime_alias_list_lookup (alias_list, mime_type)) != NULL)
721 xdg_mime_unalias_mime_type (const char *mime_type)
725 return _xdg_mime_unalias_mime_type (mime_type);
729 _xdg_mime_mime_type_equal (const char *mime_a,
732 const char *unalias_a, *unalias_b;
734 unalias_a = _xdg_mime_unalias_mime_type (mime_a);
735 unalias_b = _xdg_mime_unalias_mime_type (mime_b);
737 if (strcmp (unalias_a, unalias_b) == 0)
744 xdg_mime_mime_type_equal (const char *mime_a,
749 return _xdg_mime_mime_type_equal (mime_a, mime_b);
753 xdg_mime_media_type_equal (const char *mime_a,
758 sep = strchr (mime_a, '/');
760 if (sep && strncmp (mime_a, mime_b, sep - mime_a + 1) == 0)
768 xdg_mime_is_super_type (const char *mime)
773 length = strlen (mime);
774 type = &(mime[length - 2]);
776 if (strcmp (type, "/*") == 0)
784 _xdg_mime_mime_type_subclass (const char *mime,
787 const char *umime, *ubase;
788 const char **parents;
791 return _xdg_mime_cache_mime_type_subclass (mime, base);
793 umime = _xdg_mime_unalias_mime_type (mime);
794 ubase = _xdg_mime_unalias_mime_type (base);
796 if (strcmp (umime, ubase) == 0)
800 /* Handle supertypes */
801 if (xdg_mime_is_super_type (ubase) &&
802 xdg_mime_media_type_equal (umime, ubase))
806 /* Handle special cases text/plain and application/octet-stream */
807 if (strcmp (ubase, "text/plain") == 0 &&
808 strncmp (umime, "text/", 5) == 0)
811 if (strcmp (ubase, "application/octet-stream") == 0)
814 parents = _xdg_mime_parent_list_lookup (parent_list, umime);
815 for (; parents && *parents; parents++)
817 if (_xdg_mime_mime_type_subclass (*parents, ubase))
825 xdg_mime_mime_type_subclass (const char *mime,
830 return _xdg_mime_mime_type_subclass (mime, base);
834 xdg_mime_list_mime_parents (const char *mime)
836 const char **parents;
841 return _xdg_mime_cache_list_mime_parents (mime);
843 parents = xdg_mime_get_mime_parents (mime);
848 for (i = 0; parents[i]; i++) ;
850 n = (i + 1) * sizeof (char *);
851 result = (char **) malloc (n);
852 memcpy (result, parents, n);
858 xdg_mime_get_mime_parents (const char *mime)
864 umime = _xdg_mime_unalias_mime_type (mime);
866 return _xdg_mime_parent_list_lookup (parent_list, umime);
874 printf ("*** ALIASES ***\n\n");
875 _xdg_mime_alias_list_dump (alias_list);
876 printf ("\n*** PARENTS ***\n\n");
877 _xdg_mime_parent_list_dump (parent_list);
878 printf ("\n*** CACHE ***\n\n");
879 _xdg_glob_hash_dump (global_hash);
880 printf ("\n*** GLOBS ***\n\n");
881 _xdg_glob_hash_dump (global_hash);
882 printf ("\n*** GLOBS REVERSE TREE ***\n\n");
883 _xdg_mime_cache_glob_dump ();
887 /* Registers a function to be called every time the mime database reloads its files
890 xdg_mime_register_reload_callback (XdgMimeCallback callback,
892 XdgMimeDestroy destroy)
894 XdgCallbackList *list_el;
895 static int callback_id = 1;
897 /* Make a new list element */
898 list_el = calloc (1, sizeof (XdgCallbackList));
899 list_el->callback_id = callback_id;
900 list_el->callback = callback;
901 list_el->data = data;
902 list_el->destroy = destroy;
903 list_el->next = callback_list;
905 list_el->next->prev = list_el;
907 callback_list = list_el;
910 return callback_id - 1;
914 xdg_mime_remove_callback (int callback_id)
916 XdgCallbackList *list;
918 for (list = callback_list; list; list = list->next)
920 if (list->callback_id == callback_id)
923 list->next = list->prev;
926 list->prev->next = list->next;
928 callback_list = list->next;
930 /* invoke the destroy handler */
931 (list->destroy) (list->data);
939 xdg_mime_get_icon (const char *mime)
944 return _xdg_mime_cache_get_icon (mime);
946 return _xdg_mime_icon_list_lookup (icon_list, mime);
950 xdg_mime_get_generic_icon (const char *mime)
955 return _xdg_mime_cache_get_generic_icon (mime);
957 return _xdg_mime_icon_list_lookup (generic_icon_list, mime);