gtkrecentmanager.c 65.3 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

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

/* keep in sync with xdgmime */
117
#define GTK_RECENT_DEFAULT_MIME "application/octet-stream"
118 119 120 121 122

typedef struct
{
  gchar *name;
  gchar *exec;
123

124
  guint count;
125

126 127 128
  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
struct _GtkRecentInfo
{
  gchar *uri;
143

144 145
  gchar *display_name;
  gchar *description;
146

147 148 149
  time_t added;
  time_t modified;
  time_t visited;
150

151
  gchar *mime_type;
152

153 154
  GSList *applications;
  GHashTable *apps_lookup;
155

156
  GSList *groups;
157

158
  gboolean is_private;
159

160
  GdkPixbuf *icon;
161

162 163 164 165 166 167 168 169
  gint ref_count;
};

struct _GtkRecentManagerPrivate
{
  gchar *filename;

  guint is_dirty : 1;
170

171 172 173
  gint size;

  GBookmarkFile *recent_items;
174 175

  GFileMonitor *monitor;
176 177 178

  guint changed_timeout;
  guint changed_age;
179 180 181 182 183 184
};

enum
{
  PROP_0,

185
  PROP_FILENAME,
186 187 188 189
  PROP_LIMIT,
  PROP_SIZE
};

190 191 192
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,
193 194 195
                                                        guint              prop_id,
                                                        const GValue      *value,
                                                        GParamSpec        *pspec);
196
static void     gtk_recent_manager_get_property        (GObject           *object,
197 198 199
                                                        guint              prop_id,
                                                        GValue            *value,
                                                        GParamSpec        *pspec);
200 201 202 203 204 205 206 207 208 209 210 211
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
static void     build_recent_items_list                (GtkRecentManager  *manager);
static void     purge_recent_items_list                (GtkRecentManager  *manager,
                                                        GError           **error);
220 221 222 223 224 225

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
static void
234 235
filename_warning (const gchar *format,
                  const gchar *filename,
Matthias Clasen's avatar
Matthias Clasen committed
236
                  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
/* Test of haystack has the needle prefix, comparing case
 * insensitive. haystack may be UTF-8, but needle must
245 246
 * contain only lowercase ascii.
 */
Matthias Clasen's avatar
Matthias Clasen committed
247
static gboolean
248
has_case_prefix (const gchar *haystack,
Matthias Clasen's avatar
Matthias Clasen committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
                 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';
}

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

static void
gtk_recent_manager_class_init (GtkRecentManagerClass *klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
276

277 278
  gobject_class->set_property = gtk_recent_manager_set_property;
  gobject_class->get_property = gtk_recent_manager_get_property;
279
  gobject_class->dispose = gtk_recent_manager_dispose;
280
  gobject_class->finalize = gtk_recent_manager_finalize;
281

282
  /**
283
   * GtkRecentManager:filename:
284
   *
285 286
   * The full path to the file to be used to store and read the
   * recently used resources list
287 288 289 290
   *
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
291 292 293 294 295 296
                                   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,
                                                        (G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE)));
297

298
  /**
299
   * GtkRecentManager:size:
300
   *
301 302 303 304 305
   * The size of the recently used resources list.
   *
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
306 307 308 309 310 311 312 313 314
                                   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
  /**
316
   * GtkRecentManager::changed:
317 318
   * @recent_manager: the recent manager
   *
319 320 321
   * Emitted when the current recently used resources manager changes
   * its contents, either by calling gtk_recent_manager_add_item() or
   * by another application.
322 323 324 325 326
   *
   * Since: 2.10
   */
  signal_changed =
    g_signal_new (I_("changed"),
327 328 329 330 331 332 333
                  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);

334 335 336 337 338 339 340
  klass->changed = gtk_recent_manager_real_changed;
}

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

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

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

  settings = gtk_settings_get_default ();
350 351 352
  if (settings)
    g_signal_connect_swapped (settings, "notify::gtk-recent-files-enabled",
                              G_CALLBACK (gtk_recent_manager_enabled_changed), manager);
353 354 355
}

