/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */

/*

 * soup-request.c: Protocol-independent streaming request interface

 *

 * Copyright (C) 2009, 2010 Red Hat, Inc.

 * Copyright (C) 2010, Igalia S.L.

 *

 * 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 License

 * along with this library; see the file COPYING.LIB.  If not, write to

 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,

 * Boston, MA 02110-1301, USA.

 */

#ifdef HAVE_CONFIG_H

#include <config.h>

#endif

#include <glib/gi18n-lib.h>

#include "soup-request.h"

#include "soup.h"

#include "soup-requester.h"

/**

 * SECTION:soup-request

 * @short_description: Protocol-independent streaming request interface

 *

 * A #SoupRequest is created by #SoupSession, and represents a request

 * to retrieve a particular URI.

 */

/**

 * SoupRequest:

 *

 * A request to retrieve a particular URI.

 *

 * Since: 2.42

 */

enum {

	PROP_0,

	PROP_URI,

	PROP_SESSION

};

struct _SoupRequestPrivate {

	SoupURI *uri;

	SoupSession *session;

};

static void soup_request_initable_interface_init (GInitableIface *initable_interface);

G_DEFINE_TYPE_WITH_CODE (SoupRequest, soup_request, G_TYPE_OBJECT,

                         G_ADD_PRIVATE (SoupRequest)

			 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE,

						soup_request_initable_interface_init))

static void

soup_request_init (SoupRequest *request)

{

	request->priv = soup_request_get_instance_private (request);

}

static void

soup_request_finalize (GObject *object)

{

	SoupRequest *request = SOUP_REQUEST (object);

	g_clear_pointer (&request->priv->uri, soup_uri_free);

	g_clear_object (&request->priv->session);

	G_OBJECT_CLASS (soup_request_parent_class)->finalize (object);

}

static void

soup_request_set_property (GObject      *object,

			   guint prop_id,

			   const GValue *value,

			   GParamSpec   *pspec)

{

	SoupRequest *request = SOUP_REQUEST (object);

	switch (prop_id) {

	case PROP_URI:

		if (request->priv->uri)

			soup_uri_free (request->priv->uri);

		request->priv->uri = g_value_dup_boxed (value);

		break;

	case PROP_SESSION:

		if (request->priv->session)

			g_object_unref (request->priv->session);

		request->priv->session = g_value_dup_object (value);

		break;

	default:

		G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);

		break;

	}

}

static void

soup_request_get_property (GObject    *object,

			   guint prop_id,

			   GValue     *value,

			   GParamSpec *pspec)

{

	SoupRequest *request = SOUP_REQUEST (object);

	switch (prop_id) {

	case PROP_URI:

		g_value_set_boxed (value, request->priv->uri);

		break;

	case PROP_SESSION:

		g_value_set_object (value, request->priv->session);

		break;

	default:

		G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);

		break;

	}

}

static gboolean

soup_request_initable_init (GInitable     *initable,

			    GCancellable  *cancellable,

			    GError       **error)

{

	SoupRequest *request = SOUP_REQUEST (initable);

	gboolean ok;

	if (!request->priv->uri) {

		g_set_error (error, SOUP_REQUEST_ERROR, SOUP_REQUEST_ERROR_BAD_URI,

			     _("No URI provided"));

		return FALSE;

	}

	ok = SOUP_REQUEST_GET_CLASS (initable)->

		check_uri (request, request->priv->uri, error);

	if (!ok && error && !*error) {

		char *uri_string = soup_uri_to_string (request->priv->uri, FALSE);

		g_set_error (error, SOUP_REQUEST_ERROR, SOUP_REQUEST_ERROR_BAD_URI,

			     _("Invalid “%s” URI: %s"),

			     request->priv->uri->scheme,

			     uri_string);

		g_free (uri_string);

	}

	return ok;

}

static gboolean

soup_request_default_check_uri (SoupRequest  *request,

				SoupURI      *uri,

				GError      **error)

{

	return TRUE;

}

/* Default implementation: assume the sync implementation doesn't block */

static void

soup_request_default_send_async (SoupRequest          *request,

				 GCancellable         *cancellable,

				 GAsyncReadyCallback   callback,

				 gpointer              user_data)

{

	GTask *task;

	GInputStream *stream;

	GError *error = NULL;

	task = g_task_new (request, cancellable, callback, user_data);

	stream = soup_request_send (request, cancellable, &error);

	if (stream)

		g_task_return_pointer (task, stream, g_object_unref);

	else

		g_task_return_error (task, error);

	g_object_unref (task);

}

static GInputStream *

soup_request_default_send_finish (SoupRequest          *request,

				  GAsyncResult         *result,

				  GError              **error)

{

	return g_task_propagate_pointer (G_TASK (result), error);

}

/**

 * soup_request_send:

 * @request: a #SoupRequest

 * @cancellable: a #GCancellable or %NULL

 * @error: return location for a #GError, or %NULL

 *

 * Synchronously requests the URI pointed to by @request, and returns

 * a #GInputStream that can be used to read its contents.

 *

 * Note that you cannot use this method with #SoupRequests attached to

 * a #SoupSessionAsync.

 *

 * Return value: (transfer full): a #GInputStream that can be used to

 *   read from the URI pointed to by @request.

 *

 * Since: 2.42

 */

