gtkrecentmanager.c 63.4 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
 * gtkrecentmanager.c: a manager for the recently used resources
 *
 * Copyright (C) 2006 Emmanuele Bassi
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Javier Jardón's avatar
Javier Jardón committed
17
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
18 19
 */

20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
/**
 * SECTION:gtkrecentmanager
 * @Title: GtkRecentManager
 * @short_description: Managing recently used files
 * @See_Also: #GBookmarkFile, #GtkSettings, #GtkRecentChooser
 *
 * #GtkRecentManager provides a facility for adding, removing and
 * looking up recently used files. Each recently used file is
 * identified by its URI, and has meta-data associated to it, like
 * the names and command lines of the applications that have
 * registered it, the number of time each application has registered
 * the same file, the mime type of the file and whether the file
 * should be displayed only by the applications that have
 * registered it.
 *
35
 * The recently used files list is per user.
36 37 38 39 40 41 42
 *
 * The #GtkRecentManager acts like a database of all the recently
 * used files. You can create new #GtkRecentManager objects, but
 * it is more efficient to use the default manager created by GTK+.
 *
 * Adding a new recently used file is as simple as:
 *
43
 * |[<!-- language="C" -->
44 45 46 47 48 49 50 51 52 53 54 55
 * GtkRecentManager *manager;
 *
 * manager = gtk_recent_manager_get_default ();
 * gtk_recent_manager_add_item (manager, file_uri);
 * ]|
 *
 * The #GtkRecentManager will try to gather all the needed information
 * from the file itself through GIO.
 *
 * Looking up the meta-data associated with a recently used file
 * given its URI requires calling gtk_recent_manager_lookup_item():
 *
56
 * |[<!-- language="C" -->
57 58 59 60 61
 * GtkRecentManager *manager;
 * GtkRecentInfo *info;
 * GError *error = NULL;
 *
 * manager = gtk_recent_manager_get_default ();
62
 * info = gtk_recent_manager_lookup_item (manager, file_uri, &error);
63 64
 * if (error)
 *   {
65
 *     g_warning ("Could not find the file: %s", error->message);
66 67 68 69
 *     g_error_free (error);
 *   }
 * else
 *  {
70
 *    // Use the info object
71 72 73 74 75
 *    gtk_recent_info_unref (info);
 *  }
 * ]|
 *
 * In order to retrieve the list of recently used files, you can use
76
 * gtk_recent_manager_get_items(), which returns a list of #GtkRecentInfo-structs.
77 78 79 80
 *
 * A #GtkRecentManager is the model used to populate the contents of
 * one, or more #GtkRecentChooser implementations.
 *
81
 * Note that the maximum age of the recently used files list is
82
 * controllable through the #GtkSettings:gtk-recent-files-max-age
83
 * property.
84 85 86 87
 *
 * Recently used files are supported since GTK+ 2.10.
 */

88 89 90 91 92 93 94 95 96 97 98 99
#include "config.h"

#include <sys/types.h>
#include <sys/stat.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include <errno.h>
#include <string.h>
#include <stdlib.h>
#include <glib.h>
#include <glib/gstdio.h>
100
#include <gio/gio.h>
101 102 103

#include "gtkrecentmanager.h"
#include "gtkintl.h"
Emmanuele Bassi's avatar
Emmanuele Bassi committed
104
#include "gtksettings.h"
105 106 107 108 109 110
#include "gtkicontheme.h"
#include "gtktypebuiltins.h"
#include "gtkprivate.h"
#include "gtkmarshalers.h"

/* the file where we store the recently used items */
111
#define GTK_RECENTLY_USED_FILE	"recently-used.xbel"
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

/* return all items by default */
#define DEFAULT_LIMIT	-1

/* keep in sync with xdgmime */
#define GTK_RECENT_DEFAULT_MIME	"application/octet-stream"

typedef struct
{
  gchar *name;
  gchar *exec;
  
  guint count;
  
  time_t stamp;
} RecentAppInfo;

129 130 131
/**
 * GtkRecentInfo:
 *
132 133
 * #GtkRecentInfo-struct contains private data only, and should
 * be accessed using the provided API.
134
 *
135
 * #GtkRecentInfo constains all the meta-data
136 137 138 139
 * associated with an entry in the recently used files list.
 *
 * Since: 2.10
 */
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
struct _GtkRecentInfo
{
  gchar *uri;
  
  gchar *display_name;
  gchar *description;
  
  time_t added;
  time_t modified;
  time_t visited;
  
  gchar *mime_type;
  
  GSList *applications;
  GHashTable *apps_lookup;
  
  GSList *groups;
  
  gboolean is_private;
  
  GdkPixbuf *icon;
  
  gint ref_count;
};

struct _GtkRecentManagerPrivate
{
  gchar *filename;

  guint is_dirty : 1;
  
  gint size;

  GBookmarkFile *recent_items;
174 175

  GFileMonitor *monitor;
176 177 178

  guint changed_timeout;
  guint changed_age;
179 180 181 182 183 184 185 186 187 188 189
};

enum
{
  PROP_0,

  PROP_FILENAME,  
  PROP_LIMIT,
  PROP_SIZE
};

190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
static void     gtk_recent_manager_dispose             (GObject           *object);
static void     gtk_recent_manager_finalize            (GObject           *object);
static void     gtk_recent_manager_set_property        (GObject           *object,
						        guint              prop_id,
						        const GValue      *value,
						        GParamSpec        *pspec);
static void     gtk_recent_manager_get_property        (GObject           *object,
						        guint              prop_id,
						        GValue            *value,
						        GParamSpec        *pspec);
static void     gtk_recent_manager_add_item_query_info (GObject           *source_object,
                                                        GAsyncResult      *res,
                                                        gpointer           user_data);
static void     gtk_recent_manager_monitor_changed     (GFileMonitor      *monitor,
                                                        GFile             *file,
                                                        GFile             *other_file,
                                                        GFileMonitorEvent  event_type,
                                                        gpointer           user_data);
static void     gtk_recent_manager_changed             (GtkRecentManager  *manager);
static void     gtk_recent_manager_real_changed        (GtkRecentManager  *manager);
static void     gtk_recent_manager_set_filename        (GtkRecentManager  *manager,
                                                        const gchar       *filename);
212 213
static void     gtk_recent_manager_clamp_to_age        (GtkRecentManager  *manager,
                                                        gint               age);
214
static void     gtk_recent_manager_enabled_changed     (GtkRecentManager  *manager);
215

216 217 218 219 220 221 222 223 224 225

static void build_recent_items_list (GtkRecentManager  *manager);
static void purge_recent_items_list (GtkRecentManager  *manager,
                                     GError           **error);

static RecentAppInfo *recent_app_info_new  (const gchar   *app_name);
static void           recent_app_info_free (RecentAppInfo *app_info);