static void
356 357 358 359
gtk_recent_manager_set_property (GObject      *object,
                                 guint         prop_id,
                                 const GValue *value,
                                 GParamSpec   *pspec)
360 361
{
  GtkRecentManager *recent_manager = GTK_RECENT_MANAGER (object);
362

363 364 365 366 367 368 369 370 371 372 373 374
  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
375 376 377 378
gtk_recent_manager_get_property (GObject    *object,
                                 guint       prop_id,
                                 GValue     *value,
                                 GParamSpec *pspec)
379 380
{
  GtkRecentManager *recent_manager = GTK_RECENT_MANAGER (object);
381

382 383 384 385 386 387 388 389 390 391 392 393
  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;
    }
394
}
395 396

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

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
  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)
417
    {
418 419 420 421 422
      g_signal_handlers_disconnect_by_func (priv->monitor,
                                            G_CALLBACK (gtk_recent_manager_monitor_changed),
                                            manager);
      g_object_unref (priv->monitor);
      priv->monitor = NULL;
423 424
    }

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

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

439
  G_OBJECT_CLASS (gtk_recent_manager_parent_class)->dispose (gobject);
440 441
}

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

449 450 451 452 453 454 455 456 457 458
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;
459

460 461 462 463 464
      /* we are marked as dirty, so we dump the content of our
       * recently used items list
       */
      if (!priv->recent_items)
        {
465 466 467
          /* if no container object has been defined, we create a new
           * empty container, and dump it
           */
468
          priv->recent_items = g_bookmark_file_new ();
469 470
          priv->size = 0;
        }
471 472
      else
        {
473 474
          GtkSettings *settings;
          gint age;
475
          gboolean enabled;
476

477 478 479 480 481 482 483 484 485 486 487
          settings = gtk_settings_get_default ();
          if (settings)
            g_object_get (G_OBJECT (settings),
                          "gtk-recent-files-max-age", &age,
                          "gtk-recent-files-enabled", &enabled,
                          NULL);
          else
            {
              age = 30;
              enabled = TRUE;
            }
488 489

          if (age == 0 || !enabled)
490 491 492 493
            {
              g_bookmark_file_free (priv->recent_items);
              priv->recent_items = g_bookmark_file_new ();
            }
494 495
          else if (age > 0)
            gtk_recent_manager_clamp_to_age (manager, age);
496
        }
497

498
      if (priv->filename != NULL)
499
        {
500 501 502 503
          write_error = NULL;
          g_bookmark_file_to_file (priv->recent_items, priv->filename, &write_error);
          if (write_error)
            {
504
              filename_warning ("Attempting to store changes into '%s', but failed: %s",
505 506 507
                                priv->filename,
                                write_error->message);
              g_error_free (write_error);
508
            }
509

510 511
          if (g_chmod (priv->filename, 0600) < 0)
            {
512
              filename_warning ("Attempting to set the permissions of '%s', but failed: %s",
513 514 515
                                priv->filename,
                                g_strerror (errno));
            }
516 517
        }

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
      /* 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));
}

533 534 535 536 537 538
static void
gtk_recent_manager_monitor_changed (GFileMonitor      *monitor,
                                    GFile             *file,
                                    GFile             *other_file,
                                    GFileMonitorEvent  event_type,
                                    gpointer           user_data)
539
{
540
  GtkRecentManager *manager = user_data;
541

542
  switch (event_type)
543
    {
544 545
    case G_FILE_MONITOR_EVENT_CHANGED:
    case G_FILE_MONITOR_EVENT_CREATED:
546
      gdk_threads_enter ();
547
      gtk_recent_manager_changed (manager);
548
      gdk_threads_leave ();
549
      break;
550

551 552
    case G_FILE_MONITOR_EVENT_DELETED:
      break;
553

554 555 556
    default:
      break;
    }
557 558
}

559 560 561
static gchar *
get_default_filename (void)
{
562 563 564 565 566 567 568 569 570 571 572 573
  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;
    }

574 575 576 577 578
  return g_build_filename (g_get_user_data_dir (),
                           GTK_RECENTLY_USED_FILE,
                           NULL);
}

579 580
static void
gtk_recent_manager_set_filename (GtkRecentManager *manager,
581
                                 const gchar      *filename)
582 583
{
  GtkRecentManagerPrivate *priv;
584 585
  GFile *file;
  GError *error;
586

587
  g_assert (GTK_IS_RECENT_MANAGER (manager));
588

589
  priv = manager->priv;
590

591 592
  /* 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
593 594
   * called from the finalization sequence, so we simply disconnect
   * the monitoring and return.
595 596 597 598
   *
   * if no filename is set and filename is NULL, use the default.
   */
  if (priv->filename)
