summaryrefslogtreecommitdiff
path: root/libsoup/xmlrpc/soup-xmlrpc.c
blob: 42dcda9c78288c1852b78d2c3e917165eda26a81 (plain)
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
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * soup-xmlrpc.c: XML-RPC parser/generator
 *
 * Copyright 2007 Red Hat, Inc.
 * Copyright 2007 OpenedHand Ltd.
 * Copyright 2015 Collabora ltd.
 *
 * Author:
 *   Eduardo Lima Mitev  <elima@igalia.com>
 *   Xavier Claessens <xavier.claessens@collabora.com>
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <string.h>
#include <errno.h>
#include <libxml/tree.h>
#include "soup-xmlrpc.h"
#include "soup.h"

static gboolean insert_value (xmlNode  *parent, GVariant *value, GError **error);

static gboolean
insert_array (xmlNode *parent, GVariant *value, GError **error)
{
	xmlNode *node;
	GVariantIter iter;
	GVariant *child;

	node = xmlNewChild (parent, NULL,
	                    (const xmlChar *)"array", NULL);
	node = xmlNewChild (node, NULL,
	                    (const xmlChar *)"data", NULL);

	g_variant_iter_init (&iter, value);
	while ((child = g_variant_iter_next_value (&iter))) {
		if (!insert_value (node, child, error)) {
			g_variant_unref (child);
			return FALSE;
		}
		g_variant_unref (child);
	}

	return TRUE;
}

static gboolean
insert_struct_member (xmlNode *parent, GVariant *value, GError **error)
{
	xmlNode *member;
	GVariant *mname;
	GVariant *mvalue;
	gboolean ret = FALSE;

	mname = g_variant_get_child_value (value, 0);
	mvalue = g_variant_get_child_value (value, 1);

	if (g_variant_classify (mname) != G_VARIANT_CLASS_STRING) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Only string keys are supported in dictionaries, got %s",
			     g_variant_get_type_string (mname));
		goto fail;
	}

	member = xmlNewChild (parent, NULL,
	                      (const xmlChar *)"member", NULL);

	xmlNewTextChild (member, NULL,
	                 (const xmlChar *)"name",
	                 (const xmlChar *)g_variant_get_string (mname, NULL));

	ret = insert_value (member, mvalue, error);

fail:
	g_variant_unref (mname);
	g_variant_unref (mvalue);

	return ret;
}

static gboolean
insert_struct (xmlNode *parent, GVariant *value, GError **error)
{
	xmlNode *struct_node;
	GVariantIter iter;
	GVariant *child;

	struct_node = xmlNewChild (parent, NULL,
	                           (const xmlChar *)"struct", NULL);

	g_variant_iter_init (&iter, value);
	while ((child = g_variant_iter_next_value (&iter))) {
		if (!insert_struct_member (struct_node, child, error)) {
			g_variant_unref (child);
			return FALSE;
		}
		g_variant_unref (child);
	}

	return TRUE;
}

static gboolean
insert_value (xmlNode *parent, GVariant *value, GError **error)
{
	xmlNode *xvalue;
	const char *type_str = NULL;
	char buf[128];

	xvalue = xmlNewChild (parent, NULL, (const xmlChar *)"value", NULL);

	switch (g_variant_classify (value)) {
	case G_VARIANT_CLASS_BOOLEAN:
		g_snprintf (buf, sizeof (buf), "%d", g_variant_get_boolean (value));
		type_str = "boolean";
		break;
	case G_VARIANT_CLASS_BYTE:
		g_snprintf (buf, sizeof (buf), "%u", g_variant_get_byte (value));
		type_str = "int";
		break;
	case G_VARIANT_CLASS_INT16:
		g_snprintf (buf, sizeof (buf), "%d", g_variant_get_int16 (value));
		type_str = "int";
		break;
	case G_VARIANT_CLASS_UINT16:
		g_snprintf (buf, sizeof (buf), "%u", g_variant_get_uint16 (value));
		type_str = "int";
		break;
	case G_VARIANT_CLASS_INT32:
		g_snprintf (buf, sizeof (buf), "%d", g_variant_get_int32 (value));
		type_str = "int";
		break;
	case G_VARIANT_CLASS_UINT32:
		g_snprintf (buf, sizeof (buf), "%u", g_variant_get_uint32 (value));
		type_str = "i8";
		break;
	case G_VARIANT_CLASS_INT64:
		g_snprintf (buf, sizeof (buf), "%"G_GINT64_FORMAT, g_variant_get_int64 (value));
		type_str = "i8";
		break;
	case G_VARIANT_CLASS_DOUBLE:
		g_ascii_dtostr (buf, sizeof (buf), g_variant_get_double (value));
		type_str = "double";
		break;
	case G_VARIANT_CLASS_STRING:
		xmlNewTextChild (xvalue, NULL,
		                 (const xmlChar *)"string",
		                 (const xmlChar *)g_variant_get_string (value, NULL));
		break;
	case G_VARIANT_CLASS_VARIANT: {
		GVariant *child;

		xmlUnlinkNode (xvalue);
		xmlFreeNode (xvalue);

		child = g_variant_get_variant (value);
		if (!insert_value (parent, child, error)) {
			g_variant_unref (child);
			return FALSE;
		}
		g_variant_unref (child);
		break;
	}
	case G_VARIANT_CLASS_ARRAY: {
		if (g_variant_is_of_type (value, G_VARIANT_TYPE_BYTESTRING)) {
			char *encoded;

			encoded = g_base64_encode (g_variant_get_data (value),
			                           g_variant_get_size (value));
			xmlNewChild (xvalue, NULL,
			             (const xmlChar *)"base64",
			             (const xmlChar *)encoded);
			g_free (encoded);
		} else if (g_variant_is_of_type (value, G_VARIANT_TYPE_DICTIONARY)) {
			if (!insert_struct (xvalue, value, error))
				return FALSE;
		} else {
			if (!insert_array (xvalue, value, error))
				return FALSE;
		}

		break;
	}
	case G_VARIANT_CLASS_TUPLE: {
		/* Special case for custom types */
		if (g_variant_is_of_type (value, G_VARIANT_TYPE ("(oss)"))) {
			const char *path;
			const char *type;
			const char *v;

			g_variant_get (value, "(&o&s&s)", &path, &type, &v);
			if (g_str_equal (path, "/org/gnome/libsoup/ExtensionType")) {
				xmlNewTextChild (xvalue, NULL,
				                 (const xmlChar *)type,
				                 (const xmlChar *)v);
				break;
			}
		}

		if (!insert_array (xvalue, value, error))
			return FALSE;
		break;
	}
	case G_VARIANT_CLASS_DICT_ENTRY: {
		xmlNode *node;

		node = xmlNewChild (xvalue, NULL,
		                    (const xmlChar *)"struct", NULL);
		if (!insert_struct_member (node, value, error))
			return FALSE;
		break;
	}
	case G_VARIANT_CLASS_HANDLE:
	case G_VARIANT_CLASS_MAYBE:
	case G_VARIANT_CLASS_UINT64:
	case G_VARIANT_CLASS_OBJECT_PATH:
	case G_VARIANT_CLASS_SIGNATURE:
	default:
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Unsupported type: %s", g_variant_get_type_string (value));
		goto fail;
	}

	if (type_str != NULL) {
		xmlNewTextChild (xvalue, NULL,
		                 (const xmlChar *)type_str,
		                 (const xmlChar *)buf);
	}

	return TRUE;

fail:
	return FALSE;
}

