← Back to branch summary

~ubuntu-branches/ubuntu/maverick/sflphone/maverick

« back to all changes in this revision

Viewing changes to sflphone-common/libs/pjproject/pjlib-util/src/pjlib-util/xml.c

  • Committer: Bazaar Package Importer
  • Author(s): Francois Marier
  • Date: 2010-06-03 15:59:46 UTC
  • Revision ID: james.westby@ubuntu.com-20100603155946-ybe8d8o8zx8lp0m8
Tags: upstream-0.9.8.3
Import upstream version 0.9.8.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
sflphone-common/libs/pjproject/pjlib-util/src/pjlib-util/xml.c
 
1
/* $Id: xml.c 2727 2009-06-01 09:28:28Z bennylp $ */
 
2
/* 
 
3
 * Copyright (C) 2008-2009 Teluu Inc. (http://www.teluu.com)
 
4
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 
5
 *
 
6
 * This program is free software; you can redistribute it and/or modify
 
7
 * it under the terms of the GNU General Public License as published by
 
8
 * the Free Software Foundation; either version 2 of the License, or
 
9
 * (at your option) any later version.
 
10
 *
 
11
 * This program is distributed in the hope that it will be useful,
 
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
 * GNU General Public License for more details.
 
15
 *
 
16
 * You should have received a copy of the GNU General Public License
 
17
 * along with this program; if not, write to the Free Software
 
18
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 
19
 *
 
20
 *  Additional permission under GNU GPL version 3 section 7:
 
21
 *
 
22
 *  If you modify this program, or any covered work, by linking or
 
23
 *  combining it with the OpenSSL project's OpenSSL library (or a
 
24
 *  modified version of that library), containing parts covered by the
 
25
 *  terms of the OpenSSL or SSLeay licenses, Teluu Inc. (http://www.teluu.com)
 
26
 *  grants you additional permission to convey the resulting work.
 
27
 *  Corresponding Source for a non-source form of such a combination
 
28
 *  shall include the source code for the parts of OpenSSL used as well
 
29
 *  as that of the covered work.
 
30
 */
 
31
#include <pjlib-util/xml.h>
 
32
#include <pjlib-util/scanner.h>
 
33
#include <pj/except.h>
 
34
#include <pj/pool.h>
 
35
#include <pj/string.h>
 
36
#include <pj/log.h>
 
37
#include <pj/os.h>
 
38
 
 
39
#define EX_SYNTAX_ERROR 12
 
40
#define THIS_FILE       "xml.c"
 
41
 
 
42
static void on_syntax_error(struct pj_scanner *scanner)
 
43
{
 
44
    PJ_UNUSED_ARG(scanner);
 
45
    PJ_THROW(EX_SYNTAX_ERROR);
 
46
}
 
47
 
 
48
static pj_xml_node *alloc_node( pj_pool_t *pool )
 
49
{
 
50
    pj_xml_node *node;
 
51
 
 
52
    node = PJ_POOL_ZALLOC_T(pool, pj_xml_node);
 
53
    pj_list_init( &node->attr_head );
 
54
    pj_list_init( &node->node_head );
 
55
 
 
56
    return node;
 
57
}
 
58
 
 
59
static pj_xml_attr *alloc_attr( pj_pool_t *pool )
 
60
{
 
61
    return PJ_POOL_ZALLOC_T(pool, pj_xml_attr);
 
62
}
 
63
 
 
64
/* This is a recursive function! */
 
65
static pj_xml_node *xml_parse_node( pj_pool_t *pool, pj_scanner *scanner)
 