599
    {
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
      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')
619
        priv->filename = get_default_filename ();
620 621
      else
        priv->filename = g_strdup (filename);
622 623
    }

624
  if (priv->filename != NULL)
625
    {
626
      file = g_file_new_for_path (priv->filename);
627

628 629 630 631
      error = NULL;
      priv->monitor = g_file_monitor_file (file, G_FILE_MONITOR_NONE, NULL, &error);
      if (error)
        {
632
          filename_warning ("Unable to monitor '%s': %s\n"
633 634 635 636 637 638 639 640 641 642 643 644 645
                            "The GtkRecentManager will not update its contents "
                            "if the file is changed from other instances",
                            priv->filename,
                            error->message);
          g_error_free (error);
        }
      else
        g_signal_connect (priv->monitor, "changed",
                          G_CALLBACK (gtk_recent_manager_monitor_changed),
                          manager);

      g_object_unref (file);
    }
646

647
  build_recent_items_list (manager);
648 649 650 651
}

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

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

668
  if (priv->filename != NULL)
669
    {
670 671
      /* 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
672 673
       * fired.
       */
674 675 676 677 678 679 680 681 682 683 684 685
      read_error = NULL;
      g_bookmark_file_load_from_file (priv->recent_items, priv->filename, &read_error);
      if (read_error)
        {
          /* 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 "
686
                              "file at '%s', but the parser failed: %s.",
687 688
                              priv->filename,
                              read_error->message);
689

690 691
          g_bookmark_file_free (priv->recent_items);
          priv->recent_items = NULL;
692

693 694 695
          g_error_free (read_error);
        }
      else
696
        {
697 698 699 700
          size = g_bookmark_file_get_size (priv->recent_items);
          if (priv->size != size)
            {
              priv->size = size;
701

702 703
              g_object_notify (G_OBJECT (manager), "size");
            }
704
        }
705 706
    }

707
  priv->is_dirty = FALSE;
708 709 710 711 712 713 714 715 716 717
}


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


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

/**
 * gtk_recent_manager_get_default:
 *
740
 * Gets a unique instance of #GtkRecentManager, that you can share
741
 * in your application without caring about memory management.
742
 *
743 744
 * Returns: (transfer none): A unique #GtkRecentManager. Do not ref or
 *   unref it.
745 746 747 748 749 750
 *
 * Since: 2.10
 */
GtkRecentManager *
gtk_recent_manager_get_default (void)
{
751 752 753 754
  if (G_UNLIKELY (!recent_manager_singleton))
    recent_manager_singleton = gtk_recent_manager_new ();

  return recent_manager_singleton;
755 756 757
}


758
static void
759 760 761
gtk_recent_manager_add_item_query_info (GObject      *source_object,
                                        GAsyncResult *res,
                                        gpointer      user_data)
762 763 764 765 766
{
  GFile *file = G_FILE (source_object);
  GtkRecentManager *manager = user_data;
  GtkRecentData recent_data;
  GFileInfo *file_info;
767
  gchar *uri, *basename;
768 769 770

  uri = g_file_get_uri (file);

771
  file_info = g_file_query_info_finish (file, res, NULL); /* NULL-GError */
772 773 774 775 776 777

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

  if (file_info)
    {
778 779 780 781 782 783 784 785 786 787
      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);
788 789 790
      g_object_unref (file_info);
    }
  else
791 792 793 794 795
    {
      basename = g_file_get_basename (file);
      recent_data.mime_type = g_content_type_guess (basename, NULL, 0, NULL);
      g_free (basename);
    }
796 797 798 799 800 801

  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;

802 803
  gdk_threads_enter ();

804
  /* Ignore return value, this can't fail anyway since all required
805 806
   * fields are set
   */
807 808
  gtk_recent_manager_add_full (manager, uri, &recent_data);

809 810 811
  manager->priv->is_dirty = TRUE;
  gtk_recent_manager_changed (manager);

812 813
  gdk_threads_leave ();

814 815 816 817 818 819 820 821
  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);
}