/**
 * soup_xmlrpc_build_request:
 * @method_name: the name of the XML-RPC method
 * @params: a #GVariant tuple
 * @error: a #GError, or %NULL
 *
 * This creates an XML-RPC methodCall and returns it as a string.
 * This is the low-level method that soup_xmlrpc_message_new() is
 * built on.
 *
 * @params is a #GVariant tuple representing the method parameters.
 *
 * Serialization details:
 *  - "a{s*}" and "{s*}" are serialized as &lt;struct&gt;
 *  - "ay" is serialized as &lt;base64&gt;
 *  - Other arrays and tuples are serialized as &lt;array&gt;
 *  - booleans are serialized as &lt;boolean&gt;
 *  - byte, int16, uint16 and int32 are serialized as &lt;int&gt;
 *  - uint32 and int64 are serialized as the nonstandard &lt;i8&gt; type
 *  - doubles are serialized as &lt;double&gt;
 *  - Strings are serialized as &lt;string&gt;
 *  - Variants (i.e. "v" type) are unwrapped and their child is serialized.
 *  - #GVariants created by soup_xmlrpc_variant_new_datetime() are serialized as
 *    &lt;dateTime.iso8601&gt;
 *  - Other types are not supported and will return %NULL and set @error.
 *    This notably includes: object-paths, signatures, uint64, handles, maybes
 *    and dictionaries with non-string keys.
 *
 * If @params is floating, it is consumed.
 *
 * Return value: the text of the methodCall, or %NULL on error.
 * Since: 2.52
 **/
char *
soup_xmlrpc_build_request (const char  *method_name,
			   GVariant    *params,
			   GError     **error)
{
	xmlDoc *doc;
	xmlNode *node, *param;
	xmlChar *xmlbody;
	GVariantIter iter;
	GVariant *child;
	int len;
	char *body = NULL;

	g_return_val_if_fail (g_variant_is_of_type (params, G_VARIANT_TYPE_TUPLE), NULL);

	g_variant_ref_sink (params);

	doc = xmlNewDoc ((const xmlChar *)"1.0");
	doc->standalone = FALSE;
	doc->encoding = xmlCharStrdup ("UTF-8");

	node = xmlNewDocNode (doc, NULL, (const xmlChar *)"methodCall", NULL);
	xmlDocSetRootElement (doc, node);
	xmlNewChild (node, NULL, (const xmlChar *)"methodName",
		     (const xmlChar *)method_name);

	node = xmlNewChild (node, NULL, (const xmlChar *)"params", NULL);
	g_variant_iter_init (&iter, params);
	while ((child = g_variant_iter_next_value (&iter))) {
		param  = xmlNewChild (node, NULL,
				      (const xmlChar *)"param", NULL);
		if (!insert_value (param, child, error)) {
			xmlFreeDoc (doc);
			g_variant_unref (child);
			g_variant_unref (params);
			return NULL;
		}
		g_variant_unref (child);
	}

	xmlDocDumpMemory (doc, &xmlbody, &len);
	body = g_strndup ((char *)xmlbody, len);
	xmlFree (xmlbody);

	xmlFreeDoc (doc);
	g_variant_unref (params);

	return body;
}

/**
 * soup_xmlrpc_message_new:
 * @uri: URI of the XML-RPC service
 * @method_name: the name of the XML-RPC method to invoke at @uri
 * @params: a #GVariant tuple
 * @error: a #GError, or %NULL
 *
 * Creates an XML-RPC methodCall and returns a #SoupMessage, ready
 * to send, for that method call.
 *
 * See soup_xmlrpc_build_request() for serialization details.
 *
 * If @params is floating, it is consumed.
 *
 * Returns: (transfer full): a #SoupMessage encoding the
 *   indicated XML-RPC request, or %NULL on error.
 *
 * Since: 2.52
 **/