static GtkRecentInfo *gtk_recent_info_new  (const gchar   *uri);
static void           gtk_recent_info_free (GtkRecentInfo *recent_info);
226 227 228

static guint signal_changed = 0;

229 230
static GtkRecentManager *recent_manager_singleton = NULL;

231
G_DEFINE_TYPE_WITH_PRIVATE (GtkRecentManager, gtk_recent_manager, G_TYPE_OBJECT)
232

Matthias Clasen's avatar
Matthias Clasen committed
233 234 235 236
static void
filename_warning (const gchar *format, 
                  const gchar *filename, 
                  const gchar *message)
237
{
Matthias Clasen's avatar
Matthias Clasen committed
238
  gchar *utf8 = g_filename_to_utf8 (filename, -1, NULL, NULL, NULL);
239 240 241 242
  g_warning (format, utf8 ? utf8 : "(invalid filename)", message);
  g_free (utf8);
}

Matthias Clasen's avatar
Matthias Clasen committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
/* Test of haystack has the needle prefix, comparing case
 * insensitive. haystack may be UTF-8, but needle must
 * contain only lowercase ascii. */
static gboolean
has_case_prefix (const gchar *haystack, 
                 const gchar *needle)
{
  const gchar *h, *n;

  /* Eat one character at a time. */
  h = haystack;
  n = needle;

  while (*n && *h && *n == g_ascii_tolower (*h))
    {
      n++;
      h++;
    }

  return *n == '\0';
}

265 266 267
GQuark
gtk_recent_manager_error_quark (void)
{
268
  return g_quark_from_static_string ("gtk-recent-manager-error-quark");
269 270 271 272 273 274 275 276 277
}

static void
gtk_recent_manager_class_init (GtkRecentManagerClass *klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  
  gobject_class->set_property = gtk_recent_manager_set_property;
  gobject_class->get_property = gtk_recent_manager_get_property;
278
  gobject_class->dispose = gtk_recent_manager_dispose;
279 280 281
  gobject_class->finalize = gtk_recent_manager_finalize;
  
  /**
282
   * GtkRecentManager:filename:
283 284 285 286 287 288 289 290 291 292 293 294
   *
   * The full path to the file to be used to store and read the recently
   * used resources list
   *
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
		  		   PROP_FILENAME,
				   g_param_spec_string ("filename",
					   		P_("Filename"),
							P_("The full path to the file to be used to store and read the list"),
							NULL,
295
							(G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE)));
296

297
  /**
298
   * GtkRecentManager:size:
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
   * 
   * The size of the recently used resources list.
   *
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
		  		   PROP_SIZE,
				   g_param_spec_int ("size",
					   	     P_("Size"),
						     P_("The size of the recently used resources list"),
						     -1,
						     G_MAXINT,
						     0,
						     G_PARAM_READABLE));
  
  /**
315
   * GtkRecentManager::changed:
316 317 318
   * @recent_manager: the recent manager
   *
   * Emitted when the current recently used resources manager changes its
319 320
   * contents, either by calling gtk_recent_manager_add_item() or by another
   * application.
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
   *
   * Since: 2.10
   */
  signal_changed =
    g_signal_new (I_("changed"),
		  G_TYPE_FROM_CLASS (klass),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkRecentManagerClass, changed),
		  NULL, NULL,
		  g_cclosure_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
  
  klass->changed = gtk_recent_manager_real_changed;
}

static void
gtk_recent_manager_init (GtkRecentManager *manager)
{
  GtkRecentManagerPrivate *priv;
340
  GtkSettings *settings;
341

342
  manager->priv = gtk_recent_manager_get_instance_private (manager);
343 344
  priv = manager->priv;

345
  priv->size = 0;
346
  priv->filename = NULL;
347 348 349 350

  settings = gtk_settings_get_default ();
  g_signal_connect_swapped (settings, "notify::gtk-recent-files-enabled",
                            G_CALLBACK (gtk_recent_manager_enabled_changed), manager);
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
}

