[libsecret/wip/dueno/simple-item: 2/4] secret-readable-item: New interface to represent read-only item

[Daiki Ueno <dueno src gnome org>]

commit b4344c5a3c87fff0c7bc4ecb1df212e4fae11e7f
Author: Daiki Ueno <dueno src gnome org>
Date:   Mon Jun 17 15:30:00 2019 +0200

    secret-readable-item: New interface to represent read-only item

 libsecret/Makefile.am            |   2 +
 libsecret/meson.build            |   4 ++
 libsecret/secret-readable-item.c | 141 +++++++++++++++++++++++++++++++++++++++
 libsecret/secret-readable-item.h |  59 ++++++++++++++++
 4 files changed, 206 insertions(+)
---
diff --git a/libsecret/Makefile.am b/libsecret/Makefile.am
index c91b733..6063a2d 100644
--- a/libsecret/Makefile.am
+++ b/libsecret/Makefile.am
@@ -12,6 +12,7 @@ libsecret_HEADS = \
        libsecret/secret-password.h \
        libsecret/secret-paths.h \
        libsecret/secret-prompt.h \
+       libsecret/secret-readable-item.h \
        libsecret/secret-schema.h \
        libsecret/secret-schemas.h \
        libsecret/secret-service.h \
@@ -42,6 +43,7 @@ libsecret_PUBLIC = \
        libsecret/secret-methods.c \
        libsecret/secret-password.h libsecret/secret-password.c \
        libsecret/secret-prompt.h libsecret/secret-prompt.c \
+       libsecret/secret-readable-item.h libsecret/secret-readable-item.c \
        libsecret/secret-schema.h libsecret/secret-schema.c \
        libsecret/secret-schemas.h libsecret/secret-schemas.c \
        libsecret/secret-service.h libsecret/secret-service.c \