SoupMessage *
soup_xmlrpc_message_new (const char  *uri,
			 const char  *method_name,
			 GVariant    *params,
			 GError     **error)
{
	SoupMessage *msg;
	char *body;

	body = soup_xmlrpc_build_request (method_name, params, error);
	if (!body)
		return NULL;

	msg = soup_message_new ("POST", uri);
	soup_message_set_request (msg, "text/xml", SOUP_MEMORY_TAKE,
				  body, strlen (body));
	return msg;
}

/**
 * soup_xmlrpc_build_response:
 * @value: the return value
 * @error: a #GError, or %NULL
 *
 * This creates a (successful) XML-RPC methodResponse and returns it
 * as a string. To create a fault response, use soup_xmlrpc_build_fault(). This
 * is the low-level method that soup_xmlrpc_message_set_response() is built on.
 *
 * See soup_xmlrpc_build_request() for serialization details, but note
 * that since a method can only have a single return value, @value
 * should not be a tuple here (unless the return value is an array).
 *
 * If @value is floating, it is consumed.
 *
 * Returns: the text of the methodResponse, or %NULL on error.
 *
 * Since: 2.52
 **/
char *
soup_xmlrpc_build_response (GVariant *value, GError **error)
{
	xmlDoc *doc;
	xmlNode *node;
	xmlChar *xmlbody;
	char *body;
	int len;

	g_variant_ref_sink (value);

	doc = xmlNewDoc ((const xmlChar *)"1.0");
	doc->standalone = FALSE;
	doc->encoding = xmlCharStrdup ("UTF-8");

	node = xmlNewDocNode (doc, NULL,
			      (const xmlChar *)"methodResponse", NULL);
	xmlDocSetRootElement (doc, node);

	node = xmlNewChild (node, NULL, (const xmlChar *)"params", NULL);
	node = xmlNewChild (node, NULL, (const xmlChar *)"param", NULL);
	if (!insert_value (node, value, error)) {
		xmlFreeDoc (doc);
		g_variant_unref (value);
		return NULL;
	}

	xmlDocDumpMemory (doc, &xmlbody, &len);
	body = g_strndup ((char *)xmlbody, len);
	xmlFree (xmlbody);

	xmlFreeDoc (doc);
	g_variant_unref (value);

	return body;
}

char *
soup_xmlrpc_build_faultv (int         fault_code,
                          const char *fault_format,
                          va_list     args) G_GNUC_PRINTF (2, 0);

char *
soup_xmlrpc_build_faultv (int fault_code, const char *fault_format, va_list args)
{
	xmlDoc *doc;
	xmlNode *node, *member;
	GVariant *value;
	xmlChar *xmlbody;
	char *fault_string, *body;
	int len;

	fault_string = g_strdup_vprintf (fault_format, args);

	doc = xmlNewDoc ((const xmlChar *)"1.0");
	doc->standalone = FALSE;
	doc->encoding = xmlCharStrdup ("UTF-8");

	node = xmlNewDocNode (doc, NULL,
			      (const xmlChar *)"methodResponse", NULL);
	xmlDocSetRootElement (doc, node);
	node = xmlNewChild (node, NULL, (const xmlChar *)"fault", NULL);
	node = xmlNewChild (node, NULL, (const xmlChar *)"value", NULL);
	node = xmlNewChild (node, NULL, (const xmlChar *)"struct", NULL);

	member = xmlNewChild (node, NULL, (const xmlChar *)"member", NULL);
	xmlNewChild (member, NULL,
		     (const xmlChar *)"name", (const xmlChar *)"faultCode");
	value = g_variant_new_int32 (fault_code);
	insert_value (member, value, NULL);
	g_variant_unref (value);

	member = xmlNewChild (node, NULL, (const xmlChar *)"member", NULL);
	xmlNewChild (member, NULL,
		     (const xmlChar *)"name", (const xmlChar *)"faultString");
	value = g_variant_new_take_string (fault_string);
	insert_value (member, value, NULL);
	g_variant_unref (value);

	xmlDocDumpMemory (doc, &xmlbody, &len);
	body = g_strndup ((char *)xmlbody, len);
	xmlFree (xmlbody);
	xmlFreeDoc (doc);

	return body;
}

/**
 * soup_xmlrpc_build_fault:
 * @fault_code: the fault code
 * @fault_format: a printf()-style format string
 * @...: the parameters to @fault_format
 *
 * This creates an XML-RPC fault response and returns it as a string.
 * (To create a successful response, use
 * soup_xmlrpc_build_method_response().)
 *
 * Return value: the text of the fault
 **/
char *
soup_xmlrpc_build_fault (int fault_code, const char *fault_format, ...)
{
	va_list args;
	char *body;

	va_start (args, fault_format);
	body = soup_xmlrpc_build_faultv (fault_code, fault_format, args);
	va_end (args);
	return body;
}

/**
 * soup_xmlrpc_message_set_fault:
 * @msg: an XML-RPC request
 * @fault_code: the fault code
 * @fault_format: a printf()-style format string
 * @...: the parameters to @fault_format
 *
 * Sets the status code and response body of @msg to indicate an
 * unsuccessful XML-RPC call, with the error described by @fault_code
 * and @fault_format.
 *
 * Since: 2.52
 **/
void
soup_xmlrpc_message_set_fault (SoupMessage *msg, int fault_code,
			       const char *fault_format, ...)
{
	va_list args;
	char *body;

	va_start (args, fault_format);
	body = soup_xmlrpc_build_faultv (fault_code, fault_format, args);
	va_end (args);

	soup_message_set_status (msg, SOUP_STATUS_OK);
	soup_message_set_response (msg, "text/xml", SOUP_MEMORY_TAKE,
				   body, strlen (body));
}