static void
gtk_recent_manager_set_property (GObject               *object,
				 guint                  prop_id,
				 const GValue          *value,
				 GParamSpec            *pspec)
{
  GtkRecentManager *recent_manager = GTK_RECENT_MANAGER (object);
 
  switch (prop_id)
    {
    case PROP_FILENAME:
      gtk_recent_manager_set_filename (recent_manager, g_value_get_string (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_recent_manager_get_property (GObject               *object,
				 guint                  prop_id,
				 GValue                *value,
				 GParamSpec            *pspec)
{
  GtkRecentManager *recent_manager = GTK_RECENT_MANAGER (object);
  
  switch (prop_id)
    {
    case PROP_FILENAME:
      g_value_set_string (value, recent_manager->priv->filename);
      break;
    case PROP_SIZE:
      g_value_set_int (value, recent_manager->priv->size);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
} 

static void
395
gtk_recent_manager_finalize (GObject *object)
396 397 398 399
{
  GtkRecentManager *manager = GTK_RECENT_MANAGER (object);
  GtkRecentManagerPrivate *priv = manager->priv;

400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
  g_free (priv->filename);

  if (priv->recent_items != NULL)
    g_bookmark_file_free (priv->recent_items);

  G_OBJECT_CLASS (gtk_recent_manager_parent_class)->finalize (object);
}

static void
gtk_recent_manager_dispose (GObject *gobject)
{
  GtkRecentManager *manager = GTK_RECENT_MANAGER (gobject);
  GtkRecentManagerPrivate *priv = manager->priv;

  if (priv->monitor != NULL)
415
    {
416 417 418 419 420
      g_signal_handlers_disconnect_by_func (priv->monitor,
                                            G_CALLBACK (gtk_recent_manager_monitor_changed),
                                            manager);
      g_object_unref (priv->monitor);
      priv->monitor = NULL;
421 422
    }

423 424 425 426 427 428
  if (priv->changed_timeout != 0)
    {
      g_source_remove (priv->changed_timeout);
      priv->changed_timeout = 0;
      priv->changed_age = 0;
    }
429

430 431 432 433 434 435
  if (priv->is_dirty)
    {
      g_object_ref (manager);
      g_signal_emit (manager, signal_changed, 0);
      g_object_unref (manager);
    }
436

437
  G_OBJECT_CLASS (gtk_recent_manager_parent_class)->dispose (gobject);
438 439
}

440 441 442 443 444 445 446
static void
gtk_recent_manager_enabled_changed (GtkRecentManager *manager)
{
  manager->priv->is_dirty = TRUE;
  gtk_recent_manager_changed (manager);
}

447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
static void
gtk_recent_manager_real_changed (GtkRecentManager *manager)
{
  GtkRecentManagerPrivate *priv = manager->priv;

  g_object_freeze_notify (G_OBJECT (manager));

  if (priv->is_dirty)
    {
      GError *write_error;
      
      /* we are marked as dirty, so we dump the content of our
       * recently used items list
       */
      g_assert (priv->filename != NULL);

      if (!priv->recent_items)
        {
465 466 467
          /* if no container object has been defined, we create a new
           * empty container, and dump it
           */
468 469 470
          priv->recent_items = g_bookmark_file_new ();
	  priv->size = 0;
	}
471 472 473 474
      else
        {
          GtkSettings *settings = gtk_settings_get_default ();
          gint age = 30;
475
          gboolean enabled;
476

477 478 479 480 481 482
          g_object_get (G_OBJECT (settings),
                        "gtk-recent-files-max-age", &age,
                        "gtk-recent-files-enabled", &enabled,
                        NULL);

          if (age == 0 || !enabled)
483 484 485 486
            {
              g_bookmark_file_free (priv->recent_items);
              priv->recent_items = g_bookmark_file_new ();
            }
487 488
          else if (age > 0)
            gtk_recent_manager_clamp_to_age (manager, age);
489
        }
490 491

      write_error = NULL;
492
      g_bookmark_file_to_file (priv->recent_items, priv->filename, &write_error);
493 494
      if (write_error)
        {
495 496 497 498
          filename_warning ("Attempting to store changes into `%s', "
			    "but failed: %s",
			    priv->filename,
			    write_error->message);
499 500 501
	  g_error_free (write_error);
	}

502 503 504 505 506 507 508 509
      if (g_chmod (priv->filename, 0600) < 0)
        {
          filename_warning ("Attempting to set the permissions of `%s', "
                            "but failed: %s",
                            priv->filename,
                            g_strerror (errno));
        }

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
      /* mark us as clean */
      priv->is_dirty = FALSE;
    }
  else
    {
      /* we are not marked as dirty, so we have been called
       * because the recently used resources file has been
       * changed (and not from us).
       */
      build_recent_items_list (manager);
    }

  g_object_thaw_notify (G_OBJECT (manager));
}

525 526 527 528 529 530
static void
gtk_recent_manager_monitor_changed (GFileMonitor      *monitor,
                                    GFile             *file,
                                    GFile             *other_file,
                                    GFileMonitorEvent  event_type,
                                    gpointer           user_data)
531
{
532
  GtkRecentManager *manager = user_data;
533

534
  switch (event_type)
535
    {
536 537
    case G_FILE_MONITOR_EVENT_CHANGED:
    case G_FILE_MONITOR_EVENT_CREATED:
538
      gdk_threads_enter ();
539
      gtk_recent_manager_changed (manager);
540
      gdk_threads_leave ();
541
      break;
542

543 544
    case G_FILE_MONITOR_EVENT_DELETED:
      break;
545

546 547 548
    default:
      break;
    }
549 550
}

551 552 553
static gchar *
get_default_filename (void)
{
554 555 556 557 558 559 560 561 562 563 564 565
  if (g_mkdir_with_parents (g_get_user_data_dir (), 0755) == -1)
    {
      int saved_errno = errno;

      g_critical ("Unable to create user data directory '%s' for storing "
                  "the recently used files list: %s",
                  g_get_user_data_dir (),
                  g_strerror (saved_errno));

      return NULL;
    }

566 567 568 569 570
  return g_build_filename (g_get_user_data_dir (),
                           GTK_RECENTLY_USED_FILE,
                           NULL);
}

571 572 573 574 575
static void
gtk_recent_manager_set_filename (GtkRecentManager *manager,
				 const gchar      *filename)
{
  GtkRecentManagerPrivate *priv;
576 577
  GFile *file;
  GError *error;
578 579
  
  g_assert (GTK_IS_RECENT_MANAGER (manager));
580

581
  priv = manager->priv;
582

583 584 585 586 587 588 589 590
  /* if a filename is already set and filename is not NULL, then copy
   * it and reset the monitor; otherwise, if it's NULL we're being
   * called from the finalization sequence, so we simply disconnect the
   * monitoring and return.
   *
   * if no filename is set and filename is NULL, use the default.
   */
  if (priv->filename)
591
    {
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
      g_free (priv->filename);

      if (priv->monitor)
        {
          g_signal_handlers_disconnect_by_func (priv->monitor,
                                                G_CALLBACK (gtk_recent_manager_monitor_changed),
                                                manager);
          g_object_unref (priv->monitor);
          priv->monitor = NULL;
        }

      if (!filename || *filename == '\0')
        return;
      else
        priv->filename = g_strdup (filename);
    }
  else
    {
      if (!filename || *filename == '\0')
611
        priv->filename = get_default_filename ();
612 613
      else
        priv->filename = g_strdup (filename);
614 615
    }

616
  g_assert (priv->filename != NULL);
617
  file = g_file_new_for_path (priv->filename);
618

619 620 621
  error = NULL;
  priv->monitor = g_file_monitor_file (file, G_FILE_MONITOR_NONE, NULL, &error);
  if (error)
622
    {
623 624 625 626 627 628
      filename_warning ("Unable to monitor `%s': %s\n"
                        "The GtkRecentManager will not update its contents "
                        "if the file is changed from other instances",
                        priv->filename,
                        error->message);
      g_error_free (error);
629
    }
630 631 632 633
  else
    g_signal_connect (priv->monitor, "changed",
                      G_CALLBACK (gtk_recent_manager_monitor_changed),
                      manager);
634

635
  g_object_unref (file);
636

637
  priv->is_dirty = FALSE;
638
  build_recent_items_list (manager);
639 640 641 642
}

/* reads the recently used resources file and builds the items list.
 * we keep the items list inside the parser object, and build the
643
 * RecentInfo object only on user’s demand to avoid useless replication.
644
 * this function resets the dirty bit of the manager.
645 646 647 648
 */
static void
build_recent_items_list (GtkRecentManager *manager)
{
649
  GtkRecentManagerPrivate *priv = manager->priv;
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
  GError *read_error;
  gint size;

  g_assert (priv->filename != NULL);
  
  if (!priv->recent_items)
    {
      priv->recent_items = g_bookmark_file_new ();
      priv->size = 0;
    }

  /* the file exists, and it's valid (we hope); if not, destroy the container
   * object and hope for a better result when the next "changed" signal is
   * fired. */
  read_error = NULL;
665
  g_bookmark_file_load_from_file (priv->recent_items, priv->filename, &read_error);
666 667
  if (read_error)
    {
668 669 670 671 672 673 674 675 676 677 678
      /* if the file does not exist we just wait for the first write
       * operation on this recent manager instance, to avoid creating
       * empty files and leading to spurious file system events (Sabayon
       * will not be happy about those)
       */
      if (read_error->domain == G_FILE_ERROR &&
          read_error->code != G_FILE_ERROR_NOENT)
        filename_warning ("Attempting to read the recently used resources "
                          "file at `%s', but the parser failed: %s.",
                          priv->filename,
                          read_error->message);
679 680 681 682 683 684

      g_bookmark_file_free (priv->recent_items);
      priv->recent_items = NULL;

      g_error_free (read_error);
    }
685
  else
686
    {
687 688 689 690 691 692 693
      size = g_bookmark_file_get_size (priv->recent_items);
      if (priv->size != size)
        {
          priv->size = size;

          g_object_notify (G_OBJECT (manager), "size");
        }
694 695
    }

696
  priv->is_dirty = FALSE;
697 698 699 700 701 702 703 704 705 706 707 708 709
}


/********************
 * GtkRecentManager *
 ********************/


/**
 * gtk_recent_manager_new:
 * 
 * Creates a new recent manager object.  Recent manager objects are used to
 * handle the list of recently used resources.  A #GtkRecentManager object
710
 * monitors the recently used resources list, and emits the “changed” signal
711 712
 * each time something inside the list changes.
 *
713
 * #GtkRecentManager objects are expensive: be sure to create them only when
714
 * needed. You should use gtk_recent_manager_get_default() instead.
715
 *
716
 * Returns: A newly created #GtkRecentManager object.
717 718 719 720 721 722
 *
 * Since: 2.10
 */
GtkRecentManager *
gtk_recent_manager_new (void)
{
723
  return g_object_new (GTK_TYPE_RECENT_MANAGER, NULL);
724 725 726 727 728
}

/**
 * gtk_recent_manager_get_default:
 *
729
 * Gets a unique instance of #GtkRecentManager, that you can share
730
 * in your application without caring about memory management.
731
 *
732
 * Returns: (transfer none): A unique #GtkRecentManager. Do not ref or unref it.
733 734 735 736 737 738
 *
 * Since: 2.10
 */
GtkRecentManager *
gtk_recent_manager_get_default (void)
{
739 740 741 742
  if (G_UNLIKELY (!recent_manager_singleton))
    recent_manager_singleton = gtk_recent_manager_new ();

  return recent_manager_singleton;
743 744 745
}


746
static void
747 748 749
gtk_recent_manager_add_item_query_info (GObject      *source_object,
                                        GAsyncResult *res,
                                        gpointer      user_data)
750 751 752 753 754
{
  GFile *file = G_FILE (source_object);
  GtkRecentManager *manager = user_data;
  GtkRecentData recent_data;
  GFileInfo *file_info;
755
  gchar *uri, *basename;
756 757 758

  uri = g_file_get_uri (file);

759
  file_info = g_file_query_info_finish (file, res, NULL); /* NULL-GError */
760 761 762 763 764 765

  recent_data.display_name = NULL;
  recent_data.description = NULL;

  if (file_info)
    {
766 767 768 769 770 771 772 773 774 775
      gchar *content_type;

      content_type = g_file_info_get_attribute_as_string (file_info, G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE);

      if (G_LIKELY (content_type))
        recent_data.mime_type = g_content_type_get_mime_type (content_type);
      else
        recent_data.mime_type = g_strdup (GTK_RECENT_DEFAULT_MIME);

      g_free (content_type);
776 777 778
      g_object_unref (file_info);
    }
  else
779 780 781 782 783
    {
      basename = g_file_get_basename (file);
      recent_data.mime_type = g_content_type_guess (basename, NULL, 0, NULL);
      g_free (basename);
    }
784 785 786 787 788 789

  recent_data.app_name = g_strdup (g_get_application_name ());
  recent_data.app_exec = g_strjoin (" ", g_get_prgname (), "%u", NULL);
  recent_data.groups = NULL;
  recent_data.is_private = FALSE;

790 791
  gdk_threads_enter ();

792 793 794 795
  /* Ignore return value, this can't fail anyway since all required
   * fields are set */
  gtk_recent_manager_add_full (manager, uri, &recent_data);

796 797 798
  manager->priv->is_dirty = TRUE;
  gtk_recent_manager_changed (manager);

799 800
  gdk_threads_leave ();

801 802 803 804 805 806 807 808
  g_free (recent_data.mime_type);
  g_free (recent_data.app_name);
  g_free (recent_data.app_exec);

  g_object_unref (manager);
  g_free (uri);
}

809 810
/**
 * gtk_recent_manager_add_item:
811
 * @manager: a #GtkRecentManager
812 813 814 815 816
 * @uri: a valid URI
 *
 * Adds a new resource, pointed by @uri, into the recently used
 * resources list.
 *
817
 * This function automatically retrieves some of the needed
818 819
 * metadata and setting other metadata to common default values; it
 * then feeds the data to gtk_recent_manager_add_full().
820
 * 
821
 * See gtk_recent_manager_add_full() if you want to explicitly
822 823
 * define the metadata for the resource pointed by @uri.
 *
824
 * Returns: %TRUE if the new item was successfully added
825 826 827 828 829
 *   to the recently used resources list
 *
 * Since: 2.10
 */
gboolean
830
gtk_recent_manager_add_item (GtkRecentManager  *manager,
Alexander Larsson's avatar
Alexander Larsson committed
831
			     const gchar       *uri)
832
{
833
  GFile* file;
834
  
835
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
836 837
  g_return_val_if_fail (uri != NULL, FALSE);

838
  file = g_file_new_for_uri (uri);
839

840 841 842 843 844
  g_file_query_info_async (file,
                           G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE,
                           G_PRIORITY_DEFAULT,
                           G_FILE_QUERY_INFO_NONE,
                           NULL,
845
                           gtk_recent_manager_add_item_query_info,
846
                           g_object_ref (manager));
847

848
  g_object_unref (file);
849

850
  return TRUE;
851 852 853 854
}

/**
 * gtk_recent_manager_add_full:
855
 * @manager: a #GtkRecentManager
856 857 858 859
 * @uri: a valid URI
 * @recent_data: metadata of the resource
 *
 * Adds a new resource, pointed by @uri, into the recently used
860 861
 * resources list, using the metadata specified inside the #GtkRecentData-struct
 * passed in @recent_data.
862 863 864 865 866 867
 *
 * The passed URI will be used to identify this resource inside the
 * list.
 *
 * In order to register the new recently used resource, metadata about
 * the resource must be passed as well as the URI; the metadata is
868
 * stored in a #GtkRecentData-struct, which must contain the MIME
869 870 871 872
 * type of the resource pointed by the URI; the name of the application
 * that is registering the item, and a command line to be used when
 * launching the item.
 *
873
 * Optionally, a #GtkRecentData-struct might contain a UTF-8 string
874 875 876 877 878
 * to be used when viewing the item instead of the last component of the
 * URI; a short description of the item; whether the item should be
 * considered private - that is, should be displayed only by the
 * applications that have registered it.
 *
879
 * Returns: %TRUE if the new item was successfully added to the
880 881 882 883 884
 * recently used resources list, %FALSE otherwise.
 *
 * Since: 2.10
 */
gboolean
885
gtk_recent_manager_add_full (GtkRecentManager     *manager,
886
			     const gchar          *uri,
Alexander Larsson's avatar
Alexander Larsson committed
887
			     const GtkRecentData  *data)
888 889
{
  GtkRecentManagerPrivate *priv;
890 891
  GtkSettings *settings;
  gboolean enabled;
892
  
893
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
894 895 896 897 898 899 900
  g_return_val_if_fail (uri != NULL, FALSE);
  g_return_val_if_fail (data != NULL, FALSE);

  /* sanity checks */
  if ((data->display_name) &&
      (!g_utf8_validate (data->display_name, -1, NULL)))
    {
901 902 903 904
      g_warning ("Attempting to add `%s' to the list of recently used "
		 "resources, but the display name is not a valid UTF-8 "
          	 "encoded string",
		 uri);
905 906 907 908 909 910
      return FALSE;
    }
  
  if ((data->description) &&
      (!g_utf8_validate (data->description, -1, NULL)))
    {
911 912 913 914
      g_warning ("Attempting to add `%s' to the list of recently used "
		 "resources, but the description is not a valid UTF-8 "
          	 "encoded string",
		 uri);
915 916 917 918 919 920
      return FALSE;
    }

 
  if (!data->mime_type)
    {
921 922 923
      g_warning ("Attempting to add `%s' to the list of recently used "
		 "resources, but not MIME type was defined",
		 uri);
924 925 926 927 928
      return FALSE;
    }
  
  if (!data->app_name)
    {
929 930
      g_warning ("Attempting to add `%s' to the list of recently used "
		 "resources, but no name of the application that is "
Alexander Larsson's avatar
Alexander Larsson committed
931
		 "registering it was defined",
932
      		 uri);
933 934 935 936 937
      return FALSE;
    }
  
  if (!data->app_exec)
    {
938 939 940 941
      g_warning ("Attempting to add `%s' to the list of recently used "
		 "resources, but no command line for the application "
		 "that is registering it was defined",
		 uri);
942 943
      return FALSE;
    }
944 945 946 947 948 949

  settings = gtk_settings_get_default ();
  g_object_get (G_OBJECT (settings), "gtk-recent-files-enabled", &enabled, NULL);
  if (!enabled)
    return TRUE;

950
  priv = manager->priv;
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988

  if (!priv->recent_items)
    {
      priv->recent_items = g_bookmark_file_new ();
      priv->size = 0;
    }

  if (data->display_name)  
    g_bookmark_file_set_title (priv->recent_items, uri, data->display_name);
  
  if (data->description)
    g_bookmark_file_set_description (priv->recent_items, uri, data->description);

  g_bookmark_file_set_mime_type (priv->recent_items, uri, data->mime_type);
  
  if (data->groups && data->groups[0] != '\0')
    {
      gint j;
      
      for (j = 0; (data->groups)[j] != NULL; j++)
        g_bookmark_file_add_group (priv->recent_items, uri, (data->groups)[j]);
    }
  
  /* register the application; this will take care of updating the
   * registration count and time in case the application has
   * already registered the same document inside the list
   */
  g_bookmark_file_add_application (priv->recent_items, uri,
		  		   data->app_name,
				   data->app_exec);
  
  g_bookmark_file_set_is_private (priv->recent_items, uri,
		  		  data->is_private);
  
  /* mark us as dirty, so that when emitting the "changed" signal we
   * will dump our changes
   */
  priv->is_dirty = TRUE;
989
  gtk_recent_manager_changed (manager);
990 991 992 993 994 995
  
  return TRUE;
}

/**
 * gtk_recent_manager_remove_item:
996
 * @manager: a #GtkRecentManager
997
 * @uri: the URI of the item you wish to remove
998
 * @error: (allow-none): return location for a #GError, or %NULL
999 1000 1001 1002
 *
 * Removes a resource pointed by @uri from the recently used resources
 * list handled by a recent manager.
 *
1003
 * Returns: %TRUE if the item pointed by @uri has been successfully
1004 1005 1006 1007 1008
 *   removed by the recently used resources list, and %FALSE otherwise.
 *
 * Since: 2.10
 */
gboolean
1009
gtk_recent_manager_remove_item (GtkRecentManager  *manager,
1010 1011 1012 1013 1014 1015
				const gchar       *uri,
				GError           **error)
{
  GtkRecentManagerPrivate *priv;
  GError *remove_error = NULL;

1016
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
1017 1018 1019
  g_return_val_if_fail (uri != NULL, FALSE);
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
  
1020
  priv = manager->priv;
1021 1022 1023 1024 1025 1026
  
  if (!priv->recent_items)
    {
      priv->recent_items = g_bookmark_file_new ();
      priv->size = 0;

1027 1028 1029
      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
		   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
		   _("Unable to find an item with URI '%s'"),
1030 1031 1032 1033 1034 1035 1036 1037
		   uri);

      return FALSE;
    }

  g_bookmark_file_remove_item (priv->recent_items, uri, &remove_error);
  if (remove_error)
    {
1038
      g_error_free (remove_error);
1039 1040 1041 1042 1043

      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
		   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
		   _("Unable to find an item with URI '%s'"),
		   uri);
1044 1045 1046 1047 1048
      
      return FALSE;
    }

  priv->is_dirty = TRUE;
1049
  gtk_recent_manager_changed (manager);
1050 1051 1052 1053 1054 1055
  
  return TRUE;
}

/**
 * gtk_recent_manager_has_item:
1056
 * @manager: a #GtkRecentManager
1057 1058 1059 1060 1061
 * @uri: a URI
 *
 * Checks whether there is a recently used resource registered
 * with @uri inside the recent manager.
 *
1062
 * Returns: %TRUE if the resource was found, %FALSE otherwise.
1063 1064 1065 1066
 *
 * Since: 2.10
 */
gboolean
1067
gtk_recent_manager_has_item (GtkRecentManager *manager,
1068 1069 1070 1071
			     const gchar      *uri)
{
  GtkRecentManagerPrivate *priv;

1072
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
1073 1074
  g_return_val_if_fail (uri != NULL, FALSE);

1075
  priv = manager->priv;
1076 1077 1078 1079 1080
  g_return_val_if_fail (priv->recent_items != NULL, FALSE);

  return g_bookmark_file_has_item (priv->recent_items, uri);
}

1081
static void
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
build_recent_info (GBookmarkFile  *bookmarks,
		   GtkRecentInfo  *info)
{
  gchar **apps, **groups;
  gsize apps_len, groups_len, i;

  g_assert (bookmarks != NULL);
  g_assert (info != NULL);
  
  info->display_name = g_bookmark_file_get_title (bookmarks, info->uri, NULL);
  info->description = g_bookmark_file_get_description (bookmarks, info->uri, NULL);
  info->mime_type = g_bookmark_file_get_mime_type (bookmarks, info->uri, NULL);
    
  info->is_private = g_bookmark_file_get_is_private (bookmarks, info->uri, NULL);
  
  info->added = g_bookmark_file_get_added (bookmarks, info->uri, NULL);
  info->modified = g_bookmark_file_get_modified (bookmarks, info->uri, NULL);
  info->visited = g_bookmark_file_get_visited (bookmarks, info->uri, NULL);
  
  groups = g_bookmark_file_get_groups (bookmarks, info->uri, &groups_len, NULL);
  for (i = 0; i < groups_len; i++)
    {
      gchar *group_name = g_strdup (groups[i]);
      
      info->groups = g_slist_append (info->groups, group_name);
    }

  g_strfreev (groups);
  
  apps = g_bookmark_file_get_applications (bookmarks, info->uri, &apps_len, NULL);
  for (i = 0; i < apps_len; i++)
    {
      gchar *app_name, *app_exec;
      guint count;
      time_t stamp;
      RecentAppInfo *app_info;
      gboolean res;
      
      app_name = apps[i];
      
      res = g_bookmark_file_get_app_info (bookmarks, info->uri, app_name,
      					  &app_exec,
      					  &count,
      					  &stamp,
      					  NULL);
      if (!res)
        continue;
      
      app_info = recent_app_info_new (app_name);
      app_info->exec = app_exec;
      app_info->count = count;
      app_info->stamp = stamp;
      
1135
      info->applications = g_slist_prepend (info->applications, app_info);
1136 1137 1138 1139 1140 1141 1142 1143
      g_hash_table_replace (info->apps_lookup, app_info->name, app_info);
    }
  
  g_strfreev (apps);
}

/**
 * gtk_recent_manager_lookup_item:
1144
 * @manager: a #GtkRecentManager
1145
 * @uri: a URI
1146
 * @error: (allow-none): a return location for a #GError, or %NULL
1147 1148
 *
 * Searches for a URI inside the recently used resources list, and
1149
 * returns a #GtkRecentInfo-struct containing informations about the resource
1150 1151
 * like its MIME type, or its display name.
 *
1152
 * Returns: a #GtkRecentInfo-struct containing information
1153 1154 1155
 *   about the resource pointed by @uri, or %NULL if the URI was
 *   not registered in the recently used resources list.  Free with
 *   gtk_recent_info_unref().
Matthias Clasen's avatar
Matthias Clasen committed
1156 1157 1158
 *
 * Since: 2.10
 */
1159
GtkRecentInfo *
1160
gtk_recent_manager_lookup_item (GtkRecentManager  *manager,
1161 1162 1163 1164 1165 1166
				const gchar       *uri,
				GError           **error)
{
  GtkRecentManagerPrivate *priv;
  GtkRecentInfo *info = NULL;
  
1167
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1168 1169 1170
  g_return_val_if_fail (uri != NULL, NULL);
  g_return_val_if_fail (error == NULL || *error == NULL, NULL);
  
1171
  priv = manager->priv;
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
  if (!priv->recent_items)
    {
      priv->recent_items = g_bookmark_file_new ();
      priv->size = 0;

      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
		   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
		   _("Unable to find an item with URI '%s'"),
		   uri);

      return NULL;
    }
  
  if (!g_bookmark_file_has_item (priv->recent_items, uri))
    {
      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
      		   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
      		   _("Unable to find an item with URI '%s'"),
      		   uri);
      return NULL;
    }
  
  info = gtk_recent_info_new (uri);
  g_return_val_if_fail (info != NULL, NULL);
  
  /* fill the RecentInfo structure with the data retrieved by our
   * parser object from the storage file 
   */
1200 1201
  build_recent_info (priv->recent_items, info);

1202
  return info;
1203 1204 1205 1206 1207 1208
}

/**
 * gtk_recent_manager_move_item:
 * @manager: a #GtkRecentManager
 * @uri: the URI of a recently used resource
1209
 * @new_uri: (allow-none): the new URI of the recently used resource, or %NULL to
1210
 *    remove the item pointed by @uri in the list
1211
 * @error: (allow-none): a return location for a #GError, or %NULL
1212 1213 1214 1215 1216 1217
 *
 * Changes the location of a recently used resource from @uri to @new_uri.
 * 
 * Please note that this function will not affect the resource pointed
 * by the URIs, but only the URI used in the recently used resources list.
 *
1218
 * Returns: %TRUE on success.
1219 1220
 *
 * Since: 2.10
1221
 */
1222 1223
gboolean
gtk_recent_manager_move_item (GtkRecentManager  *recent_manager,
1224 1225 1226
                              const gchar       *uri,
                              const gchar       *new_uri,
                              GError           **error)
1227 1228 1229
{
  GtkRecentManagerPrivate *priv;
  GError *move_error;
1230

1231 1232 1233
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (recent_manager), FALSE);
  g_return_val_if_fail (uri != NULL, FALSE);
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1234

1235 1236
  priv = recent_manager->priv;

1237 1238 1239
  if (!priv->recent_items)
    {
      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1240 1241 1242
                   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
                   _("Unable to find an item with URI '%s'"),
                   uri);
1243 1244 1245
      return FALSE;
    }

