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>
47 typedef struct XdgDirTimeList XdgDirTimeList
;
48 typedef struct XdgCallbackList XdgCallbackList
;
50 static int need_reread
= TRUE
;
51 static time_t last_stat_time
= 0;
53 static XdgGlobHash
*global_hash
= NULL
;
54 static XdgMimeMagic
*global_magic
= NULL
;
55 static XdgAliasList
*alias_list
= NULL
;
56 static XdgParentList
*parent_list
= NULL
;
57 static XdgDirTimeList
*dir_time_list
= NULL
;
58 static XdgCallbackList
*callback_list
= NULL
;
60 XdgMimeCache
**_caches
= NULL
;
61 static int n_caches
= 0;
63 const char xdg_mime_type_unknown
[] = "application/octet-stream";
68 XDG_CHECKED_UNCHECKED
,
81 struct XdgCallbackList
83 XdgCallbackList
*next
;
84 XdgCallbackList
*prev
;
86 XdgMimeCallback callback
;
88 XdgMimeDestroy destroy
;
91 /* Function called by xdg_run_command_on_dirs. If it returns TRUE, further
92 * directories aren't looked at */
93 typedef int (*XdgDirectoryFunc
) (const char *directory
,
96 static XdgDirTimeList
*
97 xdg_dir_time_list_new (void)
99 XdgDirTimeList
*retval
;
101 retval
= calloc (1, sizeof (XdgDirTimeList
));
102 retval
->checked
= XDG_CHECKED_UNCHECKED
;
108 xdg_dir_time_list_free (XdgDirTimeList
*list
)
110 XdgDirTimeList
*next
;
115 free (list
->directory_name
);
122 xdg_mime_init_from_directory (const char *directory
)
126 XdgDirTimeList
*list
;
128 assert (directory
!= NULL
);
130 file_name
= malloc (strlen (directory
) + strlen ("/mime/mime.cache") + 1);
131 strcpy (file_name
, directory
); strcat (file_name
, "/mime/mime.cache");
132 if (stat (file_name
, &st
) == 0)
134 XdgMimeCache
*cache
= _xdg_mime_cache_new_from_file (file_name
);
138 list
= xdg_dir_time_list_new ();
139 list
->directory_name
= file_name
;
140 list
->mtime
= st
.st_mtime
;
141 list
->next
= dir_time_list
;
142 dir_time_list
= list
;
144 _caches
= realloc (_caches
, sizeof (XdgMimeCache
*) * (n_caches
+ 2));
145 _caches
[n_caches
] = cache
;
146 _caches
[n_caches
+ 1] = NULL
;
154 file_name
= malloc (strlen (directory
) + strlen ("/mime/globs") + 1);
155 strcpy (file_name
, directory
); strcat (file_name
, "/mime/globs");
156 if (stat (file_name
, &st
) == 0)
158 _xdg_mime_glob_read_from_file (global_hash
, file_name
);
160 list
= xdg_dir_time_list_new ();
161 list
->directory_name
= file_name
;
162 list
->mtime
= st
.st_mtime
;
163 list
->next
= dir_time_list
;
164 dir_time_list
= list
;
171 file_name
= malloc (strlen (directory
) + strlen ("/mime/magic") + 1);
172 strcpy (file_name
, directory
); strcat (file_name
, "/mime/magic");
173 if (stat (file_name
, &st
) == 0)
175 _xdg_mime_magic_read_from_file (global_magic
, file_name
);
177 list
= xdg_dir_time_list_new ();
178 list
->directory_name
= file_name
;
179 list
->mtime
= st
.st_mtime
;
180 list
->next
= dir_time_list
;
181 dir_time_list
= list
;
188 file_name
= malloc (strlen (directory
) + strlen ("/mime/aliases") + 1);
189 strcpy (file_name
, directory
); strcat (file_name
, "/mime/aliases");
190 _xdg_mime_alias_read_from_file (alias_list
, file_name
);
193 file_name
= malloc (strlen (directory
) + strlen ("/mime/subclasses") + 1);
194 strcpy (file_name
, directory
); strcat (file_name
, "/mime/subclasses");
195 _xdg_mime_parent_read_from_file (parent_list
, file_name
);
198 return FALSE
; /* Keep processing */
201 /* Runs a command on all the directories in the search path */
203 xdg_run_command_on_dirs (XdgDirectoryFunc func
,
206 const char *xdg_data_home
;
207 const char *xdg_data_dirs
;
210 xdg_data_home
= getenv ("XDG_DATA_HOME");
213 if ((func
) (xdg_data_home
, user_data
))
220 home
= getenv ("HOME");
223 char *guessed_xdg_home
;
226 guessed_xdg_home
= malloc (strlen (home
) + strlen ("/.local/share/") + 1);
227 strcpy (guessed_xdg_home
, home
);
228 strcat (guessed_xdg_home
, "/.local/share/");
229 stop_processing
= (func
) (guessed_xdg_home
, user_data
);
230 free (guessed_xdg_home
);
237 xdg_data_dirs
= getenv ("XDG_DATA_DIRS");
238 if (xdg_data_dirs
== NULL
)
239 xdg_data_dirs
= "/usr/local/share/:/usr/share/";
243 while (*ptr
!= '\000')
251 while (*end_ptr
!= ':' && *end_ptr
!= '\000')
263 len
= end_ptr
- ptr
+ 1;
264 dir
= malloc (len
+ 1);
265 strncpy (dir
, ptr
, len
);
267 stop_processing
= (func
) (dir
, user_data
);
277 /* Checks file_path to make sure it has the same mtime as last time it was
278 * checked. If it has a different mtime, or if the file doesn't exist, it
281 * FIXME: This doesn't protect against permission changes.
284 xdg_check_file (const char *file_path
,
289 /* If the file exists */
290 if (stat (file_path
, &st
) == 0)
292 XdgDirTimeList
*list
;
297 for (list
= dir_time_list
; list
; list
= list
->next
)
299 if (! strcmp (list
->directory_name
, file_path
) &&
300 st
.st_mtime
== list
->mtime
)
302 if (list
->checked
== XDG_CHECKED_UNCHECKED
)
303 list
->checked
= XDG_CHECKED_VALID
;
304 else if (list
->checked
== XDG_CHECKED_VALID
)
305 list
->checked
= XDG_CHECKED_INVALID
;
307 return (list
->checked
!= XDG_CHECKED_VALID
);
320 xdg_check_dir (const char *directory
,
321 int *invalid_dir_list
)
326 assert (directory
!= NULL
);
328 /* Check the mime.cache file */
329 file_name
= malloc (strlen (directory
) + strlen ("/mime/mime.cache") + 1);
330 strcpy (file_name
, directory
); strcat (file_name
, "/mime/mime.cache");
331 invalid
= xdg_check_file (file_name
, &exists
);
335 *invalid_dir_list
= TRUE
;
343 /* Check the globs file */
344 file_name
= malloc (strlen (directory
) + strlen ("/mime/globs") + 1);
345 strcpy (file_name
, directory
); strcat (file_name
, "/mime/globs");
346 invalid
= xdg_check_file (file_name
, NULL
);
350 *invalid_dir_list
= TRUE
;
354 /* Check the magic file */
355 file_name
= malloc (strlen (directory
) + strlen ("/mime/magic") + 1);
356 strcpy (file_name
, directory
); strcat (file_name
, "/mime/magic");
357 invalid
= xdg_check_file (file_name
, NULL
);
361 *invalid_dir_list
= TRUE
;
365 return FALSE
; /* Keep processing */
368 /* Walks through all the mime files stat()ing them to see if they've changed.
369 * Returns TRUE if they have. */
371 xdg_check_dirs (void)
373 XdgDirTimeList
*list
;
374 int invalid_dir_list
= FALSE
;
376 for (list
= dir_time_list
; list
; list
= list
->next
)
377 list
->checked
= XDG_CHECKED_UNCHECKED
;
379 xdg_run_command_on_dirs ((XdgDirectoryFunc
) xdg_check_dir
,
382 if (invalid_dir_list
)
385 for (list
= dir_time_list
; list
; list
= list
->next
)
387 if (list
->checked
!= XDG_CHECKED_VALID
)
394 /* We want to avoid stat()ing on every single mime call, so we only look for
395 * newer files every 5 seconds. This will return TRUE if we need to reread the
396 * mime data from disk.
399 xdg_check_time_and_dirs (void)
405 gettimeofday (&tv
, NULL
);
406 current_time
= tv
.tv_sec
;
408 if (current_time
>= last_stat_time
+ 5)
410 retval
= xdg_check_dirs ();
411 last_stat_time
= current_time
;
417 /* Called in every public function. It reloads the hash function if need be.
422 if (xdg_check_time_and_dirs ())
424 xdg_mime_shutdown ();
429 global_hash
= _xdg_glob_hash_new ();
430 global_magic
= _xdg_mime_magic_new ();
431 alias_list
= _xdg_mime_alias_list_new ();
432 parent_list
= _xdg_mime_parent_list_new ();
434 xdg_run_command_on_dirs ((XdgDirectoryFunc
) xdg_mime_init_from_directory
,
442 xdg_mime_get_mime_type_for_data (const void *data
,
445 const char *mime_type
;
450 return _xdg_mime_cache_get_mime_type_for_data (data
, len
);
452 mime_type
= _xdg_mime_magic_lookup_data (global_magic
, data
, len
, NULL
, 0);
457 return XDG_MIME_TYPE_UNKNOWN
;
461 xdg_mime_get_mime_type_for_file (const char *file_name
,
462 struct stat
*statbuf
)
464 const char *mime_type
;
465 /* currently, only a few globs occur twice, and none
466 * more often, so 5 seems plenty.
468 const char *mime_types
[5];
474 const char *base_name
;
477 if (file_name
== NULL
)
479 if (! _xdg_utf8_validate (file_name
))
485 return _xdg_mime_cache_get_mime_type_for_file (file_name
, statbuf
);
487 base_name
= _xdg_get_base_name (file_name
);
488 n
= _xdg_glob_hash_lookup_file_name (global_hash
, base_name
, mime_types
, 5);
491 return mime_types
[0];
495 if (stat (file_name
, &buf
) != 0)
496 return XDG_MIME_TYPE_UNKNOWN
;
501 if (!S_ISREG (statbuf
->st_mode
))
502 return XDG_MIME_TYPE_UNKNOWN
;
504 /* FIXME: Need to make sure that max_extent isn't totally broken. This could
505 * be large and need getting from a stream instead of just reading it all
507 max_extent
= _xdg_mime_magic_get_buffer_extents (global_magic
);
508 data
= malloc (max_extent
);
510 return XDG_MIME_TYPE_UNKNOWN
;
512 file
= fopen (file_name
, "r");
516 return XDG_MIME_TYPE_UNKNOWN
;
519 bytes_read
= fread (data
, 1, max_extent
, file
);
524 return XDG_MIME_TYPE_UNKNOWN
;
527 mime_type
= _xdg_mime_magic_lookup_data (global_magic
, data
, bytes_read
,
536 return XDG_MIME_TYPE_UNKNOWN
;
540 xdg_mime_get_mime_type_from_file_name (const char *file_name
)
542 const char *mime_type
;
547 return _xdg_mime_cache_get_mime_type_from_file_name (file_name
);
549 if (_xdg_glob_hash_lookup_file_name (global_hash
, file_name
, &mime_type
, 1))
552 return XDG_MIME_TYPE_UNKNOWN
;
556 xdg_mime_is_valid_mime_type (const char *mime_type
)
558 /* FIXME: We should make this a better test
560 return _xdg_utf8_validate (mime_type
);
564 xdg_mime_shutdown (void)
566 XdgCallbackList
*list
;
568 /* FIXME: Need to make this (and the whole library) thread safe */
571 xdg_dir_time_list_free (dir_time_list
);
572 dir_time_list
= NULL
;
577 _xdg_glob_hash_free (global_hash
);
582 _xdg_mime_magic_free (global_magic
);
588 _xdg_mime_alias_list_free (alias_list
);
594 _xdg_mime_parent_list_free (parent_list
);
602 for (i
= 0; i
< n_caches
; i
++)
603 _xdg_mime_cache_unref (_caches
[i
]);
609 for (list
= callback_list
; list
; list
= list
->next
)
610 (list
->callback
) (list
->data
);
616 xdg_mime_get_max_buffer_extents (void)
621 return _xdg_mime_cache_get_max_buffer_extents ();
623 return _xdg_mime_magic_get_buffer_extents (global_magic
);
627 _xdg_mime_unalias_mime_type (const char *mime_type
)
632 return _xdg_mime_cache_unalias_mime_type (mime_type
);
634 if ((lookup
= _xdg_mime_alias_list_lookup (alias_list
, mime_type
)) != NULL
)
641 xdg_mime_unalias_mime_type (const char *mime_type
)
645 return _xdg_mime_unalias_mime_type (mime_type
);
649 _xdg_mime_mime_type_equal (const char *mime_a
,
652 const char *unalias_a
, *unalias_b
;
654 unalias_a
= _xdg_mime_unalias_mime_type (mime_a
);
655 unalias_b
= _xdg_mime_unalias_mime_type (mime_b
);
657 if (strcmp (unalias_a
, unalias_b
) == 0)
664 xdg_mime_mime_type_equal (const char *mime_a
,
669 return _xdg_mime_mime_type_equal (mime_a
, mime_b
);
673 xdg_mime_media_type_equal (const char *mime_a
,
680 sep
= strchr (mime_a
, '/');
682 if (sep
&& strncmp (mime_a
, mime_b
, sep
- mime_a
+ 1) == 0)
690 xdg_mime_is_super_type (const char *mime
)
695 length
= strlen (mime
);
696 type
= &(mime
[length
- 2]);
698 if (strcmp (type
, "/*") == 0)
706 _xdg_mime_mime_type_subclass (const char *mime
,
709 const char *umime
, *ubase
;
710 const char **parents
;
713 return _xdg_mime_cache_mime_type_subclass (mime
, base
);
715 umime
= _xdg_mime_unalias_mime_type (mime
);
716 ubase
= _xdg_mime_unalias_mime_type (base
);
718 if (strcmp (umime
, ubase
) == 0)
722 /* Handle supertypes */
723 if (xdg_mime_is_super_type (ubase
) &&
724 xdg_mime_media_type_equal (umime
, ubase
))
728 /* Handle special cases text/plain and application/octet-stream */
729 if (strcmp (ubase
, "text/plain") == 0 &&
730 strncmp (umime
, "text/", 5) == 0)
733 if (strcmp (ubase
, "application/octet-stream") == 0)
736 parents
= _xdg_mime_parent_list_lookup (parent_list
, umime
);
737 for (; parents
&& *parents
; parents
++)
739 if (_xdg_mime_mime_type_subclass (*parents
, ubase
))
747 xdg_mime_mime_type_subclass (const char *mime
,
752 return _xdg_mime_mime_type_subclass (mime
, base
);
756 xdg_mime_list_mime_parents (const char *mime
)
758 const char **parents
;
763 return _xdg_mime_cache_list_mime_parents (mime
);
765 parents
= xdg_mime_get_mime_parents (mime
);
770 for (i
= 0; parents
[i
]; i
++) ;
772 n
= (i
+ 1) * sizeof (char *);
773 result
= (char **) malloc (n
);
774 memcpy (result
, parents
, n
);
780 xdg_mime_get_mime_parents (const char *mime
)
786 umime
= _xdg_mime_unalias_mime_type (mime
);
788 return _xdg_mime_parent_list_lookup (parent_list
, umime
);
794 printf ("*** ALIASES ***\n\n");
795 _xdg_mime_alias_list_dump (alias_list
);
796 printf ("\n*** PARENTS ***\n\n");
797 _xdg_mime_parent_list_dump (parent_list
);
801 /* Registers a function to be called every time the mime database reloads its files
804 xdg_mime_register_reload_callback (XdgMimeCallback callback
,
806 XdgMimeDestroy destroy
)
808 XdgCallbackList
*list_el
;
809 static int callback_id
= 1;
811 /* Make a new list element */
812 list_el
= calloc (1, sizeof (XdgCallbackList
));
813 list_el
->callback_id
= callback_id
;
814 list_el
->callback
= callback
;
815 list_el
->data
= data
;
816 list_el
->destroy
= destroy
;
817 list_el
->next
= callback_list
;
819 list_el
->next
->prev
= list_el
;
821 callback_list
= list_el
;
824 return callback_id
- 1;
828 xdg_mime_remove_callback (int callback_id
)
830 XdgCallbackList
*list
;
832 for (list
= callback_list
; list
; list
= list
->next
)
834 if (list
->callback_id
== callback_id
)
837 list
->next
= list
->prev
;
840 list
->prev
->next
= list
->next
;
842 callback_list
= list
->next
;
844 /* invoke the destroy handler */
845 (list
->destroy
) (list
->data
);