GInputStream *

soup_request_send (SoupRequest          *request,

		   GCancellable         *cancellable,

		   GError              **error)

{

	return SOUP_REQUEST_GET_CLASS (request)->

		send (request, cancellable, error);

}

/**

 * soup_request_send_async:

 * @request: a #SoupRequest

 * @cancellable: a #GCancellable or %NULL

 * @callback: a #GAsyncReadyCallback

 * @user_data: user data passed to @callback

 *

 * Begins an asynchronously request for the URI pointed to by

 * @request.

 *

 * Note that you cannot use this method with #SoupRequests attached to

 * a #SoupSessionSync.

 *

 * Since: 2.42

 */

void

soup_request_send_async (SoupRequest         *request,

			 GCancellable        *cancellable,

			 GAsyncReadyCallback  callback,

			 gpointer             user_data)

{

	SOUP_REQUEST_GET_CLASS (request)->

		send_async (request, cancellable, callback, user_data);

}

/**

 * soup_request_send_finish:

 * @request: a #SoupRequest

 * @result: the #GAsyncResult

 * @error: return location for a #GError, or %NULL

 *

 * Gets the result of a soup_request_send_async().

 *

 * Return value: (transfer full): a #GInputStream that can be used to

 *   read from the URI pointed to by @request.

 *

 * Since: 2.42

 */

GInputStream *

soup_request_send_finish (SoupRequest          *request,

			  GAsyncResult         *result,

			  GError              **error)

{

	return SOUP_REQUEST_GET_CLASS (request)->

		send_finish (request, result, error);

}

static void

soup_request_class_init (SoupRequestClass *request_class)

{

	GObjectClass *object_class = G_OBJECT_CLASS (request_class);

	request_class->check_uri = soup_request_default_check_uri;

	request_class->send_async = soup_request_default_send_async;

	request_class->send_finish = soup_request_default_send_finish;

	object_class->finalize = soup_request_finalize;

	object_class->set_property = soup_request_set_property;

	object_class->get_property = soup_request_get_property;

	/**

	 * SOUP_REQUEST_URI:

	 *

	 * Alias for the #SoupRequest:uri property, qv.

	 *

	 * Since: 2.42

	 */

	/**

	 * SoupRequest:uri:

	 *

	 * The request URI.

	 *

	 * Since: 2.42

	 */

	g_object_class_install_property (

		 object_class, PROP_URI,

		 g_param_spec_boxed (SOUP_REQUEST_URI,

				     "URI",

				     "The request URI",

				     SOUP_TYPE_URI,

				     G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));

	/**

	 * SOUP_REQUEST_SESSION:

	 *

	 * Alias for the #SoupRequest:session property, qv.

	 *

	 * Since: 2.42

	 */

	/**

	 * SoupRequest:session:

	 *

	 * The request's #SoupSession.

	 *

	 * Since: 2.42

	 */

	g_object_class_install_property (

		 object_class, PROP_SESSION,

		 g_param_spec_object (SOUP_REQUEST_SESSION,

				      "Session",

				      "The request's session",

				      SOUP_TYPE_SESSION,

				      G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));

}

static void

soup_request_initable_interface_init (GInitableIface *initable_interface)

{

	initable_interface->init = soup_request_initable_init;

}

/**

 * soup_request_get_uri:

 * @request: a #SoupRequest

 *

 * Gets @request's URI

 *

 * Return value: (transfer none): @request's URI

 *

 * Since: 2.42

 */

SoupURI *

soup_request_get_uri (SoupRequest *request)

{

	return request->priv->uri;

}

/**

 * soup_request_get_session:

 * @request: a #SoupRequest

 *

 * Gets @request's #SoupSession

 *

 * Return value: (transfer none): @request's #SoupSession

 *

 * Since: 2.42

 */

SoupSession *

soup_request_get_session (SoupRequest *request)

{

	return request->priv->session;

}

/**

 * soup_request_get_content_length:

 * @request: a #SoupRequest

 *

 * Gets the length of the data represented by @request. For most

 * request types, this will not be known until after you call

 * soup_request_send() or soup_request_send_finish().

 *

 * Return value: the length of the data represented by @request,

 *   or -1 if not known.

 *

 * Since: 2.42

 */

goffset

soup_request_get_content_length (SoupRequest *request)

{

	return SOUP_REQUEST_GET_CLASS (request)->get_content_length (request);

}

/**

 * soup_request_get_content_type:

 * @request: a #SoupRequest

 *

 * Gets the type of the data represented by @request. For most request

 * types, this will not be known until after you call

 * soup_request_send() or soup_request_send_finish().

 *

 * As in the HTTP Content-Type header, this may include parameters

 * after the MIME type.

 *

 * Return value: (nullable): the type of the data represented by

 *   @request, or %NULL if not known.

 *

 * Since: 2.42

 */

const char *

soup_request_get_content_type (SoupRequest  *request)

{

	return SOUP_REQUEST_GET_CLASS (request)->get_content_type (request);

}