822 823
/**
 * gtk_recent_manager_add_item:
824
 * @manager: a #GtkRecentManager
825 826 827 828 829
 * @uri: a valid URI
 *
 * Adds a new resource, pointed by @uri, into the recently used
 * resources list.
 *
830
 * This function automatically retrieves some of the needed
831 832
 * metadata and setting other metadata to common default values;
 * it then feeds the data to gtk_recent_manager_add_full().
833
 *
834
 * See gtk_recent_manager_add_full() if you want to explicitly
835 836
 * define the metadata for the resource pointed by @uri.
 *
837
 * Returns: %TRUE if the new item was successfully added
838 839 840 841 842
 *   to the recently used resources list
 *
 * Since: 2.10
 */
gboolean
843 844
gtk_recent_manager_add_item (GtkRecentManager *manager,
                             const gchar      *uri)
845
{
846
  GFile* file;
847

848
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
849 850
  g_return_val_if_fail (uri != NULL, FALSE);

851
  file = g_file_new_for_uri (uri);
852

853 854 855 856 857
  g_file_query_info_async (file,
                           G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE,
                           G_PRIORITY_DEFAULT,
                           G_FILE_QUERY_INFO_NONE,
                           NULL,
858
                           gtk_recent_manager_add_item_query_info,
859
                           g_object_ref (manager));
860

861
  g_object_unref (file);
862

863
  return TRUE;
864 865 866 867
}

/**
 * gtk_recent_manager_add_full:
868
 * @manager: a #GtkRecentManager
869 870 871 872
 * @uri: a valid URI
 * @recent_data: metadata of the resource
 *
 * Adds a new resource, pointed by @uri, into the recently used
873 874
 * resources list, using the metadata specified inside the
 * #GtkRecentData-struct passed in @recent_data.
875 876 877 878 879 880
 *
 * 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
881
 * stored in a #GtkRecentData-struct, which must contain the MIME
882 883 884 885
 * 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.
 *
886
 * Optionally, a #GtkRecentData-struct might contain a UTF-8 string
887 888 889
 * 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
890 891
 * applications that have registered it.
 *
892
 * Returns: %TRUE if the new item was successfully added to the
893
 *     recently used resources list, %FALSE otherwise
894 895 896 897
 *
 * Since: 2.10
 */
gboolean
898 899 900
gtk_recent_manager_add_full (GtkRecentManager    *manager,
                             const gchar         *uri,
                             const GtkRecentData *data)
901 902
{
  GtkRecentManagerPrivate *priv;
903 904
  GtkSettings *settings;
  gboolean enabled;
905

906
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
907 908 909 910 911 912 913
  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)))
    {
914
      g_warning ("Attempting to add '%s' to the list of recently used "
915 916 917
                 "resources, but the display name is not a valid UTF-8 "
                 "encoded string",
                 uri);
918 919
      return FALSE;
    }
920

921 922 923
  if ((data->description) &&
      (!g_utf8_validate (data->description, -1, NULL)))
    {
924
      g_warning ("Attempting to add '%s' to the list of recently used "
925 926 927
                 "resources, but the description is not a valid UTF-8 "
                 "encoded string",
                 uri);
928 929 930
      return FALSE;
    }

931

932 933
  if (!data->mime_type)
    {
934
      g_warning ("Attempting to add '%s' to the list of recently used "
935 936
                 "resources, but no MIME type was defined",
                 uri);
937 938
      return FALSE;
    }
939

940 941
  if (!data->app_name)
    {
942
      g_warning ("Attempting to add '%s' to the list of recently used "
943 944 945
                 "resources, but no name of the application that is "
                 "registering it was defined",
                 uri);
946 947
      return FALSE;
    }
