Blame gdata/app/gdata-app-categories.c

Packit 4b6dd7
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
Packit 4b6dd7
/*
Packit 4b6dd7
 * GData Client
Packit 4b6dd7
 * Copyright (C) Philip Withnall 2010, 2015 <philip@tecnocode.co.uk>
Packit 4b6dd7
 *
Packit 4b6dd7
 * GData Client is free software; you can redistribute it and/or
Packit 4b6dd7
 * modify it under the terms of the GNU Lesser General Public
Packit 4b6dd7
 * License as published by the Free Software Foundation; either
Packit 4b6dd7
 * version 2.1 of the License, or (at your option) any later version.
Packit 4b6dd7
 *
Packit 4b6dd7
 * GData Client is distributed in the hope that it will be useful,
Packit 4b6dd7
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 4b6dd7
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 4b6dd7
 * Lesser General Public License for more details.
Packit 4b6dd7
 *
Packit 4b6dd7
 * You should have received a copy of the GNU Lesser General Public
Packit 4b6dd7
 * License along with GData Client.  If not, see <http://www.gnu.org/licenses/>.
Packit 4b6dd7
 */
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * SECTION:gdata-app-categories
Packit 4b6dd7
 * @short_description: GData APP categories object
Packit 4b6dd7
 * @stability: Stable
Packit 4b6dd7
 * @include: gdata/app/gdata-app-categories.h
Packit 4b6dd7
 *
Packit 4b6dd7
 * #GDataAPPCategories is a list of categories (#GDataCategory) returned as the result of querying an
Packit 4b6dd7
 * <ulink type="http" url="http://www.atomenabled.org/developers/protocol/#category">Atom Publishing Protocol Category Document</ulink>.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.7.0
Packit 4b6dd7
 */
Packit 4b6dd7
Packit 4b6dd7
#include <config.h>
Packit 4b6dd7
#include <glib.h>
Packit 4b6dd7
Packit 4b6dd7
#include "gdata-app-categories.h"
Packit 4b6dd7
#include "atom/gdata-category.h"
Packit 4b6dd7
#include "gdata-parsable.h"
Packit 4b6dd7
#include "gdata-parser.h"
Packit 4b6dd7
Packit 4b6dd7
static void gdata_app_categories_dispose (GObject *object);
Packit 4b6dd7
static void gdata_app_categories_finalize (GObject *object);
Packit 4b6dd7
static void gdata_app_categories_get_property (GObject *object, guint property_id, GValue *value, GParamSpec *pspec);
Packit 4b6dd7
static gboolean
Packit 4b6dd7
parse_json (GDataParsable *parsable, JsonReader *reader, gpointer user_data,
Packit 4b6dd7
            GError **error);
