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,
23 #include <sys/types.h>
32 #include <glib/gstdio.h>
34 #include "gtkrecentmanager.h"
37 #include "gtkicontheme.h"
38 #include "gtktypebuiltins.h"
39 #include "gtkprivate.h"
40 #include "gtkmarshalers.h"
44 #define XDG_PREFIX _gtk_xdg
45 #include "xdgmime/xdgmime.h"
48 /* the file where we store the recently used items */
49 #define GTK_RECENTLY_USED_FILE ".recently-used.xbel"
51 /* a poll per second should be enough */
52 #define POLL_DELTA 1000
54 /* return all items by default */
55 #define DEFAULT_LIMIT -1
57 /* keep in sync with xdgmime */
58 #define GTK_RECENT_DEFAULT_MIME "application/octet-stream"
84 GHashTable *apps_lookup;
95 struct _GtkRecentManagerPrivate
99 guint is_screen_singleton : 1;
101 guint write_in_progress : 1;
102 guint read_in_progress : 1;
109 GBookmarkFile *recent_items;
124 static void gtk_recent_manager_finalize (GObject *object);
126 static void gtk_recent_manager_set_property (GObject *object,
130 static void gtk_recent_manager_get_property (GObject *object,
134 static void gtk_recent_manager_changed (GtkRecentManager *manager);
136 static void gtk_recent_manager_real_changed (GtkRecentManager *manager);
137 static gboolean gtk_recent_manager_poll_timeout (gpointer data);
138 static void gtk_recent_manager_set_filename (GtkRecentManager *manager,
139 const gchar *filename);
141 static void build_recent_items_list (GtkRecentManager *manager);
142 static void purge_recent_items_list (GtkRecentManager *manager,
145 static RecentAppInfo *recent_app_info_new (const gchar *app_name);
146 static void recent_app_info_free (RecentAppInfo *app_info);
148 static GtkRecentInfo *gtk_recent_info_new (const gchar *uri);
149 static void gtk_recent_info_free (GtkRecentInfo *recent_info);
151 static guint signal_changed = 0;
153 G_DEFINE_TYPE (GtkRecentManager, gtk_recent_manager, G_TYPE_OBJECT);
156 filename_warning (const gchar *format,
157 const gchar *filename,
158 const gchar *message)
160 gchar *utf8 = g_filename_to_utf8 (filename, -1, NULL, NULL, NULL);
161 g_warning (format, utf8 ? utf8 : "(invalid filename)", message);
165 /* Test of haystack has the needle prefix, comparing case
166 * insensitive. haystack may be UTF-8, but needle must
167 * contain only lowercase ascii. */
169 has_case_prefix (const gchar *haystack,
174 /* Eat one character at a time. */
178 while (*n && *h && *n == g_ascii_tolower (*h))
188 gtk_recent_manager_error_quark (void)
190 return g_quark_from_static_string ("gtk-recent-manager-error-quark");
195 gtk_recent_manager_class_init (GtkRecentManagerClass *klass)
197 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
199 gtk_recent_manager_parent_class = g_type_class_peek_parent (klass);
201 gobject_class->set_property = gtk_recent_manager_set_property;
202 gobject_class->get_property = gtk_recent_manager_get_property;
203 gobject_class->finalize = gtk_recent_manager_finalize;
206 * GtkRecentManager:filename
208 * The full path to the file to be used to store and read the recently
209 * used resources list
213 g_object_class_install_property (gobject_class,
215 g_param_spec_string ("filename",
217 P_("The full path to the file to be used to store and read the list"),
219 (G_PARAM_CONSTRUCT_ONLY | G_PARAM_READABLE | G_PARAM_WRITABLE)));
221 * GtkRecentManager:limit
223 * The maximum number of items to be returned by the
224 * gtk_recent_manager_get_items() function.
228 g_object_class_install_property (gobject_class,
230 g_param_spec_int ("limit",
232 P_("The maximum number of items to be returned by gtk_recent_manager_get_items()"),
238 * GtkRecentManager:size
240 * The size of the recently used resources list.
244 g_object_class_install_property (gobject_class,
246 g_param_spec_int ("size",
248 P_("The size of the recently used resources list"),
255 * GtkRecentManager::changed
256 * @recent_manager: the recent manager
258 * Emitted when the current recently used resources manager changes its
264 g_signal_new (I_("changed"),
265 G_TYPE_FROM_CLASS (klass),
267 G_STRUCT_OFFSET (GtkRecentManagerClass, changed),
269 g_cclosure_marshal_VOID__VOID,
272 klass->changed = gtk_recent_manager_real_changed;
274 g_type_class_add_private (klass, sizeof (GtkRecentManagerPrivate));
278 gtk_recent_manager_init (GtkRecentManager *manager)
280 GtkRecentManagerPrivate *priv;
282 priv = g_type_instance_get_private ((GTypeInstance *) manager,
283 GTK_TYPE_RECENT_MANAGER);
284 manager->priv = priv;
286 priv->filename = g_build_filename (g_get_home_dir (),
287 GTK_RECENTLY_USED_FILE,
290 priv->limit = DEFAULT_LIMIT;
293 priv->is_screen_singleton = FALSE;
294 priv->is_dirty = FALSE;
295 priv->write_in_progress = FALSE;
296 priv->read_in_progress = FALSE;
300 build_recent_items_list (manager);
304 gtk_recent_manager_set_property (GObject *object,
309 GtkRecentManager *recent_manager = GTK_RECENT_MANAGER (object);
314 gtk_recent_manager_set_filename (recent_manager, g_value_get_string (value));
317 gtk_recent_manager_set_limit (recent_manager, g_value_get_int (value));
320 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
326 gtk_recent_manager_get_property (GObject *object,
331 GtkRecentManager *recent_manager = GTK_RECENT_MANAGER (object);
336 g_value_set_string (value, recent_manager->priv->filename);
339 g_value_set_int (value, recent_manager->priv->limit);
342 g_value_set_int (value, recent_manager->priv->size);
345 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
351 gtk_recent_manager_finalize (GObject *object)
353 GtkRecentManager *manager = GTK_RECENT_MANAGER (object);
354 GtkRecentManagerPrivate *priv = manager->priv;
356 /* remove the poll timeout */
357 if (priv->poll_timeout)
358 g_source_remove (priv->poll_timeout);
361 g_free (priv->filename);
363 if (priv->recent_items)
364 g_bookmark_file_free (priv->recent_items);
366 /* chain up parent's finalize method */
367 G_OBJECT_CLASS (gtk_recent_manager_parent_class)->finalize (object);
371 gtk_recent_manager_real_changed (GtkRecentManager *manager)
373 GtkRecentManagerPrivate *priv = manager->priv;
375 g_object_freeze_notify (G_OBJECT (manager));
380 struct stat stat_buf;
382 /* we are marked as dirty, so we dump the content of our
383 * recently used items list
385 g_assert (priv->filename != NULL);
387 priv->write_in_progress = TRUE;
389 /* if no container object has been defined, we create a new
390 * empty container, and dump it
392 if (!priv->recent_items)
394 priv->recent_items = g_bookmark_file_new ();
399 g_bookmark_file_to_file (priv->recent_items,
404 filename_warning ("Attempting to store changes into `%s', "
407 write_error->message);
408 g_error_free (write_error);
411 /* we have sync'ed our list with the storage file, so we
412 * update the file mtime in order to skip the timed check
413 * and spare us from a re-read.
415 if (g_stat (priv->filename, &stat_buf) < 0)
417 filename_warning ("Unable to stat() the recently used resources file "
422 priv->write_in_progress = FALSE;
424 g_object_thaw_notify (G_OBJECT (manager));
429 priv->last_mtime = stat_buf.st_mtime;
431 /* mark us as clean */
432 priv->is_dirty = FALSE;
436 /* we are not marked as dirty, so we have been called
437 * because the recently used resources file has been
438 * changed (and not from us).
440 build_recent_items_list (manager);
443 g_object_thaw_notify (G_OBJECT (manager));
446 /* timed poll()-ing of the recently used resources file.
447 * an event-based system would be more efficient.
450 gtk_recent_manager_poll_timeout (gpointer data)
452 GtkRecentManager *manager = GTK_RECENT_MANAGER (data);
453 GtkRecentManagerPrivate *priv = manager->priv;
454 struct stat stat_buf;
457 /* wait for the next timeout if we have a read/write in progress */
458 if (priv->write_in_progress || priv->read_in_progress)
461 stat_res = g_stat (priv->filename, &stat_buf);
464 /* the file does not exist, yet, so we wait */
468 filename_warning ("Unable to stat() the recently used resources file "
476 /* the file didn't change from the last poll(), so we bail out */
477 if (stat_buf.st_mtime == priv->last_mtime)
480 /* the file has been changed, hence we emit the "changed" signal */
481 gtk_recent_manager_changed (manager);
487 gtk_recent_manager_set_filename (GtkRecentManager *manager,
488 const gchar *filename)
490 GtkRecentManagerPrivate *priv;
492 g_assert (GTK_IS_RECENT_MANAGER (manager));
493 priv = manager->priv;
495 if (!filename || filename[0] == '\0')
498 g_free (manager->priv->filename);
500 if (manager->priv->poll_timeout)
502 g_source_remove (manager->priv->poll_timeout);
503 manager->priv->poll_timeout = 0;
506 priv->filename = g_strdup (filename);
507 priv->poll_timeout = g_timeout_add (POLL_DELTA,
508 gtk_recent_manager_poll_timeout,
511 /* mark us clean, so that we can re-read the list
512 * of recently used resources
514 priv->is_dirty = FALSE;
515 build_recent_items_list (manager);
518 /* reads the recently used resources file and builds the items list.
519 * we keep the items list inside the parser object, and build the
520 * RecentInfo object only on user's demand to avoid useless replication.
521 * this function resets the dirty bit of the manager.
524 build_recent_items_list (GtkRecentManager *manager)
526 GtkRecentManagerPrivate *priv;
527 struct stat stat_buf;
533 priv = manager->priv;
534 g_assert (priv->filename != NULL);
536 if (!priv->recent_items)
538 priv->recent_items = g_bookmark_file_new ();
542 stat_res = g_stat (priv->filename, &stat_buf);
545 /* the file doesn't exists, so we bail out and wait for the first
553 filename_warning ("Attempting to read the recently used resources file "
554 "at `%s', but an error occurred: %s. Aborting.",
562 /* record the last mtime, for later use */
563 priv->last_mtime = stat_buf.st_mtime;
565 priv->read_in_progress = TRUE;
567 /* the file exists, and it's valid (we hope); if not, destroy the container
568 * object and hope for a better result when the next "changed" signal is
571 res = g_bookmark_file_load_from_file (priv->recent_items,
576 filename_warning ("Attempting to read the recently used resources file "
577 "at `%s', but the parser failed: %s.",
579 read_error->message);
581 g_bookmark_file_free (priv->recent_items);
582 priv->recent_items = NULL;
584 g_error_free (read_error);
587 size = g_bookmark_file_get_size (priv->recent_items);
588 if (priv->size != size)
592 g_object_notify (G_OBJECT (manager), "size");
595 priv->read_in_progress = FALSE;
596 priv->is_dirty = FALSE;
600 /********************
602 ********************/
606 * gtk_recent_manager_new:
608 * Creates a new recent manager object. Recent manager objects are used to
609 * handle the list of recently used resources. A #GtkRecentManager object
610 * monitors the recently used resources list, and emits the "changed" signal
611 * each time something inside the list changes.
613 * #GtkRecentManager objects are expansive: be sure to create them only when
614 * needed. You should use the gtk_recent_manager_new_for_screen() or the
615 * gtk_recent_manager_get_default() functions instead.
617 * Return value: A newly created #GtkRecentManager object.
622 gtk_recent_manager_new (void)
624 return g_object_new (GTK_TYPE_RECENT_MANAGER, NULL);
628 * gtk_recent_manager_get_default:
630 * Gets the recent manager for the default screen. See
631 * gtk_recent_manager_get_for_screen().
633 * Return value: A unique #GtkRecentManager associated with the
634 * default screen. This recent manager is associated to the
635 * screen and can be used as long as the screen is open.
636 * Do no ref or unref it.
641 gtk_recent_manager_get_default (void)
643 return gtk_recent_manager_get_for_screen (gdk_screen_get_default ());
647 * gtk_recent_manager_get_for_screen:
648 * @screen: a #GdkScreen
650 * Gets the recent manager object associated with @screen; if this
651 * function has not previously been called for the given screen,
652 * a new recent manager object will be created and associated with
653 * the screen. Recent manager objects are fairly expensive to create,
654 * so using this function is usually a better choice than calling
655 * gtk_recent_manager_new() and setting the screen yourself; by using
656 * this function a single recent manager object will be shared between
659 * Return value: A unique #GtkRecentManager associated with the given
660 * screen. This recent manager is associated to the with the screen
661 * and can be used as long as the screen is open. Do not ref or
667 gtk_recent_manager_get_for_screen (GdkScreen *screen)
669 GtkRecentManager *manager;
671 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
672 g_return_val_if_fail (!screen->closed, NULL);
674 manager = g_object_get_data (G_OBJECT (screen), "gtk-recent-manager-default");
677 GtkRecentManagerPrivate *priv;
679 manager = gtk_recent_manager_new ();
680 gtk_recent_manager_set_screen (manager, screen);
682 priv = manager->priv;
683 priv->is_screen_singleton = TRUE;
685 g_object_set_data (G_OBJECT (screen), I_("gtk-recent-manager-default"), manager);
692 display_closed (GdkDisplay *display,
694 GtkRecentManager *manager)
696 GtkRecentManagerPrivate *priv = manager->priv;
697 GdkScreen *screen = priv->screen;
698 gboolean was_screen_singleton = priv->is_screen_singleton;
700 if (was_screen_singleton)
702 g_object_set_data (G_OBJECT (screen), I_("gtk-recent-manager-default"), NULL);
703 priv->is_screen_singleton = FALSE;
706 gtk_recent_manager_set_screen (manager, NULL);
708 if (was_screen_singleton)
709 g_object_unref (manager);
713 unset_screen (GtkRecentManager *manager)
715 GtkRecentManagerPrivate *priv = manager->priv;
720 display = gdk_screen_get_display (priv->screen);
722 g_signal_handlers_disconnect_by_func (display,
723 (gpointer) display_closed,
731 * gtk_recent_manager_set_screen:
732 * @manager: a #GtkRecentManager
733 * @screen: a #GdkScreen
735 * Sets the screen for a recent manager; the screen is used to
736 * track the user's currently configured recently used documents
742 gtk_recent_manager_set_screen (GtkRecentManager *manager,
745 GtkRecentManagerPrivate *priv;
748 g_return_if_fail (GTK_IS_RECENT_MANAGER (manager));
749 g_return_if_fail (screen == NULL || GDK_IS_SCREEN (screen));
751 priv = manager->priv;
753 unset_screen (manager);
757 display = gdk_screen_get_display (screen);
759 priv->screen = screen;
761 g_signal_connect (display, "closed",
762 G_CALLBACK (display_closed), manager);
767 * gtk_recent_manager_set_limit:
768 * @manager: a #GtkRecentManager
769 * @limit: the maximum number of items to return, or -1.
771 * Sets the maximum number of item that the gtk_recent_manager_get_items()
772 * function should return. If @limit is set to -1, then return all the
778 gtk_recent_manager_set_limit (GtkRecentManager *manager,
781 GtkRecentManagerPrivate *priv;
783 g_return_if_fail (GTK_IS_RECENT_MANAGER (manager));
785 priv = manager->priv;
790 * gtk_recent_manager_get_limit:
791 * @manager: a #GtkRecentManager
793 * Gets the maximum number of items that the gtk_recent_manager_get_items()
794 * function should return.
796 * Return value: the number of items to return, or -1 for every item.
801 gtk_recent_manager_get_limit (GtkRecentManager *manager)
803 GtkRecentManagerPrivate *priv;
805 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), DEFAULT_LIMIT);
807 priv = manager->priv;
812 * gtk_recent_manager_add_item:
813 * @manager: a #GtkRecentManager
815 * @error: return location for a #GError, or %NULL
817 * Adds a new resource, pointed by @uri, into the recently used
820 * This function automatically retrieving some of the needed
821 * metadata and setting other metadata to common default values; it
822 * then feeds the data to gtk_recent_manager_add_full().
824 * See gtk_recent_manager_add_full() if you want to explicitely
825 * define the metadata for the resource pointed by @uri.
827 * Return value: %TRUE if the new item was successfully added
828 * to the recently used resources list
833 gtk_recent_manager_add_item (GtkRecentManager *manager,
837 GtkRecentData *recent_data;
841 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
842 g_return_val_if_fail (uri != NULL, FALSE);
844 recent_data = g_slice_new (GtkRecentData);
846 recent_data->display_name = NULL;
847 recent_data->description = NULL;
850 if (has_case_prefix (uri, "file:/"))
853 const gchar *mime_type;
855 filename = g_filename_from_uri (uri, NULL, NULL);
856 mime_type = xdg_mime_get_mime_type_for_file (filename, NULL);
858 recent_data->mime_type = g_strdup (GTK_RECENT_DEFAULT_MIME);
860 recent_data->mime_type = g_strdup (mime_type);
866 recent_data->mime_type = g_strdup (GTK_RECENT_DEFAULT_MIME);
868 recent_data->app_name = g_strdup (g_get_application_name ());
869 recent_data->app_exec = g_strjoin (" ", g_get_prgname (), "%u", NULL);
871 recent_data->groups = NULL;
873 recent_data->is_private = FALSE;
876 retval = gtk_recent_manager_add_full (manager, uri, recent_data, &add_error);
878 g_free (recent_data->mime_type);
879 g_free (recent_data->app_name);
880 g_free (recent_data->app_exec);
882 g_slice_free (GtkRecentData, recent_data);
886 g_propagate_error (error, add_error);
895 * gtk_recent_manager_add_full:
896 * @manager: a #GtkRecentManager
898 * @recent_data: metadata of the resource
899 * @error: return location for a #GError, or %NULL
901 * Adds a new resource, pointed by @uri, into the recently used
902 * resources list, using the metadata specified inside the #GtkRecentData
903 * structure passed in @recent_data.
905 * The passed URI will be used to identify this resource inside the
908 * In order to register the new recently used resource, metadata about
909 * the resource must be passed as well as the URI; the metadata is
910 * stored in a #GtkRecentData structure, which must contain the MIME
911 * type of the resource pointed by the URI; the name of the application
912 * that is registering the item, and a command line to be used when
913 * launching the item.
915 * Optionally, a #GtkRecentData structure might contain a UTF-8 string
916 * to be used when viewing the item instead of the last component of the
917 * URI; a short description of the item; whether the item should be
918 * considered private - that is, should be displayed only by the
919 * applications that have registered it.
921 * Return value: %TRUE if the new item was successfully added to the
922 * recently used resources list, %FALSE otherwise.
927 gtk_recent_manager_add_full (GtkRecentManager *manager,
929 const GtkRecentData *data,
932 GtkRecentManagerPrivate *priv;
934 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
935 g_return_val_if_fail (uri != NULL, FALSE);
936 g_return_val_if_fail (data != NULL, FALSE);
939 if ((data->display_name) &&
940 (!g_utf8_validate (data->display_name, -1, NULL)))
942 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
943 GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING,
944 _("The display name of the recently used resource "
945 "must be a valid UTF-8 encoded string."));
949 if ((data->description) &&
950 (!g_utf8_validate (data->description, -1, NULL)))
952 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
953 GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING,
954 _("The description of the recently used resource "
955 "must by a valid UTF-8 encoded string."));
960 if (!data->mime_type)
962 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
963 GTK_RECENT_MANAGER_ERROR_INVALID_MIME,
964 _("You must specify the MIME type of the "
965 "resource pointed by `%s'"),
972 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
973 GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED,
974 _("You must specify the name of the application "
975 "that is registering the recently used resource "
983 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
984 GTK_RECENT_MANAGER_ERROR_BAD_EXEC_STRING,
985 _("You must specify a command line to "
986 "be used when launching the resource "
992 priv = manager->priv;
994 if (!priv->recent_items)
996 priv->recent_items = g_bookmark_file_new ();
1000 if (data->display_name)
1001 g_bookmark_file_set_title (priv->recent_items, uri, data->display_name);
1003 if (data->description)
1004 g_bookmark_file_set_description (priv->recent_items, uri, data->description);
1006 g_bookmark_file_set_mime_type (priv->recent_items, uri, data->mime_type);
1008 if (data->groups && data->groups[0] != '\0')
1012 for (j = 0; (data->groups)[j] != NULL; j++)
1013 g_bookmark_file_add_group (priv->recent_items, uri, (data->groups)[j]);
1016 /* register the application; this will take care of updating the
1017 * registration count and time in case the application has
1018 * already registered the same document inside the list
1020 g_bookmark_file_add_application (priv->recent_items, uri,
1024 g_bookmark_file_set_is_private (priv->recent_items, uri,
1027 /* mark us as dirty, so that when emitting the "changed" signal we
1028 * will dump our changes
1030 priv->is_dirty = TRUE;
1032 gtk_recent_manager_changed (manager);
1038 * gtk_recent_manager_remove_item:
1039 * @manager: a #GtkRecentManager
1040 * @uri: the URI of the item you wish to remove
1041 * @error: return location for a #GError, or %NULL
1043 * Removes a resource pointed by @uri from the recently used resources
1044 * list handled by a recent manager.
1046 * Return value: %TRUE if the item pointed by @uri has been successfully
1047 * removed by the recently used resources list, and %FALSE otherwise.
1052 gtk_recent_manager_remove_item (GtkRecentManager *manager,
1056 GtkRecentManagerPrivate *priv;
1057 GError *remove_error = NULL;
1059 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
1060 g_return_val_if_fail (uri != NULL, FALSE);
1061 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1063 priv = manager->priv;
1065 if (!priv->recent_items)
1067 priv->recent_items = g_bookmark_file_new ();
1070 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1071 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1072 _("Unable to find an item with URI '%s'"),
1078 g_bookmark_file_remove_item (priv->recent_items, uri, &remove_error);
1081 g_propagate_error (error, remove_error);
1086 priv->is_dirty = TRUE;
1088 gtk_recent_manager_changed (manager);
1094 * gtk_recent_manager_has_item:
1095 * @manager: a #GtkRecentManager
1098 * Checks whether there is a recently used resource registered
1099 * with @uri inside the recent manager.
1101 * Return value: %TRUE if the resource was found, %FALSE otherwise.
1106 gtk_recent_manager_has_item (GtkRecentManager *manager,
1109 GtkRecentManagerPrivate *priv;
1111 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
1112 g_return_val_if_fail (uri != NULL, FALSE);
1114 priv = manager->priv;
1115 g_return_val_if_fail (priv->recent_items != NULL, FALSE);
1117 return g_bookmark_file_has_item (priv->recent_items, uri);
1121 build_recent_info (GBookmarkFile *bookmarks,
1122 GtkRecentInfo *info)
1124 gchar **apps, **groups;
1125 gsize apps_len, groups_len, i;
1127 g_assert (bookmarks != NULL);
1128 g_assert (info != NULL);
1130 info->display_name = g_bookmark_file_get_title (bookmarks, info->uri, NULL);
1131 info->description = g_bookmark_file_get_description (bookmarks, info->uri, NULL);
1132 info->mime_type = g_bookmark_file_get_mime_type (bookmarks, info->uri, NULL);
1134 info->is_private = g_bookmark_file_get_is_private (bookmarks, info->uri, NULL);
1136 info->added = g_bookmark_file_get_added (bookmarks, info->uri, NULL);
1137 info->modified = g_bookmark_file_get_modified (bookmarks, info->uri, NULL);
1138 info->visited = g_bookmark_file_get_visited (bookmarks, info->uri, NULL);
1140 groups = g_bookmark_file_get_groups (bookmarks, info->uri, &groups_len, NULL);
1141 for (i = 0; i < groups_len; i++)
1143 gchar *group_name = g_strdup (groups[i]);
1145 info->groups = g_slist_append (info->groups, group_name);
1148 g_strfreev (groups);
1150 apps = g_bookmark_file_get_applications (bookmarks, info->uri, &apps_len, NULL);
1151 for (i = 0; i < apps_len; i++)
1153 gchar *app_name, *app_exec;
1156 RecentAppInfo *app_info;
1161 res = g_bookmark_file_get_app_info (bookmarks, info->uri, app_name,
1169 app_info = recent_app_info_new (app_name);
1170 app_info->exec = app_exec;
1171 app_info->count = count;
1172 app_info->stamp = stamp;
1174 info->applications = g_slist_append (info->applications,
1176 g_hash_table_replace (info->apps_lookup, app_info->name, app_info);
1185 * gtk_recent_manager_lookup_item:
1186 * @manager: a #GtkRecentManager
1188 * @error: a return location for a #GError, or %NULL
1190 * Searches for a URI inside the recently used resources list, and
1191 * returns a structure containing informations about the resource
1192 * like its MIME type, or its display name.
1194 * Return value: a #GtkRecentInfo structure containing information
1195 * about the resource pointed by @uri, or %NULL if the URI was
1196 * not registered in the recently used resources list. Free with
1197 * gtk_recent_info_unref().
1200 gtk_recent_manager_lookup_item (GtkRecentManager *manager,
1204 GtkRecentManagerPrivate *priv;
1205 GtkRecentInfo *info = NULL;
1208 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1209 g_return_val_if_fail (uri != NULL, NULL);
1210 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1212 priv = manager->priv;
1213 if (!priv->recent_items)
1215 priv->recent_items = g_bookmark_file_new ();
1218 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1219 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1220 _("Unable to find an item with URI '%s'"),
1226 if (!g_bookmark_file_has_item (priv->recent_items, uri))
1228 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1229 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1230 _("Unable to find an item with URI '%s'"),
1235 info = gtk_recent_info_new (uri);
1236 g_return_val_if_fail (info != NULL, NULL);
1238 /* fill the RecentInfo structure with the data retrieved by our
1239 * parser object from the storage file
1241 res = build_recent_info (priv->recent_items, info);
1244 gtk_recent_info_free (info);
1249 return gtk_recent_info_ref (info);
1253 * gtk_recent_manager_move_item:
1254 * @manager: a #GtkRecentManager
1255 * @uri: the URI of a recently used resource
1256 * @new_uri: the new URI of the recently used resource, or %NULL to
1257 * remove the item pointed by @uri in the list
1258 * @error: a return location for a #GError, or %NULL
1260 * Changes the location of a recently used resource from @uri to @new_uri.
1262 * Please note that this function will not affect the resource pointed
1263 * by the URIs, but only the URI used in the recently used resources list.
1265 * Return value: %TRUE on success.
1270 gtk_recent_manager_move_item (GtkRecentManager *recent_manager,
1272 const gchar *new_uri,
1275 GtkRecentManagerPrivate *priv;
1279 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (recent_manager), FALSE);
1280 g_return_val_if_fail (uri != NULL, FALSE);
1281 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1283 priv = recent_manager->priv;
1285 if (!g_bookmark_file_has_item (priv->recent_items, uri))
1287 g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1288 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1289 _("Unable to find an item with URI '%s'"),
1295 res = g_bookmark_file_move_item (priv->recent_items,
1300 g_propagate_error (error, move_error);
1304 priv->is_dirty = TRUE;
1306 gtk_recent_manager_changed (recent_manager);
1312 * gtk_recent_manager_get_items:
1313 * @manager: a #GtkRecentManager
1315 * Gets the list of recently used resources.
1317 * Return value: a list of newly allocated #GtkRecentInfo objects. Use
1318 * gtk_recent_info_unref() on each item inside the list, and then
1319 * free the list itself using g_list_free().
1324 gtk_recent_manager_get_items (GtkRecentManager *manager)
1326 GtkRecentManagerPrivate *priv;
1327 GList *retval = NULL;
1331 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1333 priv = manager->priv;
1334 if (!priv->recent_items)
1337 uris = g_bookmark_file_get_uris (priv->recent_items, &uris_len);
1338 for (i = 0; i < uris_len; i++)
1340 GtkRecentInfo *info;
1343 info = gtk_recent_info_new (uris[i]);
1344 res = build_recent_info (priv->recent_items, info);
1347 g_warning ("Unable to create a RecentInfo object for "
1348 "item with URI `%s'",
1350 gtk_recent_info_free (info);
1355 retval = g_list_prepend (retval, info);
1360 /* clamp the list, if a limit is present */
1361 if ((priv->limit != -1) &&
1362 (g_list_length (retval) > priv->limit))
1366 clamp = g_list_nth (retval, priv->limit - 1);
1374 g_list_foreach (l, (GFunc) gtk_recent_info_free, NULL);
1382 purge_recent_items_list (GtkRecentManager *manager,
1385 GtkRecentManagerPrivate *priv = manager->priv;
1387 if (!priv->recent_items)
1390 g_bookmark_file_free (priv->recent_items);
1391 priv->recent_items = NULL;
1393 priv->recent_items = g_bookmark_file_new ();
1395 priv->is_dirty = TRUE;
1397 /* emit the changed signal, to ensure that the purge is written */
1398 gtk_recent_manager_changed (manager);
1402 * gtk_recent_manager_purge_items:
1403 * @manager: a #GtkRecentManager
1404 * @error: a return location for a #GError, or %NULL
1406 * Purges every item from the recently used resources list.
1408 * Return value: the number of items that have been removed from the
1409 * recently used resources list.
1414 gtk_recent_manager_purge_items (GtkRecentManager *manager,
1417 GtkRecentManagerPrivate *priv;
1420 g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), -1);
1422 priv = manager->priv;
1423 if (!priv->recent_items)
1426 count = g_bookmark_file_get_size (priv->recent_items);
1430 purge_recent_items_list (manager, error);
1432 purged = count - g_bookmark_file_get_size (priv->recent_items);
1438 gtk_recent_manager_changed (GtkRecentManager *recent_manager)
1440 g_signal_emit (recent_manager, signal_changed, 0);
1448 gtk_recent_info_get_type (void)
1450 static GType info_type = 0;
1453 info_type = g_boxed_type_register_static ("GtkRecentInfo",
1454 (GBoxedCopyFunc) gtk_recent_info_ref,
1455 (GBoxedFreeFunc) gtk_recent_info_unref);
1459 static GtkRecentInfo *
1460 gtk_recent_info_new (const gchar *uri)
1462 GtkRecentInfo *info;
1464 g_assert (uri != NULL);
1466 info = g_new0 (GtkRecentInfo, 1);
1467 info->uri = g_strdup (uri);
1469 info->applications = NULL;
1470 info->apps_lookup = g_hash_table_new (g_str_hash, g_str_equal);
1472 info->groups = NULL;
1474 info->ref_count = 1;
1480 gtk_recent_info_free (GtkRecentInfo *recent_info)
1485 g_free (recent_info->uri);
1486 g_free (recent_info->display_name);
1487 g_free (recent_info->description);
1488 g_free (recent_info->mime_type);
1490 if (recent_info->applications)
1492 g_slist_foreach (recent_info->applications,
1493 (GFunc) recent_app_info_free,
1495 g_slist_free (recent_info->applications);
1497 recent_info->applications = NULL;
1500 if (recent_info->apps_lookup)
1501 g_hash_table_destroy (recent_info->apps_lookup);
1503 if (recent_info->groups)
1505 g_slist_foreach (recent_info->groups,
1508 g_slist_free (recent_info->groups);
1510 recent_info->groups = NULL;
1513 if (recent_info->icon)
1514 g_object_unref (recent_info->icon);
1516 g_free (recent_info);
1520 * gtk_recent_info_ref:
1521 * @info: a #GtkRecentInfo
1523 * Increases the reference count of @recent_info by one.
1525 * Return value: the recent info object with its reference count increased
1531 gtk_recent_info_ref (GtkRecentInfo *info)
1533 g_return_val_if_fail (info != NULL, NULL);
1534 g_return_val_if_fail (info->ref_count > 0, NULL);
1536 info->ref_count += 1;
1542 * gtk_recent_info_unref:
1543 * @info: a #GtkRecentInfo
1545 * Decreases the reference count of @info by one. If the reference
1546 * count reaches zero, @info is deallocated, and the memory freed.
1551 gtk_recent_info_unref (GtkRecentInfo *info)
1553 g_return_if_fail (info != NULL);
1554 g_return_if_fail (info->ref_count > 0);
1556 info->ref_count -= 1;
1558 if (info->ref_count == 0)
1559 gtk_recent_info_free (info);
1563 * gtk_recent_info_get_uri:
1564 * @info: a #GtkRecentInfo
1566 * Gets the URI of the resource.
1568 * Return value: the URI of the resource. The returned string is
1569 * owned by the recent manager, and should not be freed.
1573 G_CONST_RETURN gchar *
1574 gtk_recent_info_get_uri (GtkRecentInfo *info)
1576 g_return_val_if_fail (info != NULL, NULL);
1582 * gtk_recent_info_get_display_name:
1583 * @info: a #GtkRecentInfo
1585 * Gets the name of the resource. If none has been defined, the basename
1586 * of the resource is obtained.
1588 * Return value: the display name of the resource. The returned string
1589 * is owned by the recent manager, and should not be freed.
1593 G_CONST_RETURN gchar *
1594 gtk_recent_info_get_display_name (GtkRecentInfo *info)
1596 g_return_val_if_fail (info != NULL, NULL);
1598 if (!info->display_name)
1599 info->display_name = gtk_recent_info_get_short_name (info);
1601 return info->display_name;
1605 * gtk_recent_info_get_description:
1606 * @info: a #GtkRecentInfo
1608 * Gets the (short) description of the resource.
1610 * Return value: the description of the resource. The returned string
1611 * is owned by the recent manager, and should not be freed.
1615 G_CONST_RETURN gchar *
1616 gtk_recent_info_get_description (GtkRecentInfo *info)
1618 g_return_val_if_fail (info != NULL, NULL);
1620 return info->description;
1624 * gtk_recent_info_get_mime_type:
1625 * @info: a #GtkRecentInfo
1627 * Gets the MIME type of the resource.
1629 * Return value: the MIME type of the resource. The returned string
1630 * is owned by the recent manager, and should not be freed.
1634 G_CONST_RETURN gchar *
1635 gtk_recent_info_get_mime_type (GtkRecentInfo *info)
1637 g_return_val_if_fail (info != NULL, NULL);
1639 if (!info->mime_type)
1640 info->mime_type = g_strdup (GTK_RECENT_DEFAULT_MIME);
1642 return info->mime_type;
1646 * gtk_recent_info_get_added:
1647 * @info: a #GtkRecentInfo
1649 * Gets the timestamp (seconds from system's Epoch) when the resource
1650 * was added to the recently used resources list.
1652 * Return value: the number of seconds elapsed from system's Epoch when
1653 * the resource was added to the list, or -1 on failure.
1658 gtk_recent_info_get_added (GtkRecentInfo *info)
1660 g_return_val_if_fail (info != NULL, (time_t) -1);
1666 * gtk_recent_info_get_modified:
1667 * @info: a #GtkRecentInfo
1669 * Gets the timestamp (seconds from system's Epoch) when the resource
1670 * was last modified.
1672 * Return value: the number of seconds elapsed from system's Epoch when
1673 * the resource was last modified, or -1 on failure.
1678 gtk_recent_info_get_modified (GtkRecentInfo *info)
1680 g_return_val_if_fail (info != NULL, (time_t) -1);
1682 return info->modified;
1686 * gtk_recent_info_get_visited:
1687 * @info: a #GtkRecentInfo
1689 * Gets the timestamp (seconds from system's Epoch) when the resource
1692 * Return value: the number of seconds elapsed from system's Epoch when
1693 * the resource was last visited, or -1 on failure.
1698 gtk_recent_info_get_visited (GtkRecentInfo *info)
1700 g_return_val_if_fail (info != NULL, (time_t) -1);
1702 return info->visited;
1706 * gtk_recent_info_get_private_hint:
1707 * @info: a #GtkRecentInfo
1709 * Gets the value of the "private" flag. Resources in the recently used
1710 * list that have this flag set to %TRUE should only be displayed by the
1711 * applications that have registered them.
1713 * Return value: %TRUE if the private flag was found, %FALSE otherwise.
1718 gtk_recent_info_get_private_hint (GtkRecentInfo *info)
1720 g_return_val_if_fail (info != NULL, FALSE);
1722 return info->is_private;
1726 static RecentAppInfo *
1727 recent_app_info_new (const gchar *app_name)
1729 RecentAppInfo *app_info;
1731 g_assert (app_name != NULL);
1733 app_info = g_new0 (RecentAppInfo, 1);
1734 app_info->name = g_strdup (app_name);
1735 app_info->exec = NULL;
1736 app_info->count = 1;
1737 app_info->stamp = time (NULL);
1743 recent_app_info_free (RecentAppInfo *app_info)
1749 g_free (app_info->name);
1752 g_free (app_info->exec);
1758 * gtk_recent_info_get_application_info:
1759 * @info: a #GtkRecentInfo
1760 * @app_name: the name of the application that has registered this item
1761 * @app_exec: return location for the string containing the command line
1762 * @count: return location for the number of times this item was registered
1763 * @time: return location for the timestamp this item was last registered
1764 * for this application
1766 * Gets the data regarding the application that has registered the resource
1769 * If the command line contains any escape characters defined inside the
1770 * storage specification, they will be expanded.
1772 * Return value: %TRUE if an application with @app_name has registered this
1773 * resource inside the recently used list, or %FALSE otherwise. You should
1774 * free the returned command line using g_free().
1779 gtk_recent_info_get_application_info (GtkRecentInfo *info,
1780 const gchar *app_name,
1787 g_return_val_if_fail (info != NULL, FALSE);
1788 g_return_val_if_fail (app_name != NULL, FALSE);
1790 ai = (RecentAppInfo *) g_hash_table_lookup (info->apps_lookup,
1794 g_warning ("No registered application with name '%s' "
1795 "for item with URI '%s' found",
1802 *app_exec = ai->exec;
1814 * gtk_recent_info_get_applications:
1815 * @info: a #GtkRecentInfo
1816 * @length: return location for the length of the returned list, or %NULL
1818 * Retrieves the list of applications that have registered this resource.
1820 * Return value: a newly allocated %NULL-terminated array of strings.
1821 * Use g_strfreev() to free it.
1826 gtk_recent_info_get_applications (GtkRecentInfo *info,
1833 g_return_val_if_fail (info != NULL, NULL);
1835 if (!info->applications)
1843 n_apps = g_slist_length (info->applications);
1845 retval = g_new0 (gchar *, n_apps + 1);
1847 for (l = info->applications, i = 0;
1851 RecentAppInfo *ai = (RecentAppInfo *) l->data;
1853 g_assert (ai != NULL);
1855 retval[i++] = g_strdup (ai->name);
1866 * gtk_recent_info_has_application:
1867 * @info: a #GtkRecentInfo
1868 * @app_name: a string containing an application name
1870 * Checks whether an application registered this resource using @app_name.
1872 * Return value: %TRUE if an application with name @app_name was found,
1878 gtk_recent_info_has_application (GtkRecentInfo *info,
1879 const gchar *app_name)
1881 g_return_val_if_fail (info != NULL, FALSE);
1882 g_return_val_if_fail (app_name != NULL, FALSE);
1884 return (NULL != g_hash_table_lookup (info->apps_lookup, app_name));
1888 * gtk_recent_info_last_application:
1889 * @info: a #GtkRecentInfo
1891 * Gets the name of the last application that have registered the
1892 * recently used resource represented by @info.
1894 * Return value: an application name. Use g_free() to free it.
1899 gtk_recent_info_last_application (GtkRecentInfo *info)
1902 time_t last_stamp = (time_t) -1;
1905 g_return_val_if_fail (info != NULL, NULL);
1907 for (l = info->applications; l != NULL; l = l->next)
1909 RecentAppInfo *ai = (RecentAppInfo *) l->data;
1911 if (ai->stamp > last_stamp)
1914 last_stamp = ai->stamp;
1918 return g_strdup (name);
1928 icon_cache_element_free (IconCacheElement *element)
1930 if (element->pixbuf)
1931 g_object_unref (element->pixbuf);
1936 icon_theme_changed (GtkIconTheme *icon_theme)
1940 /* Difference from the initial creation is that we don't
1941 * reconnect the signal
1943 cache = g_hash_table_new_full (g_str_hash, g_str_equal,
1944 (GDestroyNotify)g_free,
1945 (GDestroyNotify)icon_cache_element_free);
1946 g_object_set_data_full (G_OBJECT (icon_theme), "gtk-recent-icon-cache",
1947 cache, (GDestroyNotify)g_hash_table_destroy);
1950 /* TODO: use the GtkFileChooser's icon cache instead of our own to reduce
1951 * the memory footprint
1954 get_cached_icon (const gchar *name,
1957 GtkIconTheme *icon_theme;
1959 IconCacheElement *element;
1961 icon_theme = gtk_icon_theme_get_default ();
1962 cache = g_object_get_data (G_OBJECT (icon_theme), "gtk-recent-icon-cache");
1966 cache = g_hash_table_new_full (g_str_hash, g_str_equal,
1967 (GDestroyNotify)g_free,
1968 (GDestroyNotify)icon_cache_element_free);
1970 g_object_set_data_full (G_OBJECT (icon_theme), "gtk-recent-icon-cache",
1971 cache, (GDestroyNotify)g_hash_table_destroy);
1972 g_signal_connect (icon_theme, "changed",
1973 G_CALLBACK (icon_theme_changed), NULL);
1976 element = g_hash_table_lookup (cache, name);
1979 element = g_new0 (IconCacheElement, 1);
1980 g_hash_table_insert (cache, g_strdup (name), element);
1983 if (element->size != pixel_size)
1985 if (element->pixbuf)
1986 g_object_unref (element->pixbuf);
1988 element->size = pixel_size;
1989 element->pixbuf = gtk_icon_theme_load_icon (icon_theme, name,
1990 pixel_size, 0, NULL);
1993 return element->pixbuf ? g_object_ref (element->pixbuf) : NULL;
1998 get_icon_for_mime_type (const char *mime_type,
2001 const char *separator;
2005 separator = strchr (mime_type, '/');
2007 return NULL; /* maybe we should return a GError with "invalid MIME-type" */
2009 icon_name = g_string_new ("gnome-mime-");
2010 g_string_append_len (icon_name, mime_type, separator - mime_type);
2011 g_string_append_c (icon_name, '-');
2012 g_string_append (icon_name, separator + 1);
2013 pixbuf = get_cached_icon (icon_name->str, pixel_size);
2014 g_string_free (icon_name, TRUE);
2018 icon_name = g_string_new ("gnome-mime-");
2019 g_string_append_len (icon_name, mime_type, separator - mime_type);
2020 pixbuf = get_cached_icon (icon_name->str, pixel_size);
2021 g_string_free (icon_name, TRUE);
2027 get_icon_fallback (const gchar *icon_name,
2030 GtkIconTheme *icon_theme;
2033 icon_theme = gtk_icon_theme_get_default ();
2035 retval = gtk_icon_theme_load_icon (icon_theme, icon_name,
2037 GTK_ICON_LOOKUP_USE_BUILTIN,
2039 g_assert (retval != NULL);
2045 * gtk_recent_info_get_icon:
2046 * @info: a #GtkRecentInfo
2047 * @size: the size of the icon in pixels
2049 * Retrieves the icon of size @size associated to the resource MIME type.
2051 * Return value: a #GdkPixbuf containing the icon, or %NULL.
2056 gtk_recent_info_get_icon (GtkRecentInfo *info,
2059 GdkPixbuf *retval = NULL;
2061 g_return_val_if_fail (info != NULL, NULL);
2063 if (info->mime_type)
2064 retval = get_icon_for_mime_type (info->mime_type, size);
2066 /* this should never fail */
2068 retval = get_icon_fallback (GTK_STOCK_FILE, size);
2074 * gtk_recent_info_is_local:
2075 * @info: a #GtkRecentInfo
2077 * Checks whether the resource is local or not by looking at the
2078 * scheme of its URI.
2080 * Return value: %TRUE if the resource is local.
2085 gtk_recent_info_is_local (GtkRecentInfo *info)
2087 g_return_val_if_fail (info != NULL, FALSE);
2089 return has_case_prefix (info->uri, "file:/");
2093 * gtk_recent_info_exists:
2094 * @info: a #GtkRecentInfo
2096 * Checks whether the resource pointed by @info still exists. At
2097 * the moment this check is done only on resources pointing to local files.
2099 * Return value: %TRUE if the resource exists
2104 gtk_recent_info_exists (GtkRecentInfo *info)
2107 struct stat stat_buf;
2108 gboolean retval = FALSE;
2110 g_return_val_if_fail (info != NULL, FALSE);
2112 /* we guarantee only local resources */
2113 if (!gtk_recent_info_is_local (info))
2116 filename = g_filename_from_uri (info->uri, NULL, NULL);
2119 if (stat (filename, &stat_buf) == 0)
2129 * gtk_recent_info_match:
2130 * @info_a: a #GtkRecentInfo
2131 * @info_b: a #GtkRecentInfo
2133 * Checks whether two #GtkRecentInfo structures point to the same
2136 * Return value: %TRUE if both #GtkRecentInfo structures point to se same
2137 * resource, %FALSE otherwise.
2142 gtk_recent_info_match (GtkRecentInfo *info_a,
2143 GtkRecentInfo *info_b)
2145 g_return_val_if_fail (info_a != NULL, FALSE);
2146 g_return_val_if_fail (info_b != NULL, FALSE);
2148 return (0 == strcmp (info_a->uri, info_b->uri));
2151 /* taken from gnome-vfs-uri.c */
2152 static const gchar *
2153 get_method_string (const gchar *substring,
2154 gchar **method_string)
2160 g_ascii_isalnum (*p) || *p == '+' || *p == '-' || *p == '.';
2167 !(p == substring + 1 && g_ascii_isalpha (*substring))
2171 /* Found toplevel method specification. */
2172 method = g_strndup (substring, p - substring);
2173 *method_string = g_ascii_strdown (method, -1);
2179 *method_string = g_strdup ("file");
2186 /* Stolen from gnome_vfs_make_valid_utf8() */
2188 make_valid_utf8 (const char *name)
2191 const char *remainder, *invalid;
2192 int remaining_bytes, valid_bytes;
2196 remaining_bytes = name ? strlen (name) : 0;
2198 while (remaining_bytes != 0)
2200 if (g_utf8_validate (remainder, remaining_bytes, &invalid))
2203 valid_bytes = invalid - remainder;
2206 string = g_string_sized_new (remaining_bytes);
2208 g_string_append_len (string, remainder, valid_bytes);
2209 g_string_append_c (string, '?');
2211 remaining_bytes -= valid_bytes + 1;
2212 remainder = invalid + 1;
2216 return g_strdup (name);
2218 g_string_append (string, remainder);
2219 g_assert (g_utf8_validate (string->str, -1, NULL));
2221 return g_string_free (string, FALSE);
2225 get_uri_shortname_for_display (const gchar *uri)
2228 gboolean validated = FALSE;
2230 if (has_case_prefix (uri, "file:/"))
2234 local_file = g_filename_from_uri (uri, NULL, NULL);
2236 if (local_file != NULL)
2238 name = g_filename_display_basename (local_file);
2242 g_free (local_file);
2250 rest = get_method_string (uri, &method);
2251 local_file = g_filename_display_basename (rest);
2253 name = g_strdup_printf ("%s: %s", method, local_file);
2255 g_free (local_file);
2259 g_assert (name != NULL);
2261 if (!validated && !g_utf8_validate (name, -1, NULL))
2265 utf8_name = make_valid_utf8 (name);
2275 * gtk_recent_info_get_short_name:
2276 * @info: an #GtkRecentInfo
2278 * Computes a valid UTF-8 string that can be used as the name of the item in a
2279 * menu or list. For example, calling this function on an item that refers to
2280 * "file:///foo/bar.txt" will yield "bar.txt".
2282 * Return value: A newly-allocated string in UTF-8 encoding; free it with
2288 gtk_recent_info_get_short_name (GtkRecentInfo *info)
2292 g_return_val_if_fail (info != NULL, NULL);
2294 if (info->uri == NULL)
2297 short_name = get_uri_shortname_for_display (info->uri);
2303 * gtk_recent_info_get_uri_display:
2304 * @info: a #GtkRecentInfo
2306 * Gets a displayable version of the resource's URI.
2308 * Return value: a UTF-8 string containing the resource's URI or %NULL
2313 gtk_recent_info_get_uri_display (GtkRecentInfo *info)
2315 gchar *filename, *filename_utf8;
2317 g_return_val_if_fail (info != NULL, NULL);
2319 filename = g_filename_from_uri (info->uri, NULL, NULL);
2323 filename_utf8 = g_filename_to_utf8 (filename, -1, NULL, NULL, NULL);
2326 return filename_utf8;
2330 * gtk_recent_info_get_age:
2331 * @info: a #GtkRecentInfo
2333 * Gets the number of days elapsed since the last update of the resource
2336 * Return value: a positive integer containing the number of days elapsed
2337 * since the time this resource was last modified.
2342 gtk_recent_info_get_age (GtkRecentInfo *info)
2347 g_return_val_if_fail (info != NULL, -1);
2351 delta = now - info->modified;
2353 retval = (gint) (delta / (60 * 60 * 24));
2359 * gtk_recent_info_get_groups:
2360 * @info: a #GtkRecentInfo
2361 * @length: return location for the number of groups returned, or %NULL
2363 * Returns all groups registered for the recently used item @info. The
2364 * array of returned group names will be %NULL terminated, so length might
2365 * optionally be %NULL.
2367 * Return value: a newly allocated %NULL terminated array of strings. Use
2368 * g_strfreev() to free it.
2373 gtk_recent_info_get_groups (GtkRecentInfo *info,
2380 g_return_val_if_fail (info != NULL, NULL);
2390 n_groups = g_slist_length (info->groups);
2392 retval = g_new0 (gchar *, n_groups + 1);
2394 for (l = info->groups, i = 0;
2398 gchar *group_name = (gchar *) l->data;
2400 g_assert (group_name != NULL);
2402 retval[i++] = g_strdup (group_name);
2413 * gtk_recent_info_has_group:
2414 * @info: a #GtkRecentInfo
2415 * @group_name: name of a group
2417 * Checks whether @group_name appears inside the groups registered for the
2418 * recently used item @info.
2420 * Return value: %TRUE if the group was found.
2425 gtk_recent_info_has_group (GtkRecentInfo *info,
2426 const gchar *group_name)
2430 g_return_val_if_fail (info != NULL, FALSE);
2431 g_return_val_if_fail (group_name != NULL, FALSE);
2436 for (l = info->groups; l != NULL; l = l->next)
2438 gchar *g = (gchar *) l->data;
2440 if (strcmp (g, group_name) == 0)
2447 #define __GTK_RECENT_MANAGER_C__
2448 #include "gtkaliasdef.c"