/**
 * soup_xmlrpc_message_set_response:
 * @msg: an XML-RPC request
 * @value: a #GVariant
 * @error: a #GError, or %NULL
 *
 * Sets the status code and response body of @msg to indicate a
 * successful XML-RPC call, with a return value given by @value. To set a
 * fault response, use soup_xmlrpc_message_set_fault().
 *
 * See soup_xmlrpc_build_request() for serialization details.
 *
 * If @value is floating, it is consumed.
 *
 * Returns: %TRUE on success, %FALSE otherwise.
 *
 * Since: 2.52
 **/
gboolean
soup_xmlrpc_message_set_response (SoupMessage *msg, GVariant *value, GError **error)
{
	char *body;

	body = soup_xmlrpc_build_response (value, error);
	if (!body)
		return FALSE;

	soup_message_set_status (msg, SOUP_STATUS_OK);
	soup_message_set_response (msg, "text/xml", SOUP_MEMORY_TAKE,
				   body, strlen (body));
	return TRUE;
}

static GVariant *parse_value (xmlNode *node, const char **signature, GError **error);

static xmlNode *
find_real_node (xmlNode *node)
{
	while (node && (node->type == XML_COMMENT_NODE ||
			xmlIsBlankNode (node)))
		node = node->next;
	return node;
}

static char *
signature_get_next_complete_type (const char **signature)
{
	GVariantClass class;
	const char *initial_signature;
	char *result;

	/* here it is assumed that 'signature' is a valid type string */

	initial_signature = *signature;
	class = (*signature)[0];

	if (class == G_VARIANT_CLASS_TUPLE || class == G_VARIANT_CLASS_DICT_ENTRY) {
		char stack[256] = {0};
		guint stack_len = 0;

		do {
			if ((*signature)[0] == G_VARIANT_CLASS_TUPLE) {
				stack[stack_len] = ')';
				stack_len++;
			}
			else if ( (*signature)[0] == G_VARIANT_CLASS_DICT_ENTRY) {
				stack[stack_len] = '}';
				stack_len++;
			}

			(*signature)++;

			if ( (*signature)[0] == stack[stack_len - 1])
				stack_len--;
		} while (stack_len > 0);

		(*signature)++;
	} else if (class == G_VARIANT_CLASS_ARRAY || class == G_VARIANT_CLASS_MAYBE) {
		char *tmp_sig;

		(*signature)++;
		tmp_sig = signature_get_next_complete_type (signature);
		g_free (tmp_sig);
	} else {
		(*signature)++;
	}

	result = g_strndup (initial_signature, (*signature) - initial_signature);

	return result;
}

static GVariant *
parse_array (xmlNode *node, const char **signature, GError **error)
{
	GVariant *variant = NULL;
	char *child_signature = NULL;
	char *array_signature = NULL;
	const char *tmp_signature;
	gboolean is_tuple = FALSE;
	xmlNode *member;
	GVariantBuilder builder;
	gboolean is_params = FALSE;

	if (signature && *signature[0] == G_VARIANT_CLASS_VARIANT)
		signature = NULL;

	if (g_str_equal (node->name, "array")) {
		node = find_real_node (node->children);
		if (!g_str_equal (node->name, "data")) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "<data> expected but got '%s'", node->name);
			goto fail;
		}
	} else if (g_str_equal (node->name, "params")) {
		is_params = TRUE;
	} else {
		g_assert_not_reached ();
	}

	if (signature != NULL) {
		if ((*signature)[0] == G_VARIANT_CLASS_TUPLE) {
			tmp_signature = *signature;
			array_signature = signature_get_next_complete_type (&tmp_signature);
			is_tuple = TRUE;
		}
		(*signature)++;
		child_signature = signature_get_next_complete_type (signature);
	} else {
		child_signature = g_strdup ("v");
	}

	if (!array_signature)
		array_signature = g_strdup_printf ("a%s", child_signature);
	g_variant_builder_init (&builder, G_VARIANT_TYPE (array_signature));

	for (member = find_real_node (node->children);
	     member;
	     member = find_real_node (member->next)) {
		GVariant *child;
		xmlNode *xval = member;

		if (is_params) {
			if (!g_str_equal (member->name, "param")) {
				g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
					     "<param> expected but got '%s'", member->name);
				goto fail;
			}
			xval = find_real_node (member->children);
		}

		if (strcmp ((const char *)xval->name, "value") != 0) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "<value> expected but got '%s'", xval->name);
			goto fail;
		}

		if (is_tuple && child_signature[0] == ')') {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "Too many values for tuple");
			goto fail;
		}

		tmp_signature = child_signature;
		child = parse_value (xval, &tmp_signature, error);
		if (child == NULL)
			goto fail;

		if (is_tuple) {
			g_free (child_signature),
			child_signature = signature_get_next_complete_type (signature);
		}

		g_variant_builder_add_value (&builder, child);
	}

	if (is_tuple && child_signature[0] != ')') {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Too few values for tuple");
		goto fail;
	}

	variant = g_variant_builder_end (&builder);

fail:
	g_variant_builder_clear (&builder);
	g_free (child_signature);
	g_free (array_signature);

	/* compensate the (*signature)++ call at the end of 'recurse()' */
	if (signature)
		(*signature)--;

	return variant;
}

static void
parse_dict_entry_signature (const char **signature,
			    char       **entry_signature,
			    char       **key_signature,
			    char       **value_signature)
{
	const char *tmp_sig;

	if (signature)
		*entry_signature = signature_get_next_complete_type (signature);
	else
		*entry_signature = g_strdup ("{sv}");

	tmp_sig = (*entry_signature) + 1;
	*key_signature = signature_get_next_complete_type (&tmp_sig);
	*value_signature = signature_get_next_complete_type (&tmp_sig);
}