66
{
 
67
    pj_xml_node *node;
 
68
    pj_str_t end_name;
 
69
 
 
70
    PJ_CHECK_STACK();
 
71
 
 
72
    if (*scanner->curptr != '<')
 
73
        on_syntax_error(scanner);
 
74
 
 
75
    /* Handle Processing Instructino (PI) construct (i.e. "<?") */
 
76
    if (*scanner->curptr == '<' && *(scanner->curptr+1) == '?') {
 
77
        pj_scan_advance_n(scanner, 2, PJ_FALSE);
 
78
        for (;;) {
 
79
            pj_str_t dummy;
 
80
            pj_scan_get_until_ch(scanner, '?', &dummy);
 
81
            if (*scanner->curptr=='?' && *(scanner->curptr+1)=='>') {
 
82
                pj_scan_advance_n(scanner, 2, PJ_TRUE);
 
83
                break;
 
84
            } else {
 
85
                pj_scan_advance_n(scanner, 1, PJ_FALSE);
 
86
            }
 
87
        }
 
88
        return xml_parse_node(pool, scanner);
 
89
    }
 
90
 
 
91
    /* Handle comments construct (i.e. "<!") */
 
92
    if (pj_scan_strcmp(scanner, "<!", 2) == 0) {
 
93
        pj_scan_advance_n(scanner, 2, PJ_FALSE);
 
94
        for (;;) {
 
95
            pj_str_t dummy;
 
96
            pj_scan_get_until_ch(scanner, '>', &dummy);
 
97
            if (pj_scan_strcmp(scanner, ">", 1) == 0) {
 
98
                pj_scan_advance_n(scanner, 1, PJ_TRUE);
 
99
                break;
 
100
            } else {
 
101
                pj_scan_advance_n(scanner, 1, PJ_FALSE);
 
102
            }
 
103
        }
 
104
        return xml_parse_node(pool, scanner);
 
105
    }
 
106
 
 
107
    /* Alloc node. */
 
108
    node = alloc_node(pool);
 
109
 
 
110
    /* Get '<' */
 
111
    pj_scan_get_char(scanner);
 
112
 
 
113
    /* Get node name. */
 
114
    pj_scan_get_until_chr( scanner, " />\t", &node->name);
 
115
 
 
116
    /* Get attributes. */
 
117
    while (*scanner->curptr != '>' && *scanner->curptr != '/') {
 
118
        pj_xml_attr *attr = alloc_attr(pool);
 
119
        
 
120
        pj_scan_get_until_chr( scanner, "=> \t", &attr->name);
 
121
        if (*scanner->curptr == '=') {
 
122
            pj_scan_get_char( scanner );
 
123
            pj_scan_get_quotes(scanner, "\"'", "\"'", 2, &attr->value);
 
124
            /* remove quote characters */
 
125
            ++attr->value.ptr;
 
126
            attr->value.slen -= 2;
 
127
        }
 
128
        
 
129
        pj_list_push_back( &node->attr_head, attr );
 
130
    }
 
131
 
 
132
    if (*scanner->curptr == '/') {
 
133
        pj_scan_get_char(scanner);
 
134
        if (pj_scan_get_char(scanner) != '>')
 
135
            on_syntax_error(scanner);
 
136
        return node;
 
137
    }
 
138
 
 
139
    /* Enclosing bracket. */
 
140
    if (pj_scan_get_char(scanner) != '>')
 
141
        on_syntax_error(scanner);
 
142
 
 
143
    /* Sub nodes. */
 
144
    while (*scanner->curptr == '<' && *(scanner->curptr+1) != '/') {
 
145
        pj_xml_node *sub_node = xml_parse_node(pool, scanner);
 
146
        pj_list_push_back( &node->node_head, sub_node );
 
147
    }
 
148
 
 
149
    /* Content. */
 
150
    if (!pj_scan_is_eof(scanner) && *scanner->curptr != '<') {
 
151
        pj_scan_get_until_ch(scanner, '<', &node->content);
 
152
    }
 
153
 
 
154
    /* Enclosing node. */
 
155
    if (pj_scan_get_char(scanner) != '<' || pj_scan_get_char(scanner) != '/')
 
156
        on_syntax_error(scanner);
 
157
 
 
158
    pj_scan_get_until_chr(scanner, " \t>", &end_name);
 
159
 
 
160
    /* Compare name. */
 
161
    if (pj_stricmp(&node->name, &end_name) != 0)
 
162
        on_syntax_error(scanner);
 
163
 
 
164
    /* Enclosing '>' */
 
165
    if (pj_scan_get_char(scanner) != '>')
 
166
        on_syntax_error(scanner);
 
167
 
 
168
    return node;
 
169
}
 
170
 
 
171
PJ_DEF(pj_xml_node*) pj_xml_parse( pj_pool_t *pool, char *msg, pj_size_t len)
 
172
{
 
173
    pj_xml_node *node = NULL;
 
174
    pj_scanner scanner;
 
175
    PJ_USE_EXCEPTION;
 
176
 
 
177
    if (!msg || !len || !pool)
 
178
        return NULL;
 
179
 
 
180
    pj_scan_init( &scanner, msg, len, 
 
181
                  PJ_SCAN_AUTOSKIP_WS|PJ_SCAN_AUTOSKIP_NEWLINE, 
 
182
                  &on_syntax_error);
 
183
    PJ_TRY {
 
184
        node =  xml_parse_node(pool, &scanner);
 
185
    }
 
186
    PJ_CATCH_ANY {
 
187
        PJ_LOG(4,(THIS_FILE, "Syntax error parsing XML in line %d column %d",
 
188
                  scanner.line, pj_scan_get_col(&scanner)));
 
189
    }
 
190
    PJ_END;
 
191
    pj_scan_fini( &scanner );
 
192
    return node;
 
193
}
 