948

949 950
  if (!data->app_exec)
    {
951
      g_warning ("Attempting to add '%s' to the list of recently used "
952 953 954
                 "resources, but no command line for the application "
                 "that is registering it was defined",
                 uri);
955 956
      return FALSE;
    }
957 958 959 960 961 962

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

963
  priv = manager->priv;
964 965 966 967 968 969 970

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

971
  if (data->display_name)
972
    g_bookmark_file_set_title (priv->recent_items, uri, data->display_name);
973

974 975 976 977
  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);
978

979 980 981
  if (data->groups && data->groups[0] != '\0')
    {
      gint j;
982

983 984 985
      for (j = 0; (data->groups)[j] != NULL; j++)
        g_bookmark_file_add_group (priv->recent_items, uri, (data->groups)[j]);
    }
986

987 988 989 990 991
  /* 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,
992 993 994
                                   data->app_name,
                                   data->app_exec);

995
  g_bookmark_file_set_is_private (priv->recent_items, uri,
996 997
                                  data->is_private);

998 999 1000 1001
  /* mark us as dirty, so that when emitting the "changed" signal we
   * will dump our changes
   */
  priv->is_dirty = TRUE;
1002
  gtk_recent_manager_changed (manager);
1003

1004 1005 1006 1007 1008
  return TRUE;
}

/**
 * gtk_recent_manager_remove_item:
1009
 * @manager: a #GtkRecentManager
1010
 * @uri: the URI of the item you wish to remove
1011
 * @error: (allow-none): return location for a #GError, or %NULL
1012 1013 1014 1015
 *
 * Removes a resource pointed by @uri from the recently used resources
 * list handled by a recent manager.
 *
1016
 * Returns: %TRUE if the item pointed by @uri has been successfully
1017
 *   removed by the recently used resources list, and %FALSE otherwise
1018 1019 1020 1021
 *
 * Since: 2.10
 */
gboolean
1022
gtk_recent_manager_remove_item (GtkRecentManager  *manager,
1023 1024
                                const gchar       *uri,
                                GError           **error)
1025 1026 1027 1028
{
  GtkRecentManagerPrivate *priv;
  GError *remove_error = NULL;

1029
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
1030 1031
  g_return_val_if_fail (uri != NULL, FALSE);
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1032

1033
  priv = manager->priv;
1034

1035 1036 1037 1038 1039
  if (!priv->recent_items)
    {
      priv->recent_items = g_bookmark_file_new ();
      priv->size = 0;

1040
      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1041 1042 1043
                   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
                   _("Unable to find an item with URI '%s'"),
                   uri);
1044 1045 1046 1047 1048 1049 1050

      return FALSE;
    }

  g_bookmark_file_remove_item (priv->recent_items, uri, &remove_error);
  if (remove_error)
    {
1051
      g_error_free (remove_error);
1052 1053

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

1058 1059 1060 1061
      return FALSE;
    }

  priv->is_dirty = TRUE;
1062
  gtk_recent_manager_changed (manager);
1063

1064 1065 1066 1067 1068
  return TRUE;
}

/**
 * gtk_recent_manager_has_item:
1069
 * @manager: a #GtkRecentManager
1070 1071 1072 1073 1074
 * @uri: a URI
 *
 * Checks whether there is a recently used resource registered
 * with @uri inside the recent manager.
 *
1075
 * Returns: %TRUE if the resource was found, %FALSE otherwise
1076 1077 1078 1079
 *
 * Since: 2.10
 */
gboolean
1080
gtk_recent_manager_has_item (GtkRecentManager *manager,
1081
                             const gchar      *uri)
1082 1083 1084
{
  GtkRecentManagerPrivate *priv;

1085
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), FALSE);
1086 1087
  g_return_val_if_fail (uri != NULL, FALSE);

1088
  priv = manager->priv;
1089 1090 1091 1092 1093
  g_return_val_if_fail (priv->recent_items != NULL, FALSE);

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

1094
static void
1095 1096
build_recent_info (GBookmarkFile *bookmarks,
                   GtkRecentInfo *info)
