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>
48 typedef struct XdgDirTimeList XdgDirTimeList
;
49 typedef struct XdgCallbackList XdgCallbackList
;
51 static int need_reread
= TRUE
;
52 static time_t last_stat_time
= 0;
54 static XdgGlobHash
*global_hash
= NULL
;
55 static XdgMimeMagic
*global_magic
= NULL
;
56 static XdgAliasList
*alias_list
= NULL
;
57 static XdgParentList
*parent_list
= NULL
;
58 static XdgDirTimeList
*dir_time_list
= NULL
;
59 static XdgCallbackList
*callback_list
= NULL
;
60 static XdgIconList
*icon_list
= NULL
;
61 static XdgIconList
*generic_icon_list
= NULL
;
63 XdgMimeCache
**_caches
= NULL
;
64 static int n_caches
= 0;
66 const char xdg_mime_type_unknown
[] = "application/octet-stream";
67 const char xdg_mime_type_empty
[] = "application/x-zerosize";
68 const char xdg_mime_type_textplain
[] = "text/plain";
73 XDG_CHECKED_UNCHECKED
,
86 struct XdgCallbackList
88 XdgCallbackList
*next
;
89 XdgCallbackList
*prev
;
91 XdgMimeCallback callback
;
93 XdgMimeDestroy destroy
;
96 /* Function called by xdg_run_command_on_dirs. If it returns TRUE, further
97 * directories aren't looked at */
98 typedef int (*XdgDirectoryFunc
) (const char *directory
,
102 xdg_dir_time_list_add (char *file_name
,
105 XdgDirTimeList
*list
;
107 for (list
= dir_time_list
; list
; list
= list
->next
)
109 if (strcmp (list
->directory_name
, file_name
) == 0)
116 list
= calloc (1, sizeof (XdgDirTimeList
));
117 list
->checked
= XDG_CHECKED_UNCHECKED
;
118 list
->directory_name
= file_name
;
120 list
->next
= dir_time_list
;
121 dir_time_list
= list
;
125 xdg_dir_time_list_free (XdgDirTimeList
*list
)
127 XdgDirTimeList
*next
;
132 free (list
->directory_name
);
139 xdg_mime_init_from_directory (const char *directory
)
144 assert (directory
!= NULL
);
146 file_name
= malloc (strlen (directory
) + strlen ("/mime/mime.cache") + 1);
147 strcpy (file_name
, directory
); strcat (file_name
, "/mime/mime.cache");
148 if (stat (file_name
, &st
) == 0)
150 XdgMimeCache
*cache
= _xdg_mime_cache_new_from_file (file_name
);
154 xdg_dir_time_list_add (file_name
, st
.st_mtime
);
156 _caches
= realloc (_caches
, sizeof (XdgMimeCache
*) * (n_caches
+ 2));
157 _caches
[n_caches
] = cache
;
158 _caches
[n_caches
+ 1] = NULL
;
166 file_name
= malloc (strlen (directory
) + strlen ("/mime/globs2") + 1);
167 strcpy (file_name
, directory
); strcat (file_name
, "/mime/globs2");
168 if (stat (file_name
, &st
) == 0)
170 _xdg_mime_glob_read_from_file (global_hash
, file_name
, TRUE
);
171 xdg_dir_time_list_add (file_name
, st
.st_mtime
);
176 file_name
= malloc (strlen (directory
) + strlen ("/mime/globs") + 1);
177 strcpy (file_name
, directory
); strcat (file_name
, "/mime/globs");
178 if (stat (file_name
, &st
) == 0)
180 _xdg_mime_glob_read_from_file (global_hash
, file_name
, FALSE
);
181 xdg_dir_time_list_add (file_name
, st
.st_mtime
);
189 file_name
= malloc (strlen (directory
) + strlen ("/mime/magic") + 1);
190 strcpy (file_name
, directory
); strcat (file_name
, "/mime/magic");
191 if (stat (file_name
, &st
) == 0)
193 _xdg_mime_magic_read_from_file (global_magic
, file_name
);
194 xdg_dir_time_list_add (file_name
, st
.st_mtime
);
201 file_name
= malloc (strlen (directory
) + strlen ("/mime/aliases") + 1);
202 strcpy (file_name
, directory
); strcat (file_name
, "/mime/aliases");
203 _xdg_mime_alias_read_from_file (alias_list
, file_name
);
206 file_name
= malloc (strlen (directory
) + strlen ("/mime/subclasses") + 1);
207 strcpy (file_name
, directory
); strcat (file_name
, "/mime/subclasses");
208 _xdg_mime_parent_read_from_file (parent_list
, file_name
);
211 file_name
= malloc (strlen (directory
) + strlen ("/mime/icons") + 1);
212 strcpy (file_name
, directory
); strcat (file_name
, "/mime/icons");
213 _xdg_mime_icon_read_from_file (icon_list
, file_name
);
216 file_name
= malloc (strlen (directory
) + strlen ("/mime/generic-icons") + 1);
217 strcpy (file_name
, directory
); strcat (file_name
, "/mime/generic-icons");
218 _xdg_mime_icon_read_from_file (generic_icon_list
, file_name
);
221 return FALSE
; /* Keep processing */
224 /* Runs a command on all the directories in the search path */
226 xdg_run_command_on_dirs (XdgDirectoryFunc func
,
229 const char *xdg_data_home
;
230 const char *xdg_data_dirs
;
233 xdg_data_home
= getenv ("XDG_DATA_HOME");
236 if ((func
) (xdg_data_home
, user_data
))
243 home
= getenv ("HOME");
246 char *guessed_xdg_home
;
249 guessed_xdg_home
= malloc (strlen (home
) + strlen ("/.local/share/") + 1);
250 strcpy (guessed_xdg_home
, home
);
251 strcat (guessed_xdg_home
, "/.local/share/");
252 stop_processing
= (func
) (guessed_xdg_home
, user_data
);
253 free (guessed_xdg_home
);
260 xdg_data_dirs
= getenv ("XDG_DATA_DIRS");
261 if (xdg_data_dirs
== NULL
)
262 xdg_data_dirs
= "/usr/local/share/:/usr/share/";
266 while (*ptr
!= '\000')
274 while (*end_ptr
!= ':' && *end_ptr
!= '\000')
286 len
= end_ptr
- ptr
+ 1;
287 dir
= malloc (len
+ 1);
288 strncpy (dir
, ptr
, len
);
290 stop_processing
= (func
) (dir
, user_data
);
300 /* Checks file_path to make sure it has the same mtime as last time it was
301 * checked. If it has a different mtime, or if the file doesn't exist, it
304 * FIXME: This doesn't protect against permission changes.
307 xdg_check_file (const char *file_path
,
312 /* If the file exists */
313 if (stat (file_path
, &st
) == 0)
315 XdgDirTimeList
*list
;
320 for (list
= dir_time_list
; list
; list
= list
->next
)
322 if (! strcmp (list
->directory_name
, file_path
))
324 if (st
.st_mtime
== list
->mtime
)
325 list
->checked
= XDG_CHECKED_VALID
;
327 list
->checked
= XDG_CHECKED_INVALID
;
329 return (list
->checked
!= XDG_CHECKED_VALID
);
342 xdg_check_dir (const char *directory
,
343 int *invalid_dir_list
)
348 assert (directory
!= NULL
);
350 /* Check the mime.cache file */
351 file_name
= malloc (strlen (directory
) + strlen ("/mime/mime.cache") + 1);
352 strcpy (file_name
, directory
); strcat (file_name
, "/mime/mime.cache");
353 invalid
= xdg_check_file (file_name
, &exists
);
357 *invalid_dir_list
= TRUE
;
365 /* Check the globs file */
366 file_name
= malloc (strlen (directory
) + strlen ("/mime/globs") + 1);
367 strcpy (file_name
, directory
); strcat (file_name
, "/mime/globs");
368 invalid
= xdg_check_file (file_name
, NULL
);
372 *invalid_dir_list
= TRUE
;
376 /* Check the magic file */
377 file_name
= malloc (strlen (directory
) + strlen ("/mime/magic") + 1);
378 strcpy (file_name
, directory
); strcat (file_name
, "/mime/magic");
379 invalid
= xdg_check_file (file_name
, NULL
);
383 *invalid_dir_list
= TRUE
;
387 return FALSE
; /* Keep processing */
390 /* Walks through all the mime files stat()ing them to see if they've changed.
391 * Returns TRUE if they have. */
393 xdg_check_dirs (void)
395 XdgDirTimeList
*list
;
396 int invalid_dir_list
= FALSE
;
398 for (list
= dir_time_list
; list
; list
= list
->next
)
399 list
->checked
= XDG_CHECKED_UNCHECKED
;
401 xdg_run_command_on_dirs ((XdgDirectoryFunc
) xdg_check_dir
,
404 if (invalid_dir_list
)
407 for (list
= dir_time_list
; list
; list
= list
->next
)
409 if (list
->checked
!= XDG_CHECKED_VALID
)
416 /* We want to avoid stat()ing on every single mime call, so we only look for
417 * newer files every 5 seconds. This will return TRUE if we need to reread the
418 * mime data from disk.
421 xdg_check_time_and_dirs (void)
427 gettimeofday (&tv
, NULL
);
428 current_time
= tv
.tv_sec
;
430 if (current_time
>= last_stat_time
+ 5)
432 retval
= xdg_check_dirs ();
433 last_stat_time
= current_time
;
439 /* Called in every public function. It reloads the hash function if need be.
444 if (xdg_check_time_and_dirs ())
446 xdg_mime_shutdown ();
451 global_hash
= _xdg_glob_hash_new ();
452 global_magic
= _xdg_mime_magic_new ();
453 alias_list
= _xdg_mime_alias_list_new ();
454 parent_list
= _xdg_mime_parent_list_new ();
455 icon_list
= _xdg_mime_icon_list_new ();
456 generic_icon_list
= _xdg_mime_icon_list_new ();
458 xdg_run_command_on_dirs ((XdgDirectoryFunc
) xdg_mime_init_from_directory
,
466 xdg_mime_get_mime_type_for_data (const void *data
,
470 const char *mime_type
;
475 return XDG_MIME_TYPE_EMPTY
;
481 mime_type
= _xdg_mime_cache_get_mime_type_for_data (data
, len
, result_prio
);
483 mime_type
= _xdg_mime_magic_lookup_data (global_magic
, data
, len
, result_prio
, NULL
, 0);
488 return _xdg_binary_or_text_fallback(data
, len
);
492 xdg_mime_get_mime_type_for_file (const char *file_name
,
493 struct stat
*statbuf
)
495 const char *mime_type
;
496 /* currently, only a few globs occur twice, and none
497 * more often, so 5 seems plenty.
499 const char *mime_types
[5];
505 const char *base_name
;
508 if (file_name
== NULL
)
510 if (! _xdg_utf8_validate (file_name
))
516 return _xdg_mime_cache_get_mime_type_for_file (file_name
, statbuf
);
518 base_name
= _xdg_get_base_name (file_name
);
519 n
= _xdg_glob_hash_lookup_file_name (global_hash
, base_name
, mime_types
, 5);
522 return mime_types
[0];
526 if (stat (file_name
, &buf
) != 0)
527 return XDG_MIME_TYPE_UNKNOWN
;
532 if (!S_ISREG (statbuf
->st_mode
))
533 return XDG_MIME_TYPE_UNKNOWN
;
535 /* FIXME: Need to make sure that max_extent isn't totally broken. This could
536 * be large and need getting from a stream instead of just reading it all
538 max_extent
= _xdg_mime_magic_get_buffer_extents (global_magic
);
539 data
= malloc (max_extent
);
541 return XDG_MIME_TYPE_UNKNOWN
;
543 file
= fopen (file_name
, "r");
547 return XDG_MIME_TYPE_UNKNOWN
;
550 bytes_read
= fread (data
, 1, max_extent
, file
);
555 return XDG_MIME_TYPE_UNKNOWN
;
558 mime_type
= _xdg_mime_magic_lookup_data (global_magic
, data
, bytes_read
, NULL
,
564 mime_type
= _xdg_binary_or_text_fallback(data
, bytes_read
);
571 xdg_mime_get_mime_type_from_file_name (const char *file_name
)
573 const char *mime_type
;
578 return _xdg_mime_cache_get_mime_type_from_file_name (file_name
);
580 if (_xdg_glob_hash_lookup_file_name (global_hash
, file_name
, &mime_type
, 1))
583 return XDG_MIME_TYPE_UNKNOWN
;
587 xdg_mime_get_mime_types_from_file_name (const char *file_name
,
588 const char *mime_types
[],
594 return _xdg_mime_cache_get_mime_types_from_file_name (file_name
, mime_types
, n_mime_types
);
596 return _xdg_glob_hash_lookup_file_name (global_hash
, file_name
, mime_types
, n_mime_types
);
600 xdg_mime_is_valid_mime_type (const char *mime_type
)
602 /* FIXME: We should make this a better test
604 return _xdg_utf8_validate (mime_type
);
608 xdg_mime_shutdown (void)
610 XdgCallbackList
*list
;
612 /* FIXME: Need to make this (and the whole library) thread safe */
615 xdg_dir_time_list_free (dir_time_list
);
616 dir_time_list
= NULL
;
621 _xdg_glob_hash_free (global_hash
);
626 _xdg_mime_magic_free (global_magic
);
632 _xdg_mime_alias_list_free (alias_list
);
638 _xdg_mime_parent_list_free (parent_list
);
644 _xdg_mime_icon_list_free (icon_list
);
648 if (generic_icon_list
)
650 _xdg_mime_icon_list_free (generic_icon_list
);
651 generic_icon_list
= NULL
;
658 for (i
= 0; i
< n_caches
; i
++)
659 _xdg_mime_cache_unref (_caches
[i
]);
665 for (list
= callback_list
; list
; list
= list
->next
)
666 (list
->callback
) (list
->data
);
672 xdg_mime_get_max_buffer_extents (void)
677 return _xdg_mime_cache_get_max_buffer_extents ();
679 return _xdg_mime_magic_get_buffer_extents (global_magic
);
683 _xdg_mime_unalias_mime_type (const char *mime_type
)
688 return _xdg_mime_cache_unalias_mime_type (mime_type
);
690 if ((lookup
= _xdg_mime_alias_list_lookup (alias_list
, mime_type
)) != NULL
)
697 xdg_mime_unalias_mime_type (const char *mime_type
)
701 return _xdg_mime_unalias_mime_type (mime_type
);
705 _xdg_mime_mime_type_equal (const char *mime_a
,
708 const char *unalias_a
, *unalias_b
;
710 unalias_a
= _xdg_mime_unalias_mime_type (mime_a
);
711 unalias_b
= _xdg_mime_unalias_mime_type (mime_b
);
713 if (strcmp (unalias_a
, unalias_b
) == 0)
720 xdg_mime_mime_type_equal (const char *mime_a
,
725 return _xdg_mime_mime_type_equal (mime_a
, mime_b
);
729 xdg_mime_media_type_equal (const char *mime_a
,
734 sep
= strchr (mime_a
, '/');
736 if (sep
&& strncmp (mime_a
, mime_b
, sep
- mime_a
+ 1) == 0)
744 xdg_mime_is_super_type (const char *mime
)
749 length
= strlen (mime
);
750 type
= &(mime
[length
- 2]);
752 if (strcmp (type
, "/*") == 0)
760 _xdg_mime_mime_type_subclass (const char *mime
,
763 const char *umime
, *ubase
;
764 const char **parents
;
767 return _xdg_mime_cache_mime_type_subclass (mime
, base
);
769 umime
= _xdg_mime_unalias_mime_type (mime
);
770 ubase
= _xdg_mime_unalias_mime_type (base
);
772 if (strcmp (umime
, ubase
) == 0)
776 /* Handle supertypes */
777 if (xdg_mime_is_super_type (ubase
) &&
778 xdg_mime_media_type_equal (umime
, ubase
))
782 /* Handle special cases text/plain and application/octet-stream */
783 if (strcmp (ubase
, "text/plain") == 0 &&
784 strncmp (umime
, "text/", 5) == 0)
787 if (strcmp (ubase
, "application/octet-stream") == 0)
790 parents
= _xdg_mime_parent_list_lookup (parent_list
, umime
);
791 for (; parents
&& *parents
; parents
++)
793 if (_xdg_mime_mime_type_subclass (*parents
, ubase
))
801 xdg_mime_mime_type_subclass (const char *mime
,
806 return _xdg_mime_mime_type_subclass (mime
, base
);
810 xdg_mime_list_mime_parents (const char *mime
)
812 const char **parents
;
817 return _xdg_mime_cache_list_mime_parents (mime
);
819 parents
= xdg_mime_get_mime_parents (mime
);
824 for (i
= 0; parents
[i
]; i
++) ;
826 n
= (i
+ 1) * sizeof (char *);
827 result
= (char **) malloc (n
);
828 memcpy (result
, parents
, n
);
834 xdg_mime_get_mime_parents (const char *mime
)
840 umime
= _xdg_mime_unalias_mime_type (mime
);
842 return _xdg_mime_parent_list_lookup (parent_list
, umime
);
850 printf ("*** ALIASES ***\n\n");
851 _xdg_mime_alias_list_dump (alias_list
);
852 printf ("\n*** PARENTS ***\n\n");
853 _xdg_mime_parent_list_dump (parent_list
);
854 printf ("\n*** CACHE ***\n\n");
855 _xdg_glob_hash_dump (global_hash
);
856 printf ("\n*** GLOBS ***\n\n");
857 _xdg_glob_hash_dump (global_hash
);
858 printf ("\n*** GLOBS REVERSE TREE ***\n\n");
859 _xdg_mime_cache_glob_dump ();
863 /* Registers a function to be called every time the mime database reloads its files
866 xdg_mime_register_reload_callback (XdgMimeCallback callback
,
868 XdgMimeDestroy destroy
)
870 XdgCallbackList
*list_el
;
871 static int callback_id
= 1;
873 /* Make a new list element */
874 list_el
= calloc (1, sizeof (XdgCallbackList
));
875 list_el
->callback_id
= callback_id
;
876 list_el
->callback
= callback
;
877 list_el
->data
= data
;
878 list_el
->destroy
= destroy
;
879 list_el
->next
= callback_list
;
881 list_el
->next
->prev
= list_el
;
883 callback_list
= list_el
;
886 return callback_id
- 1;
890 xdg_mime_remove_callback (int callback_id
)
892 XdgCallbackList
*list
;
894 for (list
= callback_list
; list
; list
= list
->next
)
896 if (list
->callback_id
== callback_id
)
899 list
->next
= list
->prev
;
902 list
->prev
->next
= list
->next
;
904 callback_list
= list
->next
;
906 /* invoke the destroy handler */
907 (list
->destroy
) (list
->data
);
915 xdg_mime_get_icon (const char *mime
)
920 return _xdg_mime_cache_get_icon (mime
);
922 return _xdg_mime_icon_list_lookup (icon_list
, mime
);
926 xdg_mime_get_generic_icon (const char *mime
)
931 return _xdg_mime_cache_get_generic_icon (mime
);
933 return _xdg_mime_icon_list_lookup (generic_icon_list
, mime
);