1246 1247 1248
  if (!g_bookmark_file_has_item (priv->recent_items, uri))
    {
      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1249 1250 1251
                   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
                   _("Unable to find an item with URI '%s'"),
                   uri);
1252 1253
      return FALSE;
    }
1254

1255
  move_error = NULL;
1256 1257 1258 1259
  if (!g_bookmark_file_move_item (priv->recent_items,
                                  uri,
                                  new_uri,
                                  &move_error))
1260
    {
1261 1262 1263
      g_error_free (move_error);

      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1264 1265 1266
                   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
                   _("Unable to find an item with URI '%s'"),
                   uri);
1267 1268
      return FALSE;
    }
1269

1270 1271
  priv->is_dirty = TRUE;
  gtk_recent_manager_changed (recent_manager);
1272

1273 1274 1275 1276 1277
  return TRUE;
}

/**
 * gtk_recent_manager_get_items:
1278
 * @manager: a #GtkRecentManager
1279 1280 1281
 *
 * Gets the list of recently used resources.
 *
1282
 * Returns:  (element-type GtkRecentInfo) (transfer full): a list of
1283
 *   newly allocated #GtkRecentInfo objects. Use
1284 1285 1286 1287 1288 1289
 *   gtk_recent_info_unref() on each item inside the list, and then
 *   free the list itself using g_list_free().
 *
 * Since: 2.10
 */