1097 1098 1099 1100 1101 1102
{
  gchar **apps, **groups;
  gsize apps_len, groups_len, i;

  g_assert (bookmarks != NULL);
  g_assert (info != NULL);
1103

1104 1105 1106
  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);
1107

1108
  info->is_private = g_bookmark_file_get_is_private (bookmarks, info->uri, NULL);
1109

1110 1111 1112
  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);
1113

1114 1115 1116 1117
  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]);
1118

1119 1120 1121 1122
      info->groups = g_slist_append (info->groups, group_name);
    }

  g_strfreev (groups);
1123

1124 1125 1126 1127 1128 1129 1130 1131
  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;
1132

1133
      app_name = apps[i];
1134

1135
      res = g_bookmark_file_get_app_info (bookmarks, info->uri, app_name,
1136 1137 1138 1139
                                          &app_exec,
                                          &count,
                                          &stamp,
                                          NULL);
1140 1141
      if (!res)
        continue;
1142

1143 1144 1145 1146
      app_info = recent_app_info_new (app_name);
      app_info->exec = app_exec;
      app_info->count = count;
      app_info->stamp = stamp;
1147

1148
      info->applications = g_slist_prepend (info->applications, app_info);
1149 1150
      g_hash_table_replace (info->apps_lookup, app_info->name, app_info);
    }
1151

1152 1153 1154 1155 1156
  g_strfreev (apps);
}

/**
 * gtk_recent_manager_lookup_item:
1157
 * @manager: a #GtkRecentManager
1158
 * @uri: a URI
1159
 * @error: (allow-none): a return location for a #GError, or %NULL
1160 1161
 *
 * Searches for a URI inside the recently used resources list, and
1162
 * returns a #GtkRecentInfo-struct containing informations about the resource
1163 1164
 * like its MIME type, or its display name.
 *
1165
 * Returns: a #GtkRecentInfo-struct containing information
1166
 *   about the resource pointed by @uri, or %NULL if the URI was
1167
 *   not registered in the recently used resources list. Free with
1168
 *   gtk_recent_info_unref().
Matthias Clasen's avatar
Matthias Clasen committed
1169 1170 1171
 *
 * Since: 2.10
 */
1172
GtkRecentInfo *
1173
gtk_recent_manager_lookup_item (GtkRecentManager  *manager,
1174 1175
                                const gchar       *uri,
                                GError           **error)
1176 1177 1178
{
  GtkRecentManagerPrivate *priv;
  GtkRecentInfo *info = NULL;
1179

1180
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1181 1182
  g_return_val_if_fail (uri != NULL, NULL);
  g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1183

1184
  priv = manager->priv;
1185 1186 1187 1188 1189 1190
  if (!priv->recent_items)
    {
      priv->recent_items = g_bookmark_file_new ();
      priv->size = 0;

      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1191 1192 1193
                   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
                   _("Unable to find an item with URI '%s'"),
                   uri);
1194 1195 1196

      return NULL;
    }
1197

1198 1199 1200
  if (!g_bookmark_file_has_item (priv->recent_items, uri))
    {
      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1201 1202 1203
                   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
                   _("Unable to find an item with URI '%s'"),
                   uri);
1204 1205
      return NULL;
    }
1206

1207 1208
  info = gtk_recent_info_new (uri);
  g_return_val_if_fail (info != NULL, NULL);
1209

1210
  /* fill the RecentInfo structure with the data retrieved by our
1211
   * parser object from the storage file
1212
   */
1213 1214
  build_recent_info (priv->recent_items, info);

1215
  return info;
1216 1217 1218 1219 1220 1221
}

/**
 * gtk_recent_manager_move_item:
 * @manager: a #GtkRecentManager
 * @uri: the URI of a recently used resource
1222 1223
 * @new_uri: (allow-none): the new URI of the recently used resource, or
 *    %NULL to remove the item pointed by @uri in the list
1224
 * @error: (allow-none): a return location for a #GError, or %NULL
1225 1226
 *
 * Changes the location of a recently used resource from @uri to @new_uri.
1227
 *
1228 1229 1230
 * 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.
 *
1231
 * Returns: %TRUE on success
1232 1233
 *
 * Since: 2.10
1234
 */
