Blame gfbgraph/gfbgraph-album.c

Packit 87b8d1
/* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 8; tab-width: 8 -*-  */
Packit 87b8d1
/*
Packit 87b8d1
 * libgfbgraph - GObject library for Facebook Graph API
Packit 87b8d1
 * Copyright (C) 2013 Álvaro Peña <alvaropg@gmail.com>
Packit 87b8d1
 *
Packit 87b8d1
 * GFBGraph is free software; you can redistribute it and/or
Packit 87b8d1
 * modify it under the terms of the GNU Lesser General Public
Packit 87b8d1
 * License as published by the Free Software Foundation; either
Packit 87b8d1
 * version 2.1 of the License, or (at your option) any later version.
Packit 87b8d1
 *
Packit 87b8d1
 * GFBGraph is distributed in the hope that it will be useful,
Packit 87b8d1
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 87b8d1
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 87b8d1
 * Lesser General Public License for more details.
Packit 87b8d1
 *
Packit 87b8d1
 * You should have received a copy of the GNU Lesser General Public
Packit 87b8d1
 * License along with GFBGraph.  If not, see <http://www.gnu.org/licenses/>.
Packit 87b8d1
 */
Packit 87b8d1
Packit 87b8d1
/**
Packit 87b8d1
 * SECTION:gfbgraph-album
Packit 87b8d1
 * @short_description: GFBGraph Photo album node object
Packit 87b8d1
 * @stability: Unstable
Packit 87b8d1
 * @include: gfbgraph/gfbgraph.h
Packit 87b8d1
 *
Packit 87b8d1
 * #GFGraphAlbum represents the <ulink url="https://developers.facebook.com/docs/reference/api/album/">
Packit 87b8d1
 * photo album node in the Graph API</ulink>.
Packit 87b8d1
 *
Packit 87b8d1
 * This node is connectable to:
Packit 87b8d1
 *  - #GFBGraphUser
Packit 87b8d1
 **/
Packit 87b8d1
Packit 87b8d1
#include "gfbgraph-album.h"
Packit 87b8d1
#include "gfbgraph-user.h"
Packit 87b8d1
#include "gfbgraph-connectable.h"
Packit 87b8d1
Packit 87b8d1
enum {
Packit 87b8d1
        PROP_O,
Packit 87b8d1
Packit 87b8d1
        PROP_NAME,
Packit 87b8d1
        PROP_DESCRIPTION,
Packit 87b8d1
        PROP_COVER_PHOTO,
Packit 87b8d1
        PROP_COUNT
Packit 87b8d1
};
Packit 87b8d1
Packit 87b8d1
struct _GFBGraphAlbumPrivate {
Packit 87b8d1
        gchar *name;
Packit 87b8d1
        gchar *description;
Packit 87b8d1
        gchar *cover_photo;
Packit 87b8d1
        guint  count;
Packit 87b8d1
};
Packit 87b8d1
Packit 87b8d1
static void gfbgraph_album_init         (GFBGraphAlbum *obj);
Packit 87b8d1
static void gfbgraph_album_class_init   (GFBGraphAlbumClass *klass);
Packit 87b8d1
static void gfbgraph_album_finalize     (GObject *obj);
Packit 87b8d1
static void gfbgraph_album_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
Packit 87b8d1
static void gfbgraph_album_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
Packit 87b8d1
Packit 87b8d1
static void gfbgraph_album_connectable_iface_init (GFBGraphConnectableInterface *iface);
Packit 87b8d1
GHashTable* gfbgraph_album_get_connection_post_params (GFBGraphConnectable *self, GType node_type);
Packit 87b8d1
Packit 87b8d1
#define GFBGRAPH_ALBUM_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), GFBGRAPH_TYPE_ALBUM, GFBGraphAlbumPrivate))
Packit 87b8d1
Packit 87b8d1
static GFBGraphNodeClass *parent_class = NULL;
Packit 87b8d1
Packit 87b8d1
G_DEFINE_TYPE_WITH_CODE (GFBGraphAlbum, gfbgraph_album, GFBGRAPH_TYPE_NODE,
Packit 87b8d1
                         G_IMPLEMENT_INTERFACE (GFBGRAPH_TYPE_CONNECTABLE, gfbgraph_album_connectable_iface_init));
