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