diff --git a/libsecret/meson.build b/libsecret/meson.build
index f35c396..ad70c55 100644
--- a/libsecret/meson.build
+++ b/libsecret/meson.build
@@ -7,6 +7,7 @@ libsecret_sources = [
   'secret-methods.c',
   'secret-password.c',
   'secret-prompt.c',
+  'secret-readable-item.c',
   'secret-schema.c',
   'secret-schemas.c',
   'secret-service.c',
@@ -24,6 +25,7 @@ libsecret_headers = [
   'secret-password.h',
   'secret-paths.h',
   'secret-prompt.h',
+  'secret-readable-item.h',
   'secret-schema.h',
   'secret-schemas.h',
   'secret-service.h',
@@ -104,6 +106,8 @@ libsecret_gir_sources = [
   'secret-paths.h',
   'secret-prompt.c',
   'secret-prompt.h',
+  'secret-readable-item.c',
+  'secret-readable-item.h',
   'secret-schema.c',
   'secret-schema.h',
   'secret-schemas.c',
diff --git a/libsecret/secret-readable-item.c b/libsecret/secret-readable-item.c
new file mode 100644
index 0000000..fb2d919
--- /dev/null
+++ b/libsecret/secret-readable-item.c
@@ -0,0 +1,141 @@
+/* libsecret - GLib wrapper for Secret Service
+ *
+ * Copyright 2019 Red Hat, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation; either version 2.1 of the licence or (at
+ * your option) any later version.
+ *
+ * See the included COPYING file for more information.
+ *
+ * Author: Daiki Ueno
+ */
+
+#include "config.h"
+
+#include "secret-readable-item.h"
+
+/**
+ * SECTION:secret-readable-item
+ * @title: SecretReadableItem
+ * @short_description: A read-only secret item
+ *
+ * #SecretReadableItem provides a read-only view of a secret item
+ * stored in the Secret Service.
+ *
+ * Each item has a value, represented by a #SecretValue, which can be
+ * retrieved by secret_readable_item_retrieve() and
+ * secret_readable_item_retrieve_finish().
+ *
+ * Stability: Stable
+ */
+
+/**
+ * SecretReadableItem:
+ *
+ * An object providing a read-only view of a secret item in the Secret Service.
+ */
+
+/**
+ * SecretReadableItemInterface:
+ * @parent_iface: the parent interface
+ *
+ * The interface for #SecretReadableItem.
+ */
+
+G_DEFINE_INTERFACE (SecretReadableItem, secret_readable_item, G_TYPE_OBJECT);
+
+static void
+secret_readable_item_default_init (SecretReadableItemInterface *iface)
+{
+       /**
+        * SecretReadableItem:attributes: (type GLib.HashTable(utf8,utf8)) (transfer full)
+        *
+        * The attributes set on this item. Attributes are used to locate an
+        * item. They are not guaranteed to be stored or transferred securely.
+        */
+       g_object_interface_install_property (iface,
+                    g_param_spec_boxed ("attributes", "Attributes", "Item attributes",
+                                        G_TYPE_HASH_TABLE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+       /**
+        * SecretReadableItem:created:
+        *
+        * The date and time (in seconds since the UNIX epoch) that this
+        * item was created.
+        */
+       g_object_interface_install_property (iface,
+                   g_param_spec_uint64 ("created", "Created", "Item creation date",
+                                        0UL, G_MAXUINT64, 0UL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+       /**
+        * SecretReadableItem:modified:
+        *
+        * The date and time (in seconds since the UNIX epoch) that this
+        * item was last modified.
+        */
+       g_object_interface_install_property (iface,
+                   g_param_spec_uint64 ("modified", "Modified", "Item modified date",
+                                        0UL, G_MAXUINT64, 0UL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+}
+
+void
+secret_readable_item_retrieve_secret (SecretReadableItem *self,
+                                     GCancellable *cancellable,
+                                     GAsyncReadyCallback callback,
+                                     gpointer user_data)
+{
+       SecretReadableItemInterface *iface;
+
+       g_return_if_fail (SECRET_IS_READABLE_ITEM (self));
+       iface = SECRET_READABLE_ITEM_GET_IFACE (self);
+       g_return_if_fail (iface->retrieve_secret != NULL);
+       iface->retrieve_secret (self, cancellable, callback, user_data);
+}
+
+SecretValue *
+secret_readable_item_retrieve_secret_finish (SecretReadableItem *self,
+                                            GAsyncResult *result,
+                                            GError **error)
+{
+       SecretReadableItemInterface *iface;
+
+       g_return_if_fail (SECRET_IS_READABLE_ITEM (self));
+       iface = SECRET_READABLE_ITEM_GET_IFACE (self);
+       g_return_if_fail (iface->retrieve_secret_finish != NULL);
+       return iface->retrieve_secret_finish (self, result, error);
+}
+
+GHashTable *
+secret_readable_item_get_attributes (SecretReadableItem *self)
+{
+       GValue value;
+
+       g_return_val_if_fail (SECRET_IS_READABLE_ITEM (self), NULL);
+
+       g_object_get_property (self, "attributes", &value);
+       return g_value_get_boxed (&value);
+}
+
+guint64
+secret_readable_item_get_created (SecretReadableItem *self)
+{
+       GValue value;
+
+       g_return_val_if_fail (SECRET_IS_READABLE_ITEM (self), NULL);
+
+       g_object_get_property (self, "created", &value);
+       return g_value_get_uint64 (&value);
+}
+
+guint64
+secret_readable_item_get_modified (SecretReadableItem *self)
+{
+       GValue value;
+
+       g_return_val_if_fail (SECRET_IS_READABLE_ITEM (self), NULL);
+
+       g_object_get_property (self, "modified", &value);
+       return g_value_get_uint64 (&value);
+}
diff --git a/libsecret/secret-readable-item.h b/libsecret/secret-readable-item.h
new file mode 100644
index 0000000..1c2efb8
--- /dev/null
+++ b/libsecret/secret-readable-item.h
@@ -0,0 +1,59 @@
+/* libsecret - GLib wrapper for Secret Service
+ *
+ * Copyright 2019 Red Hat, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation; either version 2.1 of the licence or (at
+ * your option) any later version.
+ *
+ * See the included COPYING file for more information.
+ *
+ * Author: Daiki Ueno
+ */
+
+#if !defined (__SECRET_INSIDE_HEADER__) && !defined (SECRET_COMPILATION)
+#error "Only <libsecret/secret.h> can be included directly."
+#endif
+
+#ifndef __SECRET_READABLE_ITEM_H__
+#define __SECRET_READABLE_ITEM_H__
+
+#include <glib-object.h>
+#include "secret-value.h"
+
+G_BEGIN_DECLS
+
+#define SECRET_TYPE_READABLE_ITEM secret_readable_item_get_type ()
+G_DECLARE_INTERFACE (SecretReadableItem, secret_readable_item, SECRET, READABLE_ITEM, GObject)
+
+struct _SecretReadableItemInterface
+{
+       GTypeInterface parent_iface;
+
+       void        *(*retrieve_secret)        (SecretReadableItem *self,
+                                               GCancellable *cancellable,
+                                               GAsyncReadyCallback callback,
+                                               gpointer user_data);
+       SecretValue *(*retrieve_secret_finish) (SecretReadableItem *self,
+                                               GAsyncResult *result,
+                                               GError **error);
+};
+
+void         secret_readable_item_retrieve_secret        (SecretReadableItem *self,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+
+SecretValue *secret_readable_item_retrieve_secret_finish (SecretReadableItem *self,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+
+GHashTable  *secret_readable_item_get_attributes         (SecretReadableItem *self);
+guint64      secret_readable_item_get_created            (SecretReadableItem *self);
+guint64      secret_readable_item_get_modified           (SecretReadableItem *self);
+
+
+G_END_DECLS
+
+#endif /* __SECRET_READABLE_ITEM_H__ */