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 "xdgmimeparent.h"
38 #include "xdgmimecache.h"
42 #include <sys/types.h>
51 typedef struct XdgDirTimeList XdgDirTimeList
;
52 typedef struct XdgCallbackList XdgCallbackList
;
54 static int need_reread
= TRUE
;
55 static time_t last_stat_time
= 0;
57 static XdgGlobHash
*global_hash
= NULL
;
58 static XdgMimeMagic
*global_magic
= NULL
;
59 static XdgAliasList
*alias_list
= NULL
;
60 static XdgParentList
*parent_list
= NULL
;
61 static XdgDirTimeList
*dir_time_list
= NULL
;
62 static XdgCallbackList
*callback_list
= NULL
;
64 XdgMimeCache
**_xdg_mime_caches
= NULL
;
65 static int n_caches
= 0;
67 const char xdg_mime_type_unknown
[] = "application/octet-stream";
68 const char xdg_mime_type_unknown_text
[] = "text/plain"; /* ROX: */
73 XDG_CHECKED_UNCHECKED
,
87 struct XdgCallbackList
89 XdgCallbackList
*next
;
90 XdgCallbackList
*prev
;
92 XdgMimeCallback callback
;
94 XdgMimeDestroy destroy
;
97 /* Function called by xdg_run_command_on_dirs. If it returns TRUE, further
98 * directories aren't looked at */
99 typedef int (*XdgDirectoryFunc
) (const char *directory
,
102 static XdgDirTimeList
*
103 xdg_dir_time_list_new (void)
105 XdgDirTimeList
*retval
;
107 retval
= calloc (1, sizeof (XdgDirTimeList
));
108 retval
->checked
= XDG_CHECKED_UNCHECKED
;
114 xdg_dir_time_list_free (XdgDirTimeList
*list
)
116 XdgDirTimeList
*next
;
121 free (list
->directory_name
);
128 xdg_mime_init_from_directory (const char *directory
)
132 XdgDirTimeList
*list
;
134 assert (directory
!= NULL
);
136 file_name
= malloc (strlen (directory
) + strlen ("/mime/mime.cache") + 1);
137 strcpy (file_name
, directory
); strcat (file_name
, "/mime/mime.cache");
138 if (stat (file_name
, &st
) == 0)
140 XdgMimeCache
*cache
= _xdg_mime_cache_new_from_file (file_name
);
144 list
= xdg_dir_time_list_new ();
145 list
->directory_name
= file_name
;
146 list
->mtime
= st
.st_mtime
;
147 list
->next
= dir_time_list
;
149 dir_time_list
= list
;
151 _xdg_mime_caches
= realloc (_xdg_mime_caches
, sizeof (XdgMimeCache
*) * (n_caches
+ 2));
152 _xdg_mime_caches
[n_caches
] = cache
;
153 _xdg_mime_caches
[n_caches
+ 1] = NULL
;
161 file_name
= malloc (strlen (directory
) + strlen ("/mime/globs") + 1);
162 strcpy (file_name
, directory
); strcat (file_name
, "/mime/globs");
163 if (stat (file_name
, &st
) == 0)
165 _xdg_mime_glob_read_from_file (global_hash
, file_name
);
167 list
= xdg_dir_time_list_new ();
168 list
->directory_name
= file_name
;
169 list
->mtime
= st
.st_mtime
;
170 list
->next
= dir_time_list
;
171 dir_time_list
= list
;
178 file_name
= malloc (strlen (directory
) + strlen ("/mime/magic") + 1);
179 strcpy (file_name
, directory
); strcat (file_name
, "/mime/magic");
180 if (stat (file_name
, &st
) == 0)
182 _xdg_mime_magic_read_from_file (global_magic
, file_name
);
184 list
= xdg_dir_time_list_new ();
185 list
->directory_name
= file_name
;
186 list
->mtime
= st
.st_mtime
;
187 list
->next
= dir_time_list
;
188 dir_time_list
= list
;
195 file_name
= malloc (strlen (directory
) + strlen ("/mime/aliases") + 1);
196 strcpy (file_name
, directory
); strcat (file_name
, "/mime/aliases");
197 _xdg_mime_alias_read_from_file (alias_list
, file_name
);
200 file_name
= malloc (strlen (directory
) + strlen ("/mime/subclasses") + 1);
201 strcpy (file_name
, directory
); strcat (file_name
, "/mime/subclasses");
202 _xdg_mime_parent_read_from_file (parent_list
, file_name
);
205 return FALSE
; /* Keep processing */
208 /* Runs a command on all the directories in the search path */
210 xdg_run_command_on_dirs (XdgDirectoryFunc func
,
213 const char *xdg_data_home
;
214 const char *xdg_data_dirs
;
217 xdg_data_home
= getenv ("XDG_DATA_HOME");
220 if ((func
) (xdg_data_home
, user_data
))
227 home
= getenv ("HOME");
230 char *guessed_xdg_home
;
233 guessed_xdg_home
= malloc (strlen (home
) + strlen ("/.local/share/") + 1);
234 strcpy (guessed_xdg_home
, home
);
235 strcat (guessed_xdg_home
, "/.local/share/");
236 stop_processing
= (func
) (guessed_xdg_home
, user_data
);
237 free (guessed_xdg_home
);
244 xdg_data_dirs
= getenv ("XDG_DATA_DIRS");
245 if (xdg_data_dirs
== NULL
)
246 xdg_data_dirs
= "/usr/local/share/:/usr/share/";
250 while (*ptr
!= '\000')
258 while (*end_ptr
!= ':' && *end_ptr
!= '\000')
270 len
= end_ptr
- ptr
+ 1;
271 dir
= malloc (len
+ 1);
272 strncpy (dir
, ptr
, len
);
274 stop_processing
= (func
) (dir
, user_data
);
284 static XdgMimeCache
*
285 xdg_lookup_cache_for_file (const char *file_path
)
287 XdgDirTimeList
*list
;
289 for (list
= dir_time_list
; list
; list
= list
->next
)
290 if (! strcmp (list
->directory_name
, file_path
))
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
)
307 /* If the file exists */
308 if (stat (file_path
, &st
) == 0)
310 XdgDirTimeList
*list
;
312 for (list
= dir_time_list
; list
; list
= list
->next
)
314 if (! strcmp (list
->directory_name
, file_path
) &&
315 st
.st_mtime
== list
->mtime
)
317 if (list
->checked
== XDG_CHECKED_UNCHECKED
)
318 list
->checked
= XDG_CHECKED_VALID
;
319 else if (list
->checked
== XDG_CHECKED_VALID
)
320 list
->checked
= XDG_CHECKED_INVALID
;
322 return (list
->checked
!= XDG_CHECKED_VALID
);
332 xdg_check_dir (const char *directory
,
333 int *invalid_dir_list
)
335 int invalid
, has_cache
;
338 assert (directory
!= NULL
);
340 /* Check the mime.cache file */
341 file_name
= malloc (strlen (directory
) + strlen ("/mime/mime.cache") + 1);
342 strcpy (file_name
, directory
); strcat (file_name
, "/mime/mime.cache");
343 invalid
= xdg_check_file (file_name
);
344 has_cache
= xdg_lookup_cache_for_file (file_name
) != NULL
;
351 *invalid_dir_list
= TRUE
;
358 /* Check the globs file */
359 file_name
= malloc (strlen (directory
) + strlen ("/mime/globs") + 1);
360 strcpy (file_name
, directory
); strcat (file_name
, "/mime/globs");
361 invalid
= xdg_check_file (file_name
);
365 *invalid_dir_list
= TRUE
;
369 /* Check the magic file */
370 file_name
= malloc (strlen (directory
) + strlen ("/mime/magic") + 1);
371 strcpy (file_name
, directory
); strcat (file_name
, "/mime/magic");
372 invalid
= xdg_check_file (file_name
);
376 *invalid_dir_list
= TRUE
;
380 return FALSE
; /* Keep processing */
383 /* Walks through all the mime files stat()ing them to see if they've changed.
384 * Returns TRUE if they have. */
386 xdg_check_dirs (void)
388 XdgDirTimeList
*list
;
389 int invalid_dir_list
= FALSE
;
391 for (list
= dir_time_list
; list
; list
= list
->next
)
392 list
->checked
= XDG_CHECKED_UNCHECKED
;
394 xdg_run_command_on_dirs ((XdgDirectoryFunc
) xdg_check_dir
,
397 if (invalid_dir_list
)
400 for (list
= dir_time_list
; list
; list
= list
->next
)
402 if (list
->checked
!= XDG_CHECKED_VALID
)
409 /* We want to avoid stat()ing on every single mime call, so we only look for
410 * newer files every 5 seconds. This will return TRUE if we need to reread the
411 * mime data from disk.
414 xdg_check_time_and_dirs (void)
420 gettimeofday (&tv
, NULL
);
421 current_time
= tv
.tv_sec
;
423 if (current_time
>= last_stat_time
+ 5)
425 retval
= xdg_check_dirs ();
426 last_stat_time
= current_time
;
432 /* Called in every public function. It reloads the hash function if need be.
437 if (xdg_check_time_and_dirs ())
439 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 ();
452 xdg_run_command_on_dirs ((XdgDirectoryFunc
) xdg_mime_init_from_directory
,
455 /* ROX: We want to support shared-mime-database < 0.16, where we can't
456 * do this with the rox.xml file.
458 mime_parents
= g_build_filename(app_dir
, "subclasses", NULL
);
459 _xdg_mime_parent_read_from_file(parent_list
, mime_parents
);
460 g_free(mime_parents
);
467 xdg_mime_get_mime_type_for_data (const void *data
,
470 const char *mime_type
;
474 if (_xdg_mime_caches
)
475 return _xdg_mime_cache_get_mime_type_for_data (data
, len
);
477 mime_type
= _xdg_mime_magic_lookup_data (global_magic
, data
, len
, NULL
, 0);
482 return XDG_MIME_TYPE_UNKNOWN
;
486 xdg_mime_get_mime_type_for_file (const char *file_name
,
487 struct stat
*statbuf
)
489 const char *mime_type
;
490 /* Used to detect whether multiple MIME types match file_name */
491 const char *mime_types
[2];
497 const char *base_name
;
500 if (file_name
== NULL
)
502 if (! _xdg_utf8_validate (file_name
))
507 if (_xdg_mime_caches
)
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
, 2);
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
,
559 return XDG_MIME_TYPE_UNKNOWN
;
563 xdg_mime_get_mime_type_from_file_name (const char *file_name
)
565 const char *mime_types
[2];
569 if (_xdg_mime_caches
)
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_types
, 2) == 1)
573 return mime_types
[0];
575 return XDG_MIME_TYPE_UNKNOWN
;
579 xdg_mime_is_valid_mime_type (const char *mime_type
)
581 /* FIXME: We should make this a better test
583 return _xdg_utf8_validate (mime_type
);
587 xdg_mime_shutdown (void)
589 XdgCallbackList
*list
;
591 /* FIXME: Need to make this (and the whole library) thread safe */
594 xdg_dir_time_list_free (dir_time_list
);
595 dir_time_list
= NULL
;
600 _xdg_glob_hash_free (global_hash
);
605 _xdg_mime_magic_free (global_magic
);
611 _xdg_mime_alias_list_free (alias_list
);
617 _xdg_mime_parent_list_free (parent_list
);
621 if (_xdg_mime_caches
)
624 for (i
= 0; i
< n_caches
; i
++)
625 _xdg_mime_cache_unref (_xdg_mime_caches
[i
]);
626 free (_xdg_mime_caches
);
627 _xdg_mime_caches
= NULL
;
631 for (list
= callback_list
; list
; list
= list
->next
)
632 (list
->callback
) (list
->data
);
638 xdg_mime_get_max_buffer_extents (void)
642 if (_xdg_mime_caches
)
643 return _xdg_mime_cache_get_max_buffer_extents ();
645 return _xdg_mime_magic_get_buffer_extents (global_magic
);
649 _xdg_mime_unalias_mime_type (const char *mime_type
)
653 if (_xdg_mime_caches
)
654 return _xdg_mime_cache_unalias_mime_type (mime_type
);
656 if ((lookup
= _xdg_mime_alias_list_lookup (alias_list
, mime_type
)) != NULL
)
663 xdg_mime_unalias_mime_type (const char *mime_type
)
667 return _xdg_mime_unalias_mime_type (mime_type
);
671 _xdg_mime_mime_type_equal (const char *mime_a
,
674 const char *unalias_a
, *unalias_b
;
676 unalias_a
= _xdg_mime_unalias_mime_type (mime_a
);
677 unalias_b
= _xdg_mime_unalias_mime_type (mime_b
);
679 if (strcmp (unalias_a
, unalias_b
) == 0)
686 xdg_mime_mime_type_equal (const char *mime_a
,
691 return _xdg_mime_mime_type_equal (mime_a
, mime_b
);
695 _xdg_mime_media_type_equal (const char *mime_a
,
702 sep
= strchr (mime_a
, '/');
704 if (sep
&& strncmp (mime_a
, mime_b
, sep
- mime_a
+ 1) == 0)
711 xdg_mime_media_type_equal (const char *mime_a
,
716 return _xdg_mime_media_type_equal (mime_a
, mime_b
);
721 xdg_mime_is_super_type (const char *mime
)
726 length
= strlen (mime
);
727 type
= &(mime
[length
- 2]);
729 if (strcmp (type
, "/*") == 0)
737 _xdg_mime_mime_type_subclass (const char *mime
,
740 const char *umime
, *ubase
;
741 const char **parents
;
743 if (_xdg_mime_caches
)
744 return _xdg_mime_cache_mime_type_subclass (mime
, base
);
746 umime
= _xdg_mime_unalias_mime_type (mime
);
747 ubase
= _xdg_mime_unalias_mime_type (base
);
749 if (strcmp (umime
, ubase
) == 0)
753 /* Handle supertypes */
754 if (xdg_mime_is_super_type (ubase
) &&
755 _xdg_mime_media_type_equal (umime
, ubase
))
759 /* Handle special cases text/plain and application/octet-stream */
760 if (strcmp (ubase
, "text/plain") == 0 &&
761 strncmp (umime
, "text/", 5) == 0)
764 if (strcmp (ubase
, "application/octet-stream") == 0)
767 parents
= _xdg_mime_parent_list_lookup (parent_list
, umime
);
768 for (; parents
&& *parents
; parents
++)
770 if (_xdg_mime_mime_type_subclass (*parents
, ubase
))
778 xdg_mime_mime_type_subclass (const char *mime
,
783 return _xdg_mime_mime_type_subclass (mime
, base
);
787 xdg_mime_list_mime_parents (const char *mime
)
789 const char **parents
;
793 if (_xdg_mime_caches
)
794 return _xdg_mime_cache_list_mime_parents (mime
);
796 parents
= xdg_mime_get_mime_parents (mime
);
801 for (i
= 0; parents
[i
]; i
++) ;
803 n
= (i
+ 1) * sizeof (char *);
804 result
= (char **) malloc (n
);
805 memcpy (result
, parents
, n
);
811 xdg_mime_get_mime_parents (const char *mime
)
817 umime
= _xdg_mime_unalias_mime_type (mime
);
819 return _xdg_mime_parent_list_lookup (parent_list
, umime
);
825 printf ("*** ALIASES ***\n\n");
826 _xdg_mime_alias_list_dump (alias_list
);
827 printf ("\n*** PARENTS ***\n\n");
828 _xdg_mime_parent_list_dump (parent_list
);
829 printf ("\n*** CACHE ***\n\n");
830 _xdg_glob_hash_dump (global_hash
);
834 /* Registers a function to be called every time the mime database reloads its files
837 xdg_mime_register_reload_callback (XdgMimeCallback callback
,
839 XdgMimeDestroy destroy
)
841 XdgCallbackList
*list_el
;
842 static int callback_id
= 1;
844 /* Make a new list element */
845 list_el
= calloc (1, sizeof (XdgCallbackList
));
846 list_el
->callback_id
= callback_id
;
847 list_el
->callback
= callback
;
848 list_el
->data
= data
;
849 list_el
->destroy
= destroy
;
850 list_el
->next
= callback_list
;
852 list_el
->next
->prev
= list_el
;
854 callback_list
= list_el
;
857 return callback_id
- 1;
861 xdg_mime_remove_callback (int callback_id
)
863 XdgCallbackList
*list
;
865 for (list
= callback_list
; list
; list
= list
->next
)
867 if (list
->callback_id
== callback_id
)
870 list
->next
= list
->prev
;
873 list
->prev
->next
= list
->next
;
875 callback_list
= list
->next
;
877 /* invoke the destroy handler */
878 (list
->destroy
) (list
->data
);