static GVariant *
parse_dictionary (xmlNode *node, const char **signature, GError **error)
{
	GVariant *variant = NULL;
	char *dict_signature;
	char *entry_signature;
	char *key_signature;
	char *value_signature;
	GVariantBuilder builder;
	xmlNode *member;

	if (signature && *signature[0] == G_VARIANT_CLASS_VARIANT)
		signature = NULL;

	if (signature)
		(*signature)++;

	parse_dict_entry_signature (signature,
				    &entry_signature,
				    &key_signature,
				    &value_signature);

	dict_signature = g_strdup_printf ("a%s", entry_signature);
	g_variant_builder_init (&builder, G_VARIANT_TYPE (dict_signature));

	if (!g_str_equal (key_signature, "s")) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Dictionary key must be string but got '%s'", key_signature);
		goto fail;
	}

	for (member = find_real_node (node->children);
	     member;
	     member = find_real_node (member->next)) {
		xmlNode *child, *mname, *mxval;
		const char *tmp_signature;
		GVariant *value;
		xmlChar *content;

		if (strcmp ((const char *)member->name, "member") != 0) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "<member> expected but got '%s'", member->name);
			goto fail;
		}

		mname = mxval = NULL;

		for (child = find_real_node (member->children);
		     child;
		     child = find_real_node (child->next)) {
			if (!strcmp ((const char *)child->name, "name"))
				mname = child;
			else if (!strcmp ((const char *)child->name, "value"))
				mxval = child;
			else {
				g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
					     "<name> or <value> expected but got '%s'", child->name);
				goto fail;
			}
		}

		if (!mname || !mxval) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "Missing name or value in <member>");
			goto fail;
		}

		tmp_signature = value_signature;
		value = parse_value (mxval, &tmp_signature, error);
		if (!value)
			goto fail;

		content = xmlNodeGetContent (mname);
		g_variant_builder_open (&builder, G_VARIANT_TYPE (entry_signature));
		g_variant_builder_add (&builder, "s", content);
		g_variant_builder_add_value (&builder, value);
		g_variant_builder_close (&builder);
		xmlFree (content);
	}

	variant = g_variant_builder_end (&builder);

fail:
	g_variant_builder_clear (&builder);
	g_free (value_signature);
	g_free (key_signature);
	g_free (entry_signature);
	g_free (dict_signature);

	/* compensate the (*signature)++ call at the end of 'recurse()' */
	if (signature != NULL)
		(*signature)--;

	return variant;
}

static GVariant *
parse_number (xmlNode *typenode, GVariantClass class, GError **error)
{
	xmlChar *content;
	const char *str;
	char *endptr;
	gint64 num = 0;
	guint64 unum = 0;
	GVariant *variant = NULL;

	content = xmlNodeGetContent (typenode);
	str = (const char *) content;

	errno = 0;

	if (class == G_VARIANT_CLASS_UINT64)
		unum = g_ascii_strtoull (str, &endptr, 10);
	else
		num = g_ascii_strtoll (str, &endptr, 10);

	if (errno || endptr == str) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Couldn't parse number '%s'", str);
		goto fail;
	}

#define RANGE(v, min, max) \
G_STMT_START{ \
	if (v < min || v > max) { \
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS, \
			     "Number out of range '%s'", str); \
		goto fail; \
	} \
} G_STMT_END

	switch (class) {
	case G_VARIANT_CLASS_BOOLEAN:
		RANGE (num, 0, 1);
		variant = g_variant_new_boolean (num);
		break;
	case G_VARIANT_CLASS_BYTE:
		RANGE (num, 0, G_MAXUINT8);
		variant = g_variant_new_byte (num);
		break;
	case G_VARIANT_CLASS_INT16:
		RANGE (num, G_MININT16, G_MAXINT16);
		variant = g_variant_new_int16 (num);
		break;
	case G_VARIANT_CLASS_UINT16:
		RANGE (num, 0, G_MAXUINT16);
		variant = g_variant_new_uint16 (num);
		break;
	case G_VARIANT_CLASS_INT32:
		RANGE (num, G_MININT32, G_MAXINT32);
		variant = g_variant_new_int32 (num);
		break;
	case G_VARIANT_CLASS_UINT32:
		RANGE (num, 0, G_MAXUINT32);
		variant = g_variant_new_uint32 (num);
		break;
	case G_VARIANT_CLASS_INT64:
		RANGE (num, G_MININT64, G_MAXINT64);
		variant = g_variant_new_int64 (num);
		break;
	case G_VARIANT_CLASS_UINT64:
		RANGE (unum, 0, G_MAXUINT64);
		variant = g_variant_new_uint64 (unum);
		break;
	default:
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "<%s> node does not match signature",
			     (const char *)typenode->name);
		goto fail;
	}

fail:
	xmlFree (content);

	return variant;
}

static GVariant *
parse_double (xmlNode *typenode, GError **error)
{
	GVariant *variant = NULL;
	xmlChar *content;
	const char *str;
	char *endptr;
	gdouble d;

	content = xmlNodeGetContent (typenode);
	str = (const char *) content;

	errno = 0;
	d = g_ascii_strtod (str, &endptr);
	if (errno || endptr == str) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Couldn't parse double '%s'", str);
		goto fail;
	}

	variant = g_variant_new_double (d);

fail:
	xmlFree (content);

	return variant;
}

static GVariant *
parse_base64 (xmlNode *typenode, GError **error)
{
	GVariant *variant;
	xmlChar *content;
	guchar *decoded;
	gsize len;

	content = xmlNodeGetContent (typenode);
	decoded = g_base64_decode ((char *)content, &len);
	variant = g_variant_new_from_data (G_VARIANT_TYPE ("ay"),
					   decoded, len,
					   TRUE,
					   g_free, decoded);
	xmlFree (content);

	return variant;
}

static GVariant *
soup_xmlrpc_variant_new_custom (const char *type, const char *v)
{
	return g_variant_new ("(oss)", "/org/gnome/libsoup/ExtensionType",
			      type, v);
}

