1 /* GTK - The GIMP Toolkit
2 * gtkrecentmanager.c: a manager for the recently used resources
4 * Copyright (C) 2006 Emmanuele Bassi
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * SECTION:gtkrecentmanager
23 * @Title: GtkRecentManager
24 * @short_description: Managing recently used files
25 * @See_Also: #GBookmarkFile, #GtkSettings, #GtkRecentChooser
27 * #GtkRecentManager provides a facility for adding, removing and
28 * looking up recently used files. Each recently used file is
29 * identified by its URI, and has meta-data associated to it, like
30 * the names and command lines of the applications that have
31 * registered it, the number of time each application has registered
32 * the same file, the mime type of the file and whether the file
33 * should be displayed only by the applications that have
36 * <note><para>The recently used files list is per user.</para></note>
38 * The #GtkRecentManager acts like a database of all the recently
39 * used files. You can create new #GtkRecentManager objects, but
40 * it is more efficient to use the default manager created by GTK+.
42 * Adding a new recently used file is as simple as:
45 * GtkRecentManager *manager;
47 * manager = gtk_recent_manager_get_default ();
48 * gtk_recent_manager_add_item (manager, file_uri);
51 * The #GtkRecentManager will try to gather all the needed information
52 * from the file itself through GIO.
54 * Looking up the meta-data associated with a recently used file
55 * given its URI requires calling gtk_recent_manager_lookup_item():
58 * GtkRecentManager *manager;
59 * GtkRecentInfo *info;
60 * GError *error = NULL;
62 * manager = gtk_recent_manager_get_default ();
63 * info = gtk_recent_manager_lookup_item (manager, file_uri, &error);
66 * g_warning ("Could not find the file: %s", error->message);
67 * g_error_free (error);
71 * /* Use the info object */
72 * gtk_recent_info_unref (info);
76 * In order to retrieve the list of recently used files, you can use
77 * gtk_recent_manager_get_items(), which returns a list of #GtkRecentInfo
80 * A #GtkRecentManager is the model used to populate the contents of
81 * one, or more #GtkRecentChooser implementations.
83 * <note><para>The maximum age of the recently used files list is
84 * controllable through the #GtkSettings:gtk-recent-files-max-age
85 * property.</para></note>
87 * Recently used files are supported since GTK+ 2.10.
92 #include <sys/types.h>
101 #include <glib/gstdio.h>
104 #include "gtkrecentmanager.h"
106 #include "gtksettings.h"
107 #include "gtkstock.h"
108 #include "gtkicontheme.h"
109 #include "gtktypebuiltins.h"
110 #include "gtkprivate.h"
111 #include "gtkmarshalers.h"
113 /* the file where we store the recently used items */
114 #define GTK_RECENTLY_USED_FILE "recently-used.xbel"
116 /* return all items by default */
117 #define DEFAULT_LIMIT -1
119 /* keep in sync with xdgmime */
120 #define GTK_RECENT_DEFAULT_MIME "application/octet-stream"
135 * #GtkRecentInfo is an opaque data structure
136 * whose members can only be accessed using the provided API.
138 * #GtkRecentInfo constains all the meta-data
139 * associated with an entry in the recently used files list.
143 struct _GtkRecentInfo
156 GSList *applications;
157 GHashTable *apps_lookup;
168 struct _GtkRecentManagerPrivate
176 GBookmarkFile *recent_items;
178 GFileMonitor *monitor;
180 guint changed_timeout;
193 static void gtk_recent_manager_dispose (GObject *object);
194 static void gtk_recent_manager_finalize (GObject *object);
195 static void gtk_recent_manager_set_property (GObject *object,
199 static void gtk_recent_manager_get_property (GObject *object,
203 static void gtk_recent_manager_add_item_query_info (GObject *source_object,
206 static void gtk_recent_manager_monitor_changed (GFileMonitor *monitor,
209 GFileMonitorEvent event_type,
211 static void gtk_recent_manager_changed (GtkRecentManager *manager);
212 static void gtk_recent_manager_real_changed (GtkRecentManager *manager);
213 static void gtk_recent_manager_set_filename (GtkRecentManager *manager,
214 const gchar *filename);
215 static void gtk_recent_manager_clamp_to_age (GtkRecentManager *manager,
219 static void build_recent_items_list (GtkRecentManager *manager);
220 static void purge_recent_items_list (GtkRecentManager *manager,
223 static RecentAppInfo *recent_app_info_new (const gchar *app_name);
224 static void recent_app_info_free (RecentAppInfo *app_info);
226 static GtkRecentInfo *gtk_recent_info_new (const gchar *uri);
227 static void gtk_recent_info_free (GtkRecentInfo *recent_info);
229 static guint signal_changed = 0;
231 static GtkRecentManager *recent_manager_singleton = NULL;
233 G_DEFINE_TYPE (GtkRecentManager, gtk_recent_manager, G_TYPE_OBJECT)
236 filename_warning (const gchar *format,
237 const gchar *filename,
238 const gchar *message)
240 gchar *utf8 = g_filename_to_utf8 (filename, -1, NULL, NULL, NULL);
241 g_warning (format, utf8 ? utf8 : "(invalid filename)", message);
245 /* Test of haystack has the needle prefix, comparing case
246 * insensitive. haystack may be UTF-8, but needle must
247 * contain only lowercase ascii. */
249 has_case_prefix (const gchar *haystack,
254 /* Eat one character at a time. */
258 while (*n && *h && *n == g_ascii_tolower (*h))
268 gtk_recent_manager_error_quark (void)
270 return g_quark_from_static_string ("gtk-recent-manager-error-quark");
274 gtk_recent_manager_class_init (GtkRecentManagerClass *klass)
276 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
278 gobject_class->set_property = gtk_recent_manager_set_property;
279 gobject_class->get_property = gtk_recent_manager_get_property;
280 gobject_class->dispose = gtk_recent_manager_dispose;
281 gobject_class->finalize = gtk_recent_manager_finalize;
284 * GtkRecentManager:filename
286 * The full path to the file to be used to store and read the recently
287 * used resources list
291 g_object_class_install_property (gobject_class,
293 g_param_spec_string ("filename",
295 P_("The full path to the file to be used to store and read the list"),
297 (G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE)));
300 * GtkRecentManager:size
302 * The size of the recently used resources list.
306 g_object_class_install_property (gobject_class,
308 g_param_spec_int ("size",
310 P_("The size of the recently used resources list"),
317 * GtkRecentManager::changed
318 * @recent_manager: the recent manager
320 * Emitted when the current recently used resources manager changes its
321 * contents, either by calling gtk_recent_manager_add_item() or by another
327 g_signal_new (I_("changed"),
328 G_TYPE_FROM_CLASS (klass),
330 G_STRUCT_OFFSET (GtkRecentManagerClass, changed),
332 g_cclosure_marshal_VOID__VOID,
335 klass->changed = gtk_recent_manager_real_changed;
337 g_type_class_add_private (klass, sizeof (GtkRecentManagerPrivate));
341 gtk_recent_manager_init (GtkRecentManager *manager)
343 GtkRecentManagerPrivate *priv;
345 manager->priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
346 GTK_TYPE_RECENT_MANAGER,
347 GtkRecentManagerPrivate);
348 priv = manager->priv;
351 priv->filename = NULL;
355 gtk_recent_manager_set_property (GObject *object,
360 GtkRecentManager *recent_manager = GTK_RECENT_MANAGER (object);
365 gtk_recent_manager_set_filename (recent_manager, g_value_get_string (value));
368 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
374 gtk_recent_manager_get_property (GObject *object,
379 GtkRecentManager *recent_manager = GTK_RECENT_MANAGER (object);
384 g_value_set_string (value, recent_manager->priv->filename);
387 g_value_set_int (value, recent_manager->priv->size);
390 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
396 gtk_recent_manager_finalize (GObject *object)
398 GtkRecentManager *manager = GTK_RECENT_MANAGER (object);
399 GtkRecentManagerPrivate *priv = manager->priv;
401 g_free (priv->filename);
403 if (priv->recent_items != NULL)
404 g_bookmark_file_free (priv->recent_items);
406 G_OBJECT_CLASS (gtk_recent_manager_parent_class)->finalize (object);
410 gtk_recent_manager_dispose (GObject *gobject)
412 GtkRecentManager *manager = GTK_RECENT_MANAGER (gobject);
413 GtkRecentManagerPrivate *priv = manager->priv;
415 if (priv->monitor != NULL)
417 g_signal_handlers_disconnect_by_func (priv->monitor,
418 G_CALLBACK (gtk_recent_manager_monitor_changed),
420 g_object_unref (priv->monitor);
421 priv->monitor = NULL;
424 if (priv->changed_timeout != 0)
426 g_source_remove (priv->changed_timeout);
427 priv->changed_timeout = 0;
428 priv->changed_age = 0;
433 g_object_ref (manager);
434 g_signal_emit (manager, signal_changed, 0);
435 g_object_unref (manager);
438 G_OBJECT_CLASS (gtk_recent_manager_parent_class)->dispose (gobject);
442 gtk_recent_manager_real_changed (GtkRecentManager *manager)
444 GtkRecentManagerPrivate *priv = manager->priv;
446 g_object_freeze_notify (G_OBJECT (manager));
452 /* we are marked as dirty, so we dump the content of our
453 * recently used items list
455 g_assert (priv->filename != NULL);
457 if (!priv->recent_items)
459 /* if no container object has been defined, we create a new
460 * empty container, and dump it
462 priv->recent_items = g_bookmark_file_new ();
467 GtkSettings *settings = gtk_settings_get_default ();
470 g_object_get (G_OBJECT (settings), "gtk-recent-files-max-age", &age, NULL);
472 gtk_recent_manager_clamp_to_age (manager, age);
475 g_bookmark_file_free (priv->recent_items);
476 priv->recent_items = g_bookmark_file_new ();
481 g_bookmark_file_to_file (priv->recent_items, priv->filename, &write_error);
484 filename_warning ("Attempting to store changes into `%s', "
487 write_error->message);
488 g_error_free (write_error);
491 if (g_chmod (priv->filename, 0600) < 0)
493 filename_warning ("Attempting to set the permissions of `%s', "
499 /* mark us as clean */
500 priv->is_dirty = FALSE;
504 /* we are not marked as dirty, so we have been called
505 * because the recently used resources file has been
506 * changed (and not from us).
508 build_recent_items_list (manager);
511 g_object_thaw_notify (G_OBJECT (manager));
515 gtk_recent_manager_monitor_changed (GFileMonitor *monitor,
518 GFileMonitorEvent event_type,
521 GtkRecentManager *manager = user_data;
525 case G_FILE_MONITOR_EVENT_CHANGED:
526 case G_FILE_MONITOR_EVENT_CREATED:
527 gdk_threads_enter ();
528 gtk_recent_manager_changed (manager);
529 gdk_threads_leave ();
532 case G_FILE_MONITOR_EVENT_DELETED:
541 get_default_filename (void)
543 return g_build_filename (g_get_user_data_dir (),
544 GTK_RECENTLY_USED_FILE,
549 gtk_recent_manager_set_filename (GtkRecentManager *manager,
550 const gchar *filename)
552 GtkRecentManagerPrivate *priv;
556 g_assert (GTK_IS_RECENT_MANAGER (manager));
558 priv = manager->priv;
560 /* if a filename is already set and filename is not NULL, then copy
561 * it and reset the monitor; otherwise, if it's NULL we're being
562 * called from the finalization sequence, so we simply disconnect the
563 * monitoring and return.
565 * if no filename is set and filename is NULL, use the default.
569 g_free (priv->filename);
573 g_signal_handlers_disconnect_by_func (priv->monitor,
574 G_CALLBACK (gtk_recent_manager_monitor_changed),
576 g_object_unref (priv->monitor);
577 priv->monitor = NULL;
580 if (!filename || *filename == '\0')
583 priv->filename = g_strdup (filename);
587 if (!filename || *filename == '\0')
588 priv->filename = get_default_filename ();
590 priv->filename = g_strdup (filename);
593 g_assert (priv->filename != NULL);
594 file = g_file_new_for_path (priv->filename);
597 priv->monitor = g_file_monitor_file (file, G_FILE_MONITOR_NONE, NULL, &error);
600 filename_warning ("Unable to monitor `%s': %s\n"
601 "The GtkRecentManager will not update its contents "
602 "if the file is changed from other instances",
605 g_error_free (error);
608 g_signal_connect (priv->monitor, "changed",
609 G_CALLBACK (gtk_recent_manager_monitor_changed),
612 g_object_unref (file);
614 priv->is_dirty = FALSE;
615 build_recent_items_list (manager);
618 /* reads the recently used resources file and builds the items list.
619 * we keep the items list inside the parser object, and build the
620 * RecentInfo object only on user's demand to avoid useless replication.
621 * this function resets the dirty bit of the manager.
624 build_recent_items_list (GtkRecentManager *manager)
626 GtkRecentManagerPrivate *priv = manager->priv;
630 g_assert (priv->filename != NULL);
632 if (!priv->recent_items)
634 priv->recent_items = g_bookmark_file_new ();
638 /* the file exists, and it's valid (we hope); if not, destroy the container
639 * object and hope for a better result when the next "changed" signal is
642 g_bookmark_file_load_from_file (priv->recent_items, priv->filename, &read_error);
645 /* if the file does not exist we just wait for the first write
646 * operation on this recent manager instance, to avoid creating
647 * empty files and leading to spurious file system events (Sabayon
648 * will not be happy about those)
650 if (read_error->domain == G_FILE_ERROR &&
651 read_error->code != G_FILE_ERROR_NOENT)
652 filename_warning ("Attempting to read the recently used resources "
653 "file at `%s', but the parser failed: %s.",
655 read_error->message);
657 g_bookmark_file_free (priv->recent_items);
658 priv->recent_items = NULL;
660 g_error_free (read_error);
664 size = g_bookmark_file_get_size (priv->recent_items);
665 if (priv->size != size)
669 g_object_notify (G_OBJECT (manager), "size");
673 priv->is_dirty = FALSE;
677 /********************
679 ********************/
683 * gtk_recent_manager_new:
685 * Creates a new recent manager object. Recent manager objects are used to
686 * handle the list of recently used resources. A #GtkRecentManager object
687 * monitors the recently used resources list, and emits the "changed" signal
688 * each time something inside the list changes.
690 * #GtkRecentManager objects are expensive: be sure to create them only when
691 * needed. You should use gtk_recent_manager_get_default() instead.
693 * Return value: A newly created #GtkRecentManager object.
698 gtk_recent_manager_new (void)
700 return g_object_new (GTK_TYPE_RECENT_MANAGER, NULL);
704 * gtk_recent_manager_get_default:
706 * Gets a unique instance of #GtkRecentManager, that you can share
707 * in your application without caring about memory management.
709 * Return value: (transfer none): A unique #GtkRecentManager. Do not ref or unref it.
714 gtk_recent_manager_get_default (void)
716 if (G_UNLIKELY (!recent_manager_singleton))
717 recent_manager_singleton = gtk_recent_manager_new ();
719 return recent_manager_singleton;
724 gtk_recent_manager_add_item_query_info (GObject *source_object,
728 GFile *file = G_FILE (source_object);
729 GtkRecentManager *manager = user_data;
730 GtkRecentData recent_data;
731 GFileInfo *file_info;
734 uri = g_file_get_uri (file);
736 file_info = g_file_query_info_finish (file, res, NULL); /* NULL-GError */
738 recent_data.display_name = NULL;
739 recent_data.description = NULL;
745 content_type = g_file_info_get_attribute_as_string (file_info, G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE);
747 if (G_LIKELY (content_type))
748 recent_data.mime_type = g_content_type_get_mime_type (content_type);
750 recent_data.mime_type = g_strdup (GTK_RECENT_DEFAULT_MIME);
752 g_free (content_type);
753 g_object_unref (file_info);
756 recent_data.mime_type = g_content_type_guess (g_file_get_basename (file), NULL, 0, NULL);
758 recent_data.app_name = g_strdup (g_get_application_name ());
759 recent_data.app_exec = g_strjoin (" ", g_get_prgname (), "%u", NULL);
760 recent_data.groups = NULL;
761 recent_data.is_private = FALSE;
763 gdk_threads_enter ();
765 /* Ignore return value, this can't fail anyway since all required
767 gtk_recent_manager_add_full (manager, uri, &recent_data);
769 manager->priv->is_dirty = TRUE;
770 gtk_recent_manager_changed (manager);
772 gdk_threads_leave ();
774 g_free (recent_data.mime_type);
775 g_free (recent_data.app_name);
776 g_free (recent_data.app_exec);
778 g_object_unref (manager);
783 * gtk_recent_manager_add_item:
784 * @manager: a #GtkRecentManager
787 * Adds a new resource, pointed by @uri, into the recently used
790 * This function automatically retrieves some of the needed
791 * metadata and setting other metadata to common default values; it
792 * then feeds the data to gtk_recent_manager_add_full().
794 * See gtk_recent_manager_add_full() if you want to explicitly
795 * define the metadata for the resource pointed by @uri.
797 * Return value: %TRUE if the new item was successfully added
798 * to the recently used resources list
803 gtk_recent_manager_add_item (GtkRecentManager *manager,
808 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
809 g_return_val_if_fail (uri != NULL, FALSE);
811 file = g_file_new_for_uri (uri);
813 g_file_query_info_async (file,
814 G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE,
816 G_FILE_QUERY_INFO_NONE,
818 gtk_recent_manager_add_item_query_info,
819 g_object_ref (manager));
821 g_object_unref (file);
827 * gtk_recent_manager_add_full:
828 * @manager: a #GtkRecentManager
830 * @recent_data: metadata of the resource
832 * Adds a new resource, pointed by @uri, into the recently used
833 * resources list, using the metadata specified inside the #GtkRecentData
834 * structure passed in @recent_data.
836 * The passed URI will be used to identify this resource inside the
839 * In order to register the new recently used resource, metadata about
840 * the resource must be passed as well as the URI; the metadata is
841 * stored in a #GtkRecentData structure, which must contain the MIME
842 * type of the resource pointed by the URI; the name of the application
843 * that is registering the item, and a command line to be used when
844 * launching the item.
846 * Optionally, a #GtkRecentData structure might contain a UTF-8 string
847 * to be used when viewing the item instead of the last component of the
848 * URI; a short description of the item; whether the item should be
849 * considered private - that is, should be displayed only by the
850 * applications that have registered it.
852 * Return value: %TRUE if the new item was successfully added to the
853 * recently used resources list, %FALSE otherwise.
858 gtk_recent_manager_add_full (GtkRecentManager *manager,
860 const GtkRecentData *data)
862 GtkRecentManagerPrivate *priv;
864 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
865 g_return_val_if_fail (uri != NULL, FALSE);
866 g_return_val_if_fail (data != NULL, FALSE);
869 if ((data->display_name) &&
870 (!g_utf8_validate (data->display_name, -1, NULL)))
872 g_warning ("Attempting to add `%s' to the list of recently used "
873 "resources, but the display name is not a valid UTF-8 "
879 if ((data->description) &&
880 (!g_utf8_validate (data->description, -1, NULL)))
882 g_warning ("Attempting to add `%s' to the list of recently used "
883 "resources, but the description is not a valid UTF-8 "
890 if (!data->mime_type)
892 g_warning ("Attempting to add `%s' to the list of recently used "
893 "resources, but not MIME type was defined",
900 g_warning ("Attempting to add `%s' to the list of recently used "
901 "resources, but no name of the application that is "
902 "registering it was defined",
909 g_warning ("Attempting to add `%s' to the list of recently used "
910 "resources, but no command line for the application "
911 "that is registering it was defined",
916 priv = manager->priv;
918 if (!priv->recent_items)
920 priv->recent_items = g_bookmark_file_new ();
924 if (data->display_name)
925 g_bookmark_file_set_title (priv->recent_items, uri, data->display_name);
927 if (data->description)
928 g_bookmark_file_set_description (priv->recent_items, uri, data->description);
930 g_bookmark_file_set_mime_type (priv->recent_items, uri, data->mime_type);
932 if (data->groups && data->groups[0] != '\0')
936 for (j = 0; (data->groups)[j] != NULL; j++)
937 g_bookmark_file_add_group (priv->recent_items, uri, (data->groups)[j]);
940 /* register the application; this will take care of updating the
941 * registration count and time in case the application has
942 * already registered the same document inside the list
944 g_bookmark_file_add_application (priv->recent_items, uri,
948 g_bookmark_file_set_is_private (priv->recent_items, uri,
951 /* mark us as dirty, so that when emitting the "changed" signal we
952 * will dump our changes
954 priv->is_dirty = TRUE;
955 gtk_recent_manager_changed (manager);
961 * gtk_recent_manager_remove_item:
962 * @manager: a #GtkRecentManager
963 * @uri: the URI of the item you wish to remove
964 * @error: (allow-none): return location for a #GError, or %NULL
966 * Removes a resource pointed by @uri from the recently used resources
967 * list handled by a recent manager.
969 * Return value: %TRUE if the item pointed by @uri has been successfully
970 * removed by the recently used resources list, and %FALSE otherwise.
975 gtk_recent_manager_remove_item (GtkRecentManager *manager,
979 GtkRecentManagerPrivate *priv;
980 GError *remove_error = NULL;
982 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
983 g_return_val_if_fail (uri != NULL, FALSE);
984 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
986 priv = manager->priv;
988 if (!priv->recent_items)
990 priv->recent_items = g_bookmark_file_new ();
993 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
994 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
995 _("Unable to find an item with URI '%s'"),
1001 g_bookmark_file_remove_item (priv->recent_items, uri, &remove_error);
1004 g_error_free (remove_error);
1006 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1007 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1008 _("Unable to find an item with URI '%s'"),
1014 priv->is_dirty = TRUE;
1015 gtk_recent_manager_changed (manager);
1021 * gtk_recent_manager_has_item:
1022 * @manager: a #GtkRecentManager
1025 * Checks whether there is a recently used resource registered
1026 * with @uri inside the recent manager.
1028 * Return value: %TRUE if the resource was found, %FALSE otherwise.
1033 gtk_recent_manager_has_item (GtkRecentManager *manager,
1036 GtkRecentManagerPrivate *priv;
1038 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
1039 g_return_val_if_fail (uri != NULL, FALSE);
1041 priv = manager->priv;
1042 g_return_val_if_fail (priv->recent_items != NULL, FALSE);
1044 return g_bookmark_file_has_item (priv->recent_items, uri);
1048 build_recent_info (GBookmarkFile *bookmarks,
1049 GtkRecentInfo *info)
1051 gchar **apps, **groups;
1052 gsize apps_len, groups_len, i;
1054 g_assert (bookmarks != NULL);
1055 g_assert (info != NULL);
1057 info->display_name = g_bookmark_file_get_title (bookmarks, info->uri, NULL);
1058 info->description = g_bookmark_file_get_description (bookmarks, info->uri, NULL);
1059 info->mime_type = g_bookmark_file_get_mime_type (bookmarks, info->uri, NULL);
1061 info->is_private = g_bookmark_file_get_is_private (bookmarks, info->uri, NULL);
1063 info->added = g_bookmark_file_get_added (bookmarks, info->uri, NULL);
1064 info->modified = g_bookmark_file_get_modified (bookmarks, info->uri, NULL);
1065 info->visited = g_bookmark_file_get_visited (bookmarks, info->uri, NULL);
1067 groups = g_bookmark_file_get_groups (bookmarks, info->uri, &groups_len, NULL);
1068 for (i = 0; i < groups_len; i++)
1070 gchar *group_name = g_strdup (groups[i]);
1072 info->groups = g_slist_append (info->groups, group_name);
1075 g_strfreev (groups);
1077 apps = g_bookmark_file_get_applications (bookmarks, info->uri, &apps_len, NULL);
1078 for (i = 0; i < apps_len; i++)
1080 gchar *app_name, *app_exec;
1083 RecentAppInfo *app_info;
1088 res = g_bookmark_file_get_app_info (bookmarks, info->uri, app_name,
1096 app_info = recent_app_info_new (app_name);
1097 app_info->exec = app_exec;
1098 app_info->count = count;
1099 app_info->stamp = stamp;
1101 info->applications = g_slist_prepend (info->applications, app_info);
1102 g_hash_table_replace (info->apps_lookup, app_info->name, app_info);
1109 * gtk_recent_manager_lookup_item:
1110 * @manager: a #GtkRecentManager
1112 * @error: (allow-none): a return location for a #GError, or %NULL
1114 * Searches for a URI inside the recently used resources list, and
1115 * returns a structure containing informations about the resource
1116 * like its MIME type, or its display name.
1118 * Return value: a #GtkRecentInfo structure containing information
1119 * about the resource pointed by @uri, or %NULL if the URI was
1120 * not registered in the recently used resources list. Free with
1121 * gtk_recent_info_unref().
1126 gtk_recent_manager_lookup_item (GtkRecentManager *manager,
1130 GtkRecentManagerPrivate *priv;
1131 GtkRecentInfo *info = NULL;
1133 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1134 g_return_val_if_fail (uri != NULL, NULL);
1135 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1137 priv = manager->priv;
1138 if (!priv->recent_items)
1140 priv->recent_items = g_bookmark_file_new ();
1143 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1144 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1145 _("Unable to find an item with URI '%s'"),
1151 if (!g_bookmark_file_has_item (priv->recent_items, uri))
1153 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1154 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1155 _("Unable to find an item with URI '%s'"),
1160 info = gtk_recent_info_new (uri);
1161 g_return_val_if_fail (info != NULL, NULL);
1163 /* fill the RecentInfo structure with the data retrieved by our
1164 * parser object from the storage file
1166 build_recent_info (priv->recent_items, info);
1172 * gtk_recent_manager_move_item:
1173 * @manager: a #GtkRecentManager
1174 * @uri: the URI of a recently used resource
1175 * @new_uri: (allow-none): the new URI of the recently used resource, or %NULL to
1176 * remove the item pointed by @uri in the list
1177 * @error: (allow-none): a return location for a #GError, or %NULL
1179 * Changes the location of a recently used resource from @uri to @new_uri.
1181 * Please note that this function will not affect the resource pointed
1182 * by the URIs, but only the URI used in the recently used resources list.
1184 * Return value: %TRUE on success.
1189 gtk_recent_manager_move_item (GtkRecentManager *recent_manager,
1191 const gchar *new_uri,
1194 GtkRecentManagerPrivate *priv;
1197 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (recent_manager), FALSE);
1198 g_return_val_if_fail (uri != NULL, FALSE);
1199 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1201 priv = recent_manager->priv;
1203 if (!priv->recent_items)
1205 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1206 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1207 _("Unable to find an item with URI '%s'"),
1212 if (!g_bookmark_file_has_item (priv->recent_items, uri))
1214 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1215 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1216 _("Unable to find an item with URI '%s'"),
1222 if (!g_bookmark_file_move_item (priv->recent_items,
1227 g_error_free (move_error);
1229 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1230 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1231 _("Unable to find an item with URI '%s'"),
1236 priv->is_dirty = TRUE;
1237 gtk_recent_manager_changed (recent_manager);
1243 * gtk_recent_manager_get_items:
1244 * @manager: a #GtkRecentManager
1246 * Gets the list of recently used resources.
1248 * Return value: (element-type GtkRecentInfo) (transfer full): a list of
1249 * newly allocated #GtkRecentInfo objects. Use
1250 * gtk_recent_info_unref() on each item inside the list, and then
1251 * free the list itself using g_list_free().
1256 gtk_recent_manager_get_items (GtkRecentManager *manager)
1258 GtkRecentManagerPrivate *priv;
1259 GList *retval = NULL;
1263 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1265 priv = manager->priv;
1266 if (!priv->recent_items)
1269 uris = g_bookmark_file_get_uris (priv->recent_items, &uris_len);
1270 for (i = 0; i < uris_len; i++)
1272 GtkRecentInfo *info;
1274 info = gtk_recent_info_new (uris[i]);
1275 build_recent_info (priv->recent_items, info);
1277 retval = g_list_prepend (retval, info);
1286 purge_recent_items_list (GtkRecentManager *manager,
1289 GtkRecentManagerPrivate *priv = manager->priv;
1291 if (priv->recent_items == NULL)
1294 g_bookmark_file_free (priv->recent_items);
1295 priv->recent_items = g_bookmark_file_new ();
1298 /* emit the changed signal, to ensure that the purge is written */
1299 priv->is_dirty = TRUE;
1300 gtk_recent_manager_changed (manager);
1304 * gtk_recent_manager_purge_items:
1305 * @manager: a #GtkRecentManager
1306 * @error: (allow-none): a return location for a #GError, or %NULL
1308 * Purges every item from the recently used resources list.
1310 * Return value: the number of items that have been removed from the
1311 * recently used resources list.
1316 gtk_recent_manager_purge_items (GtkRecentManager *manager,
1319 GtkRecentManagerPrivate *priv;
1322 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), -1);
1324 priv = manager->priv;
1325 if (!priv->recent_items)
1328 count = g_bookmark_file_get_size (priv->recent_items);
1332 purge_recent_items_list (manager, error);
1334 purged = count - g_bookmark_file_get_size (priv->recent_items);
1340 emit_manager_changed (gpointer data)
1342 GtkRecentManager *manager = data;
1344 manager->priv->changed_age = 0;
1345 manager->priv->changed_timeout = 0;
1347 g_signal_emit (manager, signal_changed, 0);
1353 gtk_recent_manager_changed (GtkRecentManager *manager)
1355 /* coalesce consecutive changes
1357 * we schedule a write in 250 msecs immediately; if we get more than one
1358 * request per millisecond before the timeout has a chance to run, we
1359 * schedule an emission immediately.
1361 if (manager->priv->changed_timeout == 0)
1362 manager->priv->changed_timeout = gdk_threads_add_timeout (250, emit_manager_changed, manager);
1365 manager->priv->changed_age += 1;
1367 if (manager->priv->changed_age > 250)
1369 g_source_remove (manager->priv->changed_timeout);
1370 g_signal_emit (manager, signal_changed, 0);
1372 manager->priv->changed_age = 0;
1373 manager->priv->changed_timeout = 0;
1379 gtk_recent_manager_clamp_to_age (GtkRecentManager *manager,
1382 GtkRecentManagerPrivate *priv = manager->priv;
1387 if (G_UNLIKELY (!priv->recent_items))
1392 uris = g_bookmark_file_get_uris (priv->recent_items, &n_uris);
1394 for (i = 0; i < n_uris; i++)
1396 const gchar *uri = uris[i];
1400 modified = g_bookmark_file_get_modified (priv->recent_items, uri, NULL);
1401 item_age = (gint) ((now - modified) / (60 * 60 * 24));
1403 g_bookmark_file_remove_item (priv->recent_items, uri, NULL);
1413 G_DEFINE_BOXED_TYPE (GtkRecentInfo, gtk_recent_info,
1414 gtk_recent_info_ref,
1415 gtk_recent_info_unref)
1417 static GtkRecentInfo *
1418 gtk_recent_info_new (const gchar *uri)
1420 GtkRecentInfo *info;
1422 g_assert (uri != NULL);
1424 info = g_new0 (GtkRecentInfo, 1);
1425 info->uri = g_strdup (uri);
1427 info->applications = NULL;
1428 info->apps_lookup = g_hash_table_new (g_str_hash, g_str_equal);
1430 info->groups = NULL;
1432 info->ref_count = 1;
1438 gtk_recent_info_free (GtkRecentInfo *recent_info)
1443 g_free (recent_info->uri);
1444 g_free (recent_info->display_name);
1445 g_free (recent_info->description);
1446 g_free (recent_info->mime_type);
1448 if (recent_info->applications)
1450 g_slist_foreach (recent_info->applications,
1451 (GFunc) recent_app_info_free,
1453 g_slist_free (recent_info->applications);
1455 recent_info->applications = NULL;
1458 if (recent_info->apps_lookup)
1459 g_hash_table_destroy (recent_info->apps_lookup);
1461 if (recent_info->groups)
1463 g_slist_foreach (recent_info->groups,
1466 g_slist_free (recent_info->groups);
1468 recent_info->groups = NULL;
1471 if (recent_info->icon)
1472 g_object_unref (recent_info->icon);
1474 g_free (recent_info);
1478 * gtk_recent_info_ref:
1479 * @info: a #GtkRecentInfo
1481 * Increases the reference count of @recent_info by one.
1483 * Return value: the recent info object with its reference count increased
1489 gtk_recent_info_ref (GtkRecentInfo *info)
1491 g_return_val_if_fail (info != NULL, NULL);
1492 g_return_val_if_fail (info->ref_count > 0, NULL);
1494 info->ref_count += 1;
1500 * gtk_recent_info_unref:
1501 * @info: a #GtkRecentInfo
1503 * Decreases the reference count of @info by one. If the reference
1504 * count reaches zero, @info is deallocated, and the memory freed.
1509 gtk_recent_info_unref (GtkRecentInfo *info)
1511 g_return_if_fail (info != NULL);
1512 g_return_if_fail (info->ref_count > 0);
1514 info->ref_count -= 1;
1516 if (info->ref_count == 0)
1517 gtk_recent_info_free (info);
1521 * gtk_recent_info_get_uri:
1522 * @info: a #GtkRecentInfo
1524 * Gets the URI of the resource.
1526 * Return value: the URI of the resource. The returned string is
1527 * owned by the recent manager, and should not be freed.
1532 gtk_recent_info_get_uri (GtkRecentInfo *info)
1534 g_return_val_if_fail (info != NULL, NULL);
1540 * gtk_recent_info_get_display_name:
1541 * @info: a #GtkRecentInfo
1543 * Gets the name of the resource. If none has been defined, the basename
1544 * of the resource is obtained.
1546 * Return value: the display name of the resource. The returned string
1547 * is owned by the recent manager, and should not be freed.
1552 gtk_recent_info_get_display_name (GtkRecentInfo *info)
1554 g_return_val_if_fail (info != NULL, NULL);
1556 if (!info->display_name)
1557 info->display_name = gtk_recent_info_get_short_name (info);
1559 return info->display_name;
1563 * gtk_recent_info_get_description:
1564 * @info: a #GtkRecentInfo
1566 * Gets the (short) description of the resource.
1568 * Return value: the description of the resource. The returned string
1569 * is owned by the recent manager, and should not be freed.
1574 gtk_recent_info_get_description (GtkRecentInfo *info)
1576 g_return_val_if_fail (info != NULL, NULL);
1578 return info->description;
1582 * gtk_recent_info_get_mime_type:
1583 * @info: a #GtkRecentInfo
1585 * Gets the MIME type of the resource.
1587 * Return value: the MIME type of the resource. The returned string
1588 * is owned by the recent manager, and should not be freed.
1593 gtk_recent_info_get_mime_type (GtkRecentInfo *info)
1595 g_return_val_if_fail (info != NULL, NULL);
1597 if (!info->mime_type)
1598 info->mime_type = g_strdup (GTK_RECENT_DEFAULT_MIME);
1600 return info->mime_type;
1604 * gtk_recent_info_get_added:
1605 * @info: a #GtkRecentInfo
1607 * Gets the timestamp (seconds from system's Epoch) when the resource
1608 * was added to the recently used resources list.
1610 * Return value: the number of seconds elapsed from system's Epoch when
1611 * the resource was added to the list, or -1 on failure.
1616 gtk_recent_info_get_added (GtkRecentInfo *info)
1618 g_return_val_if_fail (info != NULL, (time_t) -1);
1624 * gtk_recent_info_get_modified:
1625 * @info: a #GtkRecentInfo
1627 * Gets the timestamp (seconds from system's Epoch) when the resource
1628 * was last modified.
1630 * Return value: the number of seconds elapsed from system's Epoch when
1631 * the resource was last modified, or -1 on failure.
1636 gtk_recent_info_get_modified (GtkRecentInfo *info)
1638 g_return_val_if_fail (info != NULL, (time_t) -1);
1640 return info->modified;
1644 * gtk_recent_info_get_visited:
1645 * @info: a #GtkRecentInfo
1647 * Gets the timestamp (seconds from system's Epoch) when the resource
1650 * Return value: the number of seconds elapsed from system's Epoch when
1651 * the resource was last visited, or -1 on failure.
1656 gtk_recent_info_get_visited (GtkRecentInfo *info)
1658 g_return_val_if_fail (info != NULL, (time_t) -1);
1660 return info->visited;
1664 * gtk_recent_info_get_private_hint:
1665 * @info: a #GtkRecentInfo
1667 * Gets the value of the "private" flag. Resources in the recently used
1668 * list that have this flag set to %TRUE should only be displayed by the
1669 * applications that have registered them.
1671 * Return value: %TRUE if the private flag was found, %FALSE otherwise.
1676 gtk_recent_info_get_private_hint (GtkRecentInfo *info)
1678 g_return_val_if_fail (info != NULL, FALSE);
1680 return info->is_private;
1684 static RecentAppInfo *
1685 recent_app_info_new (const gchar *app_name)
1687 RecentAppInfo *app_info;
1689 g_assert (app_name != NULL);
1691 app_info = g_slice_new0 (RecentAppInfo);
1692 app_info->name = g_strdup (app_name);
1693 app_info->exec = NULL;
1694 app_info->count = 1;
1695 app_info->stamp = 0;
1701 recent_app_info_free (RecentAppInfo *app_info)
1706 g_free (app_info->name);
1707 g_free (app_info->exec);
1709 g_slice_free (RecentAppInfo, app_info);
1713 * gtk_recent_info_get_application_info:
1714 * @info: a #GtkRecentInfo
1715 * @app_name: the name of the application that has registered this item
1716 * @app_exec: (transfer none) (out): return location for the string containing the command line
1717 * @count: (out): return location for the number of times this item was registered
1718 * @time_: (out): return location for the timestamp this item was last registered
1719 * for this application
1721 * Gets the data regarding the application that has registered the resource
1724 * If the command line contains any escape characters defined inside the
1725 * storage specification, they will be expanded.
1727 * Return value: %TRUE if an application with @app_name has registered this
1728 * resource inside the recently used list, or %FALSE otherwise. The
1729 * @app_exec string is owned by the #GtkRecentInfo and should not be
1735 gtk_recent_info_get_application_info (GtkRecentInfo *info,
1736 const gchar *app_name,
1737 const gchar **app_exec,
1743 g_return_val_if_fail (info != NULL, FALSE);
1744 g_return_val_if_fail (app_name != NULL, FALSE);
1746 ai = (RecentAppInfo *) g_hash_table_lookup (info->apps_lookup,
1750 g_warning ("No registered application with name '%s' "
1751 "for item with URI '%s' found",
1758 *app_exec = ai->exec;
1770 * gtk_recent_info_get_applications:
1771 * @info: a #GtkRecentInfo
1772 * @length: (out) (allow-none): return location for the length of the returned list
1774 * Retrieves the list of applications that have registered this resource.
1776 * Return value: (array length=length zero-terminated=1) (transfer full):
1777 * a newly allocated %NULL-terminated array of strings.
1778 * Use g_strfreev() to free it.
1783 gtk_recent_info_get_applications (GtkRecentInfo *info,
1790 g_return_val_if_fail (info != NULL, NULL);
1792 if (!info->applications)
1800 n_apps = g_slist_length (info->applications);
1802 retval = g_new0 (gchar *, n_apps + 1);
1804 for (l = info->applications, i = 0;
1808 RecentAppInfo *ai = (RecentAppInfo *) l->data;
1810 g_assert (ai != NULL);
1812 retval[i++] = g_strdup (ai->name);
1823 * gtk_recent_info_has_application:
1824 * @info: a #GtkRecentInfo
1825 * @app_name: a string containing an application name
1827 * Checks whether an application registered this resource using @app_name.
1829 * Return value: %TRUE if an application with name @app_name was found,
1835 gtk_recent_info_has_application (GtkRecentInfo *info,
1836 const gchar *app_name)
1838 g_return_val_if_fail (info != NULL, FALSE);
1839 g_return_val_if_fail (app_name != NULL, FALSE);
1841 return (NULL != g_hash_table_lookup (info->apps_lookup, app_name));
1845 * gtk_recent_info_last_application:
1846 * @info: a #GtkRecentInfo
1848 * Gets the name of the last application that have registered the
1849 * recently used resource represented by @info.
1851 * Return value: an application name. Use g_free() to free it.
1856 gtk_recent_info_last_application (GtkRecentInfo *info)
1859 time_t last_stamp = (time_t) -1;
1862 g_return_val_if_fail (info != NULL, NULL);
1864 for (l = info->applications; l != NULL; l = l->next)
1866 RecentAppInfo *ai = (RecentAppInfo *) l->data;
1868 if (ai->stamp > last_stamp)
1871 last_stamp = ai->stamp;
1875 return g_strdup (name);
1879 get_icon_for_mime_type (const char *mime_type,
1882 GtkIconTheme *icon_theme;
1888 icon_theme = gtk_icon_theme_get_default ();
1890 content_type = g_content_type_from_mime_type (mime_type);
1895 icon = g_content_type_get_icon (content_type);
1896 info = gtk_icon_theme_lookup_by_gicon (icon_theme,
1899 GTK_ICON_LOOKUP_USE_BUILTIN);
1900 g_free (content_type);
1901 g_object_unref (icon);
1906 pixbuf = gtk_icon_info_load_icon (info, NULL);
1907 gtk_icon_info_free (info);
1913 get_icon_fallback (const gchar *icon_name,
1916 GtkIconTheme *icon_theme;
1919 icon_theme = gtk_icon_theme_get_default ();
1921 retval = gtk_icon_theme_load_icon (icon_theme, icon_name,
1923 GTK_ICON_LOOKUP_USE_BUILTIN,
1925 g_assert (retval != NULL);
1931 * gtk_recent_info_get_icon:
1932 * @info: a #GtkRecentInfo
1933 * @size: the size of the icon in pixels
1935 * Retrieves the icon of size @size associated to the resource MIME type.
1937 * Return value: (transfer full): a #GdkPixbuf containing the icon,
1938 * or %NULL. Use g_object_unref() when finished using the icon.
1943 gtk_recent_info_get_icon (GtkRecentInfo *info,
1946 GdkPixbuf *retval = NULL;
1948 g_return_val_if_fail (info != NULL, NULL);
1950 if (info->mime_type)
1951 retval = get_icon_for_mime_type (info->mime_type, size);
1953 /* this function should never fail */
1956 if (info->mime_type &&
1957 strcmp (info->mime_type, "x-directory/normal") == 0)
1958 retval = get_icon_fallback ("folder", size);
1960 retval = get_icon_fallback ("text-x-generic", size);
1967 * gtk_recent_info_get_gicon:
1968 * @info: a #GtkRecentInfo
1970 * Retrieves the icon associated to the resource MIME type.
1972 * Return value: (transfer full): a #GIcon containing the icon, or %NULL. Use
1973 * g_object_unref() when finished using the icon
1978 gtk_recent_info_get_gicon (GtkRecentInfo *info)
1981 gchar *content_type;
1983 g_return_val_if_fail (info != NULL, NULL);
1985 if (info->mime_type != NULL &&
1986 (content_type = g_content_type_from_mime_type (info->mime_type)) != NULL)
1988 icon = g_content_type_get_icon (content_type);
1989 g_free (content_type);
1996 * gtk_recent_info_is_local:
1997 * @info: a #GtkRecentInfo
1999 * Checks whether the resource is local or not by looking at the
2000 * scheme of its URI.
2002 * Return value: %TRUE if the resource is local.
2007 gtk_recent_info_is_local (GtkRecentInfo *info)
2009 g_return_val_if_fail (info != NULL, FALSE);
2011 return has_case_prefix (info->uri, "file:/");
2015 * gtk_recent_info_exists:
2016 * @info: a #GtkRecentInfo
2018 * Checks whether the resource pointed by @info still exists. At
2019 * the moment this check is done only on resources pointing to local files.
2021 * Return value: %TRUE if the resource exists
2026 gtk_recent_info_exists (GtkRecentInfo *info)
2030 gboolean retval = FALSE;
2032 g_return_val_if_fail (info != NULL, FALSE);
2034 /* we guarantee only local resources */
2035 if (!gtk_recent_info_is_local (info))
2038 filename = g_filename_from_uri (info->uri, NULL, NULL);
2041 if (g_stat (filename, &stat_buf) == 0)
2051 * gtk_recent_info_match:
2052 * @info_a: a #GtkRecentInfo
2053 * @info_b: a #GtkRecentInfo
2055 * Checks whether two #GtkRecentInfo structures point to the same
2058 * Return value: %TRUE if both #GtkRecentInfo structures point to se same
2059 * resource, %FALSE otherwise.
2064 gtk_recent_info_match (GtkRecentInfo *info_a,
2065 GtkRecentInfo *info_b)
2067 g_return_val_if_fail (info_a != NULL, FALSE);
2068 g_return_val_if_fail (info_b != NULL, FALSE);
2070 return (0 == strcmp (info_a->uri, info_b->uri));
2073 /* taken from gnome-vfs-uri.c */
2074 static const gchar *
2075 get_method_string (const gchar *substring,
2076 gchar **method_string)
2082 g_ascii_isalnum (*p) || *p == '+' || *p == '-' || *p == '.';
2089 !(p == substring + 1 && g_ascii_isalpha (*substring))
2093 /* Found toplevel method specification. */
2094 method = g_strndup (substring, p - substring);
2095 *method_string = g_ascii_strdown (method, -1);
2101 *method_string = g_strdup ("file");
2108 /* Stolen from gnome_vfs_make_valid_utf8() */
2110 make_valid_utf8 (const char *name)
2113 const char *remainder, *invalid;
2114 int remaining_bytes, valid_bytes;
2118 remaining_bytes = name ? strlen (name) : 0;
2120 while (remaining_bytes != 0)
2122 if (g_utf8_validate (remainder, remaining_bytes, &invalid))
2125 valid_bytes = invalid - remainder;
2128 string = g_string_sized_new (remaining_bytes);
2130 g_string_append_len (string, remainder, valid_bytes);
2131 g_string_append_c (string, '?');
2133 remaining_bytes -= valid_bytes + 1;
2134 remainder = invalid + 1;
2138 return g_strdup (name);
2140 g_string_append (string, remainder);
2141 g_assert (g_utf8_validate (string->str, -1, NULL));
2143 return g_string_free (string, FALSE);
2147 get_uri_shortname_for_display (const gchar *uri)
2150 gboolean validated = FALSE;
2152 if (has_case_prefix (uri, "file:/"))
2156 local_file = g_filename_from_uri (uri, NULL, NULL);
2160 name = g_filename_display_basename (local_file);
2164 g_free (local_file);
2173 rest = get_method_string (uri, &method);
2174 local_file = g_filename_display_basename (rest);
2176 name = g_strconcat (method, ": ", local_file, NULL);
2178 g_free (local_file);
2182 g_assert (name != NULL);
2184 if (!validated && !g_utf8_validate (name, -1, NULL))
2188 utf8_name = make_valid_utf8 (name);
2198 * gtk_recent_info_get_short_name:
2199 * @info: an #GtkRecentInfo
2201 * Computes a valid UTF-8 string that can be used as the name of the item in a
2202 * menu or list. For example, calling this function on an item that refers to
2203 * "file:///foo/bar.txt" will yield "bar.txt".
2205 * Return value: A newly-allocated string in UTF-8 encoding; free it with
2211 gtk_recent_info_get_short_name (GtkRecentInfo *info)
2215 g_return_val_if_fail (info != NULL, NULL);
2217 if (info->uri == NULL)
2220 short_name = get_uri_shortname_for_display (info->uri);
2226 * gtk_recent_info_get_uri_display:
2227 * @info: a #GtkRecentInfo
2229 * Gets a displayable version of the resource's URI. If the resource
2230 * is local, it returns a local path; if the resource is not local,
2231 * it returns the UTF-8 encoded content of gtk_recent_info_get_uri().
2233 * Return value: a newly allocated UTF-8 string containing the
2234 * resource's URI or %NULL. Use g_free() when done using it.
2239 gtk_recent_info_get_uri_display (GtkRecentInfo *info)
2243 g_return_val_if_fail (info != NULL, NULL);
2246 if (gtk_recent_info_is_local (info))
2250 filename = g_filename_from_uri (info->uri, NULL, NULL);
2254 retval = g_filename_to_utf8 (filename, -1, NULL, NULL, NULL);
2259 retval = make_valid_utf8 (info->uri);
2266 * gtk_recent_info_get_age:
2267 * @info: a #GtkRecentInfo
2269 * Gets the number of days elapsed since the last update of the resource
2272 * Return value: a positive integer containing the number of days elapsed
2273 * since the time this resource was last modified.
2278 gtk_recent_info_get_age (GtkRecentInfo *info)
2283 g_return_val_if_fail (info != NULL, -1);
2287 delta = now - info->modified;
2289 retval = (gint) (delta / (60 * 60 * 24));
2295 * gtk_recent_info_get_groups:
2296 * @info: a #GtkRecentInfo
2297 * @length: (out) (allow-none): return location for the number of groups returned
2299 * Returns all groups registered for the recently used item @info. The
2300 * array of returned group names will be %NULL terminated, so length might
2301 * optionally be %NULL.
2303 * Return value: (array length=length zero-terminated=1) (transfer full):
2304 * a newly allocated %NULL terminated array of strings.
2305 * Use g_strfreev() to free it.
2310 gtk_recent_info_get_groups (GtkRecentInfo *info,
2317 g_return_val_if_fail (info != NULL, NULL);
2327 n_groups = g_slist_length (info->groups);
2329 retval = g_new0 (gchar *, n_groups + 1);
2331 for (l = info->groups, i = 0;
2335 gchar *group_name = (gchar *) l->data;
2337 g_assert (group_name != NULL);
2339 retval[i++] = g_strdup (group_name);
2350 * gtk_recent_info_has_group:
2351 * @info: a #GtkRecentInfo
2352 * @group_name: name of a group
2354 * Checks whether @group_name appears inside the groups registered for the
2355 * recently used item @info.
2357 * Return value: %TRUE if the group was found.
2362 gtk_recent_info_has_group (GtkRecentInfo *info,
2363 const gchar *group_name)
2367 g_return_val_if_fail (info != NULL, FALSE);
2368 g_return_val_if_fail (group_name != NULL, FALSE);
2373 for (l = info->groups; l != NULL; l = l->next)
2375 gchar *g = (gchar *) l->data;
2377 if (strcmp (g, group_name) == 0)
2385 * gtk_recent_info_create_app_info:
2386 * @info: a #GtkRecentInfo
2387 * @app_name: (allow-none): the name of the application that should
2388 * be mapped to a #GAppInfo; if %NULL is used then the default
2389 * application for the MIME type is used
2390 * @error: (allow-none): return location for a #GError, or %NULL
2392 * Creates a #GAppInfo for the specified #GtkRecentInfo
2394 * Return value: (transfer full): the newly created #GAppInfo, or %NULL.
2395 * In case of error, @error will be set either with a
2396 * %GTK_RECENT_MANAGER_ERROR or a %G_IO_ERROR
2399 gtk_recent_info_create_app_info (GtkRecentInfo *info,
2400 const gchar *app_name,
2405 GError *internal_error = NULL;
2407 g_return_val_if_fail (info != NULL, NULL);
2409 if (app_name == NULL || *app_name == '\0')
2413 if (info->mime_type == NULL)
2416 content_type = g_content_type_from_mime_type (info->mime_type);
2417 if (content_type == NULL)
2420 app_info = g_app_info_get_default_for_type (content_type, TRUE);
2421 g_free (content_type);
2426 ai = g_hash_table_lookup (info->apps_lookup, app_name);
2429 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
2430 GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED,
2431 _("No registered application with name '%s' for item with URI '%s' found"),
2437 internal_error = NULL;
2438 app_info = g_app_info_create_from_commandline (ai->exec, ai->name,
2439 G_APP_INFO_CREATE_NONE,
2441 if (internal_error != NULL)
2443 g_propagate_error (error, internal_error);
2451 * _gtk_recent_manager_sync:
2453 * Private function for synchronising the recent manager singleton.
2456 _gtk_recent_manager_sync (void)
2458 if (recent_manager_singleton)
2460 /* force a dump of the contents of the recent manager singleton */
2461 recent_manager_singleton->priv->is_dirty = TRUE;
2462 gtk_recent_manager_real_changed (recent_manager_singleton);