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
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* soup-server.c: Asynchronous HTTP server
*
* Copyright (C) 2001-2003, Ximian, Inc.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string.h>
#include "soup-server.h"
#include "soup.h"
#include "soup-message-private.h"
#include "soup-misc-private.h"
#include "soup-path-map.h"
/**
* SECTION:soup-server
* @short_description: HTTP server
* @see_also: #SoupAuthDomain
*
* #SoupServer implements a simple HTTP server.
*
* To begin, create a server using soup_server_new(). Add at least one
* handler by calling soup_server_add_handler(); the handler will be
* called to process any requests underneath the path passed to
* soup_server_add_handler(). (If you want all requests to go to the
* same handler, just pass "/" (or %NULL) for the path.) Any request
* that does not match any handler will automatically be returned to
* the client with a 404 (Not Found) status.
*
* If you want to handle the special "*" URI (eg, "OPTIONS *"), you
* must explicitly register a handler for "*"; the default handler
* will not be used for that case.
*
* To add authentication to some or all paths, create an appropriate
* #SoupAuthDomain (qv), and add it to the server via
* soup_server_add_auth_domain(). (As with handlers, you must
* explicitly add "*" to an auth domain if you want it to be covered.)
*
* Additional processing options are available via #SoupServer's
* signals; Connect to #SoupServer::request-started to be notified
* every time a new request is being processed. (This gives you a
* chance to connect to the #SoupMessage "got-" signals in case you
* want to do processing before the body has been fully read.)
*
* Once the server is set up, start it processing connections by
* calling soup_server_run_async() or soup_server_run(). #SoupServer
* runs via the glib main loop; if you need to have a server that runs
* in another thread (or merely isn't bound to the default main loop),
* create a #GMainContext for it to use, and set that via the
* #SOUP_SERVER_ASYNC_CONTEXT property.
**/
G_DEFINE_TYPE (SoupServer, soup_server, G_TYPE_OBJECT)
enum {
REQUEST_STARTED,
REQUEST_READ,
REQUEST_FINISHED,
REQUEST_ABORTED,
LAST_SIGNAL
};
static guint signals[LAST_SIGNAL] = { 0 };
struct SoupClientContext {
SoupServer *server;
SoupSocket *sock;
SoupMessage *msg;
SoupAuthDomain *auth_domain;
char *auth_user;
int ref_count;
};
typedef struct {
char *path;
SoupServerCallback callback;
GDestroyNotify destroy;
gpointer user_data;
} SoupServerHandler;
typedef struct {
SoupAddress *iface;
guint port;
char *ssl_cert_file, *ssl_key_file;
GTlsCertificate *ssl_cert;
char *server_header;
GMainLoop *loop;
SoupSocket *listen_sock;
GSList *clients;
gboolean raw_paths;
SoupPathMap *handlers;
SoupServerHandler *default_handler;
GSList *auth_domains;
GMainContext *async_context;
char **http_aliases, **https_aliases;
} SoupServerPrivate;
#define SOUP_SERVER_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), SOUP_TYPE_SERVER, SoupServerPrivate))
#define SOUP_SERVER_SERVER_HEADER_BASE "libsoup/" PACKAGE_VERSION
enum {
PROP_0,
PROP_PORT,
PROP_INTERFACE,
PROP_SSL_CERT_FILE,
PROP_SSL_KEY_FILE,
PROP_TLS_CERTIFICATE,
PROP_ASYNC_CONTEXT,
PROP_RAW_PATHS,
PROP_SERVER_HEADER,
PROP_HTTP_ALIASES,
PROP_HTTPS_ALIASES,
LAST_PROP
};
static SoupClientContext *soup_client_context_ref (SoupClientContext *client);
static void soup_client_context_unref (SoupClientContext *client);
static void
free_handler (SoupServerHandler *hand)
{
g_free (hand->path);
g_slice_free (SoupServerHandler, hand);
}
static void
soup_server_init (SoupServer *server)
{
SoupServerPrivate *priv = SOUP_SERVER_GET_PRIVATE (server);
priv->handlers = soup_path_map_new ((GDestroyNotify)free_handler);
priv->http_aliases = g_new (char *, 2);
priv->http_aliases[0] = (char *)g_intern_string ("*");
priv->http_aliases[1] = NULL;
}
static void
soup_server_finalize (GObject *object)
{
SoupServer *server = SOUP_SERVER (object);
SoupServerPrivate *priv = SOUP_SERVER_GET_PRIVATE (server);
g_clear_object (&priv->iface);
g_free (priv->ssl_cert_file);
g_free (priv->ssl_key_file);
g_clear_object (&priv->ssl_cert);
g_free (priv->server_header);
g_clear_object (&priv->listen_sock);
while (priv->clients) {
SoupClientContext *client = priv->clients->data;
SoupSocket *sock = g_object_ref (client->sock);
priv->clients = g_slist_remove (priv->clients, client);
/* keep a ref on the client context so it doesn't get destroyed
* when we finish the message; the SoupSocket::disconnect
* handler will refer to client->server later when the socket is
* disconnected.
*/
soup_client_context_ref (client);
if (client->msg) {
soup_message_set_status (client->msg, SOUP_STATUS_IO_ERROR);
soup_message_io_finished (client->msg);
}
soup_socket_disconnect (sock);
g_object_unref (sock);
soup_client_context_unref (client);
}
g_clear_pointer (&priv->default_handler, free_handler);
soup_path_map_free (priv->handlers);
g_slist_free_full (priv->auth_domains, g_object_unref);
g_clear_pointer (&priv->loop, g_main_loop_unref);
g_clear_pointer (&priv->async_context, g_main_context_unref);
g_free (priv->http_aliases);
g_free (priv->https_aliases);
G_OBJECT_CLASS (soup_server_parent_class)->finalize (object);
}
static GObject *
soup_server_constructor (GType type,
guint n_construct_properties,
GObjectConstructParam *construct_properties)
{
GObject *server;
SoupServerPrivate *priv;
server = G_OBJECT_CLASS (soup_server_parent_class)->constructor (
type, n_construct_properties, construct_properties);
if (!server)
return NULL;
priv = SOUP_SERVER_GET_PRIVATE (server);
if (!priv->iface) {
priv->iface =
soup_address_new_any (SOUP_ADDRESS_FAMILY_IPV4,
priv->port);
}
if (priv->ssl_cert_file && priv->ssl_key_file) {
GError *error = NULL;
if (priv->ssl_cert)
g_object_unref (priv->ssl_cert);
priv->ssl_cert = g_tls_certificate_new_from_files (priv->ssl_cert_file, priv->ssl_key_file, &error);
if (!priv->ssl_cert) {
g_warning ("Could not read SSL certificate from '%s': %s",
priv->ssl_cert_file, error->message);
g_error_free (error);
g_object_unref (server);
return NULL;
}
}
priv->listen_sock =
soup_socket_new (SOUP_SOCKET_LOCAL_ADDRESS, priv->iface,
SOUP_SOCKET_SSL_CREDENTIALS, priv->ssl_cert,
SOUP_SOCKET_ASYNC_CONTEXT, priv->async_context,
NULL);
if (!soup_socket_listen (priv->listen_sock)) {
g_object_unref (server);
return NULL;
}
/* Re-resolve the interface address, in particular in case
* the passed-in address had SOUP_ADDRESS_ANY_PORT.
*/
g_object_unref (priv->iface);
priv->iface = soup_socket_get_local_address (priv->listen_sock);
g_object_ref (priv->iface);
priv->port = soup_address_get_port (priv->iface);
return server;
}
/* priv->http_aliases and priv->https_aliases are stored as arrays of
* *interned* strings, so we can't just use g_strdupv() to set them.
*/
static void
set_aliases (char ***variable, char **value)
{
int len, i;
if (*variable)
g_free (*variable);
if (!value) {
*variable = NULL;
return;
}
len = g_strv_length (value);
*variable = g_new (char *, len + 1);
for (i = 0; i < len; i++)
(*variable)[i] = (char *)g_intern_string (value[i]);
(*variable)[i] = NULL;
}
static void
soup_server_set_property (GObject *object, guint prop_id,
const GValue *value, GParamSpec *pspec)
{
SoupServerPrivate *priv = SOUP_SERVER_GET_PRIVATE (object);
const char *header;
switch (prop_id) {
case PROP_PORT:
priv->port = g_value_get_uint (value);
break;
case PROP_INTERFACE:
if (priv->iface)
g_object_unref (priv->iface);
priv->iface = g_value_get_object (value);
if (priv->iface)
g_object_ref (priv->iface);
break;
case PROP_SSL_CERT_FILE:
priv->ssl_cert_file =
g_strdup (g_value_get_string (value));
break;
case PROP_SSL_KEY_FILE:
priv->ssl_key_file =
g_strdup (g_value_get_string (value));
break;
case PROP_TLS_CERTIFICATE:
if (priv->ssl_cert)
g_object_unref (priv->ssl_cert);
priv->ssl_cert = g_value_dup_object (value);
break;
case PROP_ASYNC_CONTEXT:
priv->async_context = g_value_get_pointer (value);
if (priv->async_context)
g_main_context_ref (priv->async_context);
break;
case PROP_RAW_PATHS:
priv->raw_paths = g_value_get_boolean (value);
break;
case PROP_SERVER_HEADER:
g_free (priv->server_header);
header = g_value_get_string (value);
if (!header)
priv->server_header = NULL;
else if (!*header) {
priv->server_header =
g_strdup (SOUP_SERVER_SERVER_HEADER_BASE);
} else if (g_str_has_suffix (header, " ")) {
priv->server_header =
g_strdup_printf ("%s%s", header,
SOUP_SERVER_SERVER_HEADER_BASE);
} else
priv->server_header = g_strdup (header);
break;
case PROP_HTTP_ALIASES:
set_aliases (&priv->http_aliases, g_value_get_boxed (value));
break;
case PROP_HTTPS_ALIASES:
set_aliases (&priv->https_aliases, g_value_get_boxed (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
soup_server_get_property (GObject *object, guint prop_id,
GValue *value, GParamSpec *pspec)
{
SoupServerPrivate *priv = SOUP_SERVER_GET_PRIVATE (object);
switch (prop_id) {
case PROP_PORT:
g_value_set_uint (value, priv->port);
break;
case PROP_INTERFACE:
g_value_set_object (value, priv->iface);
break;
case PROP_SSL_CERT_FILE:
g_value_set_string (value, priv->ssl_cert_file);
break;
case PROP_SSL_KEY_FILE:
g_value_set_string (value, priv->ssl_key_file);
break;
case PROP_TLS_CERTIFICATE:
g_value_set_object (value, priv->ssl_cert);
break;
case PROP_ASYNC_CONTEXT:
g_value_set_pointer (value, priv->async_context ? g_main_context_ref (priv->async_context) : NULL);
break;
case PROP_RAW_PATHS:
g_value_set_boolean (value, priv->raw_paths);
break;
case PROP_SERVER_HEADER:
g_value_set_string (value, priv->server_header);
break;
case PROP_HTTP_ALIASES:
g_value_set_boxed (value, priv->http_aliases);
break;
case PROP_HTTPS_ALIASES:
g_value_set_boxed (value, priv->https_aliases);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
soup_server_class_init (SoupServerClass *server_class)
{
GObjectClass *object_class = G_OBJECT_CLASS (server_class);
g_type_class_add_private (server_class, sizeof (SoupServerPrivate));
/* virtual method override */
object_class->constructor = soup_server_constructor;
object_class->finalize = soup_server_finalize;
object_class->set_property = soup_server_set_property;
object_class->get_property = soup_server_get_property;
/* signals */
/**
* SoupServer::request-started:
* @server: the server
* @message: the new message
* @client: the client context
*
* Emitted when the server has started reading a new request.
* @message will be completely blank; not even the
* Request-Line will have been read yet. About the only thing
* you can usefully do with it is connect to its signals.
*
* If the request is read successfully, this will eventually
* be followed by a #SoupServer::request_read signal. If a
* response is then sent, the request processing will end with
* a #SoupServer::request_finished signal. If a network error
* occurs, the processing will instead end with
* #SoupServer::request_aborted.
**/
signals[REQUEST_STARTED] =
g_signal_new ("request-started",
G_OBJECT_CLASS_TYPE (object_class),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (SoupServerClass, request_started),
NULL, NULL,
NULL,
G_TYPE_NONE, 2,
SOUP_TYPE_MESSAGE,
SOUP_TYPE_CLIENT_CONTEXT);
/**
* SoupServer::request-read:
* @server: the server
* @message: the message
* @client: the client context
*
* Emitted when the server has successfully read a request.
* @message will have all of its request-side information
* filled in, and if the message was authenticated, @client
* will have information about that. This signal is emitted
* before any handlers are called for the message, and if it
* sets the message's #status_code, then normal handler
* processing will be skipped.
**/
signals[REQUEST_READ] =
g_signal_new ("request-read",
G_OBJECT_CLASS_TYPE (object_class),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (SoupServerClass, request_read),
NULL, NULL,
NULL,
G_TYPE_NONE, 2,
SOUP_TYPE_MESSAGE,
SOUP_TYPE_CLIENT_CONTEXT);
/**
* SoupServer::request-finished:
* @server: the server
* @message: the message
* @client: the client context
*
* Emitted when the server has finished writing a response to
* a request.
**/
signals[REQUEST_FINISHED] =
g_signal_new ("request-finished",
G_OBJECT_CLASS_TYPE (object_class),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (SoupServerClass, request_finished),
NULL, NULL,
NULL,
G_TYPE_NONE, 2,
SOUP_TYPE_MESSAGE,
SOUP_TYPE_CLIENT_CONTEXT);
/**
* SoupServer::request-aborted:
* @server: the server
* @message: the message
* @client: the client context
*
* Emitted when processing has failed for a message; this
* could mean either that it could not be read (if
* #SoupServer::request_read has not been emitted for it yet),
* or that the response could not be written back (if
* #SoupServer::request_read has been emitted but
* #SoupServer::request_finished has not been).
*
* @message is in an undefined state when this signal is
* emitted; the signal exists primarily to allow the server to
* free any state that it may have allocated in
* #SoupServer::request_started.
**/
signals[REQUEST_ABORTED] =
g_signal_new ("request-aborted",
G_OBJECT_CLASS_TYPE (object_class),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (SoupServerClass, request_aborted),
NULL, NULL,
NULL,
G_TYPE_NONE, 2,
SOUP_TYPE_MESSAGE,
SOUP_TYPE_CLIENT_CONTEXT);
/* properties */
/**
* SOUP_SERVER_PORT:
*
* Alias for the #SoupServer:port property. (The port the
* server listens on.)
**/
g_object_class_install_property (
object_class, PROP_PORT,
g_param_spec_uint (SOUP_SERVER_PORT,
"Port",
"Port to listen on",
0, 65536, 0,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
/**
* SOUP_SERVER_INTERFACE:
*
* Alias for the #SoupServer:interface property. (The address
* of the network interface the server listens on.)
**/
g_object_class_install_property (
object_class, PROP_INTERFACE,
g_param_spec_object (SOUP_SERVER_INTERFACE,
"Interface",
"Address of interface to listen on",
SOUP_TYPE_ADDRESS,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
/**
* SOUP_SERVER_SSL_CERT_FILE:
*
* Alias for the #SoupServer:ssl-cert-file property, qv.
*/
/**
* SoupServer:ssl-cert-file:
*
* Path to a file containing a PEM-encoded certificate. If
* this and #SoupServer:ssl-key-file are both set, then the
* server will speak https rather than plain http.
*
* Alternatively, you can use #SoupServer:tls-certificate
* to provide an arbitrary #GTlsCertificate.
*/
g_object_class_install_property (
object_class, PROP_SSL_CERT_FILE,
g_param_spec_string (SOUP_SERVER_SSL_CERT_FILE,
"SSL certificate file",
"File containing server SSL certificate",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
/**
* SOUP_SERVER_SSL_KEY_FILE:
*
* Alias for the #SoupServer:ssl-key-file property, qv.
*/
/**
* SoupServer:ssl-key-file:
*
* Path to a file containing a PEM-encoded private key. If
* this and #SoupServer:ssl-key-file are both set, then the
* server will speak https rather than plain http. Note that
* you are allowed to set them to the same value, if you have
* a single file containing both the certificate and the key.
*
* Alternatively, you can use #SoupServer:tls-certificate
* to provide an arbitrary #GTlsCertificate.
*/
g_object_class_install_property (
object_class, PROP_SSL_KEY_FILE,
g_param_spec_string (SOUP_SERVER_SSL_KEY_FILE,
"SSL key file",
"File containing server SSL key",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
/**
* SOUP_SERVER_TLS_CERTIFICATE:
*
* Alias for the #SoupServer:tls-certificate property, qv.
*/
/**
* SoupServer:tls-certificate:
*
* A #GTlsCertificate that has a #GTlsCertificate:private-key
* set. If this is set, then the server will speak https
* rather than plain http.
*
* Alternatively, you can use #SoupServer:ssl-cert-file and
* #SoupServer:ssl-key-file properties, to have #SoupServer
* read in a a certificate from a file.
*/
g_object_class_install_property (
object_class, PROP_TLS_CERTIFICATE,
g_param_spec_object (SOUP_SERVER_TLS_CERTIFICATE,
"TLS certificate",
"GTlsCertificate to use for https",
G_TYPE_TLS_CERTIFICATE,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
/**
* SOUP_SERVER_ASYNC_CONTEXT:
*
* Alias for the #SoupServer:async-context property. (The
* server's #GMainContext.)
**/
g_object_class_install_property (
object_class, PROP_ASYNC_CONTEXT,
g_param_spec_pointer (SOUP_SERVER_ASYNC_CONTEXT,
"Async GMainContext",
"The GMainContext to dispatch async I/O in",
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
/**
* SOUP_SERVER_RAW_PATHS:
*
* Alias for the #SoupServer:raw-paths property. (If %TRUE,
* percent-encoding in the Request-URI path will not be
* automatically decoded.)
**/
g_object_class_install_property (
object_class, PROP_RAW_PATHS,
g_param_spec_boolean (SOUP_SERVER_RAW_PATHS,
"Raw paths",
"If %TRUE, percent-encoding in the Request-URI path will not be automatically decoded.",
FALSE,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
/**
* SoupServer:server-header:
*
* If non-%NULL, the value to use for the "Server" header on
* #SoupMessage<!-- -->s processed by this server.
*
* The Server header is the server equivalent of the
* User-Agent header, and provides information about the
* server and its components. It contains a list of one or
* more product tokens, separated by whitespace, with the most
* significant product token coming first. The tokens must be
* brief, ASCII, and mostly alphanumeric (although "-", "_",
* and "." are also allowed), and may optionally include a "/"
* followed by a version string. You may also put comments,
* enclosed in parentheses, between or after the tokens.
*
* Some HTTP server implementations intentionally do not use
* version numbers in their Server header, so that
* installations running older versions of the server don't
* end up advertising their vulnerability to specific security
* holes.
*
* As with #SoupSession:user_agent, if you set a
* #SoupServer:server_header property that has trailing whitespace,
* #SoupServer will append its own product token (eg,
* "<literal>libsoup/2.3.2</literal>") to the end of the
* header for you.
**/
/**
* SOUP_SERVER_SERVER_HEADER:
*
* Alias for the #SoupServer:server-header property, qv.
**/
g_object_class_install_property (
object_class, PROP_SERVER_HEADER,
g_param_spec_string (SOUP_SERVER_SERVER_HEADER,
"Server header",
"Server header",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
/**
* SoupServer:http-aliases:
*
* A %NULL-terminated array of URI schemes that should be
* considered to be aliases for "http". Eg, if this included
* <literal>"dav"</literal>, than a URI of
* <literal>dav://example.com/path</literal> would be treated
* identically to <literal>http://example.com/path</literal>.
* In particular, this is needed in cases where a client
* sends requests with absolute URIs, where those URIs do
* not use "http:".
*
* The default value is an array containing the single element
* <literal>"*"</literal>, a special value which means that
* any scheme except "https" is considered to be an alias for
* "http".
*
* See also #SoupServer:https-aliases.
*
* Since: 2.44
*/
/**
* SOUP_SERVERI_HTTP_ALIASES:
*
* Alias for the #SoupServer:http-aliases property, qv.
*
* Since: 2.44
*/
g_object_class_install_property (
object_class, PROP_HTTP_ALIASES,
g_param_spec_boxed (SOUP_SERVER_HTTP_ALIASES,
"http aliases",
"URI schemes that are considered aliases for 'http'",
G_TYPE_STRV,
G_PARAM_READWRITE));
/**
* SoupServer:https-aliases:
*
* A comma-delimited list of URI schemes that should be
* considered to be aliases for "https". See
* #SoupServer:http-aliases for more information.
*
* The default value is %NULL, meaning that no URI schemes
* are considered aliases for "https".
*
* Since: 2.44
*/
/**
* SOUP_SERVER_HTTPS_ALIASES:
*
* Alias for the #SoupServer:https-aliases property, qv.
*
* Since: 2.44
**/
g_object_class_install_property (
object_class, PROP_HTTPS_ALIASES,
g_param_spec_boxed (SOUP_SERVER_HTTPS_ALIASES,
"https aliases",
"URI schemes that are considered aliases for 'https'",
G_TYPE_STRV,
G_PARAM_READWRITE));
}
/**
* soup_server_new:
* @optname1: name of first property to set
* @...: value of @optname1, followed by additional property/value pairs
*
* Creates a new #SoupServer.
*
* Return value: a new #SoupServer
**/
SoupServer *
soup_server_new (const char *optname1, ...)
{
SoupServer *server;
va_list ap;
va_start (ap, optname1);
server = (SoupServer *)g_object_new_valist (SOUP_TYPE_SERVER,
optname1, ap);
va_end (ap);
return server;
}
/**
* soup_server_get_port:
* @server: a #SoupServer
*
* Gets the TCP port that @server is listening on. This is most useful
* when you did not request a specific port (or explicitly requested
* %SOUP_ADDRESS_ANY_PORT).
*
* Return value: the port @server is listening on.
**/
guint
soup_server_get_port (SoupServer *server)
{
g_return_val_if_fail (SOUP_IS_SERVER (server), 0);
return SOUP_SERVER_GET_PRIVATE (server)->port;
}
/**
* soup_server_is_https:
* @server: a #SoupServer
*
* Checks whether @server is running plain http or https.
*
* In order for a server to run https, you must set the
* %SOUP_SERVER_SSL_CERT_FILE and %SOUP_SERVER_SSL_KEY_FILE properties
* or %SOUP_SERVER_TLS_CERTIFICATE property to provide it with an SSL
* certificate to use.
*
* Return value: %TRUE if @server is serving https.
**/
gboolean
soup_server_is_https (SoupServer *server)
{
SoupServerPrivate *priv;
g_return_val_if_fail (SOUP_IS_SERVER (server), 0);
priv = SOUP_SERVER_GET_PRIVATE (server);
return priv->ssl_cert != NULL;
}
/**
* soup_server_get_listener:
* @server: a #SoupServer
*
* Gets @server's listening socket. You should treat this as
* read-only; writing to it or modifiying it may cause @server to
* malfunction.
*
* Return value: (transfer none): the listening socket.
**/
SoupSocket *
soup_server_get_listener (SoupServer *server)
{
SoupServerPrivate *priv;
g_return_val_if_fail (SOUP_IS_SERVER (server), NULL);
priv = SOUP_SERVER_GET_PRIVATE (server);
return priv->listen_sock;
}
static void start_request (SoupServer *, SoupClientContext *);
static SoupClientContext *
soup_client_context_new (SoupServer *server, SoupSocket *sock)
{
SoupClientContext *client = g_slice_new0 (SoupClientContext);
client->server = server;
client->sock = sock;
client->ref_count = 1;
return client;
}
static void
soup_client_context_cleanup (SoupClientContext *client)
{
if (client->auth_domain) {
g_object_unref (client->auth_domain);
client->auth_domain = NULL;
}
if (client->auth_user) {
g_free (client->auth_user);
client->auth_user = NULL;
}
client->msg = NULL;
}
static SoupClientContext *
soup_client_context_ref (SoupClientContext *client)
{
client->ref_count++;
return client;
}
static void
soup_client_context_unref (SoupClientContext *client)
{
if (--client->ref_count == 0) {
soup_client_context_cleanup (client);
g_slice_free (SoupClientContext, client);
}
}
static void
request_finished (SoupMessage *msg, gpointer user_data)
{
SoupClientContext *client = user_data;
SoupServer *server = client->server;
SoupSocket *sock = client->sock;
soup_message_finished (msg);
g_signal_emit (server,
msg->status_code == SOUP_STATUS_IO_ERROR ?
signals[REQUEST_ABORTED] : signals[REQUEST_FINISHED],
0, msg, client);
soup_client_context_cleanup (client);
if (soup_socket_is_connected (sock) && soup_message_is_keepalive (msg)) {
/* Start a new request */
start_request (server, client);
} else {
soup_socket_disconnect (sock);
soup_client_context_unref (client);
}
g_object_unref (msg);
g_object_unref (sock);
}
static SoupServerHandler *
soup_server_get_handler (SoupServer *server, const char *path)
{
SoupServerPrivate *priv;
SoupServerHandler *hand;
g_return_val_if_fail (SOUP_IS_SERVER (server), NULL);
priv = SOUP_SERVER_GET_PRIVATE (server);
if (path) {
hand = soup_path_map_lookup (priv->handlers, path);
if (hand)
return hand;
if (!strcmp (path, "*"))
return NULL;
}
return priv->default_handler;
}
static void
got_headers (SoupMessage *msg, SoupClientContext *client)
{
SoupServer *server = client->server;
SoupServerPrivate *priv = SOUP_SERVER_GET_PRIVATE (server);
SoupURI *uri;
SoupDate *date;
char *date_string;
SoupAuthDomain *domain;
GSList *iter;
gboolean rejected = FALSE;
char *auth_user;
uri = soup_message_get_uri (msg);
if ((soup_server_is_https (server) && !soup_uri_is_https (uri, priv->https_aliases)) ||
(!soup_server_is_https (server) && !soup_uri_is_http (uri, priv->http_aliases))) {
soup_message_set_status (msg, SOUP_STATUS_BAD_REQUEST);
return;
}
if (!priv->raw_paths) {
char *decoded_path;
decoded_path = soup_uri_decode (uri->path);
if (strstr (decoded_path, "/../") ||
g_str_has_suffix (decoded_path, "/..")) {
/* Introducing new ".." segments is not allowed */
g_free (decoded_path);
soup_message_set_status (msg, SOUP_STATUS_BAD_REQUEST);
return;
}
soup_uri_set_path (uri, decoded_path);
g_free (decoded_path);
}
/* Add required response headers */
date = soup_date_new_from_now (0);
date_string = soup_date_to_string (date, SOUP_DATE_HTTP);
soup_message_headers_replace (msg->response_headers, "Date",
date_string);
g_free (date_string);
soup_date_free (date);
/* Now handle authentication. (We do this here so that if
* the request uses "Expect: 100-continue", we can reject it
* immediately rather than waiting for the request body to
* be sent.
*/
for (iter = priv->auth_domains; iter; iter = iter->next) {
domain = iter->data;
if (soup_auth_domain_covers (domain, msg)) {
auth_user = soup_auth_domain_accepts (domain, msg);
if (auth_user) {
client->auth_domain = g_object_ref (domain);
client->auth_user = auth_user;
return;
}
rejected = TRUE;
}
}
/* If no auth domain rejected it, then it's ok. */
if (!rejected)
return;
for (iter = priv->auth_domains; iter; iter = iter->next) {
domain = iter->data;
if (soup_auth_domain_covers (domain, msg))
soup_auth_domain_challenge (domain, msg);
}
}
static void
call_handler (SoupMessage *msg, SoupClientContext *client)
{
SoupServer *server = client->server;
SoupServerHandler *hand;
SoupURI *uri;
g_signal_emit (server, signals[REQUEST_READ], 0, msg, client);
if (msg->status_code != 0)
return;
uri = soup_message_get_uri (msg);
hand = soup_server_get_handler (server, uri->path);
if (!hand) {
soup_message_set_status (msg, SOUP_STATUS_NOT_FOUND);
return;
}
if (hand->callback) {
GHashTable *form_data_set;
if (uri->query)
form_data_set = soup_form_decode (uri->query);
else
form_data_set = NULL;
/* Call method handler */
(*hand->callback) (server, msg,
uri->path, form_data_set,
client, hand->user_data);
if (form_data_set)
g_hash_table_unref (form_data_set);
}
}
static void
start_request (SoupServer *server, SoupClientContext *client)
{
SoupServerPrivate *priv = SOUP_SERVER_GET_PRIVATE (server);
SoupMessage *msg;
soup_client_context_cleanup (client);
/* Listen for another request on this connection */
msg = g_object_new (SOUP_TYPE_MESSAGE,
SOUP_MESSAGE_SERVER_SIDE, TRUE,
NULL);
client->msg = msg;
if (priv->server_header) {
soup_message_headers_append (msg->response_headers, "Server",
priv->server_header);
}
g_signal_connect (msg, "got_headers", G_CALLBACK (got_headers), client);
g_signal_connect (msg, "got_body", G_CALLBACK (call_handler), client);
g_signal_emit (server, signals[REQUEST_STARTED], 0,
msg, client);
g_object_ref (client->sock);
if (priv->async_context)
g_main_context_push_thread_default (priv->async_context);
soup_message_read_request (msg, client->sock,
request_finished, client);
if (priv->async_context)
g_main_context_pop_thread_default (priv->async_context);
}
static void
socket_disconnected (SoupSocket *sock, SoupClientContext *client)
{
SoupServerPrivate *priv = SOUP_SERVER_GET_PRIVATE (client->server);
priv->clients = g_slist_remove (priv->clients, client);
g_signal_handlers_disconnect_by_func (sock, socket_disconnected, client);
g_object_unref (sock);
}
static void
new_connection (SoupSocket *listner, SoupSocket *sock, gpointer user_data)
{
SoupServer *server = user_data;
SoupServerPrivate *priv = SOUP_SERVER_GET_PRIVATE (server);
SoupClientContext *client;
client = soup_client_context_new (server, g_object_ref (sock));
priv->clients = g_slist_prepend (priv->clients, client);
g_signal_connect (sock, "disconnected",
G_CALLBACK (socket_disconnected), client);
start_request (server, client);
}
/**
* soup_server_run_async:
* @server: a #SoupServer
*
* Starts @server, causing it to listen for and process incoming
* connections.
*
* The server actually runs in @server's #GMainContext. It will not
* actually perform any processing unless the appropriate main loop is
* running. In the simple case where you did not set the server's
* %SOUP_SERVER_ASYNC_CONTEXT property, this means the server will run
* whenever the glib main loop is running.
**/
void
soup_server_run_async (SoupServer *server)
{
SoupServerPrivate *priv;
g_return_if_fail (SOUP_IS_SERVER (server));
priv = SOUP_SERVER_GET_PRIVATE (server);
if (!priv->listen_sock) {
if (priv->loop) {
g_main_loop_unref (priv->loop);
priv->loop = NULL;
}
return;
}
g_signal_connect (priv->listen_sock, "new_connection",
G_CALLBACK (new_connection), server);
return;
}
/**
* soup_server_run:
* @server: a #SoupServer
*
* Starts @server, causing it to listen for and process incoming
* connections. Unlike soup_server_run_async(), this creates a
* #GMainLoop and runs it, and it will not return until someone calls
* soup_server_quit() to stop the server.
**/
void
soup_server_run (SoupServer *server)
{
SoupServerPrivate *priv;
g_return_if_fail (SOUP_IS_SERVER (server));
priv = SOUP_SERVER_GET_PRIVATE (server);
if (!priv->loop) {
priv->loop = g_main_loop_new (priv->async_context, TRUE);
soup_server_run_async (server);
}
if (priv->loop)
g_main_loop_run (priv->loop);
}
/**
* soup_server_quit:
* @server: a #SoupServer
*
* Stops processing for @server. Call this to clean up after
* soup_server_run_async(), or to terminate a call to soup_server_run().
*
* @server is still in a working state after this call; you can start
* and stop a server as many times as you want.
**/
void
soup_server_quit (SoupServer *server)
{
SoupServerPrivate *priv;
g_return_if_fail (SOUP_IS_SERVER (server));
priv = SOUP_SERVER_GET_PRIVATE (server);
g_signal_handlers_disconnect_by_func (priv->listen_sock,
G_CALLBACK (new_connection),
server);
if (priv->loop)
g_main_loop_quit (priv->loop);
}
/**
* soup_server_disconnect:
* @server: a #SoupServer
*
* Stops processing for @server and closes its socket. This implies
* the effects of soup_server_quit(), but additionally closes the
* listening socket. Note that messages currently in progress will
* continue to be handled, if the main loop associated with the
* server is resumed or kept running.
*
* After calling this function, @server is no longer functional, so it
* has nearly the same effect as destroying @server entirely. The
* function is thus useful mainly for language bindings without
* explicit control over object lifetime.
**/
void
soup_server_disconnect (SoupServer *server)
{
SoupServerPrivate *priv;
g_return_if_fail (SOUP_IS_SERVER (server));
priv = SOUP_SERVER_GET_PRIVATE (server);
soup_server_quit (server);
if (priv->listen_sock) {
soup_socket_disconnect (priv->listen_sock);
g_object_unref (priv->listen_sock);
priv->listen_sock = NULL;
}
}
/**
* soup_server_get_async_context:
* @server: a #SoupServer
*
* Gets @server's async_context. This does not add a ref to the
* context, so you will need to ref it yourself if you want it to
* outlive its server.
*
* Return value: (transfer none): @server's #GMainContext, which may be %NULL
**/
GMainContext *
soup_server_get_async_context (SoupServer *server)
{
SoupServerPrivate *priv;
g_return_val_if_fail (SOUP_IS_SERVER (server), NULL);
priv = SOUP_SERVER_GET_PRIVATE (server);
return priv->async_context;
}
/**
* SoupClientContext:
*
* A #SoupClientContext provides additional information about the
* client making a particular request. In particular, you can use
* soup_client_context_get_auth_domain() and
* soup_client_context_get_auth_user() to determine if HTTP
* authentication was used successfully.
*
* soup_client_context_get_address() and/or
* soup_client_context_get_host() can be used to get information for
* logging or debugging purposes. soup_client_context_get_socket() may
* also be of use in some situations (eg, tracking when multiple
* requests are made on the same connection).
**/
G_DEFINE_BOXED_TYPE (SoupClientContext, soup_client_context, soup_client_context_ref, soup_client_context_unref)
/**
* soup_client_context_get_socket:
* @client: a #SoupClientContext
*
* Retrieves the #SoupSocket that @client is associated with.
*
* If you are using this method to observe when multiple requests are
* made on the same persistent HTTP connection (eg, as the ntlm-test
* test program does), you will need to pay attention to socket
* destruction as well (either by using weak references, or by
* connecting to the #SoupSocket::disconnected signal), so that you do
* not get fooled when the allocator reuses the memory address of a
* previously-destroyed socket to represent a new socket.
*
* Return value: (transfer none): the #SoupSocket that @client is
* associated with.
**/
SoupSocket *
soup_client_context_get_socket (SoupClientContext *client)
{
g_return_val_if_fail (client != NULL, NULL);
return client->sock;
}
/**
* soup_client_context_get_address:
* @client: a #SoupClientContext
*
* Retrieves the #SoupAddress associated with the remote end
* of a connection.
*
* Return value: (transfer none): the #SoupAddress associated with the
* remote end of a connection.
**/
SoupAddress *
soup_client_context_get_address (SoupClientContext *client)
{
g_return_val_if_fail (client != NULL, NULL);
return soup_socket_get_remote_address (client->sock);
}
/**
* soup_client_context_get_host:
* @client: a #SoupClientContext
*
* Retrieves the IP address associated with the remote end of a
* connection. (If you want the actual hostname, you'll have to call
* soup_client_context_get_address() and then call the appropriate
* #SoupAddress method to resolve it.)
*
* Return value: the IP address associated with the remote end of a
* connection.
**/
const char *
soup_client_context_get_host (SoupClientContext *client)
{
SoupAddress *address;
address = soup_client_context_get_address (client);
return soup_address_get_physical (address);
}
/**
* soup_client_context_get_auth_domain:
* @client: a #SoupClientContext
*
* Checks whether the request associated with @client has been
* authenticated, and if so returns the #SoupAuthDomain that
* authenticated it.
*
* Return value: (transfer none) (allow-none): a #SoupAuthDomain, or
* %NULL if the request was not authenticated.
**/
SoupAuthDomain *
soup_client_context_get_auth_domain (SoupClientContext *client)
{
g_return_val_if_fail (client != NULL, NULL);
return client->auth_domain;
}
/**
* soup_client_context_get_auth_user:
* @client: a #SoupClientContext
*
* Checks whether the request associated with @client has been
* authenticated, and if so returns the username that the client
* authenticated as.
*
* Return value: the authenticated-as user, or %NULL if the request
* was not authenticated.
**/
const char *
soup_client_context_get_auth_user (SoupClientContext *client)
{
g_return_val_if_fail (client != NULL, NULL);
return client->auth_user;
}
/**
* SoupServerCallback:
* @server: the #SoupServer
* @msg: the message being processed
* @path: the path component of @msg's Request-URI
* @query: (element-type utf8 utf8) (allow-none): the parsed query
* component of @msg's Request-URI
* @client: additional contextual information about the client
* @user_data: the data passed to @soup_server_add_handler
*
* A callback used to handle requests to a #SoupServer. The callback
* will be invoked after receiving the request body; @msg's
* #SoupMessage:method, #SoupMessage:request_headers, and
* #SoupMessage:request_body fields will be filled in.
*
* @path and @query contain the likewise-named components of the
* Request-URI, subject to certain assumptions. By default,
* #SoupServer decodes all percent-encoding in the URI path, such that
* "/foo%<!-- -->2Fbar" is treated the same as "/foo/bar". If your
* server is serving resources in some non-POSIX-filesystem namespace,
* you may want to distinguish those as two distinct paths. In that
* case, you can set the %SOUP_SERVER_RAW_PATHS property when creating
* the #SoupServer, and it will leave those characters undecoded. (You
* may want to call soup_uri_normalize() to decode any percent-encoded
* characters that you aren't handling specially.)
*
* @query contains the query component of the Request-URI parsed
* according to the rules for HTML form handling. Although this is the
* only commonly-used query string format in HTTP, there is nothing
* that actually requires that HTTP URIs use that format; if your
* server needs to use some other format, you can just ignore @query,
* and call soup_message_get_uri() and parse the URI's query field
* yourself.
*
* After determining what to do with the request, the callback must at
* a minimum call soup_message_set_status() (or
* soup_message_set_status_full()) on @msg to set the response status
* code. Additionally, it may set response headers and/or fill in the
* response body.
*
* If the callback cannot fully fill in the response before returning
* (eg, if it needs to wait for information from a database, or
* another network server), it should call soup_server_pause_message()
* to tell #SoupServer to not send the response right away. When the
* response is ready, call soup_server_unpause_message() to cause it
* to be sent.
*
* To send the response body a bit at a time using "chunked" encoding,
* first call soup_message_headers_set_encoding() to set
* %SOUP_ENCODING_CHUNKED on the #SoupMessage:response_headers. Then call
* soup_message_body_append() (or soup_message_body_append_buffer())
* to append each chunk as it becomes ready, and
* soup_server_unpause_message() to make sure it's running. (The
* server will automatically pause the message if it is using chunked
* encoding but no more chunks are available.) When you are done, call
* soup_message_body_complete() to indicate that no more chunks are
* coming.
**/
/**
* soup_server_add_handler:
* @server: a #SoupServer
* @path: (allow-none): the toplevel path for the handler
* @callback: callback to invoke for requests under @path
* @user_data: data for @callback
* @destroy: destroy notifier to free @user_data
*
* Adds a handler to @server for requests under @path. See the
* documentation for #SoupServerCallback for information about
* how callbacks should behave.
*
* If @path is %NULL or "/", then this will be the default handler for
* all requests that don't have a more specific handler. Note though
* that if you want to handle requests to the special "*" URI, you
* must explicitly register a handler for "*"; the default handler
* will not be used for that case.
**/
void
soup_server_add_handler (SoupServer *server,
const char *path,
SoupServerCallback callback,
gpointer user_data,
GDestroyNotify destroy)
{
SoupServerPrivate *priv;
SoupServerHandler *hand;
g_return_if_fail (SOUP_IS_SERVER (server));
g_return_if_fail (callback != NULL);
priv = SOUP_SERVER_GET_PRIVATE (server);
/* "" was never documented as meaning the same this as "/",
* but it effectively was. We have to special case it now or
* otherwise it would match "*" too.
*/
if (path && (!*path || !strcmp (path, "/")))
path = NULL;
hand = g_slice_new0 (SoupServerHandler);
hand->path = g_strdup (path);
hand->callback = callback;
hand->destroy = destroy;
hand->user_data = user_data;
soup_server_remove_handler (server, path);
if (path)
soup_path_map_add (priv->handlers, path, hand);
else
priv->default_handler = hand;
}
static void
unregister_handler (SoupServerHandler *handler)
{
if (handler->destroy)
handler->destroy (handler->user_data);
}
/**
* soup_server_remove_handler:
* @server: a #SoupServer
* @path: the toplevel path for the handler
*
* Removes the handler registered at @path.
**/
void
soup_server_remove_handler (SoupServer *server, const char *path)
{
SoupServerPrivate *priv;
SoupServerHandler *hand;
g_return_if_fail (SOUP_IS_SERVER (server));
priv = SOUP_SERVER_GET_PRIVATE (server);
if (!path || !*path || !strcmp (path, "/")) {
if (priv->default_handler) {
unregister_handler (priv->default_handler);
free_handler (priv->default_handler);
priv->default_handler = NULL;
}
return;
}
hand = soup_path_map_lookup (priv->handlers, path);
if (hand && !strcmp (path, hand->path)) {
unregister_handler (hand);
soup_path_map_remove (priv->handlers, path);
}
}
/**
* soup_server_add_auth_domain:
* @server: a #SoupServer
* @auth_domain: a #SoupAuthDomain
*
* Adds an authentication domain to @server. Each auth domain will
* have the chance to require authentication for each request that
* comes in; normally auth domains will require authentication for
* requests on certain paths that they have been set up to watch, or
* that meet other criteria set by the caller. If an auth domain
* determines that a request requires authentication (and the request
* doesn't contain authentication), @server will automatically reject
* the request with an appropriate status (401 Unauthorized or 407
* Proxy Authentication Required). If the request used the
* "100-continue" Expectation, @server will reject it before the
* request body is sent.
**/
void
soup_server_add_auth_domain (SoupServer *server, SoupAuthDomain *auth_domain)
{
SoupServerPrivate *priv;
g_return_if_fail (SOUP_IS_SERVER (server));
priv = SOUP_SERVER_GET_PRIVATE (server);
priv->auth_domains = g_slist_append (priv->auth_domains, auth_domain);
g_object_ref (auth_domain);
}
/**
* soup_server_remove_auth_domain:
* @server: a #SoupServer
* @auth_domain: a #SoupAuthDomain
*
* Removes @auth_domain from @server.
**/
void
soup_server_remove_auth_domain (SoupServer *server, SoupAuthDomain *auth_domain)
{
SoupServerPrivate *priv;
g_return_if_fail (SOUP_IS_SERVER (server));
priv = SOUP_SERVER_GET_PRIVATE (server);
priv->auth_domains = g_slist_remove (priv->auth_domains, auth_domain);
g_object_unref (auth_domain);
}
/**
* soup_server_pause_message:
* @server: a #SoupServer
* @msg: a #SoupMessage associated with @server.
*
* Pauses I/O on @msg. This can be used when you need to return from
* the server handler without having the full response ready yet. Use
* soup_server_unpause_message() to resume I/O.
*
* This must only be called on #SoupMessages which were created by the
* #SoupServer and are currently doing I/O, such as those passed into a
* #SoupServerCallback or emitted in a #SoupServer::request-read signal.
**/
void
soup_server_pause_message (SoupServer *server,
SoupMessage *msg)
{
g_return_if_fail (SOUP_IS_SERVER (server));
g_return_if_fail (SOUP_IS_MESSAGE (msg));
soup_message_io_pause (msg);
}
/**
* soup_server_unpause_message:
* @server: a #SoupServer
* @msg: a #SoupMessage associated with @server.
*
* Resumes I/O on @msg. Use this to resume after calling
* soup_server_pause_message(), or after adding a new chunk to a
* chunked response.
*
* I/O won't actually resume until you return to the main loop.
*
* This must only be called on #SoupMessages which were created by the
* #SoupServer and are currently doing I/O, such as those passed into a
* #SoupServerCallback or emitted in a #SoupServer::request-read signal.
**/
void
soup_server_unpause_message (SoupServer *server,
SoupMessage *msg)
{
g_return_if_fail (SOUP_IS_SERVER (server));
g_return_if_fail (SOUP_IS_MESSAGE (msg));
soup_message_io_unpause (msg);
}
|