1235 1236
gboolean
gtk_recent_manager_move_item (GtkRecentManager  *recent_manager,
1237 1238 1239
                              const gchar       *uri,
                              const gchar       *new_uri,
                              GError           **error)
1240 1241 1242
{
  GtkRecentManagerPrivate *priv;
  GError *move_error;
1243

1244 1245 1246
  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);
1247

1248 1249
  priv = recent_manager->priv;

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

1259 1260 1261
  if (!g_bookmark_file_has_item (priv->recent_items, uri))
    {
      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1262 1263 1264
                   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
                   _("Unable to find an item with URI '%s'"),
                   uri);
1265 1266
      return FALSE;
    }
1267

1268
  move_error = NULL;
1269 1270 1271 1272
  if (!g_bookmark_file_move_item (priv->recent_items,
                                  uri,
                                  new_uri,
                                  &move_error))
1273
    {
1274 1275 1276
      g_error_free (move_error);

      g_set_error (error, GTK_RECENT_MANAGER_ERROR,
1277 1278 1279
                   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
                   _("Unable to find an item with URI '%s'"),
                   uri);
1280 1281
      return FALSE;
    }
1282

1283 1284
  priv->is_dirty = TRUE;
  gtk_recent_manager_changed (recent_manager);
1285

1286 1287 1288 1289 1290
  return TRUE;
}

/**
 * gtk_recent_manager_get_items:
1291
 * @manager: a #GtkRecentManager
1292 1293 1294
 *
 * Gets the list of recently used resources.
 *
1295
 * Returns: (element-type GtkRecentInfo) (transfer full): a list of
1296
 *   newly allocated #GtkRecentInfo objects. Use
1297 1298 1299 1300 1301 1302
 *   gtk_recent_info_unref() on each item inside the list, and then
 *   free the list itself using g_list_free().
 *
 * Since: 2.10
 */
GList *
1303
gtk_recent_manager_get_items (GtkRecentManager *manager)
1304 1305 1306 1307 1308
{
  GtkRecentManagerPrivate *priv;
  GList *retval = NULL;
  gchar **uris;
  gsize uris_len, i;
1309

1310
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), NULL);
1311

1312
  priv = manager->priv;
1313 1314
  if (!priv->recent_items)
    return NULL;
1315

1316 1317 1318 1319
  uris = g_bookmark_file_get_uris (priv->recent_items, &uris_len);
  for (i = 0; i < uris_len; i++)
    {
      GtkRecentInfo *info;
1320

1321
      info = gtk_recent_info_new (uris[i]);
1322
      build_recent_info (priv->recent_items, info);
1323

1324 1325
      retval = g_list_prepend (retval, info);
    }
1326

1327
  g_strfreev (uris);
1328

1329 1330 1331 1332 1333
  return retval;
}

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

1338
  if (priv->recent_items == NULL)
1339
    return;
1340

1341 1342 1343
  g_bookmark_file_free (priv->recent_items);
  priv->recent_items = g_bookmark_file_new ();
  priv->size = 0;
1344

1345
  /* emit the changed signal, to ensure that the purge is written */
1346
  priv->is_dirty = TRUE;
1347 1348 1349 1350 1351
  gtk_recent_manager_changed (manager);
}

/**
 * gtk_recent_manager_purge_items:
1352
 * @manager: a #GtkRecentManager
1353
 * @error: (allow-none): a return location for a #GError, or %NULL
1354 1355 1356
 *
 * Purges every item from the recently used resources list.
 *
1357
 * Returns: the number of items that have been removed from the
1358
 *   recently used resources list
1359 1360 1361 1362
 *
 * Since: 2.10
 */
gint
1363
gtk_recent_manager_purge_items (GtkRecentManager  *manager,
1364
                                GError           **error)
1365 1366 1367
{
  GtkRecentManagerPrivate *priv;
  gint count, purged;
1368

1369
  g_return_val_if_fail (GTK_IS_RECENT_MANAGER (manager), -1);
1370

1371
  priv = manager->priv;