194
 
 
195
/* This is a recursive function. */
 
196
static int xml_print_node( const pj_xml_node *node, int indent, 
 
197
                           char *buf, pj_size_t len )
 
198
{
 
199
    int i;
 
200
    char *p = buf;
 
201
    pj_xml_attr *attr;
 
202
    pj_xml_node *sub_node;
 
203
 
 
204
#define SIZE_LEFT()     ((int)(len - (p-buf)))
 
205
 
 
206
    PJ_CHECK_STACK();
 
207
 
 
208
    /* Print name. */
 
209
    if (SIZE_LEFT() < node->name.slen + indent + 5)
 
210
        return -1;
 
211
    for (i=0; i<indent; ++i)
 
212
        *p++ = ' ';
 
213
    *p++ = '<';
 
214
    pj_memcpy(p, node->name.ptr, node->name.slen);
 
215
    p += node->name.slen;
 
216
 
 
217
    /* Print attributes. */
 
218
    attr = node->attr_head.next;
 
219
    while (attr != &node->attr_head) {
 
220
 
 
221
        if (SIZE_LEFT() < attr->name.slen + attr->value.slen + 4)
 
222
            return -1;
 
223
 
 
224
        *p++ = ' ';
 
225
 
 
226
        /* Attribute name. */
 
227
        pj_memcpy(p, attr->name.ptr, attr->name.slen);
 
228
        p += attr->name.slen;
 
229
 
 
230
        /* Attribute value. */
 
231
        if (attr->value.slen) {
 
232
            *p++ = '=';
 
233
            *p++ = '"';
 
234
            pj_memcpy(p, attr->value.ptr, attr->value.slen);
 
235
            p += attr->value.slen;
 
236
            *p++ = '"';
 
237
        }
 
238
 
 
239
        attr = attr->next;
 
240
    }
 
241
 
 
242
    /* Check for empty node. */
 
243
    if (node->content.slen==0 &&
 
244
        node->node_head.next==(pj_xml_node*)&node->node_head)
 
245
    {
 
246
        *p++ = ' ';
 
247
        *p++ = '/';
 
248
        *p++ = '>';
 
249
        return p-buf;
 
250
    }
 
251
 
 
252
    /* Enclosing '>' */
 
253
    if (SIZE_LEFT() < 1) return -1;
 
254
    *p++ = '>';
 
255
 
 
256
    /* Print sub nodes. */
 
257
    sub_node = node->node_head.next;
 
258
    while (sub_node != (pj_xml_node*)&node->node_head) {
 
259
        int printed;
 
260
 
 
261
        if (SIZE_LEFT() < indent + 3)
 
262
            return -1;
 
263
        //*p++ = '\r';
 
264
        *p++ = '\n';
 
265
 
 
266
        printed = xml_print_node(sub_node, indent + 1, p, SIZE_LEFT());
 
267
        if (printed < 0)
 
268
            return -1;
 
269
 
 
270
        p += printed;
 
271
        sub_node = sub_node->next;
 
272
    }
 
273
 
 
274
    /* Content. */
 
275
    if (node->content.slen) {
 
276
        if (SIZE_LEFT() < node->content.slen) return -1;
 
277
        pj_memcpy(p, node->content.ptr, node->content.slen);
 
278
        p += node->content.slen;
 
279
    }
 
280
 
 
281
    /* Enclosing node. */
 
282
    if (node->node_head.next != (pj_xml_node*)&node->node_head) {
 
283
        if (SIZE_LEFT() < node->name.slen + 5 + indent)
 
284
            return -1;
 
285
        //*p++ = '\r';
 
286
        *p++ = '\n';
 
287
        for (i=0; i<indent; ++i)
 
288
            *p++ = ' ';
 
289
    } else {
 
290
        if (SIZE_LEFT() < node->name.slen + 3)
 
291
            return -1;
 
292
    }
 
293
    *p++ = '<';
 
294
    *p++ = '/';
 
295
    pj_memcpy(p, node->name.ptr, node->name.slen);
 
296
    p += node->name.slen;
 
297
    *p++ = '>';
 
298
 
 
299
#undef SIZE_LEFT
 
300
 
 
301
    return p - buf;
 
302
}
 
