/
xmlrpc.c
2642 lines (2385 loc) · 75.1 KB
/
xmlrpc.c
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
/*
* Copyright (C) 2005 iptelorg GmbH
* Written by Jan Janak <jan@iptel.org>
*
* This file is part of Kamailio, a free SIP server.
*
* Kamailio is free software; you can redistribute it and/or modify it under the
* terms of the GNU General Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at your option) any later
* version
*
* Kamailio is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc., 59
* Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*This define breaks on Solaris OS */
#ifndef __OS_solaris
#define _XOPEN_SOURCE 4 /* strptime */
#endif
#define _XOPEN_SOURCE_EXTENDED 1 /* solaris */
#define _SVID_SOURCE 1 /* timegm */
#define _DEFAULT_SOURCE 1 /* _SVID_SOURCE is deprecated */
#include <strings.h>
#include <time.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <stdarg.h>
#include <sys/types.h>
#include <signal.h>
#include <libxml/xmlreader.h>
#include "../../core/str.h"
#include "../../core/sr_module.h"
#include "../../core/error.h"
#include "../../core/usr_avp.h"
#include "../../core/mem/mem.h"
#include "../../core/parser/parse_uri.h"
#include "../../core/parser/msg_parser.h"
#include "../../core/ut.h"
#include "../../core/dset.h"
#include "../../core/str.h"
#include "../../core/dprint.h"
#include "../../core/data_lump.h"
#include "../../core/data_lump_rpl.h"
#include "../../core/msg_translator.h"
#include "../../core/select.h"
#include "../../core/receive.h" /* needed by process_rpc / receive_msg() */
#include "../../modules/sl/sl.h"
#include "../../core/nonsip_hooks.h"
#include "../../core/action.h" /* run_actions */
#include "../../core/script_cb.h" /* exec_*_script_cb */
#include "../../core/route.h" /* route_get */
#include "../../core/sip_msg_clone.h" /* sip_msg_shm_clone */
#include "http.h"
/** @addtogroup xmlrpc
* @ingroup modules
* @{
*
* <h1>Overview of Operation</h1>
* This module provides XML-RPC based interface to management functions in
* SER. You can send XML-RPC requests to SER when the module is loaded and
* configured and it will send XML-RPC replies back. XML-RPC requests are
* encoded as XML documents in the body of HTTP requests. Due to similarity
* between HTTP and SIP SER can easily parse HTTP requests and extract the XML
* document from their body.
*
* When you load this module into SER, it will register a callback function
* that will be called whenever the SER core receives a request with method it
* does not understand. The main callback function is process_xmlrpc(). The
* function first verifies if the protocol identifier inside the request is
* HTTP and whether the request method is either GET or POST. If both
* conditions are met then it will signal to the SER core that it is
* processing the request, otherwise it will reject the request and the SER
* core will pass the requests to other callbacks if they exist.
*
* As the next step the request will be converted from HTTP request to a SIP
* request to ensure that it can be processed by SER and its modules. The
* conversion will modify the URI in the Request-URI of the request, the new
* URI will be a SIP URI. In addition to that it will add a fake Via header
* field and copy all remaining header fields from the original HTTP request.
* The conversion is implemented in http_xmlrpc2sip() function.
*
* After the conversion the module will execute the route statement whose
* number is configured in "route" module parameter. That route stament may
* perform additional security checks and when it ensures that the client is
* authorized to execute management functions then it will call dispatch_rpc()
* module function provided by this module.
*
* dispatch_rpc() function extracts the XML-RPC document from the body of the
* request to determine the name of the method to be called and then it
* searches through the list of all management functions to find a function
* with matching name. If such a function is found then dispatch_rpc() will
* pass control to the function to handle the request. dispatch_rpc() will
* send a reply back to the client when the management function terminates, if
* the function did not do that explicitly.
*
* <h2>Memory Management</h2>
* The module provides implementation for all the functions required by the
* management interface in SER, such as rpc->rpl_printf, rpc->add, rpc->struct_add
* and so on. Whenever the management function calls one of the functions then
* corresponding function in this module will be called to handle the request.
*
* The implementation functions build the reply, that will be sent to the
* client, as they execute and they need to allocate memory to do that. That
* memory must be freed again after the reply has been sent to the client. To
* remember all the memory regions allocated during the execution of the
* management function all functions within this module record all allocated
* memory in the global variable called waste_bin. dispatch_rpc() functions
* executes function collect_garbage() after the reply has been sent to the
* client to free all memory that was allocated from the management function.
* that was executed.
*
* <h2>Request Context</h2>
* Before the module calls a management function it prepares a structure
* called context. The context is defined in structure rpc_ctx and it is
* passed as one of parameter to the management function being called. The
* context contains all the data that is needed during the execution of the
* management function, such as the pointer to the request being processed, a
* pointer to the reply being built, and so on.
*
* Another parameter to the management function being called is a structure
* that contains pointers to all implementation functions. This structure is
* of type rpc_t, this module keeps one global variable of that type called
* func_param and a pointer to that variable is passed to all management
* functions. The global variable is initialized in mod_init().
*/
/** @file
*
* This is the main file of XMLRPC SER module which contains all the functions
* related to XML-RPC processing, as well as the module interface.
*/
/*
* FIXME: Decouple code and reason phrase from reply body
* Escape special characters in strings
*/
MODULE_VERSION
static int process_xmlrpc(sip_msg_t* msg);
static int dispatch_rpc(sip_msg_t* msg, char* s1, char* s2);
static int xmlrpc_reply(sip_msg_t* msg, char* code, char* reason);
static int mod_init(void);
/* first line (w/o the version) of the sip msg created from the http xmlrpc */
#define XMLRPC_URI "sip:127.0.0.1:9"
#define XMLRPC_URI_LEN (sizeof(XMLRPC_URI)-1)
#define HTTP_GET "GET"
#define HTTP_GET_LEN (sizeof(HTTP_GET)-1)
#define HTTP_POST "POST"
#define HTTP_POST_LEN (sizeof(HTTP_POST)-1)
#define N_HTTP_GET 0x00746567U
#define N_HTTP_POST 0x74736f70U
#define LF "\n"
/** The beginning of XML document indicating an error.
*
* This is the beginning of the XML document that will be sent back to the
* client when the server encountered an error. It will be immediately
* followed by a reason phrase.
*/
#define FAULT_PREFIX \
"<?xml version=\"1.0\"?>" LF \
"<methodResponse>" LF \
"<fault>" LF \
"<value>" LF \
"<struct>" LF \
"<member>" LF \
"<name>faultCode</name>" LF \
"<value><int>"
/** The text of XML document indicating error that goes between reason code
* and reason phrase.
*/
#define FAULT_BODY \
"</int></value>" LF \
"</member>" LF \
"<member>" LF \
"<name>faultString</name>" LF \
"<value><string>"
/** The end of XML document that indicates an error.
*
* This is the closing part of the XML-RPC document that indicates an error on
* the server.
*/
#define FAULT_SUFFIX \
"</string></value>" LF \
"</member>" LF \
"</struct>" LF \
"</value>" LF \
"</fault>" LF \
"</methodResponse>"
/** The beginning of XML-RPC reply sent to the client.
*/
#define SUCCESS_PREFIX \
"<?xml version=\"1.0\"?>" LF \
"<methodResponse>" LF \
"<params>" LF \
"<param>" LF \
"<value>"
/** The closing part of XML-RPC reply document sent to
* the client.
*/
#define SUCCESS_SUFFIX \
"</value>" LF \
"</param>" LF \
"</params>" LF \
"</methodResponse>"
static str fault_prefix = STR_STATIC_INIT(FAULT_PREFIX);
static str fault_body = STR_STATIC_INIT(FAULT_BODY);
static str fault_suffix = STR_STATIC_INIT(FAULT_SUFFIX);
static str success_prefix = STR_STATIC_INIT(SUCCESS_PREFIX);
static str success_suffix = STR_STATIC_INIT(SUCCESS_SUFFIX);
static str lf = STR_STATIC_INIT(LF);
static str int_prefix = STR_STATIC_INIT("<int>");
static str int_suffix = STR_STATIC_INIT("</int>");
static str double_prefix = STR_STATIC_INIT("<double>");
static str double_suffix = STR_STATIC_INIT("</double>");
static str string_prefix = STR_STATIC_INIT("<string>");
static str string_suffix = STR_STATIC_INIT("</string>");
static str date_prefix = STR_STATIC_INIT("<dateTime.iso8601>");
static str date_suffix = STR_STATIC_INIT("</dateTime.iso8601>");
static str bool_prefix = STR_STATIC_INIT("<boolean>");
static str bool_suffix = STR_STATIC_INIT("</boolean>");
static str value_prefix = STR_STATIC_INIT("<value>");
static str value_suffix = STR_STATIC_INIT("</value>");
static str array_prefix = STR_STATIC_INIT("<array><data>" LF);
static str array_suffix = STR_STATIC_INIT("</data></array>");
static str struct_prefix = STR_STATIC_INIT("<struct>");
static str struct_suffix = STR_STATIC_INIT("</struct>");
static str member_prefix = STR_STATIC_INIT("<member>");
static str member_suffix = STR_STATIC_INIT("</member>");
static str name_prefix = STR_STATIC_INIT("<name>");
static str name_suffix = STR_STATIC_INIT("</name>");
/** Garbage collection data structure.
*
* This is the data structure used by the garbage collector in this module.
* When the xmlrpc SER module identifies the management function to be called,
* it calls corresponding function in SER. The function being called adds data
* to the reply, that will be later sent to the client, as it executes. This
* module needs to allocate memory for such data and the memory will be
* re-claimed after the reply was sent out. All the memory allocated this way
* is recorded in this data structure so that it can be identified and
* re-claimed later (when the reply is being sent out).
*
*/
static struct garbage {
enum {
JUNK_XMLCHAR,
JUNK_RPCSTRUCT, /**< This type indicates that the memory block was
* allocated for the RPC structure data type, this
* type needs to be freed differently as it may
* contain more allocated memory blocks
*/
JUNK_PKGCHAR /** This type indicates a mxr_malloc'ed string */
} type; /**< Type of the memory block */
void* ptr; /**< Pointer to the memory block obtained from
mxr_malloc */
struct garbage* next; /**< The linked list of all allocated memory
blocks */
} *waste_bin = 0;
/** Representation of the XML-RPC reply being constructed.
*
* This data structure describes the XML-RPC reply that is being constructed
* and will be sent to the client.
*/
struct xmlrpc_reply {
int code; /**< Reply code which indicates the type of the reply */
char* reason; /**< Reason phrase text which provides human-readable
* description that augments the reply code */
str body; /**< The XML-RPC document body built so far */
str buf; /**< The memory buffer allocated for the reply, this is
* where the body attribute of the structure points to
*/
};
/** The context of the XML-RPC request being processed.
*
* This is the data structure that contains all data related to the XML-RPC
* request being processed, such as the reply code and reason, data to be sent
* to the client in the reply, and so on.
*
* There is always one context per XML-RPC request.
*/
typedef struct rpc_ctx {
sip_msg_t* msg; /**< The SIP/HTTP through which the RPC has been
received */
struct xmlrpc_reply reply; /**< XML-RPC reply to be sent to the client */
struct rpc_struct* structs; /**< Structures to be added to the reply */
int msg_shm_block_size; /**< non-zero for delayed reply contexts with
shm cloned msgs */
int reply_sent; /**< The flag is set after a reply is sent,
this prevents a single reply being sent
twice */
char* method; /**< Name of the management function to be
called */
unsigned int flags; /**< Various flags, such as return value
type */
xmlDocPtr doc; /**< Pointer to the XML-RPC request
document */
xmlNodePtr act_param; /**< Pointer to the parameter being processed
in the XML-RPC request document */
} rpc_ctx_t;
/* extra rpc_ctx_t flags */
/* first 8 bits reserved for rpc flags (e.g. RET_ARRAY) */
#define XMLRPC_DELAYED_CTX_F 256
#define XMLRPC_DELAYED_REPLY_F 512
/** The structure represents a XML-RPC document structure.
*
* This is the data structure that represents XML-RPC structures that are sent
* to the client in the XML-RPC reply documents. A XML-RPC document structure
* is compound consting of name-value pairs.
* @sa http://www.xml-rpc.com
*/
struct rpc_struct {
int vtype;
xmlNodePtr struct_in; /**< Pointer to the structure parameter */
struct xmlrpc_reply struct_out; /**< Structure to be sent in reply */
struct xmlrpc_reply* reply; /**< Print errors here */
int n; /**< Number of structure members
created */
xmlDocPtr doc; /**< XML-RPC document */
int offset; /**< Offset in the reply where the
structure should be printed */
struct rpc_struct* nnext; /**< nested structure support - a recursive list of nested structrures */
struct rpc_struct* parent; /**< access to parent structure - used for flattening structure before reply */
struct rpc_struct* next;
};
/** The context of the XML-RPC request being processed.
*
* This is a global variable that records the context of the XML-RPC request
* being currently processed.
* @sa rpc_ctx
*/
static rpc_ctx_t ctx;
static void close_doc(rpc_ctx_t* ctx);
static void set_fault(struct xmlrpc_reply* reply, int code, char* fmt, ...);
static int fixup_xmlrpc_reply(void** param, int param_no);
/** Pointers to the functions that implement the RPC interface
* of xmlrpc SER module
*/
static rpc_t func_param;
/** Enable/disable additional introspection methods. If set to 1 then the
* functions defined in http://scripts.incutio.com/xmlrpc/introspection.html
* will be available on the server. If set to 0 then the functions will be
* disabled.
*/
static char* xmlrpc_route=0; /* default is the main route */
/** Reference to the sl (stateless replies) module of SER The sl module of SER
* is needed so that the xmlrpc SER module can send replies back to clients
*/
sl_api_t slb;
static int xmlrpc_route_no=DEFAULT_RT;
/* if set, try autoconverting to the requested type if possible
(e.g. convert 1 to "1" if string is requested) */
static int autoconvert=0;
/* in replies, escape CR to 
 (according to the xml specs) */
