]> Pileus Git - ~andy/gtk/blob - gtk/gtkrecentmanager.c
Replace a lot of idle and timeout calls by the new gdk_threads api.
[~andy/gtk] / gtk / gtkrecentmanager.c
1 /* GTK - The GIMP Toolkit
2  * gtkrecentmanager.c: a manager for the recently used resources
3  *
4  * Copyright (C) 2006 Emmanuele Bassi
5  *
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.
10  *
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.
15  *
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,
19  */
20
21 #include "config.h"
22
23 #include <sys/types.h>
24 #include <sys/stat.h>
25 #ifdef HAVE_UNISTD_H
26 #include <unistd.h>
27 #endif
28 #include <errno.h>
29 #include <string.h>
30 #include <stdlib.h>
31 #include <glib.h>
32 #include <glib/gstdio.h>
33
34 #include "gtkrecentmanager.h"
35 #include "gtkintl.h"
36 #include "gtkstock.h"
37 #include "gtkicontheme.h"
38 #include "gtktypebuiltins.h"
39 #include "gtkprivate.h"
40 #include "gtkmarshalers.h"
41 #include "gtkalias.h"
42
43 #ifdef G_OS_UNIX
44 #define XDG_PREFIX _gtk_xdg
45 #include "xdgmime/xdgmime.h"
46 #endif
47
48 /* the file where we store the recently used items */
49 #define GTK_RECENTLY_USED_FILE  ".recently-used.xbel"
50
51 /* a poll every two seconds should be enough */
52 #define POLL_DELTA      2000
53
54 /* return all items by default */
55 #define DEFAULT_LIMIT   -1
56
57 /* keep in sync with xdgmime */
58 #define GTK_RECENT_DEFAULT_MIME "application/octet-stream"
59
60 typedef struct
61 {
62   gchar *name;
63   gchar *exec;
64   
65   guint count;
66   
67   time_t stamp;
68 } RecentAppInfo;
69
70 struct _GtkRecentInfo
71 {
72   gchar *uri;
73   
74   gchar *display_name;
75   gchar *description;
76   
77   time_t added;
78   time_t modified;
79   time_t visited;
80   
81   gchar *mime_type;
82   
83   GSList *applications;
84   GHashTable *apps_lookup;
85   
86   GSList *groups;
87   
88   gboolean is_private;
89   
90   GdkPixbuf *icon;
91   
92   gint ref_count;
93 };
94
95 struct _GtkRecentManagerPrivate
96 {
97   gchar *filename;
98
99   guint is_screen_singleton : 1;
100   guint is_dirty : 1;
101   guint write_in_progress : 1;
102   guint read_in_progress : 1;
103   
104   gint limit;
105   gint size;
106
107   GdkScreen *screen;
108   
109   GBookmarkFile *recent_items;
110   
111   time_t last_mtime;
112   guint poll_timeout;
113 };
114
115 enum
116 {
117   PROP_0,
118
119   PROP_FILENAME,  
120   PROP_LIMIT,
121   PROP_SIZE
122 };
123
124 static void           gtk_recent_manager_finalize     (GObject               *object);
125
126 static void           gtk_recent_manager_set_property (GObject               *object,
127                                                        guint                  prop_id,
128                                                        const GValue          *value,
129                                                        GParamSpec            *pspec);
130 static void           gtk_recent_manager_get_property (GObject               *object,
131                                                        guint                  prop_id,
132                                                        GValue                *value,
133                                                        GParamSpec            *pspec);
134 static void           gtk_recent_manager_changed      (GtkRecentManager      *manager);
135
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);
140
141 static void           build_recent_items_list         (GtkRecentManager      *manager);
142 static void           purge_recent_items_list         (GtkRecentManager      *manager,
143                                                        GError               **error);
144
145 static RecentAppInfo *recent_app_info_new             (const gchar           *app_name);
146 static void           recent_app_info_free            (RecentAppInfo         *app_info);
147
148 static GtkRecentInfo *gtk_recent_info_new             (const gchar           *uri);
149 static void           gtk_recent_info_free            (GtkRecentInfo         *recent_info);
150
151 static guint signal_changed = 0;
152
153 G_DEFINE_TYPE (GtkRecentManager, gtk_recent_manager, G_TYPE_OBJECT)
154
155 static void
156 filename_warning (const gchar *format, 
157                   const gchar *filename, 
158                   const gchar *message)
159 {
160   gchar *utf8 = g_filename_to_utf8 (filename, -1, NULL, NULL, NULL);
161   g_warning (format, utf8 ? utf8 : "(invalid filename)", message);
162   g_free (utf8);
163 }
164
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. */
168 static gboolean
169 has_case_prefix (const gchar *haystack, 
170                  const gchar *needle)
171 {
172   const gchar *h, *n;
173
174   /* Eat one character at a time. */
175   h = haystack;
176   n = needle;
177
178   while (*n && *h && *n == g_ascii_tolower (*h))
179     {
180       n++;
181       h++;
182     }
183
184   return *n == '\0';
185 }
186
187 GQuark
188 gtk_recent_manager_error_quark (void)
189 {
190   return g_quark_from_static_string ("gtk-recent-manager-error-quark");
191 }
192
193
194 static void
195 gtk_recent_manager_class_init (GtkRecentManagerClass *klass)
196 {
197   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
198   
199   gtk_recent_manager_parent_class = g_type_class_peek_parent (klass);
200   
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;
204   
205   /**
206    * GtkRecentManager:filename
207    *
208    * The full path to the file to be used to store and read the recently
209    * used resources list
210    *
211    * Since: 2.10
212    */
213   g_object_class_install_property (gobject_class,
214                                    PROP_FILENAME,
215                                    g_param_spec_string ("filename",
216                                                         P_("Filename"),
217                                                         P_("The full path to the file to be used to store and read the list"),
218                                                         NULL,
219                                                         (G_PARAM_CONSTRUCT_ONLY | G_PARAM_READABLE | G_PARAM_WRITABLE)));
220   /**
221    * GtkRecentManager:limit
222    *
223    * The maximum number of items to be returned by the
224    * gtk_recent_manager_get_items() function.
225    *
226    * Since: 2.10
227    */
228   g_object_class_install_property (gobject_class,
229                                    PROP_LIMIT,
230                                    g_param_spec_int ("limit",
231                                                      P_("Limit"),
232                                                      P_("The maximum number of items to be returned by gtk_recent_manager_get_items()"),
233                                                      -1,
234                                                      G_MAXINT,
235                                                      DEFAULT_LIMIT,
236                                                      G_PARAM_READWRITE));
237   /**
238    * GtkRecentManager:size
239    * 
240    * The size of the recently used resources list.
241    *
242    * Since: 2.10
243    */
244   g_object_class_install_property (gobject_class,
245                                    PROP_SIZE,
246                                    g_param_spec_int ("size",
247                                                      P_("Size"),
248                                                      P_("The size of the recently used resources list"),
249                                                      -1,
250                                                      G_MAXINT,
251                                                      0,
252                                                      G_PARAM_READABLE));
253   
254   /**
255    * GtkRecentManager::changed
256    * @recent_manager: the recent manager
257    *
258    * Emitted when the current recently used resources manager changes its
259    * contents.
260    *
261    * Since: 2.10
262    */
263   signal_changed =
264     g_signal_new (I_("changed"),
265                   G_TYPE_FROM_CLASS (klass),
266                   G_SIGNAL_RUN_FIRST,
267                   G_STRUCT_OFFSET (GtkRecentManagerClass, changed),
268                   NULL, NULL,
269                   g_cclosure_marshal_VOID__VOID,
270                   G_TYPE_NONE, 0);
271   
272   klass->changed = gtk_recent_manager_real_changed;
273   
274   g_type_class_add_private (klass, sizeof (GtkRecentManagerPrivate));
275 }
276
277 static void
278 gtk_recent_manager_init (GtkRecentManager *manager)
279 {
280   GtkRecentManagerPrivate *priv;
281   
282   priv = g_type_instance_get_private ((GTypeInstance *) manager,
283                                       GTK_TYPE_RECENT_MANAGER);
284   manager->priv = priv;
285   
286   priv->limit = DEFAULT_LIMIT;
287   priv->size = 0;
288   
289   priv->is_screen_singleton = FALSE;
290   priv->is_dirty = FALSE;
291   priv->write_in_progress = FALSE;
292   priv->read_in_progress = FALSE;
293
294   priv->screen = NULL;
295
296   priv->filename = g_build_filename (g_get_home_dir (),
297                                      GTK_RECENTLY_USED_FILE,
298                                      NULL);
299   priv->poll_timeout = gdk_threads_add_timeout (POLL_DELTA,
300                                       gtk_recent_manager_poll_timeout,
301                                       manager);
302
303   build_recent_items_list (manager);
304 }
305
306 static void
307 gtk_recent_manager_set_property (GObject               *object,
308                                  guint                  prop_id,
309                                  const GValue          *value,
310                                  GParamSpec            *pspec)
311 {
312   GtkRecentManager *recent_manager = GTK_RECENT_MANAGER (object);
313  
314   switch (prop_id)
315     {
316     case PROP_FILENAME:
317       gtk_recent_manager_set_filename (recent_manager, g_value_get_string (value));
318       break;      
319     case PROP_LIMIT:
320       gtk_recent_manager_set_limit (recent_manager, g_value_get_int (value));
321       break;
322     default:
323       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
324       break;
325     }
326 }
327
328 static void
329 gtk_recent_manager_get_property (GObject               *object,
330                                  guint                  prop_id,
331                                  GValue                *value,
332                                  GParamSpec            *pspec)
333 {
334   GtkRecentManager *recent_manager = GTK_RECENT_MANAGER (object);
335   
336   switch (prop_id)
337     {
338     case PROP_FILENAME:
339       g_value_set_string (value, recent_manager->priv->filename);
340       break;
341     case PROP_LIMIT:
342       g_value_set_int (value, recent_manager->priv->limit);
343       break;
344     case PROP_SIZE:
345       g_value_set_int (value, recent_manager->priv->size);
346       break;
347     default:
348       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
349       break;
350     }
351
352
353 static void
354 gtk_recent_manager_finalize (GObject *object)
355 {
356   GtkRecentManager *manager = GTK_RECENT_MANAGER (object);
357   GtkRecentManagerPrivate *priv = manager->priv;
358
359   /* remove the poll timeout */
360   if (priv->poll_timeout)
361     g_source_remove (priv->poll_timeout);
362   
363   if (priv->filename)
364     g_free (priv->filename);
365   
366   if (priv->recent_items)
367     g_bookmark_file_free (priv->recent_items);
368   
369   /* chain up parent's finalize method */  
370   G_OBJECT_CLASS (gtk_recent_manager_parent_class)->finalize (object);
371 }
372
373 static void
374 gtk_recent_manager_real_changed (GtkRecentManager *manager)
375 {
376   GtkRecentManagerPrivate *priv = manager->priv;
377
378   g_object_freeze_notify (G_OBJECT (manager));
379
380   if (priv->is_dirty)
381     {
382       GError *write_error;
383       struct stat stat_buf;
384       
385       /* we are marked as dirty, so we dump the content of our
386        * recently used items list
387        */
388       g_assert (priv->filename != NULL);
389
390       priv->write_in_progress = TRUE;
391
392       /* if no container object has been defined, we create a new
393        * empty container, and dump it
394        */
395       if (!priv->recent_items)
396         {
397           priv->recent_items = g_bookmark_file_new ();
398           priv->size = 0;
399         }
400
401       write_error = NULL;
402       g_bookmark_file_to_file (priv->recent_items,
403                                priv->filename,
404                                &write_error);
405
406       if (write_error)
407         {
408           filename_warning ("Attempting to store changes into `%s', "
409                             "but failed: %s",
410                             priv->filename,
411                             write_error->message);
412           g_error_free (write_error);
413         }
414
415       priv->write_in_progress = FALSE;
416           
417       /* we have sync'ed our list with the storage file, so we
418        * update the file mtime in order to skip the timed check
419        * and spare us from a re-read.
420        */
421       if (g_stat (priv->filename, &stat_buf) < 0)
422         {
423           filename_warning ("Unable to stat() the recently used resources file "
424                             "at `%s': %s.",
425                             priv->filename,
426                             g_strerror (errno));
427
428           g_object_thaw_notify (G_OBJECT (manager));
429
430           return;
431         }
432       
433       priv->last_mtime = stat_buf.st_mtime;
434       
435       /* mark us as clean */
436       priv->is_dirty = FALSE;
437     }
438   else
439     {
440       /* we are not marked as dirty, so we have been called
441        * because the recently used resources file has been
442        * changed (and not from us).
443        */
444       build_recent_items_list (manager);
445     }
446
447   g_object_thaw_notify (G_OBJECT (manager));
448 }
449
450 /* timed poll()-ing of the recently used resources file.
451  * an event-based system would be more efficient.
452  */
453 static gboolean
454 gtk_recent_manager_poll_timeout (gpointer data)
455 {
456   GtkRecentManager *manager = GTK_RECENT_MANAGER (data);
457   GtkRecentManagerPrivate *priv = manager->priv;
458   struct stat stat_buf;
459   int stat_res;
460
461   /* wait for the next timeout if we have a read/write in progress */
462   if (priv->write_in_progress || priv->read_in_progress)
463     return TRUE;
464
465   stat_res = g_stat (priv->filename, &stat_buf);
466   if (stat_res < 0)
467     {
468       /* the file does not exist, yet, so we wait */
469       if (errno == ENOENT)
470         return TRUE;
471       
472       filename_warning ("Unable to stat() the recently used resources file "
473                         "at `%s': %s.",
474                         priv->filename,
475                         g_strerror (errno));
476       
477       return TRUE;
478     }
479
480   /* the file didn't change from the last poll(), so we bail out */
481   if (stat_buf.st_mtime == priv->last_mtime)
482     return TRUE;
483
484   /* the file has been changed, hence we emit the "changed" signal */
485   gtk_recent_manager_changed (manager);
486
487   return TRUE;
488 }
489
490 static void
491 gtk_recent_manager_set_filename (GtkRecentManager *manager,
492                                  const gchar      *filename)
493 {
494   GtkRecentManagerPrivate *priv;
495   
496   g_assert (GTK_IS_RECENT_MANAGER (manager));
497   priv = manager->priv;
498   
499   if (!filename || filename[0] == '\0')
500     return;
501   
502   g_free (manager->priv->filename);
503
504   if (manager->priv->poll_timeout)
505     {
506       g_source_remove (manager->priv->poll_timeout);
507       manager->priv->poll_timeout = 0;
508     }
509
510   priv->filename = g_strdup (filename);
511   priv->poll_timeout = gdk_threads_add_timeout (POLL_DELTA,
512                                       gtk_recent_manager_poll_timeout,
513                                       manager);
514
515   /* mark us clean, so that we can re-read the list
516    * of recently used resources
517    */
518   priv->is_dirty = FALSE;
519   build_recent_items_list (manager);
520 }
521
522 /* reads the recently used resources file and builds the items list.
523  * we keep the items list inside the parser object, and build the
524  * RecentInfo object only on user's demand to avoid useless replication.
525  * this function resets the dirty bit of the manager.
526  */
527 static void
528 build_recent_items_list (GtkRecentManager *manager)
529 {
530   GtkRecentManagerPrivate *priv;
531   struct stat stat_buf;
532   int stat_res;
533   gboolean res;
534   GError *read_error;
535   gint size;
536
537   priv = manager->priv;
538   g_assert (priv->filename != NULL);
539   
540   if (!priv->recent_items)
541     {
542       priv->recent_items = g_bookmark_file_new ();
543       priv->size = 0;
544     }
545
546   stat_res = g_stat (priv->filename, &stat_buf);
547   if (stat_res < 0)
548     {
549       /* the file doesn't exists, so we bail out and wait for the first
550        * write operation
551        */
552
553       if (errno == ENOENT)
554         return;
555       else
556         {
557           filename_warning ("Attempting to read the recently used resources file "
558                             "at `%s', but an error occurred: %s. Aborting.",
559                             priv->filename,
560                             g_strerror (errno));
561
562           return;
563         }
564     }
565
566   /* record the last mtime, for later use */
567   priv->last_mtime = stat_buf.st_mtime;
568   
569   priv->read_in_progress = TRUE;
570
571   /* the file exists, and it's valid (we hope); if not, destroy the container
572    * object and hope for a better result when the next "changed" signal is
573    * fired. */
574   read_error = NULL;
575   res = g_bookmark_file_load_from_file (priv->recent_items,
576                                         priv->filename,
577                                         &read_error);
578   if (read_error)
579     {
580       filename_warning ("Attempting to read the recently used resources file "
581                         "at `%s', but the parser failed: %s.",
582                         priv->filename,
583                         read_error->message);
584
585       g_bookmark_file_free (priv->recent_items);
586       priv->recent_items = NULL;
587
588       g_error_free (read_error);
589     }
590
591   size = g_bookmark_file_get_size (priv->recent_items);
592   if (priv->size != size)
593     {
594       priv->size = size;
595       
596       g_object_notify (G_OBJECT (manager), "size");
597     }
598
599   priv->read_in_progress = FALSE;
600   priv->is_dirty = FALSE;
601 }
602
603
604 /********************
605  * GtkRecentManager *
606  ********************/
607
608
609 /**
610  * gtk_recent_manager_new:
611  * 
612  * Creates a new recent manager object.  Recent manager objects are used to
613  * handle the list of recently used resources.  A #GtkRecentManager object
614  * monitors the recently used resources list, and emits the "changed" signal
615  * each time something inside the list changes.
616  *
617  * #GtkRecentManager objects are expansive: be sure to create them only when
618  * needed. You should use the gtk_recent_manager_new_for_screen() or the
619  * gtk_recent_manager_get_default() functions instead.
620  *
621  * Return value: A newly created #GtkRecentManager object.
622  *
623  * Since: 2.10
624  */
625 GtkRecentManager *
626 gtk_recent_manager_new (void)
627 {
628   return g_object_new (GTK_TYPE_RECENT_MANAGER, NULL);
629 }
630
631 /**
632  * gtk_recent_manager_get_default:
633  *
634  * Gets the recent manager for the default screen. See
635  * gtk_recent_manager_get_for_screen().
636  *
637  * Return value: A unique #GtkRecentManager associated with the
638  *   default screen. This recent manager is associated to the
639  *   screen and can be used as long as the screen is open.
640  *   Do no ref or unref it.
641  *
642  * Since: 2.10
643  */
644 GtkRecentManager *
645 gtk_recent_manager_get_default (void)
646 {
647   return gtk_recent_manager_get_for_screen (gdk_screen_get_default ());
648 }
649
650 /**
651  * gtk_recent_manager_get_for_screen:
652  * @screen: a #GdkScreen
653  *
654  * Gets the recent manager object associated with @screen; if this
655  * function has not previously been called for the given screen,
656  * a new recent manager object will be created and associated with
657  * the screen. Recent manager objects are fairly expensive to create,
658  * so using this function is usually a better choice than calling 
659  * gtk_recent_manager_new() and setting the screen yourself; by using
660  * this function a single recent manager object will be shared between
661  * users.
662  *
663  * Return value: A unique #GtkRecentManager associated with the given
664  *   screen. This recent manager is associated to the with the screen
665  *   and can be used as long as the screen is open. Do not ref or
666  *   unref it.
667  *
668  * Since: 2.10
669  */
670 GtkRecentManager *
671 gtk_recent_manager_get_for_screen (GdkScreen *screen)
672 {
673   GtkRecentManager *manager;
674
675   g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
676   g_return_val_if_fail (!screen->closed, NULL);
677
678   manager = g_object_get_data (G_OBJECT (screen), "gtk-recent-manager-default");
679   if (!manager)
680     {
681       GtkRecentManagerPrivate *priv;
682       
683       manager = gtk_recent_manager_new ();
684       gtk_recent_manager_set_screen (manager, screen);
685
686       priv = manager->priv;
687       priv->is_screen_singleton = TRUE;
688
689       g_object_set_data (G_OBJECT (screen), I_("gtk-recent-manager-default"), manager);
690     }
691
692   return manager;
693 }
694
695 static void
696 display_closed (GdkDisplay       *display,
697                 gboolean          is_error,
698                 GtkRecentManager *manager)
699 {
700   GtkRecentManagerPrivate *priv = manager->priv;
701   GdkScreen *screen = priv->screen;
702   gboolean was_screen_singleton = priv->is_screen_singleton;
703
704   if (was_screen_singleton)
705     {
706       g_object_set_data (G_OBJECT (screen), I_("gtk-recent-manager-default"), NULL);
707       priv->is_screen_singleton = FALSE;
708     }
709
710   gtk_recent_manager_set_screen (manager, NULL);
711
712   if (was_screen_singleton)
713     g_object_unref (manager);
714 }
715
716 static void
717 unset_screen (GtkRecentManager *manager)
718 {
719   GtkRecentManagerPrivate *priv = manager->priv;
720   GdkDisplay *display;
721
722   if (priv->screen)
723     {
724       display = gdk_screen_get_display (priv->screen);
725
726       g_signal_handlers_disconnect_by_func (display,
727                                             (gpointer) display_closed,
728                                             manager);
729
730       priv->screen = NULL;
731     }
732 }
733
734 /**
735  * gtk_recent_manager_set_screen:
736  * @manager: a #GtkRecentManager
737  * @screen: a #GdkScreen
738  *
739  * Sets the screen for a recent manager; the screen is used to
740  * track the user's currently configured recently used documents
741  * storage.
742  * 
743  * Since: 2.10
744  */
745 void
746 gtk_recent_manager_set_screen (GtkRecentManager *manager,
747                                GdkScreen        *screen)
748 {
749   GtkRecentManagerPrivate *priv;
750   GdkDisplay *display;
751
752   g_return_if_fail (GTK_IS_RECENT_MANAGER (manager));
753   g_return_if_fail (screen == NULL || GDK_IS_SCREEN (screen));
754
755   priv = manager->priv;
756
757   unset_screen (manager);
758
759   if (screen)
760     {
761       display = gdk_screen_get_display (screen);
762
763       priv->screen = screen;
764
765       g_signal_connect (display, "closed",
766                         G_CALLBACK (display_closed), manager);
767     }
768 }
769
770 /**
771  * gtk_recent_manager_set_limit:
772  * @manager: a #GtkRecentManager
773  * @limit: the maximum number of items to return, or -1.
774  *
775  * Sets the maximum number of item that the gtk_recent_manager_get_items()
776  * function should return.  If @limit is set to -1, then return all the
777  * items.
778  *
779  * Since: 2.10
780  */
781 void
782 gtk_recent_manager_set_limit (GtkRecentManager *manager,
783                               gint              limit)
784 {
785   GtkRecentManagerPrivate *priv;
786   
787   g_return_if_fail (GTK_IS_RECENT_MANAGER (manager));
788   
789   priv = manager->priv;
790   priv->limit = limit;
791 }
792
793 /**
794  * gtk_recent_manager_get_limit:
795  * @manager: a #GtkRecentManager
796  *
797  * Gets the maximum number of items that the gtk_recent_manager_get_items()
798  * function should return.
799  *
800  * Return value: the number of items to return, or -1 for every item.
801  *
802  * Since: 2.10
803  */
804 gint
805 gtk_recent_manager_get_limit (GtkRecentManager *manager)
806 {
807   GtkRecentManagerPrivate *priv;
808   
809   g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), DEFAULT_LIMIT);
810   
811   priv = manager->priv;
812   return priv->limit;
813 }
814
815 /**
816  * gtk_recent_manager_add_item:
817  * @manager: a #GtkRecentManager
818  * @uri: a valid URI
819  *
820  * Adds a new resource, pointed by @uri, into the recently used
821  * resources list.
822  *
823  * This function automatically retrieving some of the needed
824  * metadata and setting other metadata to common default values; it
825  * then feeds the data to gtk_recent_manager_add_full().
826  *
827  * See gtk_recent_manager_add_full() if you want to explicitely
828  * define the metadata for the resource pointed by @uri.
829  *
830  * Return value: %TRUE if the new item was successfully added
831  *   to the recently used resources list
832  *
833  * Since: 2.10
834  */
835 gboolean
836 gtk_recent_manager_add_item (GtkRecentManager  *manager,
837                              const gchar       *uri)
838 {
839   GtkRecentData *recent_data;
840   GError *add_error;
841   gboolean retval;
842   
843   g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
844   g_return_val_if_fail (uri != NULL, FALSE);
845
846   recent_data = g_slice_new (GtkRecentData);
847   
848   recent_data->display_name = NULL;
849   recent_data->description = NULL;
850   
851 #ifdef G_OS_UNIX
852   if (has_case_prefix (uri, "file:/"))
853     {
854       gchar *filename;
855       const gchar *mime_type;
856       
857       filename = g_filename_from_uri (uri, NULL, NULL);
858       mime_type = xdg_mime_get_mime_type_for_file (filename, NULL);
859       if (!mime_type)
860         recent_data->mime_type = g_strdup (GTK_RECENT_DEFAULT_MIME);
861       else
862         recent_data->mime_type = g_strdup (mime_type);
863       
864       g_free (filename);
865     }
866   else
867 #endif
868     recent_data->mime_type = g_strdup (GTK_RECENT_DEFAULT_MIME);
869   
870   recent_data->app_name = g_strdup (g_get_application_name ());
871   recent_data->app_exec = g_strjoin (" ", g_get_prgname (), "%u", NULL);
872   
873   recent_data->groups = NULL;
874   
875   recent_data->is_private = FALSE;
876   
877   add_error = NULL;
878   retval = gtk_recent_manager_add_full (manager, uri, recent_data);
879   
880   g_free (recent_data->mime_type);
881   g_free (recent_data->app_name);
882   g_free (recent_data->app_exec);
883
884   g_slice_free (GtkRecentData, recent_data);
885   
886   return retval;
887 }
888
889 /**
890  * gtk_recent_manager_add_full:
891  * @manager: a #GtkRecentManager
892  * @uri: a valid URI
893  * @recent_data: metadata of the resource
894  *
895  * Adds a new resource, pointed by @uri, into the recently used
896  * resources list, using the metadata specified inside the #GtkRecentData
897  * structure passed in @recent_data.
898  *
899  * The passed URI will be used to identify this resource inside the
900  * list.
901  *
902  * In order to register the new recently used resource, metadata about
903  * the resource must be passed as well as the URI; the metadata is
904  * stored in a #GtkRecentData structure, which must contain the MIME
905  * type of the resource pointed by the URI; the name of the application
906  * that is registering the item, and a command line to be used when
907  * launching the item.
908  *
909  * Optionally, a #GtkRecentData structure might contain a UTF-8 string
910  * to be used when viewing the item instead of the last component of the
911  * URI; a short description of the item; whether the item should be
912  * considered private - that is, should be displayed only by the
913  * applications that have registered it.
914  *
915  * Return value: %TRUE if the new item was successfully added to the
916  * recently used resources list, %FALSE otherwise.
917  *
918  * Since: 2.10
919  */
920 gboolean
921 gtk_recent_manager_add_full (GtkRecentManager     *manager,
922                              const gchar          *uri,
923                              const GtkRecentData  *data)
924 {
925   GtkRecentManagerPrivate *priv;
926   
927   g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
928   g_return_val_if_fail (uri != NULL, FALSE);
929   g_return_val_if_fail (data != NULL, FALSE);
930
931   /* sanity checks */
932   if ((data->display_name) &&
933       (!g_utf8_validate (data->display_name, -1, NULL)))
934     {
935       g_warning ("Attempting to add `%s' to the list of recently used "
936                  "resources, but the display name is not a valid UTF-8 "
937                  "encoded string",
938                  uri);
939       return FALSE;
940     }
941   
942   if ((data->description) &&
943       (!g_utf8_validate (data->description, -1, NULL)))
944     {
945       g_warning ("Attempting to add `%s' to the list of recently used "
946                  "resources, but the description is not a valid UTF-8 "
947                  "encoded string",
948                  uri);
949       return FALSE;
950     }
951
952  
953   if (!data->mime_type)
954     {
955       g_warning ("Attempting to add `%s' to the list of recently used "
956                  "resources, but not MIME type was defined",
957                  uri);
958       return FALSE;
959     }
960   
961   if (!data->app_name)
962     {
963       g_warning ("Attempting to add `%s' to the list of recently used "
964                  "resources, but no name of the application that is "
965                  "registering it was defined",
966                  uri);
967       return FALSE;
968     }
969   
970   if (!data->app_exec)
971     {
972       g_warning ("Attempting to add `%s' to the list of recently used "
973                  "resources, but no command line for the application "
974                  "that is registering it was defined",
975                  uri);
976       return FALSE;
977     }
978   
979   priv = manager->priv;
980
981   if (!priv->recent_items)
982     {
983       priv->recent_items = g_bookmark_file_new ();
984       priv->size = 0;
985     }
986
987   if (data->display_name)  
988     g_bookmark_file_set_title (priv->recent_items, uri, data->display_name);
989   
990   if (data->description)
991     g_bookmark_file_set_description (priv->recent_items, uri, data->description);
992
993   g_bookmark_file_set_mime_type (priv->recent_items, uri, data->mime_type);
994   
995   if (data->groups && data->groups[0] != '\0')
996     {
997       gint j;
998       
999       for (j = 0; (data->groups)[j] != NULL; j++)
1000         g_bookmark_file_add_group (priv->recent_items, uri, (data->groups)[j]);
1001     }
1002   
1003   /* register the application; this will take care of updating the
1004    * registration count and time in case the application has
1005    * already registered the same document inside the list
1006    */
1007   g_bookmark_file_add_application (priv->recent_items, uri,
1008                                    data->app_name,
1009                                    data->app_exec);
1010   
1011   g_bookmark_file_set_is_private (priv->recent_items, uri,
1012                                   data->is_private);
1013   
1014   /* mark us as dirty, so that when emitting the "changed" signal we
1015    * will dump our changes
1016    */
1017   priv->is_dirty = TRUE;
1018   
1019   gtk_recent_manager_changed (manager);
1020   
1021   return TRUE;
1022 }
1023
1024 /**
1025  * gtk_recent_manager_remove_item:
1026  * @manager: a #GtkRecentManager
1027  * @uri: the URI of the item you wish to remove
1028  * @error: return location for a #GError, or %NULL
1029  *
1030  * Removes a resource pointed by @uri from the recently used resources
1031  * list handled by a recent manager.
1032  *
1033  * Return value: %TRUE if the item pointed by @uri has been successfully
1034  *   removed by the recently used resources list, and %FALSE otherwise.
1035  *
1036  * Since: 2.10
1037  */
1038 gboolean
1039 gtk_recent_manager_remove_item (GtkRecentManager  *manager,
1040                                 const gchar       *uri,
1041                                 GError           **error)
1042 {
1043   GtkRecentManagerPrivate *priv;
1044   GError *remove_error = NULL;
1045
1046   g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
1047   g_return_val_if_fail (uri != NULL, FALSE);
1048   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1049   
1050   priv = manager->priv;
1051   
1052   if (!priv->recent_items)
1053     {
1054       priv->recent_items = g_bookmark_file_new ();
1055       priv->size = 0;
1056
1057       g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1058                    GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1059                    _("Unable to find an item with URI '%s'"),
1060                    uri);
1061
1062       return FALSE;
1063     }
1064
1065   g_bookmark_file_remove_item (priv->recent_items, uri, &remove_error);
1066   if (remove_error)
1067     {
1068       g_propagate_error (error, remove_error);
1069       
1070       return FALSE;
1071     }
1072
1073   priv->is_dirty = TRUE;
1074
1075   gtk_recent_manager_changed (manager);
1076   
1077   return TRUE;
1078 }
1079
1080 /**
1081  * gtk_recent_manager_has_item:
1082  * @manager: a #GtkRecentManager
1083  * @uri: a URI
1084  *
1085  * Checks whether there is a recently used resource registered
1086  * with @uri inside the recent manager.
1087  *
1088  * Return value: %TRUE if the resource was found, %FALSE otherwise.
1089  *
1090  * Since: 2.10
1091  */
1092 gboolean
1093 gtk_recent_manager_has_item (GtkRecentManager *manager,
1094                              const gchar      *uri)
1095 {
1096   GtkRecentManagerPrivate *priv;
1097
1098   g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
1099   g_return_val_if_fail (uri != NULL, FALSE);
1100
1101   priv = manager->priv;
1102   g_return_val_if_fail (priv->recent_items != NULL, FALSE);
1103
1104   return g_bookmark_file_has_item (priv->recent_items, uri);
1105 }
1106
1107 static gboolean
1108 build_recent_info (GBookmarkFile  *bookmarks,
1109                    GtkRecentInfo  *info)
1110 {
1111   gchar **apps, **groups;
1112   gsize apps_len, groups_len, i;
1113
1114   g_assert (bookmarks != NULL);
1115   g_assert (info != NULL);
1116   
1117   info->display_name = g_bookmark_file_get_title (bookmarks, info->uri, NULL);
1118   info->description = g_bookmark_file_get_description (bookmarks, info->uri, NULL);
1119   info->mime_type = g_bookmark_file_get_mime_type (bookmarks, info->uri, NULL);
1120     
1121   info->is_private = g_bookmark_file_get_is_private (bookmarks, info->uri, NULL);
1122   
1123   info->added = g_bookmark_file_get_added (bookmarks, info->uri, NULL);
1124   info->modified = g_bookmark_file_get_modified (bookmarks, info->uri, NULL);
1125   info->visited = g_bookmark_file_get_visited (bookmarks, info->uri, NULL);
1126   
1127   groups = g_bookmark_file_get_groups (bookmarks, info->uri, &groups_len, NULL);
1128   for (i = 0; i < groups_len; i++)
1129     {
1130       gchar *group_name = g_strdup (groups[i]);
1131       
1132       info->groups = g_slist_append (info->groups, group_name);
1133     }
1134
1135   g_strfreev (groups);
1136   
1137   apps = g_bookmark_file_get_applications (bookmarks, info->uri, &apps_len, NULL);
1138   for (i = 0; i < apps_len; i++)
1139     {
1140       gchar *app_name, *app_exec;
1141       guint count;
1142       time_t stamp;
1143       RecentAppInfo *app_info;
1144       gboolean res;
1145       
1146       app_name = apps[i];
1147       
1148       res = g_bookmark_file_get_app_info (bookmarks, info->uri, app_name,
1149                                           &app_exec,
1150                                           &count,
1151                                           &stamp,
1152                                           NULL);
1153       if (!res)
1154         continue;
1155       
1156       app_info = recent_app_info_new (app_name);
1157       app_info->exec = app_exec;
1158       app_info->count = count;
1159       app_info->stamp = stamp;
1160       
1161       info->applications = g_slist_append (info->applications,
1162                                            app_info);
1163       g_hash_table_replace (info->apps_lookup, app_info->name, app_info);
1164     }
1165   
1166   g_strfreev (apps);
1167   
1168   return TRUE; 
1169 }
1170
1171 /**
1172  * gtk_recent_manager_lookup_item:
1173  * @manager: a #GtkRecentManager
1174  * @uri: a URI
1175  * @error: a return location for a #GError, or %NULL
1176  *
1177  * Searches for a URI inside the recently used resources list, and
1178  * returns a structure containing informations about the resource
1179  * like its MIME type, or its display name.
1180  *
1181  * Return value: a #GtkRecentInfo structure containing information
1182  *   about the resource pointed by @uri, or %NULL if the URI was
1183  *   not registered in the recently used resources list.  Free with
1184  *   gtk_recent_info_unref().
1185  *
1186  * Since: 2.10
1187  */
1188 GtkRecentInfo *
1189 gtk_recent_manager_lookup_item (GtkRecentManager  *manager,
1190                                 const gchar       *uri,
1191                                 GError           **error)
1192 {
1193   GtkRecentManagerPrivate *priv;
1194   GtkRecentInfo *info = NULL;
1195   gboolean res;
1196   
1197   g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1198   g_return_val_if_fail (uri != NULL, NULL);
1199   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1200   
1201   priv = manager->priv;
1202   if (!priv->recent_items)
1203     {
1204       priv->recent_items = g_bookmark_file_new ();
1205       priv->size = 0;
1206
1207       g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1208                    GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1209                    _("Unable to find an item with URI '%s'"),
1210                    uri);
1211
1212       return NULL;
1213     }
1214   
1215   if (!g_bookmark_file_has_item (priv->recent_items, uri))
1216     {
1217       g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1218                    GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1219                    _("Unable to find an item with URI '%s'"),
1220                    uri);
1221       return NULL;
1222     }
1223   
1224   info = gtk_recent_info_new (uri);
1225   g_return_val_if_fail (info != NULL, NULL);
1226   
1227   /* fill the RecentInfo structure with the data retrieved by our
1228    * parser object from the storage file 
1229    */
1230   res = build_recent_info (priv->recent_items, info);
1231   if (!res)
1232     {
1233       gtk_recent_info_free (info);
1234       
1235       return NULL;
1236     }
1237  
1238   return gtk_recent_info_ref (info);
1239 }
1240
1241 /**
1242  * gtk_recent_manager_move_item:
1243  * @manager: a #GtkRecentManager
1244  * @uri: the URI of a recently used resource
1245  * @new_uri: the new URI of the recently used resource, or %NULL to
1246  *    remove the item pointed by @uri in the list
1247  * @error: a return location for a #GError, or %NULL
1248  *
1249  * Changes the location of a recently used resource from @uri to @new_uri.
1250  * 
1251  * Please note that this function will not affect the resource pointed
1252  * by the URIs, but only the URI used in the recently used resources list.
1253  *
1254  * Return value: %TRUE on success.
1255  *
1256  * Since: 2.10
1257  */ 
1258 gboolean
1259 gtk_recent_manager_move_item (GtkRecentManager  *recent_manager,
1260                               const gchar       *uri,
1261                               const gchar       *new_uri,
1262                               GError           **error)
1263 {
1264   GtkRecentManagerPrivate *priv;
1265   GError *move_error;
1266   gboolean res;
1267   
1268   g_return_val_if_fail (GTK_IS_RECENT_MANAGER (recent_manager), FALSE);
1269   g_return_val_if_fail (uri != NULL, FALSE);
1270   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1271   
1272   priv = recent_manager->priv;
1273
1274   if (!g_bookmark_file_has_item (priv->recent_items, uri))
1275     {
1276       g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1277                    GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
1278                    _("Unable to find an item with URI '%s'"),
1279                    uri);
1280       return FALSE;
1281     }
1282   
1283   move_error = NULL;
1284   res = g_bookmark_file_move_item (priv->recent_items,
1285                                    uri, new_uri,
1286                                    &move_error);
1287   if (move_error)
1288     {
1289       g_propagate_error (error, move_error);
1290       return FALSE;
1291     }
1292   
1293   priv->is_dirty = TRUE;
1294
1295   gtk_recent_manager_changed (recent_manager);
1296   
1297   return TRUE;
1298 }
1299
1300 /**
1301  * gtk_recent_manager_get_items:
1302  * @manager: a #GtkRecentManager
1303  *
1304  * Gets the list of recently used resources.
1305  *
1306  * Return value: a list of newly allocated #GtkRecentInfo objects. Use
1307  *   gtk_recent_info_unref() on each item inside the list, and then
1308  *   free the list itself using g_list_free().
1309  *
1310  * Since: 2.10
1311  */
1312 GList *
1313 gtk_recent_manager_get_items (GtkRecentManager *manager)
1314 {
1315   GtkRecentManagerPrivate *priv;
1316   GList *retval = NULL;
1317   gchar **uris;
1318   gsize uris_len, i;
1319   
1320   g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1321   
1322   priv = manager->priv;
1323   if (!priv->recent_items)
1324     return NULL;
1325
1326   if (priv->limit == 0)
1327     return NULL;
1328   
1329   uris = g_bookmark_file_get_uris (priv->recent_items, &uris_len);
1330   for (i = 0; i < uris_len; i++)
1331     {
1332       GtkRecentInfo *info;
1333       gboolean res;
1334       
1335       info = gtk_recent_info_new (uris[i]);
1336       res = build_recent_info (priv->recent_items, info);
1337       if (!res)
1338         {
1339           g_warning ("Unable to create a RecentInfo object for "
1340                      "item with URI `%s'",
1341                      uris[i]);
1342           gtk_recent_info_free (info);
1343           
1344           continue;
1345         }
1346       
1347       retval = g_list_prepend (retval, info);
1348     }
1349   
1350   g_strfreev (uris);
1351     
1352   /* clamp the list, if a limit is present */
1353   if ((priv->limit != -1) &&
1354       (g_list_length (retval) > priv->limit))
1355     {
1356       GList *clamp, *l;
1357       
1358       clamp = g_list_nth (retval, priv->limit - 1);
1359       
1360       if (!clamp)
1361         return retval;
1362       
1363       l = clamp->next;
1364       clamp->next = NULL;
1365       
1366       g_list_foreach (l, (GFunc) gtk_recent_info_free, NULL);
1367       g_list_free (l);
1368     }
1369   
1370   return retval;
1371 }
1372
1373 static void
1374 purge_recent_items_list (GtkRecentManager  *manager,
1375                          GError           **error)
1376 {
1377   GtkRecentManagerPrivate *priv = manager->priv;
1378
1379   if (!priv->recent_items)
1380     return;
1381   
1382   g_bookmark_file_free (priv->recent_items);
1383   priv->recent_items = NULL;
1384       
1385   priv->recent_items = g_bookmark_file_new ();
1386   priv->size = 0;
1387   priv->is_dirty = TRUE;
1388       
1389   /* emit the changed signal, to ensure that the purge is written */
1390   gtk_recent_manager_changed (manager);
1391 }
1392
1393 /**
1394  * gtk_recent_manager_purge_items:
1395  * @manager: a #GtkRecentManager
1396  * @error: a return location for a #GError, or %NULL
1397  *
1398  * Purges every item from the recently used resources list.
1399  *
1400  * Return value: the number of items that have been removed from the
1401  *   recently used resources list.
1402  *
1403  * Since: 2.10
1404  */
1405 gint
1406 gtk_recent_manager_purge_items (GtkRecentManager  *manager,
1407                                 GError           **error)
1408 {
1409   GtkRecentManagerPrivate *priv;
1410   gint count, purged;
1411   
1412   g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), -1);
1413
1414   priv = manager->priv;
1415   if (!priv->recent_items)
1416     return 0;
1417   
1418   count = g_bookmark_file_get_size (priv->recent_items);
1419   if (!count)
1420     return 0;
1421   
1422   purge_recent_items_list (manager, error);
1423   
1424   purged = count - g_bookmark_file_get_size (priv->recent_items);
1425
1426   return purged;
1427 }
1428
1429 static void
1430 gtk_recent_manager_changed (GtkRecentManager *recent_manager)
1431 {
1432   g_signal_emit (recent_manager, signal_changed, 0);
1433 }
1434
1435 /*****************
1436  * GtkRecentInfo *
1437  *****************/
1438  
1439 GType
1440 gtk_recent_info_get_type (void)
1441 {
1442   static GType info_type = 0;
1443   
1444   if (!info_type)
1445     info_type = g_boxed_type_register_static ("GtkRecentInfo",
1446                                               (GBoxedCopyFunc) gtk_recent_info_ref,
1447                                               (GBoxedFreeFunc) gtk_recent_info_unref);
1448   return info_type;
1449 }
1450
1451 static GtkRecentInfo *
1452 gtk_recent_info_new (const gchar *uri)
1453 {
1454   GtkRecentInfo *info;
1455
1456   g_assert (uri != NULL);
1457
1458   info = g_new0 (GtkRecentInfo, 1);
1459   info->uri = g_strdup (uri);
1460   
1461   info->applications = NULL;
1462   info->apps_lookup = g_hash_table_new (g_str_hash, g_str_equal);
1463   
1464   info->groups = NULL;
1465   
1466   info->ref_count = 1;
1467
1468   return info;
1469 }
1470
1471 static void
1472 gtk_recent_info_free (GtkRecentInfo *recent_info)
1473 {
1474   if (!recent_info)
1475     return;
1476
1477   g_free (recent_info->uri);
1478   g_free (recent_info->display_name);
1479   g_free (recent_info->description);
1480   g_free (recent_info->mime_type);
1481   
1482   if (recent_info->applications)
1483     {
1484       g_slist_foreach (recent_info->applications,
1485                        (GFunc) recent_app_info_free,
1486                        NULL);
1487       g_slist_free (recent_info->applications);
1488       
1489       recent_info->applications = NULL;
1490     }
1491   
1492   if (recent_info->apps_lookup)
1493     g_hash_table_destroy (recent_info->apps_lookup);
1494
1495   if (recent_info->groups)
1496     {
1497       g_slist_foreach (recent_info->groups,
1498                        (GFunc) g_free,
1499                        NULL);
1500       g_slist_free (recent_info->groups);
1501
1502       recent_info->groups = NULL;
1503     }
1504   
1505   if (recent_info->icon)
1506     g_object_unref (recent_info->icon);
1507
1508   g_free (recent_info);
1509 }
1510
1511 /**
1512  * gtk_recent_info_ref:
1513  * @info: a #GtkRecentInfo
1514  *
1515  * Increases the reference count of @recent_info by one.
1516  *
1517  * Return value: the recent info object with its reference count increased
1518  *   by one.
1519  *
1520  * Since: 2.10
1521  */
1522 GtkRecentInfo *
1523 gtk_recent_info_ref (GtkRecentInfo *info)
1524 {
1525   g_return_val_if_fail (info != NULL, NULL);
1526   g_return_val_if_fail (info->ref_count > 0, NULL);
1527   
1528   info->ref_count += 1;
1529     
1530   return info;
1531 }
1532
1533 /**
1534  * gtk_recent_info_unref:
1535  * @info: a #GtkRecentInfo
1536  *
1537  * Decreases the reference count of @info by one.  If the reference
1538  * count reaches zero, @info is deallocated, and the memory freed.
1539  *
1540  * Since: 2.10
1541  */
1542 void
1543 gtk_recent_info_unref (GtkRecentInfo *info)
1544 {
1545   g_return_if_fail (info != NULL);
1546   g_return_if_fail (info->ref_count > 0);
1547
1548   info->ref_count -= 1;
1549   
1550   if (info->ref_count == 0)
1551     gtk_recent_info_free (info);
1552 }
1553
1554 /**
1555  * gtk_recent_info_get_uri:
1556  * @info: a #GtkRecentInfo
1557  *
1558  * Gets the URI of the resource.
1559  *
1560  * Return value: the URI of the resource.  The returned string is
1561  *   owned by the recent manager, and should not be freed.
1562  *
1563  * Since: 2.10
1564  */
1565 G_CONST_RETURN gchar *
1566 gtk_recent_info_get_uri (GtkRecentInfo *info)
1567 {
1568   g_return_val_if_fail (info != NULL, NULL);
1569   
1570   return info->uri;
1571 }
1572
1573 /**
1574  * gtk_recent_info_get_display_name:
1575  * @info: a #GtkRecentInfo
1576  *
1577  * Gets the name of the resource.  If none has been defined, the basename
1578  * of the resource is obtained.
1579  *
1580  * Return value: the display name of the resource.  The returned string
1581  *   is owned by the recent manager, and should not be freed.
1582  *
1583  * Since: 2.10
1584  */
1585 G_CONST_RETURN gchar *
1586 gtk_recent_info_get_display_name (GtkRecentInfo *info)
1587 {
1588   g_return_val_if_fail (info != NULL, NULL);
1589   
1590   if (!info->display_name)
1591     info->display_name = gtk_recent_info_get_short_name (info);
1592   
1593   return info->display_name;
1594 }
1595
1596 /**
1597  * gtk_recent_info_get_description:
1598  * @info: a #GtkRecentInfo
1599  *
1600  * Gets the (short) description of the resource.
1601  *
1602  * Return value: the description of the resource.  The returned string
1603  *   is owned by the recent manager, and should not be freed.
1604  *
1605  * Since: 2.10
1606  **/
1607 G_CONST_RETURN gchar *
1608 gtk_recent_info_get_description (GtkRecentInfo *info)
1609 {
1610   g_return_val_if_fail (info != NULL, NULL);
1611   
1612   return info->description;
1613 }
1614
1615 /**
1616  * gtk_recent_info_get_mime_type:
1617  * @info: a #GtkRecentInfo
1618  *
1619  * Gets the MIME type of the resource.
1620  *
1621  * Return value: the MIME type of the resource.  The returned string
1622  *   is owned by the recent manager, and should not be freed.
1623  *
1624  * Since: 2.10
1625  */
1626 G_CONST_RETURN gchar *
1627 gtk_recent_info_get_mime_type (GtkRecentInfo *info)
1628 {
1629   g_return_val_if_fail (info != NULL, NULL);
1630   
1631   if (!info->mime_type)
1632     info->mime_type = g_strdup (GTK_RECENT_DEFAULT_MIME);
1633   
1634   return info->mime_type;
1635 }
1636
1637 /**
1638  * gtk_recent_info_get_added:
1639  * @info: a #GtkRecentInfo
1640  *
1641  * Gets the timestamp (seconds from system's Epoch) when the resource
1642  * was added to the recently used resources list.
1643  *
1644  * Return value: the number of seconds elapsed from system's Epoch when
1645  *   the resource was added to the list, or -1 on failure.
1646  *
1647  * Since: 2.10
1648  */
1649 time_t
1650 gtk_recent_info_get_added (GtkRecentInfo *info)
1651 {
1652   g_return_val_if_fail (info != NULL, (time_t) -1);
1653   
1654   return info->added;
1655 }
1656
1657 /**
1658  * gtk_recent_info_get_modified:
1659  * @info: a #GtkRecentInfo
1660  *
1661  * Gets the timestamp (seconds from system's Epoch) when the resource
1662  * was last modified.
1663  *
1664  * Return value: the number of seconds elapsed from system's Epoch when
1665  *   the resource was last modified, or -1 on failure.
1666  *
1667  * Since: 2.10
1668  */
1669 time_t
1670 gtk_recent_info_get_modified (GtkRecentInfo *info)
1671 {
1672   g_return_val_if_fail (info != NULL, (time_t) -1);
1673   
1674   return info->modified;
1675 }
1676
1677 /**
1678  * gtk_recent_info_get_visited:
1679  * @info: a #GtkRecentInfo
1680  *
1681  * Gets the timestamp (seconds from system's Epoch) when the resource
1682  * was last visited.
1683  *
1684  * Return value: the number of seconds elapsed from system's Epoch when
1685  *   the resource was last visited, or -1 on failure.
1686  *
1687  * Since: 2.10
1688  */
1689 time_t
1690 gtk_recent_info_get_visited (GtkRecentInfo *info)
1691 {
1692   g_return_val_if_fail (info != NULL, (time_t) -1);
1693   
1694   return info->visited;
1695 }
1696
1697 /**
1698  * gtk_recent_info_get_private_hint:
1699  * @info: a #GtkRecentInfo
1700  *
1701  * Gets the value of the "private" flag.  Resources in the recently used
1702  * list that have this flag set to %TRUE should only be displayed by the
1703  * applications that have registered them.
1704  *
1705  * Return value: %TRUE if the private flag was found, %FALSE otherwise.
1706  *
1707  * Since: 2.10
1708  */
1709 gboolean
1710 gtk_recent_info_get_private_hint (GtkRecentInfo *info)
1711 {
1712   g_return_val_if_fail (info != NULL, FALSE);
1713   
1714   return info->is_private;
1715 }
1716
1717
1718 static RecentAppInfo *
1719 recent_app_info_new (const gchar *app_name)
1720 {
1721   RecentAppInfo *app_info;
1722
1723   g_assert (app_name != NULL);
1724   
1725   app_info = g_new0 (RecentAppInfo, 1);
1726   app_info->name = g_strdup (app_name);
1727   app_info->exec = NULL;
1728   app_info->count = 1;
1729   app_info->stamp = time (NULL);
1730   
1731   return app_info;
1732 }
1733
1734 static void
1735 recent_app_info_free (RecentAppInfo *app_info)
1736 {
1737   if (!app_info)
1738     return;
1739   
1740   if (app_info->name)
1741     g_free (app_info->name);
1742   
1743   if (app_info->exec)
1744     g_free (app_info->exec);
1745   
1746   g_free (app_info);
1747 }
1748
1749 /**
1750  * gtk_recent_info_get_application_info:
1751  * @info: a #GtkRecentInfo
1752  * @app_name: the name of the application that has registered this item
1753  * @app_exec: return location for the string containing the command line
1754  * @count: return location for the number of times this item was registered
1755  * @time_: return location for the timestamp this item was last registered
1756  *    for this application
1757  *
1758  * Gets the data regarding the application that has registered the resource
1759  * pointed by @info.
1760  *
1761  * If the command line contains any escape characters defined inside the
1762  * storage specification, they will be expanded.
1763  *
1764  * Return value: %TRUE if an application with @app_name has registered this
1765  *   resource inside the recently used list, or %FALSE otherwise.  You should
1766  *   free the returned command line using g_free().
1767  *
1768  * Since: 2.10
1769  */
1770 gboolean
1771 gtk_recent_info_get_application_info (GtkRecentInfo  *info,
1772                                       const gchar    *app_name,
1773                                       gchar         **app_exec,
1774                                       guint          *count,
1775                                       time_t         *time_)
1776 {
1777   RecentAppInfo *ai;
1778   
1779   g_return_val_if_fail (info != NULL, FALSE);
1780   g_return_val_if_fail (app_name != NULL, FALSE);
1781   
1782   ai = (RecentAppInfo *) g_hash_table_lookup (info->apps_lookup,
1783                                               app_name);
1784   if (!ai)
1785     {
1786       g_warning ("No registered application with name '%s' "
1787                  "for item with URI '%s' found",
1788                  app_name,
1789                  info->uri);
1790       return FALSE;
1791     }
1792   
1793   if (app_exec)
1794     *app_exec = ai->exec;
1795   
1796   if (count)
1797     *count = ai->count;
1798   
1799   if (time_)
1800     *time_ = ai->stamp;
1801
1802   return TRUE;
1803 }
1804
1805 /**
1806  * gtk_recent_info_get_applications:
1807  * @info: a #GtkRecentInfo
1808  * @length: return location for the length of the returned list, or %NULL
1809  *
1810  * Retrieves the list of applications that have registered this resource.
1811  *
1812  * Return value: a newly allocated %NULL-terminated array of strings.
1813  *   Use g_strfreev() to free it.
1814  *
1815  * Since: 2.10
1816  */                           
1817 gchar **
1818 gtk_recent_info_get_applications (GtkRecentInfo *info,
1819                                   gsize         *length)
1820 {
1821   GSList *l;
1822   gchar **retval;
1823   gsize n_apps, i;
1824   
1825   g_return_val_if_fail (info != NULL, NULL);
1826   
1827   if (!info->applications)
1828     {
1829       if (length)
1830         *length = 0;
1831       
1832       return NULL;    
1833     }
1834   
1835   n_apps = g_slist_length (info->applications);
1836   
1837   retval = g_new0 (gchar *, n_apps + 1);
1838   
1839   for (l = info->applications, i = 0;
1840        l != NULL;
1841        l = l->next)
1842     {
1843       RecentAppInfo *ai = (RecentAppInfo *) l->data;
1844       
1845       g_assert (ai != NULL);
1846       
1847       retval[i++] = g_strdup (ai->name);
1848     }
1849   retval[i] = NULL;
1850   
1851   if (length)
1852     *length = i;
1853   
1854   return retval;
1855 }
1856
1857 /**
1858  * gtk_recent_info_has_application:
1859  * @info: a #GtkRecentInfo
1860  * @app_name: a string containing an application name
1861  *
1862  * Checks whether an application registered this resource using @app_name.
1863  *
1864  * Return value: %TRUE if an application with name @app_name was found,
1865  *   %FALSE otherwise.
1866  *
1867  * Since: 2.10
1868  */
1869 gboolean
1870 gtk_recent_info_has_application (GtkRecentInfo *info,
1871                                  const gchar   *app_name)
1872 {
1873   g_return_val_if_fail (info != NULL, FALSE);
1874   g_return_val_if_fail (app_name != NULL, FALSE);
1875   
1876   return (NULL != g_hash_table_lookup (info->apps_lookup, app_name));
1877 }
1878
1879 /**
1880  * gtk_recent_info_last_application:
1881  * @info: a #GtkRecentInfo
1882  *
1883  * Gets the name of the last application that have registered the
1884  * recently used resource represented by @info.
1885  *
1886  * Return value: an application name.  Use g_free() to free it.
1887  *
1888  * Since: 2.10
1889  */
1890 gchar *
1891 gtk_recent_info_last_application (GtkRecentInfo  *info)
1892 {
1893   GSList *l;
1894   time_t last_stamp = (time_t) -1;
1895   gchar *name = NULL;
1896   
1897   g_return_val_if_fail (info != NULL, NULL);
1898   
1899   for (l = info->applications; l != NULL; l = l->next)
1900     {
1901       RecentAppInfo *ai = (RecentAppInfo *) l->data;
1902       
1903       if (ai->stamp > last_stamp)
1904         {
1905           name = ai->name;
1906           last_stamp = ai->stamp;
1907         }
1908     }
1909   
1910   return g_strdup (name);
1911 }
1912
1913 typedef struct
1914 {
1915   gint size;
1916   GdkPixbuf *pixbuf;
1917 } IconCacheElement;
1918
1919 static void
1920 icon_cache_element_free (IconCacheElement *element)
1921 {
1922   if (element->pixbuf)
1923     g_object_unref (element->pixbuf);
1924   g_free (element);
1925 }
1926
1927 static void
1928 icon_theme_changed (GtkIconTheme     *icon_theme)
1929 {
1930   GHashTable *cache;
1931
1932   /* Difference from the initial creation is that we don't
1933    * reconnect the signal
1934    */
1935   cache = g_hash_table_new_full (g_str_hash, g_str_equal,
1936                                  (GDestroyNotify)g_free,
1937                                  (GDestroyNotify)icon_cache_element_free);
1938   g_object_set_data_full (G_OBJECT (icon_theme), "gtk-recent-icon-cache",
1939                           cache, (GDestroyNotify)g_hash_table_destroy);
1940 }
1941
1942 /* TODO: use the GtkFileChooser's icon cache instead of our own to reduce
1943  * the memory footprint
1944  */
1945 static GdkPixbuf *
1946 get_cached_icon (const gchar *name,
1947                  gint         pixel_size)
1948 {
1949   GtkIconTheme *icon_theme;
1950   GHashTable *cache;
1951   IconCacheElement *element;
1952
1953   icon_theme = gtk_icon_theme_get_default ();
1954   cache = g_object_get_data (G_OBJECT (icon_theme), "gtk-recent-icon-cache");
1955
1956   if (!cache)
1957     {
1958       cache = g_hash_table_new_full (g_str_hash, g_str_equal,
1959                                      (GDestroyNotify)g_free,
1960                                      (GDestroyNotify)icon_cache_element_free);
1961
1962       g_object_set_data_full (G_OBJECT (icon_theme), "gtk-recent-icon-cache",
1963                               cache, (GDestroyNotify)g_hash_table_destroy);
1964       g_signal_connect (icon_theme, "changed",
1965                         G_CALLBACK (icon_theme_changed), NULL);
1966     }
1967
1968   element = g_hash_table_lookup (cache, name);
1969   if (!element)
1970     {
1971       element = g_new0 (IconCacheElement, 1);
1972       g_hash_table_insert (cache, g_strdup (name), element);
1973     }
1974
1975   if (element->size != pixel_size)
1976     {
1977       if (element->pixbuf)
1978         g_object_unref (element->pixbuf);
1979
1980       element->size = pixel_size;
1981       element->pixbuf = gtk_icon_theme_load_icon (icon_theme, name,
1982                                                   pixel_size, 0, NULL);
1983     }
1984
1985   return element->pixbuf ? g_object_ref (element->pixbuf) : NULL;
1986 }
1987
1988
1989 static GdkPixbuf *
1990 get_icon_for_mime_type (const char *mime_type,
1991                         gint        pixel_size)
1992 {
1993   const char *separator;
1994   GString *icon_name;
1995   GdkPixbuf *pixbuf;
1996
1997   separator = strchr (mime_type, '/');
1998   if (!separator)
1999     return NULL; /* maybe we should return a GError with "invalid MIME-type" */
2000
2001   icon_name = g_string_new ("gnome-mime-");
2002   g_string_append_len (icon_name, mime_type, separator - mime_type);
2003   g_string_append_c (icon_name, '-');
2004   g_string_append (icon_name, separator + 1);
2005   pixbuf = get_cached_icon (icon_name->str, pixel_size);
2006   g_string_free (icon_name, TRUE);
2007   if (pixbuf)
2008     return pixbuf;
2009
2010   icon_name = g_string_new ("gnome-mime-");
2011   g_string_append_len (icon_name, mime_type, separator - mime_type);
2012   pixbuf = get_cached_icon (icon_name->str, pixel_size);
2013   g_string_free (icon_name, TRUE);
2014
2015   return pixbuf;
2016 }
2017
2018 static GdkPixbuf *
2019 get_icon_fallback (const gchar *icon_name,
2020                    gint         size)
2021 {
2022   GtkIconTheme *icon_theme;
2023   GdkPixbuf *retval;
2024
2025   icon_theme = gtk_icon_theme_get_default ();
2026   
2027   retval = gtk_icon_theme_load_icon (icon_theme, icon_name,
2028                                      size,
2029                                      GTK_ICON_LOOKUP_USE_BUILTIN,
2030                                      NULL);
2031   g_assert (retval != NULL);
2032   
2033   return retval; 
2034 }
2035
2036 /**
2037  * gtk_recent_info_get_icon:
2038  * @info: a #GtkRecentInfo
2039  * @size: the size of the icon in pixels
2040  *
2041  * Retrieves the icon of size @size associated to the resource MIME type.
2042  *
2043  * Return value: a #GdkPixbuf containing the icon, or %NULL.
2044  *
2045  * Since: 2.10
2046  */
2047 GdkPixbuf *
2048 gtk_recent_info_get_icon (GtkRecentInfo *info,
2049                           gint           size)
2050 {
2051   GdkPixbuf *retval = NULL;
2052   
2053   g_return_val_if_fail (info != NULL, NULL);
2054   
2055   if (info->mime_type)
2056     retval = get_icon_for_mime_type (info->mime_type, size);
2057
2058   /* this should never fail */  
2059   if (!retval)
2060     retval = get_icon_fallback (GTK_STOCK_FILE, size);
2061   
2062   return retval;
2063 }
2064
2065 /**
2066  * gtk_recent_info_is_local:
2067  * @info: a #GtkRecentInfo
2068  *
2069  * Checks whether the resource is local or not by looking at the
2070  * scheme of its URI.
2071  *
2072  * Return value: %TRUE if the resource is local.
2073  *
2074  * Since: 2.10
2075  */
2076 gboolean
2077 gtk_recent_info_is_local (GtkRecentInfo *info)
2078 {
2079   g_return_val_if_fail (info != NULL, FALSE);
2080   
2081   return has_case_prefix (info->uri, "file:/");
2082 }
2083
2084 /**
2085  * gtk_recent_info_exists:
2086  * @info: a #GtkRecentInfo
2087  *
2088  * Checks whether the resource pointed by @info still exists.  At
2089  * the moment this check is done only on resources pointing to local files.
2090  *
2091  * Return value: %TRUE if the resource exists
2092  *
2093  * Since: 2.10
2094  */
2095 gboolean
2096 gtk_recent_info_exists (GtkRecentInfo *info)
2097 {
2098   gchar *filename;
2099   struct stat stat_buf;
2100   gboolean retval = FALSE;
2101   
2102   g_return_val_if_fail (info != NULL, FALSE);
2103   
2104   /* we guarantee only local resources */
2105   if (!gtk_recent_info_is_local (info))
2106     return FALSE;
2107   
2108   filename = g_filename_from_uri (info->uri, NULL, NULL);
2109   if (filename)
2110     {
2111       if (stat (filename, &stat_buf) == 0)
2112         retval = TRUE;
2113      
2114       g_free (filename);
2115     }
2116   
2117   return retval;
2118 }
2119
2120 /**
2121  * gtk_recent_info_match:
2122  * @info_a: a #GtkRecentInfo
2123  * @info_b: a #GtkRecentInfo
2124  *
2125  * Checks whether two #GtkRecentInfo structures point to the same
2126  * resource.
2127  *
2128  * Return value: %TRUE if both #GtkRecentInfo structures point to se same
2129  *   resource, %FALSE otherwise.
2130  *
2131  * Since: 2.10
2132  */
2133 gboolean
2134 gtk_recent_info_match (GtkRecentInfo *info_a,
2135                        GtkRecentInfo *info_b)
2136 {
2137   g_return_val_if_fail (info_a != NULL, FALSE);
2138   g_return_val_if_fail (info_b != NULL, FALSE);
2139   
2140   return (0 == strcmp (info_a->uri, info_b->uri));
2141 }
2142
2143 /* taken from gnome-vfs-uri.c */
2144 static const gchar *
2145 get_method_string (const gchar  *substring, 
2146                    gchar       **method_string)
2147 {
2148   const gchar *p;
2149   char *method;
2150         
2151   for (p = substring;
2152        g_ascii_isalnum (*p) || *p == '+' || *p == '-' || *p == '.';
2153        p++)
2154     ;
2155
2156   if (*p == ':'
2157 #ifdef G_OS_WIN32
2158                 &&
2159       !(p == substring + 1 && g_ascii_isalpha (*substring))
2160 #endif
2161                                                            )
2162     {
2163       /* Found toplevel method specification.  */
2164       method = g_strndup (substring, p - substring);
2165       *method_string = g_ascii_strdown (method, -1);
2166       g_free (method);
2167       p++;
2168     }
2169   else
2170     {
2171       *method_string = g_strdup ("file");
2172       p = substring;
2173     }
2174   
2175   return p;
2176 }
2177
2178 /* Stolen from gnome_vfs_make_valid_utf8() */
2179 static char *
2180 make_valid_utf8 (const char *name)
2181 {
2182   GString *string;
2183   const char *remainder, *invalid;
2184   int remaining_bytes, valid_bytes;
2185
2186   string = NULL;
2187   remainder = name;
2188   remaining_bytes = name ? strlen (name) : 0;
2189
2190   while (remaining_bytes != 0)
2191     {
2192       if (g_utf8_validate (remainder, remaining_bytes, &invalid))
2193         break;
2194       
2195       valid_bytes = invalid - remainder;
2196       
2197       if (string == NULL)
2198         string = g_string_sized_new (remaining_bytes);
2199       
2200       g_string_append_len (string, remainder, valid_bytes);
2201       g_string_append_c (string, '?');
2202       
2203       remaining_bytes -= valid_bytes + 1;
2204       remainder = invalid + 1;
2205     }
2206   
2207   if (string == NULL)
2208     return g_strdup (name);
2209
2210   g_string_append (string, remainder);
2211   g_assert (g_utf8_validate (string->str, -1, NULL));
2212
2213   return g_string_free (string, FALSE);
2214 }
2215
2216 static gchar *
2217 get_uri_shortname_for_display (const gchar *uri)
2218 {
2219   gchar *name = NULL;
2220   gboolean validated = FALSE;
2221
2222   if (has_case_prefix (uri, "file:/"))
2223     {
2224       gchar *local_file;
2225       
2226       local_file = g_filename_from_uri (uri, NULL, NULL);
2227       
2228       if (local_file)
2229         {
2230           name = g_filename_display_basename (local_file);
2231           validated = TRUE;
2232         }
2233                 
2234       g_free (local_file);
2235     } 
2236   
2237   if (!name)
2238     {
2239       gchar *method;
2240       gchar *local_file;
2241       const gchar *rest;
2242       
2243       rest = get_method_string (uri, &method);
2244       local_file = g_filename_display_basename (rest);
2245       
2246       name = g_strdup_printf ("%s: %s", method, local_file);
2247       
2248       g_free (local_file);
2249       g_free (method);
2250     }
2251   
2252   g_assert (name != NULL);
2253   
2254   if (!validated && !g_utf8_validate (name, -1, NULL))
2255     {
2256       gchar *utf8_name;
2257       
2258       utf8_name = make_valid_utf8 (name);
2259       g_free (name);
2260       
2261       name = utf8_name;
2262     }
2263
2264   return name;
2265 }
2266
2267 /**
2268  * gtk_recent_info_get_short_name:
2269  * @info: an #GtkRecentInfo
2270  *
2271  * Computes a valid UTF-8 string that can be used as the name of the item in a
2272  * menu or list.  For example, calling this function on an item that refers to
2273  * "file:///foo/bar.txt" will yield "bar.txt".
2274  *
2275  * Return value: A newly-allocated string in UTF-8 encoding; free it with
2276  *   g_free().
2277  *
2278  * Since: 2.10
2279  */
2280 gchar *
2281 gtk_recent_info_get_short_name (GtkRecentInfo *info)
2282 {
2283   gchar *short_name;
2284
2285   g_return_val_if_fail (info != NULL, NULL);
2286
2287   if (info->uri == NULL)
2288     return NULL;
2289
2290   short_name = get_uri_shortname_for_display (info->uri);
2291
2292   return short_name;
2293 }
2294
2295 /**
2296  * gtk_recent_info_get_uri_display:
2297  * @info: a #GtkRecentInfo
2298  *
2299  * Gets a displayable version of the resource's URI.  If the resource
2300  * is local, it returns a local path; if the resource is not local,
2301  * it returns the UTF-8 encoded content of gtk_recent_info_get_uri().
2302  *
2303  * Return value: a UTF-8 string containing the resource's URI or %NULL
2304  *
2305  * Since: 2.10
2306  */
2307 gchar *
2308 gtk_recent_info_get_uri_display (GtkRecentInfo *info)
2309 {
2310   gchar *retval;
2311   
2312   g_return_val_if_fail (info != NULL, NULL);
2313
2314   retval = NULL;
2315   if (gtk_recent_info_is_local (info))
2316     {
2317       gchar *filename;
2318
2319       filename = g_filename_from_uri (info->uri, NULL, NULL);
2320       if (!filename)
2321         return NULL;
2322       
2323       retval = g_filename_to_utf8 (filename, -1, NULL, NULL, NULL);
2324       g_free (filename);
2325     }
2326   else
2327     {
2328       retval = make_valid_utf8 (info->uri);
2329     }
2330
2331   return retval;
2332 }
2333
2334 /**
2335  * gtk_recent_info_get_age:
2336  * @info: a #GtkRecentInfo
2337  *
2338  * Gets the number of days elapsed since the last update of the resource
2339  * pointed by @info.
2340  *
2341  * Return value: a positive integer containing the number of days elapsed
2342  *   since the time this resource was last modified.  
2343  *
2344  * Since: 2.10
2345  */
2346 gint
2347 gtk_recent_info_get_age (GtkRecentInfo *info)
2348 {
2349   time_t now, delta;
2350   gint retval;
2351
2352   g_return_val_if_fail (info != NULL, -1);
2353
2354   now = time (NULL);
2355   
2356   delta = now - info->modified;
2357   
2358   retval = (gint) (delta / (60 * 60 * 24));
2359   
2360   return retval;
2361 }
2362
2363 /**
2364  * gtk_recent_info_get_groups:
2365  * @info: a #GtkRecentInfo
2366  * @length: return location for the number of groups returned, or %NULL
2367  *
2368  * Returns all groups registered for the recently used item @info.  The
2369  * array of returned group names will be %NULL terminated, so length might
2370  * optionally be %NULL.
2371  *
2372  * Return value: a newly allocated %NULL terminated array of strings.  Use
2373  *   g_strfreev() to free it.
2374  *
2375  * Since: 2.10
2376  */
2377 gchar **
2378 gtk_recent_info_get_groups (GtkRecentInfo *info,
2379                             gsize         *length)
2380 {
2381   GSList *l;
2382   gchar **retval;
2383   gsize n_groups, i;
2384   
2385   g_return_val_if_fail (info != NULL, NULL);
2386   
2387   if (!info->groups)
2388     {
2389       if (length)
2390         *length = 0;
2391       
2392       return NULL;
2393     }
2394   
2395   n_groups = g_slist_length (info->groups);
2396   
2397   retval = g_new0 (gchar *, n_groups + 1);
2398   
2399   for (l = info->groups, i = 0;
2400        l != NULL;
2401        l = l->next)
2402     {
2403       gchar *group_name = (gchar *) l->data;
2404       
2405       g_assert (group_name != NULL);
2406       
2407       retval[i++] = g_strdup (group_name);
2408     }
2409   retval[i] = NULL;
2410   
2411   if (length)
2412     *length = i;
2413   
2414   return retval;
2415 }
2416
2417 /**
2418  * gtk_recent_info_has_group:
2419  * @info: a #GtkRecentInfo
2420  * @group_name: name of a group
2421  *
2422  * Checks whether @group_name appears inside the groups registered for the
2423  * recently used item @info.
2424  *
2425  * Return value: %TRUE if the group was found.
2426  *
2427  * Since: 2.10
2428  */
2429 gboolean
2430 gtk_recent_info_has_group (GtkRecentInfo *info,
2431                            const gchar   *group_name)
2432 {
2433   GSList *l;
2434   
2435   g_return_val_if_fail (info != NULL, FALSE);
2436   g_return_val_if_fail (group_name != NULL, FALSE);
2437
2438   if (!info->groups)
2439     return FALSE;
2440
2441   for (l = info->groups; l != NULL; l = l->next)
2442     {
2443       gchar *g = (gchar *) l->data;
2444
2445       if (strcmp (g, group_name) == 0)
2446         return TRUE;
2447     }
2448
2449   return FALSE;
2450 }
2451
2452 #define __GTK_RECENT_MANAGER_C__
2453 #include "gtkaliasdef.c"