303
 
 
304
PJ_DEF(int) pj_xml_print(const pj_xml_node *node, char *buf, pj_size_t len,
 
305
                         pj_bool_t include_prolog)
 
306
{
 
307
    int prolog_len = 0;
 
308
    int printed;
 
309
 
 
310
    if (!node || !buf || !len)
 
311
        return 0;
 
312
 
 
313
    if (include_prolog) {
 
314
        pj_str_t prolog = {"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n", 39};
 
315
        if ((int)len < prolog.slen)
 
316
            return -1;
 
317
        pj_memcpy(buf, prolog.ptr, prolog.slen);
 
318
        prolog_len = prolog.slen;
 
319
    }
 
320
 
 
321
    printed = xml_print_node(node, 0, buf+prolog_len, len-prolog_len) + prolog_len;
 
322
    if (printed > 0 && len-printed >= 1) {
 
323
        buf[printed++] = '\n';
 
324
    }
 
325
    return printed;
 
326
}
 
327
 
 
328
PJ_DEF(pj_xml_node*) pj_xml_node_new(pj_pool_t *pool, const pj_str_t *name)
 
329
{
 
330
    pj_xml_node *node = alloc_node(pool);
 
331
    pj_strdup(pool, &node->name, name);
 
332
    return node;
 
333
}
 
334
 
 
335
PJ_DEF(pj_xml_attr*) pj_xml_attr_new( pj_pool_t *pool, const pj_str_t *name,
 
336
                                      const pj_str_t *value)
 
337
{
 
338
    pj_xml_attr *attr = alloc_attr(pool);
 
339
    pj_strdup( pool, &attr->name, name);
 
340
    pj_strdup( pool, &attr->value, value);
 
341
    return attr;
 
342
}
 
343
 
 
344
PJ_DEF(void) pj_xml_add_node( pj_xml_node *parent, pj_xml_node *node )
 
345
{
 
346
    pj_list_push_back(&parent->node_head, node);
 
347
}
 
348
 
 
349
PJ_DEF(void) pj_xml_add_attr( pj_xml_node *node, pj_xml_attr *attr )
 
350
{
 
351
    pj_list_push_back(&node->attr_head, attr);
 
352
}
 
353
 
 
354
PJ_DEF(pj_xml_node*) pj_xml_find_node(const pj_xml_node *parent, 
 
355
                                      const pj_str_t *name)
 
356
{
 
357
    const pj_xml_node *node = parent->node_head.next;
 
358
 
 
359
    PJ_CHECK_STACK();
 
360
 
 
361
    while (node != (void*)&parent->node_head) {
 
362
        if (pj_stricmp(&node->name, name) == 0)
 
363
            return (pj_xml_node*)node;
 
364
        node = node->next;
 
365
    }
 
366
    return NULL;
 
367
}
 
368
 
 
369
PJ_DEF(pj_xml_node*) pj_xml_find_node_rec(const pj_xml_node *parent, 
 
370
                                          const pj_str_t *name)
 
371
{
 
372
    const pj_xml_node *node = parent->node_head.next;
 
373
 
 
374
    PJ_CHECK_STACK();
 
375
 
 
376
    while (node != (void*)&parent->node_head) {
 
377
        pj_xml_node *found;
 
378
        if (pj_stricmp(&node->name, name) == 0)
 
379
            return (pj_xml_node*)node;
 
380
        found = pj_xml_find_node_rec(node, name);
 
381
        if (found)
 
382
            return (pj_xml_node*)found;
 
383
        node = node->next;
 
384
    }
 
385
    return NULL;
 
386
}
 
387
 
 
388
PJ_DEF(pj_xml_node*) pj_xml_find_next_node( const pj_xml_node *parent, 
 
389
                                            const pj_xml_node *node,
 
390
                                            const pj_str_t *name)
 
391
{
 
392
    PJ_CHECK_STACK();
 
393
 
 
394
    node = node->next;
 
395
    while (node != (void*)&parent->node_head) {
 
396
        if (pj_stricmp(&node->name, name) == 0)
 
397
            return (pj_xml_node*)node;
 
398
        node = node->next;
 
399
    }
 
400
    return NULL;
 
401
}
 
402
 
 
403
 
 
404
PJ_DEF(pj_xml_attr*) pj_xml_find_attr( const pj_xml_node *node, 
 
405
                                       const pj_str_t *name,
 
406
                                       const pj_str_t *value)
 