static int escape_cr=1; /* default on */
/* convert double LF to CR LF (when on, LFLF becomes an escape for CRLF, needed
with some xmlrpc clients that are not escaping CR to 
 )*/
static int lflf2crlf=0; /* default off */
/* do not register for non-sip requests */
static int xmlrpc_mode = 0;
static char* xmlrpc_url_match = NULL;
static regex_t xmlrpc_url_match_regexp;
static char* xmlrpc_url_skip = NULL;
static regex_t xmlrpc_url_skip_regexp;
/*
* Exported functions
*/
static cmd_export_t cmds[] = {
{"dispatch_rpc", dispatch_rpc, 0, 0, REQUEST_ROUTE},
{"xmlrpc_reply", xmlrpc_reply, 2, fixup_xmlrpc_reply, REQUEST_ROUTE},
{0, 0, 0, 0, 0}
};
/*
* Exported parameters
*/
static param_export_t params[] = {
{"route", PARAM_STRING, &xmlrpc_route},
{"autoconversion", PARAM_INT, &autoconvert},
{"escape_cr", PARAM_INT, &escape_cr},
{"double_lf_to_crlf", PARAM_INT, &lflf2crlf},
{"mode", PARAM_INT, &xmlrpc_mode},
{"url_match", PARAM_STRING, &xmlrpc_url_match},
{"url_skip", PARAM_STRING, &xmlrpc_url_skip},
{0, 0, 0}
};
struct module_exports exports = {
"xmlrpc",
cmds, /* Exported commands */
0, /* Exported RPC methods */
params, /* Exported parameters */
mod_init, /* module initialization function */
0, /* response function*/
0, /* destroy function */
0, /* oncancel function */
0 /* per-child init function */
};
/* XML-RPC reply helper functions */
#define ESC_LT "<"
#define ESC_AMP "&"
#define ESC_CR "
"
static void clean_context(rpc_ctx_t* ctx);
/** Adds arbitrary text to the XML-RPC reply being constructed, special
* characters < and & will be escaped.
*
* This function adds arbitrary text to the body of the XML-RPC reply being
* constructed. Note well that the function does not check whether the XML
* document being constructed is well-formed or valid. Use with care.
*
* @param reply Pointer to the structure representing the XML-RPC reply
* being constructed.
* @param text The text to be appended to the XML-RPC reply.
* @return -1 on error, 0 if the text was added successfully.
* @sa add_xmlrpc_reply()
*/
static int add_xmlrpc_reply_esc(struct xmlrpc_reply* reply, str* text)
{
char* p;
int i;
for(i = 0; i < text->len; i++) {
/* 10 must be bigger than size of longest escape sequence */
if (reply->body.len >= reply->buf.len - 10) {
p = mxr_malloc(reply->buf.len + 1024);
if (!p) {
set_fault(reply, 500,
"Internal Server Error (No memory left)");
ERR("No memory left: %d\n", reply->body.len + 1024);
return -1;
}
memcpy(p, reply->body.s, reply->body.len);
mxr_free(reply->buf.s);
reply->buf.s = p;
reply->buf.len += 1024;
reply->body.s = p;
}
switch(text->s[i]) {
case '<':
memcpy(reply->body.s + reply->body.len, ESC_LT,
sizeof(ESC_LT) - 1);
reply->body.len += sizeof(ESC_LT) - 1;
break;
case '&':
memcpy(reply->body.s + reply->body.len, ESC_AMP,
sizeof(ESC_AMP) - 1);
reply->body.len += sizeof(ESC_AMP) - 1;
break;
case '\r':
if (likely(escape_cr)){
memcpy(reply->body.s + reply->body.len, ESC_CR,
sizeof(ESC_CR) - 1);
reply->body.len += sizeof(ESC_CR) - 1;
break;
}
/* no break */
default:
reply->body.s[reply->body.len] = text->s[i];
reply->body.len++;
break;
}
}
return 0;
}
/** Add arbitrary text to the XML-RPC reply being constructed, no escaping
* done.
*
* This is a more efficient version of add_xmlrpc_reply_esc(), the function
* appends arbitrary text to the end of the XML-RPC reply being constructed,
* but the text must not contain any characters that need to be escaped in
* XML, such as < and & (or the characters must be escaped already).
*
* @param reply Pointer to the structure representing the XML-RPC reply
* being constructed.
* @param text The text to be appended to the XML-RPC reply.
* @return -1 on error, 0 if the text was added successfully.
* @sa add_xmlrpc_reply_esc()
*/
static int add_xmlrpc_reply(struct xmlrpc_reply* reply, str* text)
{
char* p;
if (text->len > (reply->buf.len - reply->body.len)) {
p = mxr_malloc(reply->buf.len + text->len + 1024);
if (!p) {
set_fault(reply, 500, "Internal Server Error (No memory left)");
ERR("No memory left: %d\n", reply->buf.len + text->len + 1024);
return -1;
}
memcpy(p, reply->body.s, reply->body.len);
mxr_free(reply->buf.s);
reply->buf.s = p;
reply->buf.len += text->len + 1024;
reply->body.s = p;
}
memcpy(reply->body.s + reply->body.len, text->s, text->len);
reply->body.len += text->len;
return 0;
}
/** Adds arbitrary text to the XML-RPC reply being constructed, the text will
* be inserted at a specified offset within the XML-RPC reply.
*
* This function inserts arbitrary text in the XML-RPC reply that is being
* constructed, unlike add_xmlrp_reply(), this function will not append the
* text at the end of the reply, but it will insert the text in the middle of
* the reply at the position provided to the function in "offset"
* parameter. The function does not escape special characters and thus the
* text must not contain such characters (or the must be escaped already).
*
* @param reply The XML-RPC reply structure representing the reply being
* constructed.
* @param offset The position of the first character where the text should be
* inserted.
* @param text The text to be inserted.
* @return 0 of the text was inserted successfully, a negative number on error.
*/
static int add_xmlrpc_reply_offset(struct xmlrpc_reply* reply, unsigned int offset, str* text)
{
char* p;
if (text->len > (reply->buf.len - reply->body.len)) {
p = mxr_malloc(reply->buf.len + text->len + 1024);
if (!p) {
set_fault(reply, 500, "Internal Server Error (No memory left)");
ERR("No memory left: %d\n", reply->buf.len + text->len + 1024);
return -1;
}
memcpy(p, reply->body.s, reply->body.len);
mxr_free(reply->buf.s);
reply->buf.s = p;
reply->buf.len += text->len + 1024;
reply->body.s = p;
}
memmove(reply->body.s + offset + text->len, reply->body.s + offset,
reply->body.len - offset);
memcpy(reply->body.s + offset, text->s, text->len);
reply->body.len += text->len;
return 0;
}
/** Returns the current length of the XML-RPC reply body.
*
* @param reply The XML-RPC reply being constructed
* @return Number of bytes of the XML-RPC reply body.
*/
static unsigned int get_reply_len(struct xmlrpc_reply* reply)
{
return reply->body.len;
}
/* Resets XMLRPC reply body.
*
* This function discards everything that has been written so far and starts
* constructing the XML-RPC reply body from the beginning.
*
* @param reply The XML-RPC reply being constructed.
*/
static void reset_xmlrpc_reply(struct xmlrpc_reply* reply)
{
reply->body.len = 0;
}
/** Initialize XML-RPC reply data structure.
*
* This function initializes the data structure that contains all data related
* to the XML-RPC reply being created. The function must be called before any
* other function that adds data to the reply.
* @param reply XML-RPC reply structure to be initialized.
* @return 0 on success, a negative number on error.
*/
static int init_xmlrpc_reply(struct xmlrpc_reply* reply)
{
reply->code = 200;
reply->reason = "OK";
reply->buf.s = mxr_malloc(1024);
if (!reply->buf.s) {
set_fault(reply, 500, "Internal Server Error (No memory left)");
ERR("No memory left\n");
return -1;
}
reply->buf.len = 1024;
reply->body.s = reply->buf.s;
reply->body.len = 0;
return 0;
}
/** Clear the XML-RPC reply code and sets it back to a success reply.
*
* @param reply XML-RPC reply structure to be cleared.
*/
static void clear_xmlrpc_reply(struct xmlrpc_reply* reply)
{
reply->code = 200;
reply->reason = "OK";
}
/* if this a delayed reply context, and it's never been use before, fix it */
static int fix_delayed_reply_ctx(rpc_ctx_t* ctx)
{
if ((ctx->flags & XMLRPC_DELAYED_CTX_F) && (ctx->reply.buf.s==0)){
if (init_xmlrpc_reply(&ctx->reply) <0) return -1;
if(add_xmlrpc_reply(&ctx->reply, &success_prefix)<0) return -1;
if (ctx->flags & RET_ARRAY)
return add_xmlrpc_reply(&ctx->reply, &array_prefix);
}
return 0;
}
/** Free all memory used by the XML-RPC reply structure. */
static void clean_xmlrpc_reply(struct xmlrpc_reply* reply)
{
if (reply->buf.s) mxr_free(reply->buf.s);
}
/** Create XML-RPC reply that indicates an error to the caller.
*
* This function is used to build the XML-RPC reply body that indicates that
* an error ocurred on the server. It is called when a management function in
* SER reports an error. The reply will contain the reason code and reason
* phrase text provided by the management function that indicated the error.
*/
static int build_fault_reply(struct xmlrpc_reply* reply)
{
str reason_s, code_s;
reason_s.s = reply->reason;
reason_s.len = strlen(reply->reason);
code_s.s = int2str(reply->code, &code_s.len);
reset_xmlrpc_reply(reply);
if (add_xmlrpc_reply(reply, &fault_prefix) < 0) return -1;
if (add_xmlrpc_reply_esc(reply, &code_s) < 0) return -1;
if (add_xmlrpc_reply(reply, &fault_body) < 0) return -1;
if (add_xmlrpc_reply_esc(reply, &reason_s) < 0) return -1;
if (add_xmlrpc_reply(reply, &fault_suffix) < 0) return -1;
return 0;
}
/** Add a memory registion to the list of memory blocks that
* need to be re-claimed later.
*
* @param type The type of the memory block (ordinary text or structure).
* @param ptr A pointer to the memory block.
* @param reply The XML-RPC the memory block is associated with.
* @return 0 on success, a negative number on error.
* @sa collect_garbage()
*/
static int add_garbage(int type, void* ptr, struct xmlrpc_reply* reply)
{
struct garbage* p;
p = (struct garbage*)mxr_malloc(sizeof(struct garbage));
if (!p) {
set_fault(reply, 500, "Internal Server Error (No memory left)");
ERR("Not enough memory\n");
return -1;
}
p->type = type;
p->ptr = ptr;
p->next = waste_bin;
waste_bin = p;
return 0;
}
/** Re-claims all memory allocated in the process of building XML-RPC
* reply.
*/
static void collect_garbage(void)
{
struct rpc_struct* s;
struct garbage* p;
/* Collect garbage */
while(waste_bin) {
p = waste_bin;
waste_bin = waste_bin->next;
switch(p->type) {
case JUNK_XMLCHAR:
if (p->ptr) xmlFree(p->ptr);
break;
case JUNK_RPCSTRUCT:
s = (struct rpc_struct*)p->ptr;
if (s && s->struct_out.buf.s) mxr_free(s->struct_out.buf.s);
if (s) mxr_free(s);
break;
case JUNK_PKGCHAR:
if (p->ptr){
mxr_free(p->ptr);
p->ptr=0;
}
break;
default:
ERR("BUG: Unsupported junk type\n");
}
mxr_free(p);
}
}
/** Extract XML-RPC query from a SIP/HTTP message.
*
* @param doc A pointer to string descriptor that will be filled
* with the pointer to the beginning of the XML-RPC
* document and length of the document.
* @param msg A structure representing the SIP/HTTP message
* carrying the XML-RPC document in body.
*/
static int get_rpc_document(str* doc, sip_msg_t* msg)
{
doc->s = get_body(msg);
if (!doc->s) {
ERR("Error while extracting message body\n");
return -1;
}
doc->len = strlen(doc->s);
return 0;
}
/** Send a reply to the client with given body.
*
* This function sends a 200 OK reply back to the client, the body of the
* reply will contain text provided to the function in "body" parameter.
*
* @param msg The request that generated the reply.
* @param body The text that will be put in the body of the reply.
*/
static int send_reply(sip_msg_t* msg, str* body)
{
if (add_lump_rpl(msg, body->s, body->len, LUMP_RPL_BODY) == 0) {
ERR("Error while adding reply lump\n");
return -1;
}
if (slb.zreply(msg, 200, "OK") == -1) {
ERR("Error while sending reply\n");
return -1;
}
return 0;
}
static int flatten_nests(struct rpc_struct* st, struct xmlrpc_reply* reply) {
if (!st)
return 1;
if (!st->nnext) {
if(st->vtype == RET_ARRAY) {
if (add_xmlrpc_reply(&st->struct_out, &array_suffix) < 0) return -1;
} else {
if (add_xmlrpc_reply(&st->struct_out, &struct_suffix) < 0) return -1;
}
if (add_xmlrpc_reply_offset(&st->parent->struct_out, st->offset, &st->struct_out.body) < 0) return -1;
} else {
flatten_nests(st->nnext, reply);
if(st->vtype == RET_ARRAY) {
if (add_xmlrpc_reply(&st->struct_out, &array_suffix) < 0) return -1;
} else {
if (add_xmlrpc_reply(&st->struct_out, &struct_suffix) < 0) return -1;
}
if (add_xmlrpc_reply_offset(&st->parent->struct_out, st->offset, &st->struct_out.body) < 0) return -1;
}
return 1;
}
static int print_structures(struct xmlrpc_reply* reply,
struct rpc_struct* st)
{
while(st) {
/* Close the structure first */
if(st->vtype == RET_ARRAY) {
if (add_xmlrpc_reply(&st->struct_out, &array_suffix) < 0) return -1;
} else {
if (add_xmlrpc_reply(&st->struct_out, &struct_suffix) < 0) return -1;
}
if (flatten_nests(st->nnext, &st->struct_out) < 0) return -1;
if (add_xmlrpc_reply_offset(reply, st->offset, &st->struct_out.body) < 0) return -1;
st = st->next;
}
return 0;
}
/** Implementation of rpc_send function required by the management API in SER.
*
* This is the function that will be called whenever a management function in
* SER asks the management interface to send the reply to the client. The
* function will generate the XML-RPC document, put it in body of a SIP
* response and send the response to the client. The SIP/HTTP reply sent to
* the client will be always 200 OK, if an error ocurred on the server then it
* will be indicated in the XML document in body.
*
* @param ctx A pointer to the context structure of the XML-RPC request that
* generated the reply.
* @return 1 if the reply was already sent, 0 on success, a negative number on
* error
*/
static int rpc_send(rpc_ctx_t* ctx)
{
struct xmlrpc_reply* reply;
if (ctx->reply_sent) return 1;
reply = &ctx->reply;
if (reply->code >= 300) {
if (build_fault_reply(reply) < 0) return -1;
} else {
if (ctx->flags & RET_ARRAY &&
add_xmlrpc_reply(reply, &array_suffix) < 0) return -1;
if (ctx->structs &&
print_structures(reply, ctx->structs) < 0) return -1;
if (add_xmlrpc_reply(reply, &success_suffix) < 0) return -1;
}
if (send_reply(ctx->msg, &reply->body) < 0) return -1;
ctx->reply_sent = 1;
return 0;
}
#define REASON_BUF_LEN 1024
static void set_fault(struct xmlrpc_reply* reply, int code, char* fmt, ...)
{
static char buf[REASON_BUF_LEN];
va_list ap;
reply->code = code;
va_start(ap, fmt);
vsnprintf(buf, REASON_BUF_LEN, fmt, ap);
va_end(ap);
reply->reason = buf;
}
/** Implementation of rpc_fault function required by the management API in
* SER.
*
* This function will be called whenever a management function in SER
* indicates that an error ocurred while it was processing the request. The
* function takes the reply code and reason phrase as parameters, these will
* be put in the body of the reply.
*
* @param ctx A pointer to the context structure of the request being
* processed.
* @param code Reason code.
* @param fmt Formatting string used to build the reason phrase.
*/
static void rpc_fault(rpc_ctx_t* ctx, int code, char* fmt, ...)
{
static char buf[REASON_BUF_LEN];
va_list ap;
fix_delayed_reply_ctx(ctx);
ctx->reply.code = code;
va_start(ap, fmt);
vsnprintf(buf, REASON_BUF_LEN, fmt, ap);
va_end(ap);
ctx->reply.reason = buf;
}
/** Create and initialize a new rpc_structure data structure.
*
* This function allocates and initializes memory for a new rpc_struct
* structure. If the caller provided non-NULL pointers in doc and structure
* parameters then the structure is coming from an XML-RPC request. If either
* of the pointers is NULL then we are creating a structure that will be
* attached to a XML-RPC reply sent to the client. The memory allocated in
* this function will be added to the garbage collection list.
*
* @param doc A pointer to the XML-RPC request document or NULL if we create
* a structure that will be put in a reply.
* @param structure A pointer to opening tag of the structure in the XML-RPC
* request document or NULL if we create a structure that
* will be put in a XML-RPC reply.
* @param reply A pointer to xml_reply structure, NULL if it is a structure
* coming from a XML-RPC request.
*/
static struct rpc_struct* new_rpcstruct(xmlDocPtr doc, xmlNodePtr structure,
struct xmlrpc_reply* reply, int vtype)
{
struct rpc_struct* p;
p = (struct rpc_struct*)mxr_malloc(sizeof(struct rpc_struct));
if (!p) {
set_fault(reply, 500, "Internal Server Error (No Memory Left");
return 0;
}
memset(p, 0, sizeof(struct rpc_struct));
p->struct_in = structure;
p->reply = reply;
p->n = 0;
p->vtype = vtype;
if (doc && structure) {
/* We will be parsing structure from request */
p->doc = doc;
p->struct_in = structure;
} else {
/* We will build a reply structure */
if (init_xmlrpc_reply(&p->struct_out) < 0) goto err;
if(vtype==RET_ARRAY) {
if (add_xmlrpc_reply(&p->struct_out, &array_prefix) < 0) goto err;
} else {
if (add_xmlrpc_reply(&p->struct_out, &struct_prefix) < 0) goto err;
}
}
if (add_garbage(JUNK_RPCSTRUCT, p, reply) < 0) goto err;
return p;
err:
if (p->struct_out.buf.s) mxr_free(p->struct_out.buf.s);
mxr_free(p);
return 0;
}
/** Converts the variables provided in parameter ap according to formatting
* string provided in parameter fmt into parameters in XML-RPC format.
*
* This function takes the parameters provided in ap parameter and creates
* XML-RPC formatted parameters that will be put in the document in res
* parameter. The format of input parameters is described in formatting string
* fmt which follows the syntax of the management API in SER. In the case of
* an error the function will generate an error reply in err_reply parameter
* instead.
* @param res A pointer to the XML-RPC result structure where the parameters
* will be written.
* @param err_reply An error reply document will be generated here if the
* function encounters a problem while processing input
* parameters.
* @param fmt Formatting string of the management API in SER.
* @param ap A pointer to the array of input parameters.
*
*/
static int print_value(struct xmlrpc_reply* res,
struct xmlrpc_reply* err_reply, char fmt, va_list* ap)
{
str prefix, body, suffix;
str* sp;
char buf[256];
time_t dt;
struct tm* t;
switch(fmt) {