Packit 4b6dd7
static gboolean
Packit 4b6dd7
post_parse_json (GDataParsable *parsable, gpointer user_data, GError **error);
Packit 4b6dd7
static const gchar *
Packit 4b6dd7
get_content_type (void);
Packit 4b6dd7
Packit 4b6dd7
struct _GDataAPPCategoriesPrivate {
Packit 4b6dd7
	GList *categories;
Packit 4b6dd7
	gchar *scheme;
Packit 4b6dd7
	gboolean fixed;
Packit 4b6dd7
};
Packit 4b6dd7
Packit 4b6dd7
enum {
Packit 4b6dd7
	PROP_IS_FIXED = 1
Packit 4b6dd7
};
Packit 4b6dd7
Packit 4b6dd7
G_DEFINE_TYPE (GDataAPPCategories, gdata_app_categories, GDATA_TYPE_PARSABLE)
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
gdata_app_categories_class_init (GDataAPPCategoriesClass *klass)
Packit 4b6dd7
{
Packit 4b6dd7
	GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Packit 4b6dd7
	GDataParsableClass *parsable_class = GDATA_PARSABLE_CLASS (klass);
Packit 4b6dd7
Packit 4b6dd7
	g_type_class_add_private (klass, sizeof (GDataAPPCategoriesPrivate));
Packit 4b6dd7
Packit 4b6dd7
	gobject_class->get_property = gdata_app_categories_get_property;
Packit 4b6dd7
	gobject_class->dispose = gdata_app_categories_dispose;
Packit 4b6dd7
	gobject_class->finalize = gdata_app_categories_finalize;
Packit 4b6dd7
Packit 4b6dd7
	parsable_class->parse_json = parse_json;
Packit 4b6dd7
	parsable_class->post_parse_json = post_parse_json;
Packit 4b6dd7
	parsable_class->get_content_type = get_content_type;
Packit 4b6dd7
Packit 4b6dd7
	parsable_class->element_name = "categories";
Packit 4b6dd7
	parsable_class->element_namespace = "app";
Packit 4b6dd7
Packit 4b6dd7
	/**
Packit 4b6dd7
	 * GDataAPPCategories:is-fixed:
Packit 4b6dd7
	 *
Packit 4b6dd7
	 * Whether entries may use categories not in this category list.
Packit 4b6dd7
	 *
Packit 4b6dd7
	 * API reference: <ulink type="http" url="http://www.atomenabled.org/developers/protocol/#appCategories2">app:categories</ulink>
Packit 4b6dd7
	 *
Packit 4b6dd7
	 * Since: 0.7.0
Packit 4b6dd7
	 */
Packit 4b6dd7
	g_object_class_install_property (gobject_class, PROP_IS_FIXED,
Packit 4b6dd7
	                                 g_param_spec_boolean ("is-fixed",
Packit 4b6dd7
	                                                       "Fixed?", "Whether entries may use categories not in this category list.",
Packit 4b6dd7
	                                                       FALSE,
Packit 4b6dd7
	                                                       G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
gdata_app_categories_init (GDataAPPCategories *self)
Packit 4b6dd7
{
Packit 4b6dd7
	self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, GDATA_TYPE_APP_CATEGORIES, GDataAPPCategoriesPrivate);
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
gdata_app_categories_dispose (GObject *object)
Packit 4b6dd7
{
Packit 4b6dd7
	GDataAPPCategoriesPrivate *priv = GDATA_APP_CATEGORIES (object)->priv;
Packit 4b6dd7
Packit 4b6dd7
	if (priv->categories != NULL) {
Packit 4b6dd7
		g_list_foreach (priv->categories, (GFunc) g_object_unref, NULL);
Packit 4b6dd7
		g_list_free (priv->categories);
Packit 4b6dd7
	}
Packit 4b6dd7
	priv->categories = NULL;
Packit 4b6dd7
Packit 4b6dd7
	/* Chain up to the parent class */
Packit 4b6dd7
	G_OBJECT_CLASS (gdata_app_categories_parent_class)->dispose (object);
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
gdata_app_categories_finalize (GObject *object)
Packit 4b6dd7
{
Packit 4b6dd7
	GDataAPPCategoriesPrivate *priv = GDATA_APP_CATEGORIES (object)->priv;
Packit 4b6dd7
Packit 4b6dd7
	g_free (priv->scheme);
Packit 4b6dd7
Packit 4b6dd7
	/* Chain up to the parent class */
Packit 4b6dd7
	G_OBJECT_CLASS (gdata_app_categories_parent_class)->finalize (object);
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
gdata_app_categories_get_property (GObject *object, guint property_id, GValue *value, GParamSpec *pspec)
Packit 4b6dd7
{
Packit 4b6dd7
	GDataAPPCategoriesPrivate *priv = GDATA_APP_CATEGORIES (object)->priv;
Packit 4b6dd7
Packit 4b6dd7
	switch (property_id) {
Packit 4b6dd7
		case PROP_IS_FIXED:
Packit 4b6dd7
			g_value_set_boolean (value, priv->fixed);
Packit 4b6dd7
			break;
Packit 4b6dd7
		default:
Packit 4b6dd7
			/* We don't have any other property... */
Packit 4b6dd7
			G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
Packit 4b6dd7
			break;
Packit 4b6dd7
	}
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/* Reference: https://developers.google.com/youtube/v3/docs/videoCategories/list */
Packit 4b6dd7
static gboolean
Packit 4b6dd7
parse_json (GDataParsable *parsable, JsonReader *reader, gpointer user_data, GError **error)
Packit 4b6dd7
{
Packit 4b6dd7
	GDataAPPCategories *self = GDATA_APP_CATEGORIES (parsable);
Packit 4b6dd7
	GDataAPPCategoriesPrivate *priv = self->priv;
Packit 4b6dd7
	GType category_type;
Packit 4b6dd7
Packit 4b6dd7
	category_type = (user_data == NULL) ?
Packit 4b6dd7
		GDATA_TYPE_CATEGORY : GPOINTER_TO_SIZE (user_data);
Packit 4b6dd7
Packit 4b6dd7
	if (g_strcmp0 (json_reader_get_member_name (reader), "items") == 0) {
Packit 4b6dd7
		guint i, elements;
Packit 4b6dd7
Packit 4b6dd7
		/* Loop through the elements array. */
Packit 4b6dd7
		for (i = 0, elements = (guint) json_reader_count_elements (reader); i < elements; i++) {
Packit 4b6dd7
			GDataCategory *category = NULL;
Packit 4b6dd7
			const gchar *id, *title;
Packit 4b6dd7
			const GError *child_error = NULL;
Packit 4b6dd7
Packit 4b6dd7
			json_reader_read_element (reader, i);
Packit 4b6dd7
Packit 4b6dd7
			json_reader_read_member (reader, "id");
Packit 4b6dd7
			id = json_reader_get_string_value (reader);
Packit 4b6dd7
			json_reader_end_member (reader);
Packit 4b6dd7
Packit 4b6dd7
			json_reader_read_member (reader, "snippet");
Packit 4b6dd7
Packit 4b6dd7
			json_reader_read_member (reader, "title");
Packit 4b6dd7
			title = json_reader_get_string_value (reader);
Packit 4b6dd7
			json_reader_end_member (reader);
Packit 4b6dd7
Packit 4b6dd7
			child_error = json_reader_get_error (reader);
Packit 4b6dd7
Packit 4b6dd7
			if (child_error != NULL) {
Packit 4b6dd7
				return gdata_parser_error_from_json_error (reader,
Packit 4b6dd7
				                                           child_error,
Packit 4b6dd7
				                                           error);
Packit 4b6dd7
			}
Packit 4b6dd7
Packit 4b6dd7
			/* Create the category. */
Packit 4b6dd7
			category = g_object_new (category_type,
Packit 4b6dd7
			                         "term", id,
Packit 4b6dd7
			                         "label", title,
Packit 4b6dd7
			                         NULL);
Packit 4b6dd7
			priv->categories = g_list_prepend (priv->categories,
Packit 4b6dd7
			                                   category);
Packit 4b6dd7
Packit 4b6dd7
			json_reader_end_member (reader);  /* snippet */
Packit 4b6dd7
			json_reader_end_element (reader);  /* category */
Packit 4b6dd7
		}
Packit 4b6dd7
Packit 4b6dd7
		return TRUE;
Packit 4b6dd7
	} else if (g_strcmp0 (json_reader_get_member_name (reader), "kind") == 0 ||
Packit 4b6dd7
	           g_strcmp0 (json_reader_get_member_name (reader), "etag") == 0 ||
Packit 4b6dd7
	           g_strcmp0 (json_reader_get_member_name (reader), "id") == 0) {
Packit 4b6dd7
		/* Ignore. */
Packit 4b6dd7
		return TRUE;
Packit 4b6dd7
	} else {
Packit 4b6dd7
		return GDATA_PARSABLE_CLASS (gdata_app_categories_parent_class)->parse_json (parsable, reader, user_data, error);
Packit 4b6dd7
	}
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static gboolean
Packit 4b6dd7
post_parse_json (GDataParsable *parsable, gpointer user_data, GError **error)
Packit 4b6dd7
{
Packit 4b6dd7
	GDataAPPCategoriesPrivate *priv = GDATA_APP_CATEGORIES (parsable)->priv;
Packit 4b6dd7
Packit 4b6dd7
	/* Reverse our lists of stuff. */
Packit 4b6dd7
	priv->categories = g_list_reverse (priv->categories);
Packit 4b6dd7
Packit 4b6dd7
	return TRUE;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static const gchar *
Packit 4b6dd7
get_content_type (void)
Packit 4b6dd7
{
Packit 4b6dd7
	return "application/json";
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * gdata_app_categories_get_categories:
Packit 4b6dd7
 * @self: a #GDataAPPCategories
Packit 4b6dd7
 *
Packit 4b6dd7
 * Returns a list of the categories in this category list.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Return value: (element-type GData.Category) (transfer none): a #GList of #GDataCategorys
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.7.0
Packit 4b6dd7
 */
Packit 4b6dd7
GList *
Packit 4b6dd7
gdata_app_categories_get_categories (GDataAPPCategories *self)
Packit 4b6dd7
{
Packit 4b6dd7
	g_return_val_if_fail (GDATA_IS_APP_CATEGORIES (self), NULL);
Packit 4b6dd7
	return self->priv->categories;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * gdata_app_categories_is_fixed:
Packit 4b6dd7
 * @self: a #GDataAPPCategories
Packit 4b6dd7
 *
Packit 4b6dd7
 * Returns #GDataAPPCategories:is-fixed.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Return value: whether entries may use categories not in this category list
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.7.0
Packit 4b6dd7
 */
Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_app_categories_is_fixed (GDataAPPCategories *self)
Packit 4b6dd7
{
Packit 4b6dd7
	g_return_val_if_fail (GDATA_IS_APP_CATEGORIES (self), FALSE);
Packit 4b6dd7
	return self->priv->fixed;
Packit 4b6dd7
}