static GVariant *
parse_value (xmlNode *node, const char **signature, GError **error)
{
	xmlNode *typenode;
	const char *typename;
	xmlChar *content = NULL;
	GVariant *variant = NULL;
	GVariantClass class = G_VARIANT_CLASS_VARIANT;

	if (signature)
		class = *signature[0];

	if (g_str_equal ((const char *)node->name, "value")) {
		typenode = find_real_node (node->children);
		if (!typenode) {
			/* If no typenode, assume value's content is string */
			typename = "string";
			typenode = node;
		} else {
			typename = (const char *)typenode->name;
		}
	} else if (g_str_equal ((const char *)node->name, "params")) {
		typenode = node;
		typename = "params";
	} else {
		g_assert_not_reached ();
	}

	if (g_str_equal (typename, "boolean")) {
		if (class != G_VARIANT_CLASS_VARIANT && class != G_VARIANT_CLASS_BOOLEAN) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "<boolean> node does not match signature");
			goto fail;
		}
		variant = parse_number (typenode, G_VARIANT_CLASS_BOOLEAN, error);
	} else if (g_str_equal (typename, "int") || g_str_equal (typename, "i4")) {
		if (class == G_VARIANT_CLASS_VARIANT)
			variant = parse_number (typenode, G_VARIANT_CLASS_INT32, error);
		else
			variant = parse_number (typenode, class, error);
	} else if (g_str_equal (typename, "i8")) {
		if (class == G_VARIANT_CLASS_VARIANT)
			variant = parse_number (typenode, G_VARIANT_CLASS_INT64, error);
		else
			variant = parse_number (typenode, class, error);
	} else  if (g_str_equal (typename, "double")) {
		if (class != G_VARIANT_CLASS_VARIANT && class != G_VARIANT_CLASS_DOUBLE) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "<double> node does not match signature");
			goto fail;
		}
		variant = parse_double (typenode, error);
	} else  if (g_str_equal (typename, "string")) {
		if (class != G_VARIANT_CLASS_VARIANT && class != G_VARIANT_CLASS_STRING) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "<string> node does not match signature");
			goto fail;
		}
		content = xmlNodeGetContent (typenode);
		variant = g_variant_new_string ((const char *)content);
	} else if (g_str_equal (typename, "base64")) {
		if (class != G_VARIANT_CLASS_VARIANT) {
			if (!g_str_has_prefix (*signature, "ay")) {
				g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
					     "<base64> node does not match signature");
				goto fail;
			}
			(*signature)++;
		}
		variant = parse_base64 (typenode, error);
	} else if (g_str_equal (typename, "struct")) {
		if (class != G_VARIANT_CLASS_VARIANT &&
		    !g_str_has_prefix (*signature, "a{")) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "<struct> node does not match signature");
			goto fail;
		}
		variant = parse_dictionary (typenode, signature, error);
	} else if (g_str_equal (typename, "array") || g_str_equal (typename, "params")) {
		if (class != G_VARIANT_CLASS_VARIANT &&
		    class != G_VARIANT_CLASS_ARRAY &&
		    class != G_VARIANT_CLASS_TUPLE) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "<%s> node does not match signature", typename);
			goto fail;
		}
		variant = parse_array (typenode, signature, error);
	} else if (g_str_equal (typename, "dateTime.iso8601")) {
		if (class != G_VARIANT_CLASS_VARIANT) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "<dateTime.iso8601> node does not match signature");
			goto fail;
		}

		content = xmlNodeGetContent (typenode);
		variant = soup_xmlrpc_variant_new_custom ("dateTime.iso8601",
							  (const char *)content);
	} else {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Unknown node name %s", typename);
		goto fail;
	}

	if (variant && signature) {
		if (class == G_VARIANT_CLASS_VARIANT)
			variant = g_variant_new_variant (variant);
		(*signature)++;
	}

fail:
	if (content)
		xmlFree (content);

	return variant;
}

/**
 * SoupXMLRPCParams:
 *
 * Opaque structure containing XML-RPC methodCall parameter values.
 * Can be parsed using soup_xmlrpc_params_parse() and freed with
 * soup_xmlrpc_params_free().
 *
 * Since: 2.52
 */
struct _SoupXMLRPCParams
{
  xmlNode *node;
};

/**
 * soup_xmlrpc_params_free:
 * @self: a SoupXMLRPCParams
 *
 * Free a #SoupXMLRPCParams returned by soup_xmlrpc_parse_request().
 *
 * Since: 2.52
 */
void
soup_xmlrpc_params_free (SoupXMLRPCParams *self)
{
	g_return_if_fail (self != NULL);

	if (self->node)
		xmlFreeDoc (self->node->doc);
	g_slice_free (SoupXMLRPCParams, self);
}

static SoupXMLRPCParams *
soup_xmlrpc_params_new (xmlNode *node)
{
	SoupXMLRPCParams *self;

	self = g_slice_new (SoupXMLRPCParams);
	self->node = node;

	return self;
}

