Blame gdata/tests/gdata-dummy-authorizer.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 2014 <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-dummy-authorizer
Packit 4b6dd7
 * @short_description: GData dummy authorization interface
Packit 4b6dd7
 * @stability: Stable
Packit 4b6dd7
 * @include: tests/gdata-dummy-authorizer.h
Packit 4b6dd7
 *
Packit 4b6dd7
 * #GDataDummyAuthorizer is a dummy #GDataAuthorizer implementation intended for
Packit 4b6dd7
 * use in prototyping and testing code. It should not be used in production
Packit 4b6dd7
 * code.
Packit 4b6dd7
 *
Packit 4b6dd7
 * It adds a constant ‘Authorization’ header to all requests it processes whose
Packit 4b6dd7
 * domain is in the set of domains the authorizer was initialised with. All
Packit 4b6dd7
 * requests for other domains have no header added, and are considered
Packit 4b6dd7
 * non-authorized.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.16.0
Packit 4b6dd7
 */
Packit 4b6dd7
Packit 4b6dd7
#include <config.h>
Packit 4b6dd7
#include <string.h>
Packit 4b6dd7
#include <glib.h>
Packit 4b6dd7
#include <glib/gi18n-lib.h>
Packit 4b6dd7
Packit 4b6dd7
#include "gdata-dummy-authorizer.h"
Packit 4b6dd7
#include "gdata-private.h"
Packit 4b6dd7
Packit 4b6dd7
static void authorizer_init (GDataAuthorizerInterface *iface);
Packit 4b6dd7
static void finalize (GObject *object);
Packit 4b6dd7
Packit 4b6dd7
static void process_request (GDataAuthorizer *self,
Packit 4b6dd7
                             GDataAuthorizationDomain *domain,
Packit 4b6dd7
                             SoupMessage *message);
Packit 4b6dd7
static gboolean is_authorized_for_domain (GDataAuthorizer *self,
Packit 4b6dd7
                                          GDataAuthorizationDomain *domain);