GList *
1290
gtk_recent_manager_get_items (GtkRecentManager *manager)
1291 1292 1293 1294 1295 1296
{
  GtkRecentManagerPrivate *priv;
  GList *retval = NULL;
  gchar **uris;
  gsize uris_len, i;
  
1297
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1298
  
1299
  priv = manager->priv;
1300 1301
  if (!priv->recent_items)
    return NULL;
1302

1303 1304 1305 1306
  uris = g_bookmark_file_get_uris (priv->recent_items, &uris_len);
  for (i = 0; i < uris_len; i++)
    {
      GtkRecentInfo *info;
1307
      
1308
      info = gtk_recent_info_new (uris[i]);
1309
      build_recent_info (priv->recent_items, info);
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
      
      retval = g_list_prepend (retval, info);
    }
  
  g_strfreev (uris);
  
  return retval;
}

static void
purge_recent_items_list (GtkRecentManager  *manager,
			 GError           **error)
{
  GtkRecentManagerPrivate *priv = manager->priv;

1325
  if (priv->recent_items == NULL)
1326
    return;
1327

1328 1329 1330
  g_bookmark_file_free (priv->recent_items);
  priv->recent_items = g_bookmark_file_new ();
  priv->size = 0;
1331

1332
  /* emit the changed signal, to ensure that the purge is written */
1333
  priv->is_dirty = TRUE;
1334 1335 1336 1337 1338
  gtk_recent_manager_changed (manager);
}

