File: http_client.c

package info (click to toggle)
libsyncml 0.5.4-2.1
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 3,276 kB
  • sloc: ansic: 38,414; xml: 355; makefile: 71; sh: 50
file content (566 lines) | stat: -rw-r--r-- 17,222 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
/*
 * libsyncml - A syncml protocol implementation
 * Copyright (C) 2005  Armin Bauer <armin.bauer@opensync.org>
 * Copyright (C) 2007-2009  Michael Bell <michael.bell@opensync.org>
 *
 * This library 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 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 */
 
#include <libsyncml/syncml.h>
#include <libsyncml/syncml_internals.h>
#include <libsyncml/sml_error_internals.h>

#include <libsyncml/sml_transport_internals.h>

#include "http_client_internals.h"

static void smlTransportHttpClientSend(void *userdata, void *link, SmlTransportData *data, SmlError *error);
static void smlTransportHttpClientDisconnect(void *data, void *linkdata);
static SmlBool smlTransportHttpClientFinalize(void *data, SmlError **error);

#ifdef HAVE_LIBSOUP22
#define soup_message_headers_get soup_message_get_header
#define soup_message_headers_append soup_message_add_header
#endif

#ifdef HAVE_LIBSOUP22
static void smlTransportHttpClientCallback(SoupMessage *msg, gpointer userdata)
{
	smlTrace(TRACE_ENTRY, "%s(%p, %p)", __func__, msg, userdata);
#else
static void smlTransportHttpClientCallback(SoupSession *session, SoupMessage *msg, gpointer userdata)
{
	/* session is only traced to avoid warnings from gcc profiling */
	smlTrace(TRACE_ENTRY, "%s(%p, %p, %p)", __func__, session, msg, userdata);
#endif
	SmlTransportHttpClientEnv *env = userdata;
	SmlError *error = NULL;

	/* handle potential session shutdown */
	if (env->connectDone && msg->status_code == SOUP_STATUS_CANCELLED)
	{
		/* FIXME: This is clearly a disconnect.
		 * FIXME: You must check if a disconnect is ongoing.
		 */
		smlTrace(TRACE_EXIT, "%s - ignoring due to shutdown", __func__);
		return;
	}

	/* handle a fresh connection */
	if (!env->connectDone)
	{
		/* This is the first answer or any other event which is
		 * detected after the first message was sent.
		 * We have to check and signal if the connection is ok or not.
		 */
		if (!SOUP_STATUS_IS_SUCCESSFUL (msg->status_code))
		{
			smlErrorSet(&error,
				 SML_ERROR_GENERIC,
				 "Connection failed (%d) - %s", msg->status_code, msg->reason_phrase);
			goto error;
		}
		else
		{
			/* If a transport has no public connect function
			 * then the connect event is sent by the
			 * transport layer itself.
			 */
			smlTrace(TRACE_INTERNAL, "%s: Connect done", __func__);
			if (!env->tsp->connected)
			{
				/* If a user of the library know that connect
				 * is not available then this is tolerated.
				 */
        			smlTransportReceiveEvent(
					env->tsp, NULL,
					SML_TRANSPORT_EVENT_CONNECT_DONE,
					NULL, NULL);
			}
		}
		env->connectDone = TRUE;
	}
	smlTrace(TRACE_INTERNAL, "%s: Result: %d %s",
		__func__, msg->status_code, msg->reason_phrase);

	/* start http handling with some checks */

	/* check the library status for errors */
	if (!SOUP_STATUS_IS_SUCCESSFUL (msg->status_code)) {
		smlErrorSet(&error, SML_ERROR_GENERIC, "Call not successfull: %d %s",
			msg->status_code, msg->reason_phrase);
		goto error;
	}

	/* check the header of the received message */
	const char *header = soup_message_headers_get(msg->response_headers, "Content-Type");
	smlTrace(TRACE_INTERNAL, "%s: content type ::= %s",
		__func__, header);
	
	SmlMimeType mimetype = SML_MIMETYPE_UNKNOWN;
	if (header && !g_strncasecmp(header, SML_ELEMENT_XML, strlen(SML_ELEMENT_XML)))
		mimetype = SML_MIMETYPE_XML;
	else if(header && !g_strncasecmp(header, SML_ELEMENT_WBXML, strlen(SML_ELEMENT_WBXML)))
		mimetype = SML_MIMETYPE_WBXML;
	else if(header && !g_strncasecmp(header, SML_ELEMENT_SAN, strlen(SML_ELEMENT_SAN)))
		mimetype = SML_MIMETYPE_SAN;
	else if (header) {
		smlErrorSet(&error, SML_ERROR_GENERIC, "Unknown mimetype");
		goto error;
	} else {
		smlErrorSet(&error, SML_ERROR_GENERIC, "Faulty mimetype");
		goto error;
		
	}

	/* prepare the received message */
	char *data;
	gsize length;

#ifdef HAVE_LIBSOUP22
	length = msg->response.length;
#else
	length = msg->response_body->length;
#endif
	smlTrace(TRACE_INTERNAL, "%s: The message length is %i.", __func__, length);

	/* We need one byte more than the response length
	 * because the data can be a native XML message.
	 * If the data is a native XML message then it is
	 * sometimes directly used as string.
	 *
	 * The string is automatically NULL terminated
	 * because smlTryMalloc0 fills the new memory with NULLs.
	 */
	data = smlTryMalloc0(length + 1, &error);
	if (!data)
		goto error;

#ifdef HAVE_LIBSOUP22
	memcpy(data, msg->response.body, length);
#else
	memcpy(data, msg->response_body->data, length);
#endif

	SmlTransportData *tspdata = smlTransportDataNew(data, length, mimetype, TRUE, &error);
	data = NULL;
	if (!tspdata)
		goto error_free_data;

	/* signal the received message */
	smlTransportReceiveEvent(env->tsp, NULL, SML_TRANSPORT_EVENT_DATA, tspdata, NULL);

	/* cleanup */
	smlTransportDataDeref(tspdata);

	smlTrace(TRACE_EXIT, "%s", __func__);
	return;
	
error_free_data:
	smlSafeCFree(&data);
error:
	smlTransportReceiveEvent(env->tsp, NULL, SML_TRANSPORT_EVENT_ERROR, NULL, error);
	smlTrace(TRACE_EXIT_ERROR, "%s: %s", __func__, smlErrorPrint(&error));
	smlErrorDeref(&error);
}

/* This is the authentication callback for libsoup.
 * If a SyncML server uses HTTP then the specification allows
 * standard HTTP authentication. This callback provides the
 * http library with the user and passphrase for the SyncML
 * account. Usually this is not required because the most
 * SyncML server manage the authentication via SyncHdr.
 */

#ifdef HAVE_LIBSOUP22
static void
_authenticate (SoupSession *session, SoupMessage *msg,
	      const char *auth_type, const char *auth_realm,
	      char **username, char **password, gpointer data)
{
	SmlTransportHttpClientEnv *env = data;
	smlTrace(TRACE_INTERNAL, "%s: authentication via auth_type %s", __func__, VA_STRING(auth_type));
	*username = g_strdup(env->username);
	*password = g_strdup(env->password);
}
#else
static void
_authenticate (SoupSession *session, SoupMessage *msg,
	       SoupAuth *auth, gboolean retrying, gpointer data)
{
	smlTrace(TRACE_INTERNAL, "%s(%p, %p, %p, %d, %p)", __func__, session, msg, auth, retrying, data);
	SmlTransportHttpClientEnv *env = data;
	smlTrace(TRACE_INTERNAL, "%s: authentication via auth_type %s", __func__, VA_STRING(soup_auth_get_scheme_name(auth)));

	if (!retrying)
		soup_auth_authenticate(auth, env->username, env->password);
}
#endif

static SmlBool smlTransportHttpClientSetConfigOption(
		SmlTransport *tsp,
		const char *name,
		const char *value,
		SmlError **error)
{
	smlTrace(TRACE_ENTRY, "%s(%p, %s, %s, %p)", __func__, tsp, VA_STRING(name), VA_STRING(value), error);
	CHECK_ERROR_REF
	smlAssert(tsp);
	smlAssert(tsp->transport_data);
	SmlTransportHttpClientEnv *env = tsp->transport_data;	

	if (!strcmp(name, SML_TRANSPORT_CONFIG_URL)) {
		if (env->url)
			smlSafeCFree(&(env->url));
		if (env->uri)
			soup_uri_free(env->uri);
		env->url = g_strdup(value);
		env->uri = soup_uri_new(env->url);
		if (env->uri == NULL) {
			smlErrorSet(error, SML_ERROR_INTERNAL_MISCONFIGURATION,
				"The configured url %s is wrong.", env->url);
			smlTrace(TRACE_EXIT_ERROR, "%s - %s", __func__, smlErrorPrint(error));
			return FALSE;
		}
		smlTrace(TRACE_INTERNAL, "%s: URL %s detected", __func__, VA_STRING(env->url));
	} else if (!strcmp(name, SML_TRANSPORT_CONFIG_PROXY)) {
		env->proxy = g_strdup(value);
		smlTrace(TRACE_INTERNAL, "%s: PROXY %s detected", __func__, VA_STRING(env->proxy));
	} else if (!strcmp(name, SML_TRANSPORT_CONFIG_USERNAME)) {
		env->username = g_strdup(value);
		smlTrace(TRACE_INTERNAL, "%s: USERNAME %s detected", __func__, VA_STRING(env->username));
	} else if (!strcmp(name, SML_TRANSPORT_CONFIG_PASSWORD)) {
		env->password = g_strdup(value);
		smlTrace(TRACE_INTERNAL, "%s: PASSWORD ******* detected", __func__);
	} else if (!strcmp(name, SML_TRANSPORT_CONFIG_SSL_CA_FILE)) {
		env->cafile = g_strdup(value);
		smlTrace(TRACE_INTERNAL, "%s: SSL_CA_FILE %s detected", __func__, VA_STRING(env->cafile));
	} else {
		smlErrorSet(error, SML_ERROR_INTERNAL_MISCONFIGURATION, "Unknown parameter %s found.", name);
		smlTrace(TRACE_EXIT_ERROR, "%s - %s", __func__, smlErrorPrint(error));
		return FALSE;
	}

	smlTrace(TRACE_EXIT, "%s", __func__);
	return TRUE;
}

/* WARNING: Do not register this function as connect function.
 *          This is only an internal connect function.
 */
static void smlTransportHttpClientConnect(void *data)
{
	smlTrace(TRACE_ENTRY, "%s(%p)", __func__, data);
	smlAssert(data);
	SmlTransportHttpClientEnv *env = data;
	SmlError *error = NULL;

	if (!env->tsp->context)
	{
		smlErrorSet(&error, SML_ERROR_INTERNAL_MISCONFIGURATION,
			"HTTP client runs only in asynchronous mode. So the context must be set.");
		goto error;
	}

	env->connectDone = FALSE;
	env->disconnectDone = FALSE;

	if (env->proxy != NULL && strlen(env->proxy) > 0)
	{
		if (env->cafile != NULL && strlen(env->cafile))
		{
#ifdef HAVE_LIBSOUP22_SOLARIS
			env->session = soup_session_sync_new_with_options(
#else
			env->session = soup_session_async_new_with_options(
					SOUP_SESSION_ASYNC_CONTEXT, env->tsp->context,
#endif
					SOUP_SESSION_PROXY_URI, env->proxy,
					SOUP_SESSION_SSL_CA_FILE, env->cafile,
					NULL);
			/* FIXME: libsoup does not support CRLs
			 * FIXME: CRL support is required for minimum security.
			 * FIXME: http://bugzilla.gnome.org/show_bug.cgi?id=547881
			 */
		} else {
#ifdef HAVE_LIBSOUP22_SOLARIS
			env->session = soup_session_sync_new_with_options(
#else
			env->session = soup_session_async_new_with_options(
					SOUP_SESSION_ASYNC_CONTEXT, env->tsp->context,
#endif
					SOUP_SESSION_PROXY_URI, env->proxy,
					NULL);
		}
	} else {
		if (env->cafile != NULL && strlen(env->cafile))
		{
#ifdef HAVE_LIBSOUP22_SOLARIS
			env->session = soup_session_sync_new_with_options(
#else
			env->session = soup_session_async_new_with_options(
					SOUP_SESSION_ASYNC_CONTEXT, env->tsp->context,
#endif
					SOUP_SESSION_SSL_CA_FILE, env->cafile,
					NULL);
		} else {
#ifdef HAVE_LIBSOUP22_SOLARIS
			env->session = soup_session_sync_new();
#else
			env->session = soup_session_async_new_with_options(
					SOUP_SESSION_ASYNC_CONTEXT, env->tsp->context,
					NULL);
#endif
		}
	}
	if (!env->session) {
		smlErrorSet(&error, SML_ERROR_GENERIC, "Unable to create new session");
		goto error;
	}

	/* add credentials to the environment and
	 * enable authentication callback for http authentication
	 */
	if (env->username || env->password)
	{
		g_signal_connect (env->session, "authenticate", G_CALLBACK (_authenticate), env);
	} else {
		env->username = NULL;
		env->password = NULL;
	}

	smlTrace(TRACE_EXIT, "%s: %p", __func__, env);
	return;
error:
	smlTrace(TRACE_EXIT_ERROR, "%s: %s", __func__, smlErrorPrint(&error));
	smlTransportReceiveEvent(env->tsp, NULL, SML_TRANSPORT_EVENT_ERROR, NULL, error);
}

static SmlBool smlTransportHttpClientSetResponseURI(
		SmlTransport *tsp,
		const char *uri,
		SmlError **error)
{
	smlTrace(TRACE_ENTRY, "%s(%p, %s, %p)", __func__, tsp, VA_STRING(uri), error);
	CHECK_ERROR_REF
	smlAssert(tsp);
	smlAssert(tsp->transport_data);
	SmlTransportHttpClientEnv *env = tsp->transport_data;	
	smlAssert(uri);

	if (env->url)
		smlSafeCFree(&(env->url));
	if (env->uri)
		soup_uri_free(env->uri);

	env->url = g_strdup(uri);
	env->uri = soup_uri_new(env->url);
	if (env->uri == NULL) {
		smlErrorSet(error, SML_ERROR_INTERNAL_MISCONFIGURATION,
			"The specified url \"%s\" is wrong.", env->url);
		smlTrace(TRACE_EXIT_ERROR, "%s - %s", __func__, smlErrorPrint(error));
		return FALSE;
	}

	smlTrace(TRACE_EXIT, "%s", __func__);
	return TRUE;
}

static SmlBool smlTransportHttpClientCleanupSession(
			gpointer data,
			SmlError **error)
{
	smlTrace(TRACE_ENTRY, "%s", __func__);
	CHECK_ERROR_REF
	smlAssert(data);

	SoupSession *session = data;
	
	soup_session_abort(session);
	g_object_unref(session);

	smlTrace(TRACE_EXIT, "%s", __func__);
	return TRUE;
}

static SmlBool smlTransportHttpClientFinalize(void *data, SmlError **error)
{
	smlTrace(TRACE_ENTRY, "%s(%p, %p)", __func__, data, error);
	CHECK_ERROR_REF
	smlAssert(data);
	SmlTransportHttpClientEnv *env = data;
	
	smlAssert(env->tsp);

	if (env->session)
	{
		if (!smlThreadCallFunction(env->tsp->thread, smlTransportHttpClientCleanupSession, env->session, error))
			goto error;
		env->session = NULL;
	}

	if (env->uri)
		soup_uri_free(env->uri);

	if (env->url)
		smlSafeCFree(&(env->url));

	if (env->proxy)
		smlSafeCFree(&(env->proxy));

	smlSafeFree((gpointer *)&env);
	
	smlTrace(TRACE_EXIT, "%s", __func__);
	return TRUE;
error:
	smlTrace(TRACE_EXIT_ERROR, "%s - %s", __func__, smlErrorPrint(error));
	return FALSE;
}

static void smlTransportHttpClientSend(void *userdata, void *link_, SmlTransportData *data, SmlError *error)
{
	smlTrace(TRACE_ENTRY, "%s(%p, %p, %p, %p)", __func__, userdata, link_, data, error);
	smlAssert(error || data);
	smlAssert(userdata);
	SmlTransportHttpClientEnv *env = userdata;
	smlAssert(env);
	smlAssert(env->uri);
	
	if (error)
		goto error;

	if (!env->connectDone)
		smlTransportHttpClientConnect(userdata);
		
	SoupMessage *msg = soup_message_new_from_uri(SOUP_METHOD_POST, env->uri);
	if (!msg) {
		smlErrorSet(&error, SML_ERROR_GENERIC, "unknown libsoup error during message_new");
		goto error;
	}

	const char *content_type;
	switch (data->type) {
		case SML_MIMETYPE_XML:
			content_type = SML_ELEMENT_XML;
			break;
		case SML_MIMETYPE_WBXML:
			content_type = SML_ELEMENT_WBXML;
			break;
		case SML_MIMETYPE_SAN:
			content_type = SML_ELEMENT_SAN;
			break;
		default:
			smlErrorSet(&error, SML_ERROR_GENERIC, "Unknown Mimetype %d", data->type);
			goto error_free_message;
	}

 	soup_message_headers_append(msg->request_headers, "Accept", content_type);
 	soup_message_set_request (msg, content_type,
#ifdef HAVE_LIBSOUP22
				  SOUP_BUFFER_SYSTEM_OWNED,
#else
				  SOUP_MEMORY_TAKE,
#endif
				  g_memdup(data->data, data->size), data->size);

#ifdef HAVE_LIBSOUP22
	smlTrace(TRACE_INTERNAL, "%s: data length: %i", __func__, msg->request.length);

#else
	smlTrace(TRACE_INTERNAL, "%s: data length: %i", __func__, msg->request_body->length);
#endif
	
#ifdef HAVE_LIBSOUP22_SOLARIS
	soup_session_send_message(env->session, msg);
	smlTrace(TRACE_INTERNAL, "%s: sent message and starting callback", __func__);
	smlTransportHttpClientCallback(msg, userdata);
	g_object_unref(msg); /* synchronous mode !!! */
#else
	soup_session_queue_message(env->session, msg, smlTransportHttpClientCallback, userdata);
#endif
	
	smlTrace(TRACE_EXIT, "%s", __func__);
	return;
	
error_free_message:
	g_object_unref(msg);
error:
	smlTransportReceiveEvent(env->tsp, NULL, SML_TRANSPORT_EVENT_ERROR, NULL, error);
	smlTrace(TRACE_EXIT_ERROR, "%s: %s", __func__, smlErrorPrint(&error));
	smlErrorDeref(&error);
}

static void smlTransportHttpClientDisconnect(void *data, void *linkdata)
{
	smlTrace(TRACE_ENTRY, "%s(%p, %p)", __func__, data, linkdata);
	smlAssert(data);
	SmlTransportHttpClientEnv *env = data;
	smlAssert(env);
	smlAssert(env->tsp);

	if (!env->connectDone && !env->session)
	{
		/* The client is not connected. */
		env->disconnectDone = TRUE;
        	smlTransportReceiveEvent(env->tsp, NULL, SML_TRANSPORT_EVENT_DISCONNECT_DONE, NULL, NULL);
		smlTrace(TRACE_EXIT, "%s - ignoring because never connected", __func__);
		return;
	}

	smlAssert(env->session);

	/* The only reason to implement a disconnect function is the fact
	 * that some servers need a TCP/IP disconnect to cleanly finish
	 * a SyncML session.
	 *
	 * Otherwise we are locked into an endless loop of Slow-Syncs.
	 */

	soup_session_abort(env->session);
	g_object_unref(env->session);
	env->session = NULL;

	/* Make a new disconnect object */
	env->disconnectDone = FALSE;
        smlTransportReceiveEvent(env->tsp, NULL, SML_TRANSPORT_EVENT_DISCONNECT_DONE, NULL, NULL);

        smlTrace(TRACE_EXIT, "%s", __func__);
}

SmlBool smlTransportHttpClientNew(SmlTransport *tsp, SmlError **error)
{
	CHECK_ERROR_REF
	smlAssert(tsp);

#ifdef HAVE_LIBSOUP22_SOLARIS
	smlTrace(TRACE_INTERNAL, "%s: Enabled libsoup 2.2 Solaris workarounds", __func__);
#endif

	tsp->functions.set_config_option = smlTransportHttpClientSetConfigOption;
	tsp->functions.set_response_uri = smlTransportHttpClientSetResponseURI;
	tsp->functions.disconnect = smlTransportHttpClientDisconnect;
	tsp->functions.finalize = smlTransportHttpClientFinalize;
	tsp->functions.send = smlTransportHttpClientSend;

	SmlTransportHttpClientEnv *env = smlTryMalloc0(sizeof(SmlTransportHttpClientEnv), error);
	if (!env)
		return FALSE;
	tsp->transport_data = env;
	env->tsp = tsp;

	return TRUE;
}