/**
 * soup_xmlrpc_params_parse:
 * @self: A #SoupXMLRPCParams
 * @signature: (allow-none): A valid #GVariant type string, or %NULL
 * @error: a #GError, or %NULL
 *
 * Parse method parameters returned by soup_xmlrpc_parse_request().
 *
 * Deserialization details:
 *  - If @signature is provided, &lt;int&gt; and &lt;i4&gt; can be deserialized
 *    to byte, int16, uint16, int32, uint32, int64 or uint64. Otherwise
 *    it will be deserialized to int32. If the value is out of range
 *    for the target type it will return an error.
 *  - &lt;struct&gt; will be deserialized to "a{sv}". @signature could define
 *    another value type (e.g. "a{ss}").
 *  - &lt;array&gt; will be deserialized to "av". @signature could define
 *    another element type (e.g. "as") or could be a tuple (e.g. "(ss)").
 *  - &lt;base64&gt; will be deserialized to "ay".
 *  - &lt;string&gt; will be deserialized to "s".
 *  - &lt;dateTime.iso8601&gt; will be deserialized to an unspecified variant
 *    type. If @signature is provided it must have the generic "v" type, which
 *    means there is no guarantee that it's actually a datetime that has been
 *    received. soup_xmlrpc_variant_get_datetime() must be used to parse and
 *    type check this special variant.
 *  - @signature must not have maybes, otherwise an error is returned.
 *  - Dictionaries must have string keys, otherwise an error is returned.
 *
 * Returns: (transfer full): a new (non-floating) #GVariant, or %NULL
 *
 * Since: 2.52
 */
GVariant *
soup_xmlrpc_params_parse (SoupXMLRPCParams  *self,
			  const char        *signature,
			  GError           **error)
{
	GVariant *value = NULL;

	g_return_val_if_fail (self, NULL);
	g_return_val_if_fail (!signature || g_variant_type_string_is_valid (signature), NULL);

	if (!self->node) {
		if (!signature || g_variant_type_equal (G_VARIANT_TYPE (signature), G_VARIANT_TYPE ("av")))
			value = g_variant_new_array (G_VARIANT_TYPE_VARIANT, NULL, 0);
		else if (g_variant_type_equal (G_VARIANT_TYPE (signature), G_VARIANT_TYPE_UNIT))
			value = g_variant_new_tuple (NULL, 0);
		else {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "Invalid signature '%s', was expecting '()'", signature);
			goto fail;
		}
	} else {
		value = parse_value (self->node, signature ? &signature : NULL, error);
	}

fail:
	return value ? g_variant_ref_sink (value) : NULL;
}

/**
 * soup_xmlrpc_parse_request:
 * @method_call: the XML-RPC methodCall string
 * @length: the length of @method_call, or -1 if it is NUL-terminated
 * @params: (out): on success, a new #SoupXMLRPCParams
 * @error: a #GError, or %NULL
 *
 * Parses @method_call and return the method name. Method parameters can be
 * parsed later using soup_xmlrpc_params_parse().
 *
 * Returns: (transfer full): method's name, or %NULL on error.
 * Since: 2.52
 **/
char *
soup_xmlrpc_parse_request (const char        *method_call,
			   int                length,
			   SoupXMLRPCParams **params,
			   GError           **error)
{
	xmlDoc *doc = NULL;
	xmlNode *node;
	xmlChar *xmlMethodName = NULL;
	char *method_name = NULL;

	doc = xmlParseMemory (method_call, length == -1 ? strlen (method_call) : length);
	if (!doc) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Could not parse XML document");
		goto fail;
	}

	node = xmlDocGetRootElement (doc);
	if (!node || strcmp ((const char *)node->name, "methodCall") != 0) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "<methodCall> node expected");
		goto fail;
	}

	node = find_real_node (node->children);
	if (!node || strcmp ((const char *)node->name, "methodName") != 0) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "<methodName> node expected");
		goto fail;
	}
	xmlMethodName = xmlNodeGetContent (node);

	if (params) {
		node = find_real_node (node->next);
		if (node) {
			if (strcmp ((const char *)node->name, "params") != 0) {
				g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
					     "<params> node expected");
				goto fail;
			}
			*params = soup_xmlrpc_params_new (node);
			doc = NULL;
		} else {
			*params = soup_xmlrpc_params_new (NULL);
		}
	}

	method_name = g_strdup ((char *)xmlMethodName);

fail:
	if (doc)
		xmlFreeDoc (doc);
	if (xmlMethodName)
		xmlFree (xmlMethodName);

	return method_name;
}

/**
 * soup_xmlrpc_parse_response:
 * @method_response: the XML-RPC methodResponse string
 * @length: the length of @method_response, or -1 if it is NUL-terminated
 * @signature: (allow-none): A valid #GVariant type string, or %NULL
 * @error: a #GError, or %NULL
 *
 * Parses @method_response and returns the return value. If
 * @method_response is a fault, %NULL is returned, and @error
 * will be set to an error in the %SOUP_XMLRPC_FAULT domain, with the error
 * code containing the fault code, and the error message containing
 * the fault string. If @method_response cannot be parsed, %NULL is returned,
 * and @error will be set to an error in the %SOUP_XMLRPC_ERROR domain.
 *
 * See soup_xmlrpc_params_parse() for deserialization details.
 *
 * Returns: (transfer full): a new (non-floating) #GVariant, or %NULL
 *
 * Since: 2.52
 **/
GVariant *
soup_xmlrpc_parse_response (const char *method_response,
			    int length,
			    const char *signature,
			    GError **error)
{
	xmlDoc *doc = NULL;
	xmlNode *node;
	GVariant *value = NULL;

	g_return_val_if_fail (!signature || g_variant_type_string_is_valid (signature), NULL);

	doc = xmlParseMemory (method_response,
				  length == -1 ? strlen (method_response) : length);
	if (!doc) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Failed to parse response XML");
		goto fail;
	}

	node = xmlDocGetRootElement (doc);
	if (!node || strcmp ((const char *)node->name, "methodResponse") != 0) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Missing 'methodResponse' node");
		goto fail;
	}

	node = find_real_node (node->children);
	if (!node) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "'methodResponse' has no child");
		goto fail;
	}

	if (!strcmp ((const char *)node->name, "fault")) {
		int fault_code;
		const char *fault_string;
		const char *fault_sig = "a{sv}";
		GVariant *fault_val;

		node = find_real_node (node->children);
		if (!node || strcmp ((const char *)node->name, "value") != 0) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "'fault' has no 'value' child");
			goto fail;
		}

		fault_val = parse_value (node, &fault_sig, error);
		if (!fault_val)
			goto fail;

		if (!g_variant_lookup (fault_val, "faultCode", "i", &fault_code) ||
		    !g_variant_lookup (fault_val, "faultString", "&s", &fault_string))  {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "'fault' missing 'faultCode' or 'faultString'");
			goto fail;
		}
		g_set_error (error, SOUP_XMLRPC_FAULT,
		             fault_code, "%s", fault_string);
		g_variant_unref (fault_val);
	} else if (!strcmp ((const char *)node->name, "params")) {
		node = find_real_node (node->children);
		if (!node || strcmp ((const char *)node->name, "param") != 0) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "'params' has no 'param' child");
			goto fail;
		}
		node = find_real_node (node->children);
		if (!node || strcmp ((const char *)node->name, "value") != 0) {
			g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
				     "'param' has no 'value' child");
			goto fail;
		}
		value = parse_value (node, signature ? &signature : NULL, error);
	}