/**
 * gtk_recent_manager_purge_items:
1339
 * @manager: a #GtkRecentManager
1340
 * @error: (allow-none): a return location for a #GError, or %NULL
1341 1342 1343
 *
 * Purges every item from the recently used resources list.
 *
1344
 * Returns: the number of items that have been removed from the
1345 1346 1347 1348 1349
 *   recently used resources list.
 *
 * Since: 2.10
 */
gint
1350
gtk_recent_manager_purge_items (GtkRecentManager  *manager,
1351 1352 1353 1354 1355
				GError           **error)
{
  GtkRecentManagerPrivate *priv;
  gint count, purged;
  
1356
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), -1);
1357

1358
  priv = manager->priv;
1359 1360 1361 1362 1363 1364 1365
  if (!priv->recent_items)
    return 0;
  
  count = g_bookmark_file_get_size (priv->recent_items);
  if (!count)
    return 0;
  
1366
  purge_recent_items_list (manager, error);
1367 1368 1369 1370 1371 1372
  
  purged = count - g_bookmark_file_get_size (priv->recent_items);

  return purged;
}

1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
static gboolean
emit_manager_changed (gpointer data)
{
  GtkRecentManager *manager = data;

  manager->priv->changed_age = 0;
  manager->priv->changed_timeout = 0;

  g_signal_emit (manager, signal_changed, 0);

  return FALSE;
}