Packit 87b8d1
Packit 87b8d1
static void
Packit 87b8d1
gfbgraph_album_init (GFBGraphAlbum *obj)
Packit 87b8d1
{
Packit 87b8d1
        obj->priv = GFBGRAPH_ALBUM_GET_PRIVATE(obj);
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
static void
Packit 87b8d1
gfbgraph_album_class_init (GFBGraphAlbumClass *klass)
Packit 87b8d1
{
Packit 87b8d1
        GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Packit 87b8d1
Packit 87b8d1
        parent_class            = g_type_class_peek_parent (klass);
Packit 87b8d1
Packit 87b8d1
        gobject_class->finalize = gfbgraph_album_finalize;
Packit 87b8d1
        gobject_class->set_property = gfbgraph_album_set_property;
Packit 87b8d1
        gobject_class->get_property = gfbgraph_album_get_property;
Packit 87b8d1
Packit 87b8d1
        g_type_class_add_private (gobject_class, sizeof(GFBGraphAlbumPrivate));
Packit 87b8d1
Packit 87b8d1
        /**
Packit 87b8d1
         * GFBGraphAlbum:name:
Packit 87b8d1
         *
Packit 87b8d1
         * The album name.
Packit 87b8d1
         **/
Packit 87b8d1
        g_object_class_install_property (gobject_class,
Packit 87b8d1
                                         PROP_NAME,
Packit 87b8d1
                                         g_param_spec_string ("name",
Packit 87b8d1
                                                              "The title", "The name of the album",
Packit 87b8d1
                                                              "",
Packit 87b8d1
                                                              G_PARAM_READABLE | G_PARAM_WRITABLE));
Packit 87b8d1
Packit 87b8d1
        /**
Packit 87b8d1
         * GFBGraphAlbum:description:
Packit 87b8d1
         *
Packit 87b8d1
         * The album description given by the owner.
Packit 87b8d1
         **/
Packit 87b8d1
        g_object_class_install_property (gobject_class,
Packit 87b8d1
                                         PROP_DESCRIPTION,
Packit 87b8d1
                                         g_param_spec_string ("description",
Packit 87b8d1
                                                              "The description", "The description of the album",
Packit 87b8d1
                                                              "",
Packit 87b8d1
                                                              G_PARAM_READABLE | G_PARAM_WRITABLE));
Packit 87b8d1
Packit 87b8d1
        /**
Packit 87b8d1
         * GFBGraphAlbum:cover_photo:
Packit 87b8d1
         *
Packit 87b8d1
         * The node ID for the album cover photo. It's an ID for a #GFBGraphPhoto node.
Packit 87b8d1
         **/
Packit 87b8d1
        g_object_class_install_property (gobject_class,
Packit 87b8d1
                                         PROP_COVER_PHOTO,
Packit 87b8d1
                                         g_param_spec_string ("cover_photo",
Packit 87b8d1
                                                              "Cover photo", "The ID for the cover photo of the album",
Packit 87b8d1
                                                              "",
Packit 87b8d1
                                                              G_PARAM_READABLE | G_PARAM_WRITABLE));
Packit 87b8d1
Packit 87b8d1
        /**
Packit 87b8d1
         * GFBGraphAlbum:count:
Packit 87b8d1
         *
Packit 87b8d1
         * The number of photos in the album.
Packit 87b8d1
         **/
Packit 87b8d1
        g_object_class_install_property (gobject_class,
Packit 87b8d1
                                         PROP_COUNT,
Packit 87b8d1
                                         g_param_spec_uint ("count",
Packit 87b8d1
                                                           "Number of photos", "The number of photos in the album",
Packit 87b8d1
                                                           0, G_MAXUINT, 0,
Packit 87b8d1
                                                           G_PARAM_READABLE | G_PARAM_WRITABLE));
Packit 87b8d1
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
static void
Packit 87b8d1
gfbgraph_album_finalize (GObject *obj)
Packit 87b8d1
{
Packit 87b8d1
        G_OBJECT_CLASS(parent_class)->finalize (obj);
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
static void
Packit 87b8d1
gfbgraph_album_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
Packit 87b8d1
{
Packit 87b8d1
        GFBGraphAlbumPrivate *priv;
Packit 87b8d1
Packit 87b8d1
        priv = GFBGRAPH_ALBUM_GET_PRIVATE (object);
Packit 87b8d1
Packit 87b8d1
        switch (prop_id) {
Packit 87b8d1
                case PROP_NAME:
Packit 87b8d1
                        if (priv->name)
Packit 87b8d1
                                g_free (priv->name);
Packit 87b8d1
                        priv->name = g_strdup (g_value_get_string (value));
Packit 87b8d1
                        break;
Packit 87b8d1
                case PROP_DESCRIPTION:
Packit 87b8d1
                        if (priv->description)
Packit 87b8d1
                                g_free (priv->description);
Packit 87b8d1
                        priv->description = g_strdup (g_value_get_string (value));
Packit 87b8d1
                        break;
Packit 87b8d1
                case PROP_COVER_PHOTO:
Packit 87b8d1
                        if (priv->cover_photo)
Packit 87b8d1
                                g_free (priv->cover_photo);
Packit 87b8d1
                        priv->cover_photo = g_strdup (g_value_get_string (value));
Packit 87b8d1
                        break;
Packit 87b8d1
                case PROP_COUNT:
Packit 87b8d1
                        priv->count = g_value_get_uint (value);
Packit 87b8d1
                        break;
Packit 87b8d1
                default:
Packit 87b8d1
                        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Packit 87b8d1
                        break;
Packit 87b8d1
        }
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
static void
Packit 87b8d1
gfbgraph_album_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
Packit 87b8d1
{
Packit 87b8d1
        GFBGraphAlbumPrivate *priv;
Packit 87b8d1
Packit 87b8d1
        priv = GFBGRAPH_ALBUM_GET_PRIVATE (object);
Packit 87b8d1
Packit 87b8d1
        switch (prop_id) {
Packit 87b8d1
                case PROP_NAME:
Packit 87b8d1
                        g_value_set_string (value, priv->name);
Packit 87b8d1
                        break;
Packit 87b8d1
                case PROP_DESCRIPTION:
Packit 87b8d1
                        g_value_set_string (value, priv->description);
Packit 87b8d1
                        break;
Packit 87b8d1
                case PROP_COVER_PHOTO:
Packit 87b8d1
                        g_value_set_string (value, priv->cover_photo);
Packit 87b8d1
                        break;
Packit 87b8d1
                case PROP_COUNT:
Packit 87b8d1
                        g_value_set_uint (value, priv->count);
Packit 87b8d1
                        break;
Packit 87b8d1
                default:
Packit 87b8d1
                        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Packit 87b8d1
                        break;
Packit 87b8d1
        }
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
static void
Packit 87b8d1
gfbgraph_album_connectable_iface_init (GFBGraphConnectableInterface *iface)
Packit 87b8d1
{
Packit 87b8d1
        GHashTable *connections;
Packit 87b8d1
Packit 87b8d1
        connections = g_hash_table_new (g_str_hash, g_str_equal);
Packit 87b8d1
        g_hash_table_insert (connections, (gpointer) g_type_name (GFBGRAPH_TYPE_USER), (gpointer) "albums");
Packit 87b8d1
Packit 87b8d1
        iface->connections = connections;
Packit 87b8d1
        iface->get_connection_post_params = gfbgraph_album_get_connection_post_params;
Packit 87b8d1
        iface->parse_connected_data = gfbgraph_connectable_default_parse_connected_data;
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
GHashTable*
Packit 87b8d1
gfbgraph_album_get_connection_post_params (GFBGraphConnectable *self, GType node_type)
Packit 87b8d1
{
Packit 87b8d1
        GHashTable *params;
Packit 87b8d1
        GFBGraphAlbumPrivate *priv;
Packit 87b8d1
Packit 87b8d1
        priv = GFBGRAPH_ALBUM_GET_PRIVATE (self);
Packit 87b8d1
Packit 87b8d1
        params = g_hash_table_new (g_str_hash, g_str_equal);
Packit 87b8d1
        g_hash_table_insert (params, "name", priv->name);
Packit 87b8d1
        if (priv->description != NULL)
Packit 87b8d1
                g_hash_table_insert (params, "message", priv->description);
Packit 87b8d1
        /* TODO: Incorpate the "privacy" param */
Packit 87b8d1
Packit 87b8d1
        return params;
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
/**
Packit 87b8d1
 * gfbgraph_album_new:
Packit 87b8d1
 *
Packit 87b8d1
 * Creates a new #GFBGraphAlbum.
Packit 87b8d1
 *
Packit 87b8d1
 * Returns: (transfer full): a new #GFBGraphAlbum; unref with g_object_unref()
Packit 87b8d1
 **/
Packit 87b8d1
GFBGraphAlbum*
Packit 87b8d1
gfbgraph_album_new (void)
Packit 87b8d1
{
Packit 87b8d1
        return GFBGRAPH_ALBUM (g_object_new(GFBGRAPH_TYPE_ALBUM, NULL));
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
/**
Packit 87b8d1
 * gfbgraph_album_new_from_id:
Packit 87b8d1
 * @authorizer: a #GFBGraphAuthorizer.
Packit 87b8d1
 * @id: a const #gchar with the album ID.
Packit 87b8d1
 * @error: (allow-none): a #GError or %NULL.
Packit 87b8d1
 *
Packit 87b8d1
 * Retrieves an album node from the Facebook Graph with the give ID.
Packit 87b8d1
 *
Packit 87b8d1
 * Returns: (transfer full): a new #GFBGraphAlbum; unref with g_object_unref()
Packit 87b8d1
 **/
Packit 87b8d1
GFBGraphAlbum*
Packit 87b8d1
gfbgraph_album_new_from_id (GFBGraphAuthorizer *authorizer, const gchar *id, GError **error)
Packit 87b8d1
{
Packit 87b8d1
        return GFBGRAPH_ALBUM (gfbgraph_node_new_from_id (authorizer, id, GFBGRAPH_TYPE_ALBUM, error));
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
/**
Packit 87b8d1
 * gfbgraph_album_get_name:
Packit 87b8d1
 * @album: a #GFBGraphAlbum.
Packit 87b8d1
 *
Packit 87b8d1
 * Returns: (transfer none): the @album name, or %NULL.
Packit 87b8d1
 **/
Packit 87b8d1
const gchar*
Packit 87b8d1
gfbgraph_album_get_name (GFBGraphAlbum *album)
Packit 87b8d1
{
Packit 87b8d1
        g_return_val_if_fail (GFBGRAPH_IS_ALBUM (album), NULL);
Packit 87b8d1
Packit 87b8d1
        return album->priv->name;
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
/**
Packit 87b8d1
 * gfbgraph_album_get_description:
Packit 87b8d1
 * @album: a #GFBGraphAlbum.
Packit 87b8d1
 *
Packit 87b8d1
 * Returns: (transfer none): the @album description, or %NULL.
Packit 87b8d1
 **/
Packit 87b8d1
const gchar*
Packit 87b8d1
gfbgraph_album_get_description (GFBGraphAlbum *album)
Packit 87b8d1
{
Packit 87b8d1
        g_return_val_if_fail (GFBGRAPH_IS_ALBUM (album), NULL);
Packit 87b8d1
Packit 87b8d1
        return album->priv->description;
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
/**
Packit 87b8d1
 * gfbgraph_album_get_cover_photo:
Packit 87b8d1
 * @album: a #GFBGraphAlbum.
Packit 87b8d1
 *
Packit 87b8d1
 * Returns: (transfer none): the cover photo node ID or %NULL.
Packit 87b8d1
 **/
Packit 87b8d1
const gchar*
Packit 87b8d1
gfbgraph_album_get_cover_photo_id (GFBGraphAlbum *album)
Packit 87b8d1
{
Packit 87b8d1
        g_return_val_if_fail (GFBGRAPH_IS_ALBUM (album), NULL);
Packit 87b8d1
Packit 87b8d1
        return album->priv->cover_photo;
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
/**
Packit 87b8d1
 * gfbgraph_album_get_count:
Packit 87b8d1
 * @album: a #GFBGraphAlbum.
Packit 87b8d1
 *
Packit 87b8d1
 * Returns: (transfer none): the number of photos into the @album or -1 in case of error.
Packit 87b8d1
 **/
Packit 87b8d1
guint
Packit 87b8d1
gfbgraph_album_get_count (GFBGraphAlbum *album)
Packit 87b8d1
{
Packit 87b8d1
        g_return_val_if_fail (GFBGRAPH_IS_ALBUM (album), -1);
Packit 87b8d1
Packit 87b8d1
        return album->priv->count;
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
/**
Packit 87b8d1
 * gfbgraph_album_set_name:
Packit 87b8d1
 * @album: a #GFBGraphAlbum.
Packit 87b8d1
 * @name: a const pointer to a #gchar.
Packit 87b8d1
 *
Packit 87b8d1
 * Sets the name for the @album.
Packit 87b8d1
 **/
Packit 87b8d1
void
Packit 87b8d1
gfbgraph_album_set_name (GFBGraphAlbum *album, const gchar *name)
Packit 87b8d1
{
Packit 87b8d1
        g_return_if_fail (GFBGRAPH_IS_ALBUM (album));
Packit 87b8d1
        g_return_if_fail (name != NULL);
Packit 87b8d1
Packit 87b8d1
        g_object_set (G_OBJECT (album),
Packit 87b8d1
                      "name", name,
Packit 87b8d1
                      NULL);
Packit 87b8d1
}
Packit 87b8d1
Packit 87b8d1
/**
Packit 87b8d1
 * gfbgraph_album_set_description:
Packit 87b8d1
 * @album: a #GFBGraphAlbum.
Packit 87b8d1
 * @description: a const pointer to a #gchar.
Packit 87b8d1
 *
Packit 87b8d1
 * Sets the description for the @album.
Packit 87b8d1
 **/
Packit 87b8d1
void
Packit 87b8d1
gfbgraph_album_set_description (GFBGraphAlbum *album, const gchar *description)
Packit 87b8d1
{
Packit 87b8d1
        g_return_if_fail (GFBGRAPH_IS_ALBUM (album));
Packit 87b8d1
        g_return_if_fail (description != NULL);
Packit 87b8d1
Packit 87b8d1
        g_object_set (G_OBJECT (album),
Packit 87b8d1
                      "description", description,
Packit 87b8d1
                      NULL);
Packit 87b8d1
}