fail:
	if (doc)
		xmlFreeDoc (doc);
	return value ? g_variant_ref_sink (value) : NULL;
}

/**
 * soup_xmlrpc_variant_new_datetime:
 * @date: a #SoupDate
 *
 * Construct a special #GVariant used to serialize a &lt;dateTime.iso8601&gt;
 * node. See soup_xmlrpc_build_request().
 *
 * The actual type of the returned #GVariant is unspecified and "v" or "*"
 * should be used in variant format strings. For example:
 * <informalexample><programlisting>
 *	args = g_variant_new ("(v)", soup_xmlrpc_variant_new_datetime (date));
 * </programlisting></informalexample>
 *
 * Returns: a floating #GVariant.
 *
 * Since: 2.52
 */
GVariant *
soup_xmlrpc_variant_new_datetime (SoupDate *date)
{
	GVariant *variant;
	char *str;

	str = soup_date_to_string (date, SOUP_DATE_ISO8601_XMLRPC);
	variant = soup_xmlrpc_variant_new_custom ("dateTime.iso8601", str);
	g_free (str);

	return variant;
}

/**
 * soup_xmlrpc_variant_get_datetime:
 * @variant: a #GVariant
 * @error: a #GError, or %NULL
 *
 * Get the #SoupDate from special #GVariant created by
 * soup_xmlrpc_variant_new_datetime() or by parsing a &lt;dateTime.iso8601&gt;
 * node. See soup_xmlrpc_params_parse().
 *
 * If @variant does not contain a datetime it will return an error but it is not
 * considered a programmer error because it generally means parameters received
 * are not in the expected type.
 *
 * Returns: a new #SoupDate, or %NULL on error.
 *
 * Since: 2.52
 */
SoupDate *
soup_xmlrpc_variant_get_datetime (GVariant *variant, GError **error)
{
	SoupDate *date = NULL;
	const char *path;
	const char *type;
	const char *v;

	if (!g_variant_is_of_type (variant, G_VARIANT_TYPE ("(oss)"))) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Variant is of type '%s' which is not expected for a datetime",
			     g_variant_get_type_string (variant));
		return NULL;
	}

	g_variant_get (variant, "(&o&s&s)", &path, &type, &v);

	if (!g_str_equal (path, "/org/gnome/libsoup/ExtensionType") ||
	    !g_str_equal (type, "dateTime.iso8601")) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Variant doesn't represent a datetime: %s",
			     g_variant_get_type_string (variant));
		return NULL;
	}

	date = soup_date_new_from_string (v);

	if (date == NULL) {
		g_set_error (error, SOUP_XMLRPC_ERROR, SOUP_XMLRPC_ERROR_ARGUMENTS,
			     "Can't parse datetime string: %s", v);
		return NULL;
	}

	return date;

}

/**
 * SOUP_XMLRPC_FAULT:
 *
 * A #GError domain representing an XML-RPC fault code. Used with
 * #SoupXMLRPCFault (although servers may also return fault codes not
 * in that enumeration).
 */

/**
 * SoupXMLRPCFault:
 * @SOUP_XMLRPC_FAULT_PARSE_ERROR_NOT_WELL_FORMED: request was not
 *   well-formed
 * @SOUP_XMLRPC_FAULT_PARSE_ERROR_UNSUPPORTED_ENCODING: request was in
 *   an unsupported encoding
 * @SOUP_XMLRPC_FAULT_PARSE_ERROR_INVALID_CHARACTER_FOR_ENCODING:
 *   request contained an invalid character
 * @SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_XML_RPC: request was not
 *   valid XML-RPC
 * @SOUP_XMLRPC_FAULT_SERVER_ERROR_REQUESTED_METHOD_NOT_FOUND: method
 *   not found
 * @SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_METHOD_PARAMETERS: invalid
 *   parameters
 * @SOUP_XMLRPC_FAULT_SERVER_ERROR_INTERNAL_XML_RPC_ERROR: internal
 *   error
 * @SOUP_XMLRPC_FAULT_APPLICATION_ERROR: start of reserved range for
 *   application error codes
 * @SOUP_XMLRPC_FAULT_SYSTEM_ERROR: start of reserved range for
 *   system error codes
 * @SOUP_XMLRPC_FAULT_TRANSPORT_ERROR: start of reserved range for
 *   transport error codes
 *
 * Pre-defined XML-RPC fault codes from <ulink
 * url="http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php">http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php</ulink>.
 * These are an extension, not part of the XML-RPC spec; you can't
 * assume servers will use them.
 */

G_DEFINE_QUARK (soup_xmlrpc_fault_quark, soup_xmlrpc_fault);
G_DEFINE_QUARK (soup_xmlrpc_error_quark, soup_xmlrpc_error);