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, see <http://www.gnu.org/licenses/>.
31 #include "xdgmimeint.h"
32 #include "xdgmimeglob.h"
33 #include "xdgmimemagic.h"
34 #include "xdgmimealias.h"
35 #include "xdgmimeicon.h"
36 #include "xdgmimeparent.h"
37 #include "xdgmimecache.h"
41 #include <sys/types.h>
46 typedef struct XdgDirTimeList XdgDirTimeList;
47 typedef struct XdgCallbackList XdgCallbackList;
49 static int need_reread = TRUE;
50 static time_t last_stat_time = 0;
52 static XdgGlobHash *global_hash = NULL;
53 static XdgMimeMagic *global_magic = NULL;
54 static XdgAliasList *alias_list = NULL;
55 static XdgParentList *parent_list = NULL;
56 static XdgDirTimeList *dir_time_list = NULL;
57 static XdgCallbackList *callback_list = NULL;
58 static XdgIconList *icon_list = NULL;
59 static XdgIconList *generic_icon_list = NULL;
61 XdgMimeCache **_caches = NULL;
62 static int n_caches = 0;
64 const char xdg_mime_type_unknown[] = "application/octet-stream";
69 XDG_CHECKED_UNCHECKED,
82 struct XdgCallbackList
84 XdgCallbackList *next;
85 XdgCallbackList *prev;
87 XdgMimeCallback callback;
89 XdgMimeDestroy destroy;
92 /* Function called by xdg_run_command_on_dirs. If it returns TRUE, further
93 * directories aren't looked at */
94 typedef int (*XdgDirectoryFunc) (const char *directory,
98 xdg_dir_time_list_add (char *file_name,
101 XdgDirTimeList *list;
103 for (list = dir_time_list; list; list = list->next)
105 if (strcmp (list->directory_name, file_name) == 0)
112 list = calloc (1, sizeof (XdgDirTimeList));
113 list->checked = XDG_CHECKED_UNCHECKED;
114 list->directory_name = file_name;
116 list->next = dir_time_list;
117 dir_time_list = list;
121 xdg_dir_time_list_free (XdgDirTimeList *list)
123 XdgDirTimeList *next;
128 free (list->directory_name);
135 xdg_mime_init_from_directory (const char *directory)
140 assert (directory != NULL);
142 file_name = malloc (strlen (directory) + strlen ("/mime/mime.cache") + 1);
143 strcpy (file_name, directory); strcat (file_name, "/mime/mime.cache");
144 if (stat (file_name, &st) == 0)
146 XdgMimeCache *cache = _xdg_mime_cache_new_from_file (file_name);
150 xdg_dir_time_list_add (file_name, st.st_mtime);
152 _caches = realloc (_caches, sizeof (XdgMimeCache *) * (n_caches + 2));
153 _caches[n_caches] = cache;
154 _caches[n_caches + 1] = NULL;
162 file_name = malloc (strlen (directory) + strlen ("/mime/globs2") + 1);
163 strcpy (file_name, directory); strcat (file_name, "/mime/globs2");
164 if (stat (file_name, &st) == 0)
166 _xdg_mime_glob_read_from_file (global_hash, file_name, TRUE);
167 xdg_dir_time_list_add (file_name, st.st_mtime);
172 file_name = malloc (strlen (directory) + strlen ("/mime/globs") + 1);
173 strcpy (file_name, directory); strcat (file_name, "/mime/globs");
174 if (stat (file_name, &st) == 0)
176 _xdg_mime_glob_read_from_file (global_hash, file_name, FALSE);
177 xdg_dir_time_list_add (file_name, st.st_mtime);
185 file_name = malloc (strlen (directory) + strlen ("/mime/magic") + 1);
186 strcpy (file_name, directory); strcat (file_name, "/mime/magic");
187 if (stat (file_name, &st) == 0)
189 _xdg_mime_magic_read_from_file (global_magic, file_name);
190 xdg_dir_time_list_add (file_name, st.st_mtime);
197 file_name = malloc (strlen (directory) + strlen ("/mime/aliases") + 1);
198 strcpy (file_name, directory); strcat (file_name, "/mime/aliases");
199 _xdg_mime_alias_read_from_file (alias_list, file_name);
202 file_name = malloc (strlen (directory) + strlen ("/mime/subclasses") + 1);
203 strcpy (file_name, directory); strcat (file_name, "/mime/subclasses");
204 _xdg_mime_parent_read_from_file (parent_list, file_name);
207 file_name = malloc (strlen (directory) + strlen ("/mime/icons") + 1);
208 strcpy (file_name, directory); strcat (file_name, "/mime/icons");
209 _xdg_mime_icon_read_from_file (icon_list, file_name);
212 file_name = malloc (strlen (directory) + strlen ("/mime/generic-icons") + 1);
213 strcpy (file_name, directory); strcat (file_name, "/mime/generic-icons");
214 _xdg_mime_icon_read_from_file (generic_icon_list, file_name);
217 return FALSE; /* Keep processing */
220 /* Runs a command on all the directories in the search path */
222 xdg_run_command_on_dirs (XdgDirectoryFunc func,
225 const char *xdg_data_home;
226 const char *xdg_data_dirs;
229 xdg_data_home = getenv ("XDG_DATA_HOME");
232 if ((func) (xdg_data_home, user_data))
239 home = getenv ("HOME");
242 char *guessed_xdg_home;
245 guessed_xdg_home = malloc (strlen (home) + strlen ("/.local/share/") + 1);
246 strcpy (guessed_xdg_home, home);
247 strcat (guessed_xdg_home, "/.local/share/");
248 stop_processing = (func) (guessed_xdg_home, user_data);
249 free (guessed_xdg_home);
256 xdg_data_dirs = getenv ("XDG_DATA_DIRS");
257 if (xdg_data_dirs == NULL)
258 xdg_data_dirs = "/usr/local/share/:/usr/share/";
262 while (*ptr != '\000')
270 while (*end_ptr != ':' && *end_ptr != '\000')
282 len = end_ptr - ptr + 1;
283 dir = malloc (len + 1);
284 strncpy (dir, ptr, len);
286 stop_processing = (func) (dir, user_data);
296 /* Checks file_path to make sure it has the same mtime as last time it was
297 * checked. If it has a different mtime, or if the file doesn't exist, it
300 * FIXME: This doesn't protect against permission changes.
303 xdg_check_file (const char *file_path,
308 /* If the file exists */
309 if (stat (file_path, &st) == 0)
311 XdgDirTimeList *list;
316 for (list = dir_time_list; list; list = list->next)
318 if (! strcmp (list->directory_name, file_path))
320 if (st.st_mtime == list->mtime)
321 list->checked = XDG_CHECKED_VALID;
323 list->checked = XDG_CHECKED_INVALID;
325 return (list->checked != XDG_CHECKED_VALID);
338 xdg_check_dir (const char *directory,
339 int *invalid_dir_list)
344 assert (directory != NULL);
346 /* Check the mime.cache file */
347 file_name = malloc (strlen (directory) + strlen ("/mime/mime.cache") + 1);
348 strcpy (file_name, directory); strcat (file_name, "/mime/mime.cache");
349 invalid = xdg_check_file (file_name, &exists);
353 *invalid_dir_list = TRUE;
361 /* Check the globs file */
362 file_name = malloc (strlen (directory) + strlen ("/mime/globs") + 1);
363 strcpy (file_name, directory); strcat (file_name, "/mime/globs");
364 invalid = xdg_check_file (file_name, NULL);
368 *invalid_dir_list = TRUE;
372 /* Check the magic file */
373 file_name = malloc (strlen (directory) + strlen ("/mime/magic") + 1);
374 strcpy (file_name, directory); strcat (file_name, "/mime/magic");
375 invalid = xdg_check_file (file_name, NULL);
379 *invalid_dir_list = TRUE;
383 return FALSE; /* Keep processing */
386 /* Walks through all the mime files stat()ing them to see if they've changed.
387 * Returns TRUE if they have. */
389 xdg_check_dirs (void)
391 XdgDirTimeList *list;
392 int invalid_dir_list = FALSE;
394 for (list = dir_time_list; list; list = list->next)
395 list->checked = XDG_CHECKED_UNCHECKED;
397 xdg_run_command_on_dirs ((XdgDirectoryFunc) xdg_check_dir,
400 if (invalid_dir_list)
403 for (list = dir_time_list; list; list = list->next)
405 if (list->checked != XDG_CHECKED_VALID)
412 /* We want to avoid stat()ing on every single mime call, so we only look for
413 * newer files every 5 seconds. This will return TRUE if we need to reread the
414 * mime data from disk.
417 xdg_check_time_and_dirs (void)
423 gettimeofday (&tv, NULL);
424 current_time = tv.tv_sec;
426 if (current_time >= last_stat_time + 5)
428 retval = xdg_check_dirs ();
429 last_stat_time = current_time;
435 /* Called in every public function. It reloads the hash function if need be.
440 if (xdg_check_time_and_dirs ())
442 xdg_mime_shutdown ();
447 global_hash = _xdg_glob_hash_new ();
448 global_magic = _xdg_mime_magic_new ();
449 alias_list = _xdg_mime_alias_list_new ();
450 parent_list = _xdg_mime_parent_list_new ();
451 icon_list = _xdg_mime_icon_list_new ();
452 generic_icon_list = _xdg_mime_icon_list_new ();
454 xdg_run_command_on_dirs ((XdgDirectoryFunc) xdg_mime_init_from_directory,
462 xdg_mime_get_mime_type_for_data (const void *data,
466 const char *mime_type;
471 return _xdg_mime_cache_get_mime_type_for_data (data, len, result_prio);
473 mime_type = _xdg_mime_magic_lookup_data (global_magic, data, len, result_prio, NULL, 0);
478 return XDG_MIME_TYPE_UNKNOWN;
481 #ifdef NOT_USED_IN_GIO
484 xdg_mime_get_mime_type_for_file (const char *file_name,
485 struct stat *statbuf)
487 const char *mime_type;
488 /* currently, only a few globs occur twice, and none
489 * more often, so 5 seems plenty.
491 const char *mime_types[5];
497 const char *base_name;
500 if (file_name == NULL)
502 if (! _xdg_utf8_validate (file_name))
508 return _xdg_mime_cache_get_mime_type_for_file (file_name, statbuf);
510 base_name = _xdg_get_base_name (file_name);
511 n = _xdg_glob_hash_lookup_file_name (global_hash, base_name, mime_types, 5);
514 return mime_types[0];
518 if (stat (file_name, &buf) != 0)
519 return XDG_MIME_TYPE_UNKNOWN;
524 if (!S_ISREG (statbuf->st_mode))
525 return XDG_MIME_TYPE_UNKNOWN;
527 /* FIXME: Need to make sure that max_extent isn't totally broken. This could
528 * be large and need getting from a stream instead of just reading it all
530 max_extent = _xdg_mime_magic_get_buffer_extents (global_magic);
531 data = malloc (max_extent);
533 return XDG_MIME_TYPE_UNKNOWN;
535 file = fopen (file_name, "r");
539 return XDG_MIME_TYPE_UNKNOWN;
542 bytes_read = fread (data, 1, max_extent, file);
547 return XDG_MIME_TYPE_UNKNOWN;
550 mime_type = _xdg_mime_magic_lookup_data (global_magic, data, bytes_read, NULL,
559 return XDG_MIME_TYPE_UNKNOWN;
563 xdg_mime_get_mime_type_from_file_name (const char *file_name)
565 const char *mime_type;
570 return _xdg_mime_cache_get_mime_type_from_file_name (file_name);
572 if (_xdg_glob_hash_lookup_file_name (global_hash, file_name, &mime_type, 1))
575 return XDG_MIME_TYPE_UNKNOWN;
581 xdg_mime_get_mime_types_from_file_name (const char *file_name,
582 const char *mime_types[],
588 return _xdg_mime_cache_get_mime_types_from_file_name (file_name, mime_types, n_mime_types);
590 return _xdg_glob_hash_lookup_file_name (global_hash, file_name, mime_types, n_mime_types);
593 #ifdef NOT_USED_IN_GIO
596 xdg_mime_is_valid_mime_type (const char *mime_type)
598 /* FIXME: We should make this a better test
600 return _xdg_utf8_validate (mime_type);
606 xdg_mime_shutdown (void)
608 XdgCallbackList *list;
610 /* FIXME: Need to make this (and the whole library) thread safe */
613 xdg_dir_time_list_free (dir_time_list);
614 dir_time_list = NULL;
619 _xdg_glob_hash_free (global_hash);
624 _xdg_mime_magic_free (global_magic);
630 _xdg_mime_alias_list_free (alias_list);
636 _xdg_mime_parent_list_free (parent_list);
642 _xdg_mime_icon_list_free (icon_list);
646 if (generic_icon_list)
648 _xdg_mime_icon_list_free (generic_icon_list);
649 generic_icon_list = NULL;
656 for (i = 0; i < n_caches; i++)
657 _xdg_mime_cache_unref (_caches[i]);
663 for (list = callback_list; list; list = list->next)
664 (list->callback) (list->data);
670 xdg_mime_get_max_buffer_extents (void)
675 return _xdg_mime_cache_get_max_buffer_extents ();
677 return _xdg_mime_magic_get_buffer_extents (global_magic);
681 _xdg_mime_unalias_mime_type (const char *mime_type)
686 return _xdg_mime_cache_unalias_mime_type (mime_type);
688 if ((lookup = _xdg_mime_alias_list_lookup (alias_list, mime_type)) != NULL)
695 xdg_mime_unalias_mime_type (const char *mime_type)
699 return _xdg_mime_unalias_mime_type (mime_type);
703 _xdg_mime_mime_type_equal (const char *mime_a,
706 const char *unalias_a, *unalias_b;
708 unalias_a = _xdg_mime_unalias_mime_type (mime_a);
709 unalias_b = _xdg_mime_unalias_mime_type (mime_b);
711 if (strcmp (unalias_a, unalias_b) == 0)
718 xdg_mime_mime_type_equal (const char *mime_a,
723 return _xdg_mime_mime_type_equal (mime_a, mime_b);
727 xdg_mime_media_type_equal (const char *mime_a,
732 sep = strchr (mime_a, '/');
734 if (sep && strncmp (mime_a, mime_b, sep - mime_a + 1) == 0)
742 ends_with (const char *str,
748 length = strlen (str);
749 suffix_length = strlen (suffix);
750 if (length < suffix_length)
753 if (strcmp (str + length - suffix_length, suffix) == 0)
760 xdg_mime_is_super_type (const char *mime)
762 return ends_with (mime, "/*");
767 _xdg_mime_mime_type_subclass (const char *mime,
770 const char *umime, *ubase;
771 const char **parents;
774 return _xdg_mime_cache_mime_type_subclass (mime, base);
776 umime = _xdg_mime_unalias_mime_type (mime);
777 ubase = _xdg_mime_unalias_mime_type (base);
779 if (strcmp (umime, ubase) == 0)
783 /* Handle supertypes */
784 if (xdg_mime_is_super_type (ubase) &&
785 xdg_mime_media_type_equal (umime, ubase))
789 /* Handle special cases text/plain and application/octet-stream */
790 if (strcmp (ubase, "text/plain") == 0 &&
791 strncmp (umime, "text/", 5) == 0)
794 if (strcmp (ubase, "application/octet-stream") == 0)
797 parents = _xdg_mime_parent_list_lookup (parent_list, umime);
798 for (; parents && *parents; parents++)
800 if (_xdg_mime_mime_type_subclass (*parents, ubase))
808 xdg_mime_mime_type_subclass (const char *mime,
813 return _xdg_mime_mime_type_subclass (mime, base);
817 xdg_mime_list_mime_parents (const char *mime)
820 const char **parents;
827 return _xdg_mime_cache_list_mime_parents (mime);
829 umime = _xdg_mime_unalias_mime_type (mime);
831 parents = _xdg_mime_parent_list_lookup (parent_list, umime);
836 for (i = 0; parents[i]; i++) ;
838 n = (i + 1) * sizeof (char *);
839 result = (char **) malloc (n);
840 memcpy (result, parents, n);
845 #ifdef NOT_USED_IN_GIO
848 xdg_mime_get_mime_parents (const char *mime)
854 umime = _xdg_mime_unalias_mime_type (mime);
856 return _xdg_mime_parent_list_lookup (parent_list, umime);
864 printf ("*** ALIASES ***\n\n");
865 _xdg_mime_alias_list_dump (alias_list);
866 printf ("\n*** PARENTS ***\n\n");
867 _xdg_mime_parent_list_dump (parent_list);
868 printf ("\n*** CACHE ***\n\n");
869 _xdg_glob_hash_dump (global_hash);
870 printf ("\n*** GLOBS ***\n\n");
871 _xdg_glob_hash_dump (global_hash);
872 printf ("\n*** GLOBS REVERSE TREE ***\n\n");
873 _xdg_mime_cache_glob_dump ();
878 /* Registers a function to be called every time the mime database reloads its files
881 xdg_mime_register_reload_callback (XdgMimeCallback callback,
883 XdgMimeDestroy destroy)
885 XdgCallbackList *list_el;
886 static int callback_id = 1;
888 /* Make a new list element */
889 list_el = calloc (1, sizeof (XdgCallbackList));
890 list_el->callback_id = callback_id;
891 list_el->callback = callback;
892 list_el->data = data;
893 list_el->destroy = destroy;
894 list_el->next = callback_list;
896 list_el->next->prev = list_el;
898 callback_list = list_el;
901 return callback_id - 1;
904 #ifdef NOT_USED_IN_GIO
907 xdg_mime_remove_callback (int callback_id)
909 XdgCallbackList *list;
911 for (list = callback_list; list; list = list->next)
913 if (list->callback_id == callback_id)
916 list->next = list->prev;
919 list->prev->next = list->next;
921 callback_list = list->next;
923 /* invoke the destroy handler */
924 (list->destroy) (list->data);
934 xdg_mime_get_icon (const char *mime)
939 return _xdg_mime_cache_get_icon (mime);
941 return _xdg_mime_icon_list_lookup (icon_list, mime);
945 xdg_mime_get_generic_icon (const char *mime)
950 return _xdg_mime_cache_get_generic_icon (mime);
952 return _xdg_mime_icon_list_lookup (generic_icon_list, mime);