407
{
 
408
    const pj_xml_attr *attr = node->attr_head.next;
 
409
    while (attr != (void*)&node->attr_head) {
 
410
        if (pj_stricmp(&attr->name, name)==0) {
 
411
            if (value) {
 
412
                if (pj_stricmp(&attr->value, value)==0)
 
413
                    return (pj_xml_attr*)attr;
 
414
            } else {
 
415
                return (pj_xml_attr*)attr;
 
416
            }
 
417
        }
 
418
        attr = attr->next;
 
419
    }
 
420
    return NULL;
 
421
}
 
422
 
 
423
 
 
424
 
 
425
PJ_DEF(pj_xml_node*) pj_xml_find( const pj_xml_node *parent, 
 
426
                                  const pj_str_t *name,
 
427
                                  const void *data, 
 
428
                                  pj_bool_t (*match)(const pj_xml_node *, 
 
429
                                                     const void*))
 
430
{
 
431
    const pj_xml_node *node = (const pj_xml_node *)parent->node_head.next;
 
432
 
 
433
    if (!name && !match)
 
434
        return NULL;
 
435
 
 
436
    while (node != (const pj_xml_node*) &parent->node_head) {
 
437
        if (name) {
 
438
            if (pj_stricmp(&node->name, name)!=0) {
 
439
                node = node->next;
 
440
                continue;
 
441
            }
 
442
        }
 
443
        if (match) {
 
444
            if (match(node, data))
 
445
                return (pj_xml_node*)node;
 
446
        } else {
 
447
            return (pj_xml_node*)node;
 
448
        }
 
449
 
 
450
        node = node->next;
 
451
    }
 
452
    return NULL;
 
453
}
 
454
 
 
455
PJ_DEF(pj_xml_node*) pj_xml_find_rec( const pj_xml_node *parent, 
 
456
                                      const pj_str_t *name,
 
457
                                      const void *data, 
 
458
                                      pj_bool_t (*match)(const pj_xml_node*, 
 
459
                                                         const void*))
 
460
{
 
461
    const pj_xml_node *node = (const pj_xml_node *)parent->node_head.next;
 
462
 
 
463
    if (!name && !match)
 
464
        return NULL;
 
465
 
 
466
    while (node != (const pj_xml_node*) &parent->node_head) {
 
467
        pj_xml_node *found;
 
468
 
 
469
        if (name) {
 
470
            if (pj_stricmp(&node->name, name)==0) {
 
471
                if (match) {
 
472
                    if (match(node, data))
 
473
                        return (pj_xml_node*)node;
 
474
                } else {
 
475
                    return (pj_xml_node*)node;
 
476
                }
 
477
            }
 
478
 
 
479
        } else if (match) {
 
480
            if (match(node, data))
 
481
                return (pj_xml_node*)node;
 
482
        }
 
483
 
 
484
        found = pj_xml_find_rec(node, name, data, match);
 
485
        if (found)
 
486
            return found;
 
487
 
 
488
        node = node->next;
 
489
    }
 
490
    return NULL;
 
491
}
 
492
 
 
493
PJ_DEF(pj_xml_node*) pj_xml_clone( pj_pool_t *pool, const pj_xml_node *rhs)
 
494
{
 
495
    pj_xml_node *node;
 
496
    const pj_xml_attr *r_attr;
 
497
    const pj_xml_node *child;
 
498
 
 
499
    node = alloc_node(pool);
 
500
 
 
501
    pj_strdup(pool, &node->name, &rhs->name);
 
502
    pj_strdup(pool, &node->content, &rhs->content);
 
503
 
 
504
    /* Clone all attributes */
 
505
    r_attr = rhs->attr_head.next;
 
506
    while (r_attr != &rhs->attr_head) {
 
507
 
 
508
        pj_xml_attr *attr;
 
509
 
 
510
        attr = alloc_attr(pool);
 
511
        pj_strdup(pool, &attr->name, &r_attr->name);
 
512
        pj_strdup(pool, &attr->value, &r_attr->value);
 
513
 
 
514
        pj_list_push_back(&node->attr_head, attr);
 
515
 
 
516
        r_attr = r_attr->next;
 
517
    }
 
518
 
 
519
    /* Clone all child nodes. */
 
520
    child = rhs->node_head.next;
 
521
    while (child != (pj_xml_node*) &rhs->node_head) {
 
522
        pj_xml_node *new_child;
 
523
 
 
524
        new_child = pj_xml_clone(pool, child);
 
525
        pj_list_push_back(&node->node_head, new_child);
 
526
 
 
527
        child = child->next;
 
528
    }
 
529
 
 
530
    return node;
 
531
}