1386
static void
1387
gtk_recent_manager_changed (GtkRecentManager *manager)
1388
{
1389 1390 1391 1392 1393 1394 1395
  /* coalesce consecutive changes
   *
   * we schedule a write in 250 msecs immediately; if we get more than one
   * request per millisecond before the timeout has a chance to run, we
   * schedule an emission immediately.
   */
  if (manager->priv->changed_timeout == 0)
1396 1397 1398 1399
    {
      manager->priv->changed_timeout = gdk_threads_add_timeout (250, emit_manager_changed, manager);
      g_source_set_name_by_id (manager->priv->changed_timeout, "[gtk+] emit_manager_changed");
    }
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412
  else
    {
      manager->priv->changed_age += 1;

      if (manager->priv->changed_age > 250)
        {
          g_source_remove (manager->priv->changed_timeout);
          g_signal_emit (manager, signal_changed, 0);

          manager->priv->changed_age = 0;
          manager->priv->changed_timeout = 0;
        }
    }
1413 1414
}

1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
static void
gtk_recent_manager_clamp_to_age (GtkRecentManager *manager,
                                 gint              age)
{
  GtkRecentManagerPrivate *priv = manager->priv;
  gchar **uris;
  gsize n_uris, i;
  time_t now;

  if (G_UNLIKELY (!priv->recent_items))
    return;

  now = time (NULL);

  uris = g_bookmark_file_get_uris (priv->recent_items, &n_uris);
1430

1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
  for (i = 0; i < n_uris; i++)
    {
      const gchar *uri = uris[i];
      time_t modified;
      gint item_age;

      modified = g_bookmark_file_get_modified (priv->recent_items, uri, NULL);
      item_age = (gint) ((now - modified) / (60 * 60 * 24));
      if (item_age > age)
        g_bookmark_file_remove_item (priv->recent_items, uri, NULL);
    }
1442 1443

  g_strfreev (uris);
1444 1445
}

1446 1447 1448 1449
/*****************
 * GtkRecentInfo *
 *****************/
 
1450 1451 1452
G_DEFINE_BOXED_TYPE (GtkRecentInfo, gtk_recent_info,
                     gtk_recent_info_ref,
                     gtk_recent_info_unref)
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519

static GtkRecentInfo *
gtk_recent_info_new (const gchar *uri)
{
  GtkRecentInfo *info;

  g_assert (uri != NULL);

  info = g_new0 (GtkRecentInfo, 1);
  info->uri = g_strdup (uri);
  
  info->applications = NULL;
  info->apps_lookup = g_hash_table_new (g_str_hash, g_str_equal);
  
  info->groups = NULL;
  
  info->ref_count = 1;

  return info;
}

static void
gtk_recent_info_free (GtkRecentInfo *recent_info)
{
  if (!recent_info)
    return;

  g_free (recent_info->uri);
  g_free (recent_info->display_name);
  g_free (recent_info->description);
  g_free (recent_info->mime_type);
  
  if (recent_info->applications)
    {
      g_slist_foreach (recent_info->applications,
      		       (GFunc) recent_app_info_free,
      		       NULL);
      g_slist_free (recent_info->applications);
      
      recent_info->applications = NULL;
    }
  
  if (recent_info->apps_lookup)
    g_hash_table_destroy (recent_info->apps_lookup);

  if (recent_info->groups)
    {
      g_slist_foreach (recent_info->groups,
		       (GFunc) g_free,
		       NULL);
      g_slist_free (recent_info->groups);

      recent_info->groups = NULL;
    }
  
  if (recent_info->icon)
    g_object_unref (recent_info->icon);

  g_free (recent_info);
}

/**
 * gtk_recent_info_ref:
 * @info: a #GtkRecentInfo
 *
 * Increases the reference count of @recent_info by one.
 *
1520
 * Returns: the recent info object with its reference count increased
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
 *   by one.
 *
 * Since: 2.10
 */
GtkRecentInfo *
gtk_recent_info_ref (GtkRecentInfo *info)
{
  g_return_val_if_fail (info != NULL, NULL);
  g_return_val_if_fail (info->ref_count > 0, NULL);
  
  info->ref_count += 1;
    
  return info;
}

/**
 * gtk_recent_info_unref:
 * @info: a #GtkRecentInfo
 *
 * Decreases the reference count of @info by one.  If the reference
 * count reaches zero, @info is deallocated, and the memory freed.
 *
 * Since: 2.10
 */