Packit 4b6dd7
Packit 4b6dd7
struct _GDataDummyAuthorizerPrivate {
Packit 4b6dd7
	GMutex mutex; /* mutex for authorization_domains */
Packit 4b6dd7
Packit 4b6dd7
	/* Mapping from GDataAuthorizationDomain to itself; a set of domains
Packit 4b6dd7
	 * which are authorised. */
Packit 4b6dd7
	GHashTable *authorization_domains;
Packit 4b6dd7
};
Packit 4b6dd7
Packit 4b6dd7
G_DEFINE_TYPE_WITH_CODE (GDataDummyAuthorizer, gdata_dummy_authorizer,
Packit 4b6dd7
                         G_TYPE_OBJECT,
Packit 4b6dd7
                         G_IMPLEMENT_INTERFACE (GDATA_TYPE_AUTHORIZER,
Packit 4b6dd7
                                                authorizer_init))
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
gdata_dummy_authorizer_class_init (GDataDummyAuthorizerClass *klass)
Packit 4b6dd7
{
Packit 4b6dd7
	GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Packit 4b6dd7
Packit 4b6dd7
	g_type_class_add_private (klass, sizeof (GDataDummyAuthorizerPrivate));
Packit 4b6dd7
Packit 4b6dd7
	gobject_class->finalize = finalize;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
authorizer_init (GDataAuthorizerInterface *iface)
Packit 4b6dd7
{
Packit 4b6dd7
	iface->process_request = process_request;
Packit 4b6dd7
	iface->is_authorized_for_domain = is_authorized_for_domain;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
gdata_dummy_authorizer_init (GDataDummyAuthorizer *self)
Packit 4b6dd7
{
Packit 4b6dd7
	self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
Packit 4b6dd7
	                                          GDATA_TYPE_DUMMY_AUTHORIZER,
Packit 4b6dd7
	                                          GDataDummyAuthorizerPrivate);
Packit 4b6dd7
Packit 4b6dd7
	/* Set up the authorizer's mutex */
Packit 4b6dd7
	g_mutex_init (&(self->priv->mutex));
Packit 4b6dd7
	self->priv->authorization_domains = g_hash_table_new_full (g_direct_hash,
Packit 4b6dd7
	                                                           g_direct_equal,
Packit 4b6dd7
	                                                           g_object_unref,
Packit 4b6dd7
	                                                           NULL);
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
finalize (GObject *object)
Packit 4b6dd7
{
Packit 4b6dd7
	GDataDummyAuthorizerPrivate *priv = GDATA_DUMMY_AUTHORIZER (object)->priv;
Packit 4b6dd7
Packit 4b6dd7
	g_hash_table_destroy (priv->authorization_domains);
Packit 4b6dd7
	g_mutex_clear (&(priv->mutex));
Packit 4b6dd7
Packit 4b6dd7
	/* Chain up to the parent class */
Packit 4b6dd7
	G_OBJECT_CLASS (gdata_dummy_authorizer_parent_class)->finalize (object);
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
process_request (GDataAuthorizer *self, GDataAuthorizationDomain *domain,
Packit 4b6dd7
                 SoupMessage *message)
Packit 4b6dd7
{
Packit 4b6dd7
	GDataDummyAuthorizerPrivate *priv = GDATA_DUMMY_AUTHORIZER (self)->priv;
Packit 4b6dd7
Packit 4b6dd7
	/* Set the authorisation header */
Packit 4b6dd7
	g_mutex_lock (&(priv->mutex));
Packit 4b6dd7
Packit 4b6dd7
	if (g_hash_table_lookup (priv->authorization_domains, domain) != NULL) {
Packit 4b6dd7
		soup_message_headers_replace (message->request_headers,
Packit 4b6dd7
		                              "Authorization", "dummy");
Packit 4b6dd7
	}
Packit 4b6dd7
Packit 4b6dd7
	g_mutex_unlock (&(priv->mutex));
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static gboolean
Packit 4b6dd7
is_authorized_for_domain (GDataAuthorizer *self,
Packit 4b6dd7
                          GDataAuthorizationDomain *domain)
Packit 4b6dd7
{
Packit 4b6dd7
	GDataDummyAuthorizerPrivate *priv = GDATA_DUMMY_AUTHORIZER (self)->priv;
Packit 4b6dd7
	gpointer result;
Packit 4b6dd7
Packit 4b6dd7
	g_mutex_lock (&(priv->mutex));
Packit 4b6dd7
	result = g_hash_table_lookup (priv->authorization_domains, domain);
Packit 4b6dd7
	g_mutex_unlock (&(priv->mutex));
Packit 4b6dd7
Packit 4b6dd7
	/* Sanity check */
Packit 4b6dd7
	g_assert (result == NULL || result == domain);
Packit 4b6dd7
Packit 4b6dd7
	return (result != NULL);
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/*
Packit 4b6dd7
 * gdata_dummy_authorizer_new:
Packit 4b6dd7
 * @service_type: the #GType of a #GDataService subclass which the
Packit 4b6dd7
 * #GDataDummyAuthorizer will be used with
Packit 4b6dd7
 *
Packit 4b6dd7
 * Creates a new #GDataDummyAuthorizer.
Packit 4b6dd7
 *
Packit 4b6dd7
 * The #GDataAuthorizationDomains for the given @service_type (i.e. as
Packit 4b6dd7
 * returned by gdata_service_get_authorization_domains()) will be authorized,
Packit 4b6dd7
 * and all others will not.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Return value: (transfer full): a new #GDataDummyAuthorizer; unref with
Packit 4b6dd7
 * g_object_unref()
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.16.0
Packit 4b6dd7
 */
Packit 4b6dd7
GDataDummyAuthorizer *
Packit 4b6dd7
gdata_dummy_authorizer_new (GType service_type)
Packit 4b6dd7
{
Packit 4b6dd7
	GList/*<unowned GDataAuthorizationDomain>*/ *domains;  /* owned */
Packit 4b6dd7
	GDataDummyAuthorizer *retval = NULL;  /* owned */
Packit 4b6dd7
Packit 4b6dd7
	g_return_val_if_fail (g_type_is_a (service_type, GDATA_TYPE_SERVICE),
Packit 4b6dd7
	                      NULL);
Packit 4b6dd7
Packit 4b6dd7
	domains = gdata_service_get_authorization_domains (service_type);
Packit 4b6dd7
	retval = gdata_dummy_authorizer_new_for_authorization_domains (domains);
Packit 4b6dd7
	g_list_free (domains);
Packit 4b6dd7
Packit 4b6dd7
	return retval;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/*
Packit 4b6dd7
 * gdata_dummy_authorizer_new_for_authorization_domains:
Packit 4b6dd7
 * @authorization_domains: (element-type GDataAuthorizationDomain) (transfer none):
Packit 4b6dd7
 * a non-empty list of #GDataAuthorizationDomains to be authorized
Packit 4b6dd7
 * against by the #GDataDummyAuthorizer
Packit 4b6dd7
 *
Packit 4b6dd7
 * Creates a new #GDataDummyAuthorizer. This function is intended to be used
Packit 4b6dd7
 * only when the default authorization domain list for a single #GDataService,
Packit 4b6dd7
 * as used by gdata_dummy_authorizer_new(), isn't suitable. For example, this
Packit 4b6dd7
 * could be because the #GDataDummyAuthorizer will be used with multiple
Packit 4b6dd7
 * #GDataService subclasses, or because the client requires a specific set of
Packit 4b6dd7
 * authorization domains.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Return value: (transfer full): a new #GDataDummyAuthorizer; unref with
Packit 4b6dd7
 * g_object_unref()
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.16.0
Packit 4b6dd7
 */
Packit 4b6dd7
GDataDummyAuthorizer *
Packit 4b6dd7
gdata_dummy_authorizer_new_for_authorization_domains (GList *authorization_domains)
Packit 4b6dd7
{
Packit 4b6dd7
	GList *i;
Packit 4b6dd7
	GDataDummyAuthorizer *authorizer;
Packit 4b6dd7
Packit 4b6dd7
	g_return_val_if_fail (authorization_domains != NULL, NULL);
Packit 4b6dd7
Packit 4b6dd7
	authorizer = GDATA_DUMMY_AUTHORIZER (g_object_new (GDATA_TYPE_DUMMY_AUTHORIZER,
Packit 4b6dd7
	                                                   NULL));
Packit 4b6dd7
Packit 4b6dd7
	/* Register all the domains with the authorizer */
Packit 4b6dd7
	for (i = authorization_domains; i != NULL; i = i->next) {
Packit 4b6dd7
		GDataAuthorizationDomain *domain;
Packit 4b6dd7
Packit 4b6dd7
		g_return_val_if_fail (GDATA_IS_AUTHORIZATION_DOMAIN (i->data),
Packit 4b6dd7
		                      NULL);
Packit 4b6dd7
Packit 4b6dd7
		/* We don't have to lock the authoriser's mutex here as no other
Packit 4b6dd7
		 * code has seen the authoriser yet */
Packit 4b6dd7
		domain = GDATA_AUTHORIZATION_DOMAIN (i->data);
Packit 4b6dd7
		g_hash_table_insert (authorizer->priv->authorization_domains,
Packit 4b6dd7
		                     g_object_ref (domain), domain);
Packit 4b6dd7
	}
Packit 4b6dd7
Packit 4b6dd7
	return authorizer;
Packit 4b6dd7
}