void
gtk_recent_info_unref (GtkRecentInfo *info)
{
  g_return_if_fail (info != NULL);
  g_return_if_fail (info->ref_count > 0);

  info->ref_count -= 1;
  
  if (info->ref_count == 0)
    gtk_recent_info_free (info);
}

/**
 * gtk_recent_info_get_uri:
 * @info: a #GtkRecentInfo
 *
 * Gets the URI of the resource.
 *
1563
 * Returns: the URI of the resource.  The returned string is
1564 1565 1566 1567
 *   owned by the recent manager, and should not be freed.
 *
 * Since: 2.10
 */
1568
const gchar *
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
gtk_recent_info_get_uri (GtkRecentInfo *info)
{
  g_return_val_if_fail (info != NULL, NULL);
  
  return info->uri;
}

/**
 * gtk_recent_info_get_display_name:
 * @info: a #GtkRecentInfo
 *
 * Gets the name of the resource.  If none has been defined, the basename
 * of the resource is obtained.
 *
1583
 * Returns: the display name of the resource.  The returned string
1584 1585 1586 1587
 *   is owned by the recent manager, and should not be freed.
 *
 * Since: 2.10
 */
1588
const gchar *
1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
gtk_recent_info_get_display_name (GtkRecentInfo *info)
{
  g_return_val_if_fail (info != NULL, NULL);
  
  if (!info->display_name)
    info->display_name = gtk_recent_info_get_short_name (info);
  
  return info->display_name;
}

/**
 * gtk_recent_info_get_description:
 * @info: a #GtkRecentInfo
 *
 * Gets the (short) description of the resource.
 *
1605
 * Returns: the description of the resource.  The returned string
1606 1607 1608 1609
 *   is owned by the recent manager, and should not be freed.
 *
 * Since: 2.10
 **/
1610
const gchar *
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623
gtk_recent_info_get_description (GtkRecentInfo *info)
{
  g_return_val_if_fail (info != NULL, NULL);
  
  return info->description;
}

/**
 * gtk_recent_info_get_mime_type:
 * @info: a #GtkRecentInfo
 *
 * Gets the MIME type of the resource.
 *
1624
 * Returns: the MIME type of the resource.  The returned string
1625 1626 1627 1628
 *   is owned by the recent manager, and should not be freed.
 *
 * Since: 2.10
 */
1629
const gchar *
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
gtk_recent_info_get_mime_type (GtkRecentInfo *info)
{
  g_return_val_if_fail (info != NULL, NULL);
  
  if (!info->mime_type)
    info->mime_type = g_strdup (GTK_RECENT_DEFAULT_MIME);
  
  return info->mime_type;
}

/**
 * gtk_recent_info_get_added:
 * @info: a #GtkRecentInfo
 *
1644
 * Gets the timestamp (seconds from system’s Epoch) when the resource
1645 1646
 * was added to the recently used resources list.
 *
1647
 * Returns: the number of seconds elapsed from system’s Epoch when
1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
 *   the resource was added to the list, or -1 on failure.
 *
 * Since: 2.10
 */
time_t
gtk_recent_info_get_added (GtkRecentInfo *info)
{
  g_return_val_if_fail (info != NULL, (time_t) -1);
  
  return info->added;
}

/**
 * gtk_recent_info_get_modified:
 * @info: a #GtkRecentInfo
 *
1664
 * Gets the timestamp (seconds from system’s Epoch) when the meta-data
1665
 * for the resource was last modified.
1666
 *
1667
 * Returns: the number of seconds elapsed from system’s Epoch when
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
 *   the resource was last modified, or -1 on failure.
 *
 * Since: 2.10
 */
time_t
gtk_recent_info_get_modified (GtkRecentInfo *info)
{
  g_return_val_if_fail (info != NULL, (time_t) -1);
  
  return info->modified;
}

/**
 * gtk_recent_info_get_visited:
 * @info: a #GtkRecentInfo
 *
1684
 * Gets the timestamp (seconds from system’s Epoch) when the meta-data
1685
 * for the resource was last visited.
1686
 *
1687
 * Returns: the number of seconds elapsed from system’s Epoch when
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
 *   the resource was last visited, or -1 on failure.
 *
 * Since: 2.10
 */
time_t
gtk_recent_info_get_visited (GtkRecentInfo *info)
{
  g_return_val_if_fail (info != NULL, (time_t) -1);
  
  return info->visited;
}

/**
 * gtk_recent_info_get_private_hint:
 * @info: a #GtkRecentInfo
 *
1704
 * Gets the value of the “private” flag.  Resources in the recently used
1705 1706 1707
 * list that have this flag set to %TRUE should only be displayed by the
 * applications that have registered them.
 *
1708
 * Returns: %TRUE if the private flag was found, %FALSE otherwise.
1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
 *
 * Since: 2.10
 */
gboolean
gtk_recent_info_get_private_hint (GtkRecentInfo *info)
{
  g_return_val_if_fail (info != NULL, FALSE);
  
  return info->is_private;
}


static RecentAppInfo *
recent_app_info_new (const gchar *app_name)
{
  RecentAppInfo *app_info;

  g_assert (app_name != NULL);
  
1728
  app_info = g_slice_new0 (RecentAppInfo);
1729 1730 1731
  app_info->name = g_strdup (app_name);
  app_info->exec = NULL;
  app_info->count = 1;
1732
  app_info->stamp = 0; 
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742
  
  return app_info;
}

static void
recent_app_info_free (RecentAppInfo *app_info)
{
  if (!app_info)
    return;
  
1743 1744
  g_free (app_info->name);
  g_free (app_info->exec);
1745
  
1746
  g_slice_free (RecentAppInfo, app_info);
1747 1748 1749 1750 1751 1752
}

/**
 * gtk_recent_info_get_application_info:
 * @info: a #GtkRecentInfo
 * @app_name: the name of the application that has registered this item
1753 1754 1755
 * @app_exec: (transfer none) (out): return location for the string containing the command line
 * @count: (out): return location for the number of times this item was registered
 * @time_: (out): return location for the timestamp this item was last registered
1756 1757 1758 1759 1760 1761 1762 1763
 *    for this application
 *
 * Gets the data regarding the application that has registered the resource
 * pointed by @info.
 *
 * If the command line contains any escape characters defined inside the
 * storage specification, they will be expanded.
 *
1764
 * Returns: %TRUE if an application with @app_name has registered this
1765 1766 1767
 *   resource inside the recently used list, or %FALSE otherwise. The
 *   @app_exec string is owned by the #GtkRecentInfo and should not be
 *   modified or freed
1768 1769 1770 1771 1772 1773
 *
 * Since: 2.10
 */
gboolean
gtk_recent_info_get_application_info (GtkRecentInfo  *info,
				      const gchar    *app_name,