Kill off red blobs in most of main/*
[asterisk/asterisk.git] / main / xmldoc.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008, Eliel C. Sardanons (LU1ALY) <eliels@gmail.com>
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief XML Documentation API
20  *
21  * \author Eliel C. Sardanons (LU1ALY) <eliels@gmail.com>
22  *
23  * \extref libxml2 http://www.xmlsoft.org/
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include "asterisk/_private.h"
31 #include "asterisk/paths.h"
32 #include "asterisk/linkedlists.h"
33 #include "asterisk/strings.h"
34 #include "asterisk/config.h"
35 #include "asterisk/term.h"
36 #include "asterisk/xmldoc.h"
37
38 #ifdef AST_XML_DOCS
39
40 /*! \brief Default documentation language. */
41 static const char default_documentation_language[] = "en_US";
42
43 /*! \brief Number of columns to print when showing the XML documentation with a
44  *         'core show application/function *' CLI command. Used in text wrapping.*/
45 static const int xmldoc_text_columns = 74;
46
47 /*! \brief This is a value that we will use to let the wrapping mechanism move the cursor
48  *         backward and forward xmldoc_max_diff positions before cutting the middle of a
49  *         word, trying to find a space or a \n. */
50 static const int xmldoc_max_diff = 5;
51
52 /*! \brief XML documentation language. */
53 static char documentation_language[6];
54
55 /*! \brief XML documentation tree */
56 struct documentation_tree {
57         char *filename;                                 /*!< XML document filename. */
58         struct ast_xml_doc *doc;                        /*!< Open document pointer. */
59         AST_RWLIST_ENTRY(documentation_tree) entry;
60 };
61
62 static char *xmldoc_get_syntax_cmd(struct ast_xml_node *fixnode, const char *name, int printname);
63 static int xmldoc_parse_enumlist(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer);
64
65 /*!
66  * \brief Container of documentation trees
67  *
68  * \note A RWLIST is a sufficient container type to use here for now.
69  *       However, some changes will need to be made to implement ref counting
70  *       if reload support is added in the future.
71  */
72 static AST_RWLIST_HEAD_STATIC(xmldoc_tree, documentation_tree);
73
74 static const struct strcolorized_tags {
75         const char *init;      /*!< Replace initial tag with this string. */
76         const char *end;       /*!< Replace end tag with this string. */
77         const int colorfg;     /*!< Foreground color. */
78         const char *inittag;   /*!< Initial tag description. */
79         const char *endtag;    /*!< Ending tag description. */
80 } colorized_tags[] = {
81         { "<",  ">",  COLOR_GREEN,  "<replaceable>", "</replaceable>" },
82         { "\'", "\'", COLOR_BLUE,   "<literal>",     "</literal>" },
83         { "*",  "*",  COLOR_RED,    "<emphasis>",    "</emphasis>" },
84         { "\"", "\"", COLOR_YELLOW, "<filename>",    "</filename>" },
85         { "\"", "\"", COLOR_CYAN,   "<directory>",   "</directory>" },
86         { "${", "}",  COLOR_GREEN,  "<variable>",    "</variable>" },
87         { "",   "",   COLOR_BLUE,   "<value>",       "</value>" },
88         { "",   "",   COLOR_BLUE,   "<enum>",        "</enum>" },
89         { "\'", "\'", COLOR_GRAY,   "<astcli>",      "</astcli>" },
90
91         /* Special tags */
92         { "", "", COLOR_YELLOW, "<note>",   "</note>" },
93         { "", "", COLOR_RED,   "<warning>", "</warning>" }
94 };
95
96 static const struct strspecial_tags {
97         const char *tagname;            /*!< Special tag name. */
98         const char *init;               /*!< Print this at the beginning. */
99         const char *end;                /*!< Print this at the end. */
100 } special_tags[] = {
101         { "note",    "<note>NOTE:</note> ",             "" },
102         { "warning", "<warning>WARNING!!!:</warning> ", "" }
103 };
104
105 /*! \internal
106  *  \brief Calculate the space in bytes used by a format string
107  *         that will be passed to a sprintf function.
108  *  \param postbr The format string to use to calculate the length.
109  *  \retval The postbr length.
110  */
111 static int xmldoc_postbrlen(const char *postbr)
112 {
113         int postbrreallen = 0, i;
114         size_t postbrlen;
115
116         if (!postbr) {
117                 return 0;
118         }
119         postbrlen = strlen(postbr);
120         for (i = 0; i < postbrlen; i++) {
121                 if (postbr[i] == '\t') {
122                         postbrreallen += 8 - (postbrreallen % 8);
123                 } else {
124                         postbrreallen++;
125                 }
126         }
127         return postbrreallen;
128 }
129
130 /*! \internal
131  *  \brief Setup postbr to be used while wrapping the text.
132  *         Add to postbr array all the spaces and tabs at the beginning of text.
133  *  \param postbr output array.
134  *  \param len text array length.
135  *  \param text Text with format string before the actual string.
136  */
137 static void xmldoc_setpostbr(char *postbr, size_t len, const char *text)
138 {
139         int c, postbrlen = 0;
140
141         if (!text) {
142                 return;
143         }
144
145         for (c = 0; c < len; c++) {
146                 if (text[c] == '\t' || text[c] == ' ') {
147                         postbr[postbrlen++] = text[c];
148                 } else {
149                         break;
150                 }
151         }
152         postbr[postbrlen] = '\0';
153 }
154
155 /*! \internal
156  *  \brief Try to find a space or a break in text starting at currentpost
157  *         and moving at most maxdiff positions.
158  *         Helper for xmldoc_string_wrap().
159  *  \param text Input string where it will search.
160  *  \param currentpos Current position within text.
161  *  \param maxdiff Not move more than maxdiff inside text.
162  *  \retval 1 if a space or break is found inside text while moving.
163  *  \retval 0 if no space or break is found.
164  */
165 static int xmldoc_wait_nextspace(const char *text, int currentpos, int maxdiff)
166 {
167         int i, textlen;
168
169         if (!text) {
170                 return 0;
171         }
172
173         textlen = strlen(text);
174         for (i = currentpos; i < textlen; i++) {
175                 if (text[i] == ESC) {
176                         /* Move to the end of the escape sequence */
177                         while (i < textlen && text[i] != 'm') {
178                                 i++;
179                         }
180                 } else if (text[i] == ' ' || text[i] == '\n') {
181                         /* Found the next space or linefeed */
182                         return 1;
183                 } else if (i - currentpos > maxdiff) {
184                         /* We have looked the max distance and didn't find it */
185                         return 0;
186                 }
187         }
188
189         /* Reached the end and did not find it */
190
191         return 0;
192 }
193
194 /*! \internal
195  *  \brief Helper function for xmldoc_string_wrap().
196  *         Try to found a space or a break inside text moving backward
197  *         not more than maxdiff positions.
198  *  \param text The input string where to search for a space.
199  *  \param currentpos The current cursor position.
200  *  \param maxdiff The max number of positions to move within text.
201  *  \retval 0 If no space is found (Notice that text[currentpos] is not a space or a break)
202  *  \retval > 0 If a space or a break is found, and the result is the position relative to
203  *              currentpos.
204  */
205 static int xmldoc_foundspace_backward(const char *text, int currentpos, int maxdiff)
206 {
207         int i;
208
209         for (i = currentpos; i > 0; i--) {
210                 if (text[i] == ' ' || text[i] == '\n') {
211                         return (currentpos - i);
212                 } else if (text[i] == 'm' && (text[i - 1] >= '0' || text[i - 1] <= '9')) {
213                         /* give up, we found the end of a possible ESC sequence. */
214                         return 0;
215                 } else if (currentpos - i > maxdiff) {
216                         /* give up, we can't move anymore. */
217                         return 0;
218                 }
219         }
220
221         /* we found the beginning of the text */
222
223         return 0;
224 }
225
226 /*! \internal
227  *  \brief Justify a text to a number of columns.
228  *  \param text Input text to be justified.
229  *  \param columns Number of columns to preserve in the text.
230  *  \param maxdiff Try to not cut a word when goinf down.
231  *  \retval NULL on error.
232  *  \retval The wrapped text.
233  */
234 static char *xmldoc_string_wrap(const char *text, int columns, int maxdiff)
235 {
236         struct ast_str *tmp;
237         char *ret, postbr[160];
238         int count = 1, i, backspace, needtobreak = 0, colmax, textlen;
239
240         /* sanity check */
241         if (!text || columns <= 0 || maxdiff < 0) {
242                 ast_log(LOG_WARNING, "Passing wrong arguments while trying to wrap the text\n");
243                 return NULL;
244         }
245
246         tmp = ast_str_create(strlen(text) * 3);
247
248         if (!tmp) {
249                 return NULL;
250         }
251
252         /* Check for blanks and tabs and put them in postbr. */
253         xmldoc_setpostbr(postbr, sizeof(postbr), text);
254         colmax = columns - xmldoc_postbrlen(postbr);
255
256         textlen = strlen(text);
257         for (i = 0; i < textlen; i++) {
258                 if (needtobreak || !(count % colmax)) {
259                         if (text[i] == ' ') {
260                                 ast_str_append(&tmp, 0, "\n%s", postbr);
261                                 needtobreak = 0;
262                                 count = 1;
263                         } else if (text[i] != '\n') {
264                                 needtobreak = 1;
265                                 if (xmldoc_wait_nextspace(text, i, maxdiff)) {
266                                         /* wait for the next space */
267                                         ast_str_append(&tmp, 0, "%c", text[i]);
268                                         continue;
269                                 }
270                                 /* Try to look backwards */
271                                 backspace = xmldoc_foundspace_backward(text, i, maxdiff);
272                                 if (backspace) {
273                                         needtobreak = 1;
274                                         ast_str_truncate(tmp, -backspace);
275                                         i -= backspace + 1;
276                                         continue;
277                                 }
278                                 ast_str_append(&tmp, 0, "\n%s", postbr);
279                                 needtobreak = 0;
280                                 count = 1;
281                         }
282                         /* skip blanks after a \n */
283                         while (text[i] == ' ') {
284                                 i++;
285                         }
286                 }
287                 if (text[i] == '\n') {
288                         xmldoc_setpostbr(postbr, sizeof(postbr), &text[i] + 1);
289                         colmax = columns - xmldoc_postbrlen(postbr);
290                         needtobreak = 0;
291                         count = 1;
292                 }
293                 if (text[i] == ESC) {
294                         /* Ignore Escape sequences. */
295                         do {
296                                 ast_str_append(&tmp, 0, "%c", text[i]);
297                                 i++;
298                         } while (i < textlen && text[i] != 'm');
299                 } else {
300                         count++;
301                 }
302                 ast_str_append(&tmp, 0, "%c", text[i]);
303         }
304
305         ret = ast_strdup(ast_str_buffer(tmp));
306         ast_free(tmp);
307
308         return ret;
309 }
310
311 char *ast_xmldoc_printable(const char *bwinput, int withcolors)
312 {
313         struct ast_str *colorized;
314         char *wrapped = NULL;
315         int i, c, len, colorsection;
316         char *tmp;
317         size_t bwinputlen;
318         static const int base_fg = COLOR_CYAN;
319
320         if (!bwinput) {
321                 return NULL;
322         }
323
324         bwinputlen = strlen(bwinput);
325
326         if (!(colorized = ast_str_create(256))) {
327                 return NULL;
328         }
329
330         if (withcolors) {
331                 ast_term_color_code(&colorized, base_fg, 0);
332                 if (!colorized) {
333                         return NULL;
334                 }
335         }
336
337         for (i = 0; i < bwinputlen; i++) {
338                 colorsection = 0;
339                 /* Check if we are at the beginning of a tag to be colorized. */
340                 for (c = 0; c < ARRAY_LEN(colorized_tags); c++) {
341                         if (strncasecmp(bwinput + i, colorized_tags[c].inittag, strlen(colorized_tags[c].inittag))) {
342                                 continue;
343                         }
344
345                         if (!(tmp = strcasestr(bwinput + i + strlen(colorized_tags[c].inittag), colorized_tags[c].endtag))) {
346                                 continue;
347                         }
348
349                         len = tmp - (bwinput + i + strlen(colorized_tags[c].inittag));
350
351                         /* Setup color */
352                         if (withcolors) {
353                                 ast_term_color_code(&colorized, colorized_tags[c].colorfg, 0);
354                                 if (!colorized) {
355                                         return NULL;
356                                 }
357                         }
358
359                         /* copy initial string replace */
360                         ast_str_append(&colorized, 0, "%s", colorized_tags[c].init);
361                         if (!colorized) {
362                                 return NULL;
363                         }
364                         {
365                                 char buf[len + 1];
366                                 ast_copy_string(buf, bwinput + i + strlen(colorized_tags[c].inittag), sizeof(buf));
367                                 ast_str_append(&colorized, 0, "%s", buf);
368                         }
369                         if (!colorized) {
370                                 return NULL;
371                         }
372
373                         /* copy the ending string replace */
374                         ast_str_append(&colorized, 0, "%s", colorized_tags[c].end);
375                         if (!colorized) {
376                                 return NULL;
377                         }
378
379                         /* Continue with the last color. */
380                         if (withcolors) {
381                                 ast_term_color_code(&colorized, base_fg, 0);
382                                 if (!colorized) {
383                                         return NULL;
384                                 }
385                         }
386
387                         i += len + strlen(colorized_tags[c].endtag) + strlen(colorized_tags[c].inittag) - 1;
388                         colorsection = 1;
389                         break;
390                 }
391
392                 if (!colorsection) {
393                         ast_str_append(&colorized, 0, "%c", bwinput[i]);
394                         if (!colorized) {
395                                 return NULL;
396                         }
397                 }
398         }
399
400         if (withcolors) {
401                 ast_str_append(&colorized, 0, "%s", term_end());
402                 if (!colorized) {
403                         return NULL;
404                 }
405         }
406
407         /* Wrap the text, notice that string wrap will avoid cutting an ESC sequence. */
408         wrapped = xmldoc_string_wrap(ast_str_buffer(colorized), xmldoc_text_columns, xmldoc_max_diff);
409
410         ast_free(colorized);
411
412         return wrapped;
413 }
414
415 /*! \internal
416  *  \brief Cleanup spaces and tabs after a \n
417  *  \param text String to be cleaned up.
418  *  \param output buffer (not already allocated).
419  *  \param lastspaces Remove last spaces in the string.
420  */
421 static void xmldoc_string_cleanup(const char *text, struct ast_str **output, int lastspaces)
422 {
423         int i;
424         size_t textlen;
425
426         if (!text) {
427                 *output = NULL;
428                 return;
429         }
430
431         textlen = strlen(text);
432
433         *output = ast_str_create(textlen);
434         if (!(*output)) {
435                 ast_log(LOG_ERROR, "Problem allocating output buffer\n");
436                 return;
437         }
438
439         for (i = 0; i < textlen; i++) {
440                 if (text[i] == '\n' || text[i] == '\r') {
441                         /* remove spaces/tabs/\n after a \n. */
442                         while (text[i + 1] == '\t' || text[i + 1] == '\r' || text[i + 1] == '\n') {
443                                 i++;
444                         }
445                         ast_str_append(output, 0, " ");
446                         continue;
447                 } else {
448                         ast_str_append(output, 0, "%c", text[i]);
449                 }
450         }
451
452         /* remove last spaces (we don't want always to remove the trailing spaces). */
453         if (lastspaces) {
454                 ast_str_trim_blanks(*output);
455         }
456 }
457
458 /*! \internal
459  * \brief Check if the given attribute on the given node matches the given value.
460  * \param node the node to match
461  * \param attr the name of the attribute
462  * \param value the expected value of the attribute
463  * \retval true if the given attribute contains the given value
464  * \retval false if the given attribute does not exist or does not contain the given value
465  */
466 static int xmldoc_attribute_match(struct ast_xml_node *node, const char *attr, const char *value)
467 {
468         const char *attr_value = ast_xml_get_attribute(node, attr);
469         int match = attr_value && !strcmp(attr_value, value);
470         ast_xml_free_attr(attr_value);
471         return match;
472 }
473
474 /*! \internal
475  *  \brief Get the application/function node for 'name' application/function with language 'language'
476  *         and module 'module' if we don't find any, get the first application
477  *         with 'name' no matter which language or module.
478  *  \param type 'application', 'function', ...
479  *  \param name Application or Function name.
480  *  \param module Module item is in.
481  *  \param language Try to get this language (if not found try with en_US)
482  *  \retval NULL on error.
483  *  \retval A node of type ast_xml_node.
484  */
485 static struct ast_xml_node *xmldoc_get_node(const char *type, const char *name, const char *module, const char *language)
486 {
487         struct ast_xml_node *node = NULL;
488         struct ast_xml_node *first_match = NULL;
489         struct ast_xml_node *lang_match = NULL;
490         struct documentation_tree *doctree;
491
492         AST_RWLIST_RDLOCK(&xmldoc_tree);
493         AST_LIST_TRAVERSE(&xmldoc_tree, doctree, entry) {
494                 /* the core xml documents have priority over thirdparty document. */
495                 node = ast_xml_get_root(doctree->doc);
496                 if (!node) {
497                         break;
498                 }
499
500                 node = ast_xml_node_get_children(node);
501                 while ((node = ast_xml_find_element(node, type, "name", name))) {
502                         if (!ast_xml_node_get_children(node)) {
503                                 /* ignore empty nodes */
504                                 node = ast_xml_node_get_next(node);
505                                 continue;
506                         }
507
508                         if (!first_match) {
509                                 first_match = node;
510                         }
511
512                         /* Check language */
513                         if (xmldoc_attribute_match(node, "language", language)) {
514                                 if (!lang_match) {
515                                         lang_match = node;
516                                 }
517
518                                 /* if module is empty we have a match */
519                                 if (ast_strlen_zero(module)) {
520                                         break;
521                                 }
522
523                                 /* Check module */
524                                 if (xmldoc_attribute_match(node, "module", module)) {
525                                         break;
526                                 }
527                         }
528
529                         node = ast_xml_node_get_next(node);
530                 }
531
532                 /* if we matched lang and module return this match */
533                 if (node) {
534                         break;
535                 }
536
537                 /* we didn't match lang and module, just return the first
538                  * result with a matching language if we have one */
539                 if (lang_match) {
540                         node = lang_match;
541                         break;
542                 }
543
544                 /* we didn't match with only the language, just return the
545                  * first match */
546                 if (first_match) {
547                         node = first_match;
548                         break;
549                 }
550         }
551         AST_RWLIST_UNLOCK(&xmldoc_tree);
552
553         return node;
554 }
555
556 /*! \internal
557  *  \brief Helper function used to build the syntax, it allocates the needed buffer (or reallocates it),
558  *         and based on the reverse value it makes use of fmt to print the parameter list inside the
559  *         realloced buffer (syntax).
560  *  \param reverse We are going backwards while generating the syntax?
561  *  \param len Current length of 'syntax' buffer.
562  *  \param syntax Output buffer for the concatenated values.
563  *  \param fmt A format string that will be used in a sprintf call.
564  */
565 static void __attribute__((format(printf, 4, 5))) xmldoc_reverse_helper(int reverse, int *len, char **syntax, const char *fmt, ...)
566 {
567         int totlen, tmpfmtlen;
568         char *tmpfmt, tmp;
569         va_list ap;
570
571         va_start(ap, fmt);
572         if (ast_vasprintf(&tmpfmt, fmt, ap) < 0) {
573                 va_end(ap);
574                 return;
575         }
576         va_end(ap);
577
578         tmpfmtlen = strlen(tmpfmt);
579         totlen = *len + tmpfmtlen + 1;
580
581         *syntax = ast_realloc(*syntax, totlen);
582
583         if (!*syntax) {
584                 ast_free(tmpfmt);
585                 return;
586         }
587
588         if (reverse) {
589                 memmove(*syntax + tmpfmtlen, *syntax, *len);
590                 /* Save this char, it will be overwritten by the \0 of strcpy. */
591                 tmp = (*syntax)[0];
592                 strcpy(*syntax, tmpfmt);
593                 /* Restore the already saved char. */
594                 (*syntax)[tmpfmtlen] = tmp;
595                 (*syntax)[totlen - 1] = '\0';
596         } else {
597                 strcpy(*syntax + *len, tmpfmt);
598         }
599
600         *len = totlen - 1;
601         ast_free(tmpfmt);
602 }
603
604 /*! \internal
605  *  \brief Check if the passed node has 'what' tags inside it.
606  *  \param node Root node to search 'what' elements.
607  *  \param what node name to search inside node.
608  *  \retval 1 If a 'what' element is found inside 'node'.
609  *  \retval 0 If no 'what' is found inside 'node'.
610  */
611 static int xmldoc_has_inside(struct ast_xml_node *fixnode, const char *what)
612 {
613         struct ast_xml_node *node = fixnode;
614
615         for (node = ast_xml_node_get_children(fixnode); node; node = ast_xml_node_get_next(node)) {
616                 if (!strcasecmp(ast_xml_node_get_name(node), what)) {
617                         return 1;
618                 }
619         }
620         return 0;
621 }
622
623 /*! \internal
624  *  \brief Check if the passed node has at least one node inside it.
625  *  \param node Root node to search node elements.
626  *  \retval 1 If a node element is found inside 'node'.
627  *  \retval 0 If no node is found inside 'node'.
628  */
629 static int xmldoc_has_nodes(struct ast_xml_node *fixnode)
630 {
631         struct ast_xml_node *node = fixnode;
632
633         for (node = ast_xml_node_get_children(fixnode); node; node = ast_xml_node_get_next(node)) {
634                 if (strcasecmp(ast_xml_node_get_name(node), "text")) {
635                         return 1;
636                 }
637         }
638         return 0;
639 }
640
641 /*! \internal
642  *  \brief Check if the passed node has at least one specialtag.
643  *  \param node Root node to search "specialtags" elements.
644  *  \retval 1 If a "specialtag" element is found inside 'node'.
645  *  \retval 0 If no "specialtag" is found inside 'node'.
646  */
647 static int xmldoc_has_specialtags(struct ast_xml_node *fixnode)
648 {
649         struct ast_xml_node *node = fixnode;
650         int i;
651
652         for (node = ast_xml_node_get_children(fixnode); node; node = ast_xml_node_get_next(node)) {
653                 for (i = 0; i < ARRAY_LEN(special_tags); i++) {
654                         if (!strcasecmp(ast_xml_node_get_name(node), special_tags[i].tagname)) {
655                                 return 1;
656                         }
657                 }
658         }
659         return 0;
660 }
661
662 /*! \internal
663  *  \brief Build the syntax for a specified starting node.
664  *  \param rootnode A pointer to the ast_xml root node.
665  *  \param rootname Name of the application, function, option, etc. to build the syntax.
666  *  \param childname The name of each parameter node.
667  *  \param printparenthesis Boolean if we must print parenthesis if not parameters are found in the rootnode.
668  *  \param printrootname Boolean if we must print the rootname before the syntax and parenthesis at the begining/end.
669  *  \retval NULL on error.
670  *  \retval An ast_malloc'ed string with the syntax generated.
671  */
672 static char *xmldoc_get_syntax_fun(struct ast_xml_node *rootnode, const char *rootname, const char *childname, int printparenthesis, int printrootname)
673 {
674 #define GOTONEXT(__rev, __a) (__rev ? ast_xml_node_get_prev(__a) : ast_xml_node_get_next(__a))
675 #define ISLAST(__rev, __a)  (__rev == 1 ? (ast_xml_node_get_prev(__a) ? 0 : 1) : (ast_xml_node_get_next(__a) ? 0 : 1))
676 #define MP(__a) ((multiple ? __a : ""))
677         struct ast_xml_node *node = NULL, *firstparam = NULL, *lastparam = NULL;
678         const char *paramtype, *multipletype, *paramnameattr, *attrargsep, *parenthesis, *argname;
679         int reverse, required, paramcount = 0, openbrackets = 0, len = 0, hasparams=0;
680         int reqfinode = 0, reqlanode = 0, optmidnode = 0, prnparenthesis, multiple;
681         char *syntax = NULL, *argsep, *paramname;
682
683         if (ast_strlen_zero(rootname) || ast_strlen_zero(childname)) {
684                 ast_log(LOG_WARNING, "Tried to look in XML tree with faulty rootname or childname while creating a syntax.\n");
685                 return NULL;
686         }
687
688         if (!rootnode || !ast_xml_node_get_children(rootnode)) {
689                 /* If the rootnode field is not found, at least print name. */
690                 ast_asprintf(&syntax, "%s%s", (printrootname ? rootname : ""), (printparenthesis ? "()" : ""));
691                 return syntax;
692         }
693
694         /* Get the argument separator from the root node attribute name 'argsep', if not found
695         defaults to ','. */
696         attrargsep = ast_xml_get_attribute(rootnode, "argsep");
697         if (attrargsep) {
698                 argsep = ast_strdupa(attrargsep);
699                 ast_xml_free_attr(attrargsep);
700         } else {
701                 argsep = ast_strdupa(",");
702         }
703
704         /* Get order of evaluation. */
705         for (node = ast_xml_node_get_children(rootnode); node; node = ast_xml_node_get_next(node)) {
706                 if (strcasecmp(ast_xml_node_get_name(node), childname)) {
707                         continue;
708                 }
709                 required = 0;
710                 hasparams = 1;
711                 if ((paramtype = ast_xml_get_attribute(node, "required"))) {
712                         if (ast_true(paramtype)) {
713                                 required = 1;
714                         }
715                         ast_xml_free_attr(paramtype);
716                 }
717
718                 lastparam = node;
719                 reqlanode = required;
720
721                 if (!firstparam) {
722                         /* first parameter node */
723                         firstparam = node;
724                         reqfinode = required;
725                 }
726         }
727
728         if (!hasparams) {
729                 /* This application, function, option, etc, doesn't have any params. */
730                 ast_asprintf(&syntax, "%s%s", (printrootname ? rootname : ""), (printparenthesis ? "()" : ""));
731                 return syntax;
732         }
733
734         if (reqfinode && reqlanode) {
735                 /* check midnode */
736                 for (node = ast_xml_node_get_children(rootnode); node; node = ast_xml_node_get_next(node)) {
737                         if (strcasecmp(ast_xml_node_get_name(node), childname)) {
738                                 continue;
739                         }
740                         if (node != firstparam && node != lastparam) {
741                                 if ((paramtype = ast_xml_get_attribute(node, "required"))) {
742                                         if (!ast_true(paramtype)) {
743                                                 optmidnode = 1;
744                                                 break;
745                                         }
746                                         ast_xml_free_attr(paramtype);
747                                 }
748                         }
749                 }
750         }
751
752         if ((!reqfinode && reqlanode) || (reqfinode && reqlanode && optmidnode)) {
753                 reverse = 1;
754                 node = lastparam;
755         } else {
756                 reverse = 0;
757                 node = firstparam;
758         }
759
760         /* init syntax string. */
761         if (reverse) {
762                 xmldoc_reverse_helper(reverse, &len, &syntax,
763                         (printrootname ? (printrootname == 2 ? ")]" : ")"): ""));
764         } else {
765                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s", (printrootname ? rootname : ""),
766                         (printrootname ? (printrootname == 2 ? "[(" : "(") : ""));
767         }
768
769         for (; node; node = GOTONEXT(reverse, node)) {
770                 if (strcasecmp(ast_xml_node_get_name(node), childname)) {
771                         continue;
772                 }
773
774                 /* Get the argument name, if it is not the leaf, go inside that parameter. */
775                 if (xmldoc_has_inside(node, "argument")) {
776                         parenthesis = ast_xml_get_attribute(node, "hasparams");
777                         prnparenthesis = 0;
778                         if (parenthesis) {
779                                 prnparenthesis = ast_true(parenthesis);
780                                 if (!strcasecmp(parenthesis, "optional")) {
781                                         prnparenthesis = 2;
782                                 }
783                                 ast_xml_free_attr(parenthesis);
784                         }
785                         argname = ast_xml_get_attribute(node, "name");
786                         if (argname) {
787                                 paramname = xmldoc_get_syntax_fun(node, argname, "argument", prnparenthesis, prnparenthesis);
788                                 ast_xml_free_attr(argname);
789                         } else {
790                                 /* Malformed XML, print **UNKOWN** */
791                                 paramname = ast_strdup("**unknown**");
792                         }
793                 } else {
794                         paramnameattr = ast_xml_get_attribute(node, "name");
795                         if (!paramnameattr) {
796                                 ast_log(LOG_WARNING, "Malformed XML %s: no %s name\n", rootname, childname);
797                                 if (syntax) {
798                                         /* Free already allocated syntax */
799                                         ast_free(syntax);
800                                 }
801                                 /* to give up is ok? */
802                                 ast_asprintf(&syntax, "%s%s", (printrootname ? rootname : ""), (printparenthesis ? "()" : ""));
803                                 return syntax;
804                         }
805                         paramname = ast_strdup(paramnameattr);
806                         ast_xml_free_attr(paramnameattr);
807                 }
808
809                 /* Defaults to 'false'. */
810                 multiple = 0;
811                 if ((multipletype = ast_xml_get_attribute(node, "multiple"))) {
812                         if (ast_true(multipletype)) {
813                                 multiple = 1;
814                         }
815                         ast_xml_free_attr(multipletype);
816                 }
817
818                 required = 0;   /* Defaults to 'false'. */
819                 if ((paramtype = ast_xml_get_attribute(node, "required"))) {
820                         if (ast_true(paramtype)) {
821                                 required = 1;
822                         }
823                         ast_xml_free_attr(paramtype);
824                 }
825
826                 /* build syntax core. */
827
828                 if (required) {
829                         /* First parameter */
830                         if (!paramcount) {
831                                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s%s%s", paramname, MP("["), MP(argsep), MP("...]"));
832                         } else {
833                                 /* Time to close open brackets. */
834                                 while (openbrackets > 0) {
835                                         xmldoc_reverse_helper(reverse, &len, &syntax, (reverse ? "[" : "]"));
836                                         openbrackets--;
837                                 }
838                                 if (reverse) {
839                                         xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s", paramname, argsep);
840                                 } else {
841                                         xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s", argsep, paramname);
842                                 }
843                                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s%s", MP("["), MP(argsep), MP("...]"));
844                         }
845                 } else {
846                         /* First parameter */
847                         if (!paramcount) {
848                                 xmldoc_reverse_helper(reverse, &len, &syntax, "[%s%s%s%s]", paramname, MP("["), MP(argsep), MP("...]"));
849                         } else {
850                                 if (ISLAST(reverse, node)) {
851                                         /* This is the last parameter. */
852                                         if (reverse) {
853                                                 xmldoc_reverse_helper(reverse, &len, &syntax, "[%s%s%s%s]%s", paramname,
854                                                                         MP("["), MP(argsep), MP("...]"), argsep);
855                                         } else {
856                                                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s[%s%s%s%s]", argsep, paramname,
857                                                                         MP("["), MP(argsep), MP("...]"));
858                                         }
859                                 } else {
860                                         if (reverse) {
861                                                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s%s%s%s]", paramname, argsep,
862                                                                         MP("["), MP(argsep), MP("...]"));
863                                         } else {
864                                                 xmldoc_reverse_helper(reverse, &len, &syntax, "[%s%s%s%s%s", argsep, paramname,
865                                                                         MP("["), MP(argsep), MP("...]"));
866                                         }
867                                         openbrackets++;
868                                 }
869                         }
870                 }
871                 ast_free(paramname);
872
873                 paramcount++;
874         }
875
876         /* Time to close open brackets. */
877         while (openbrackets > 0) {
878                 xmldoc_reverse_helper(reverse, &len, &syntax, (reverse ? "[" : "]"));
879                 openbrackets--;
880         }
881
882         /* close syntax string. */
883         if (reverse) {
884                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s", (printrootname ? rootname : ""),
885                         (printrootname ? (printrootname == 2 ? "[(" : "(") : ""));
886         } else {
887                 xmldoc_reverse_helper(reverse, &len, &syntax, (printrootname ? (printrootname == 2 ? ")]" : ")") : ""));
888         }
889
890         return syntax;
891 #undef ISLAST
892 #undef GOTONEXT
893 #undef MP
894 }
895
896 /*! \internal
897  *  \brief Parse an enumlist inside a <parameter> to generate a COMMAND
898  *         syntax.
899  *  \param fixnode A pointer to the <enumlist> node.
900  *  \retval {<unknown>} on error.
901  *  \retval A string inside brackets {} with the enum's separated by pipes |.
902  */
903 static char *xmldoc_parse_cmd_enumlist(struct ast_xml_node *fixnode)
904 {
905         struct ast_xml_node *node = fixnode;
906         struct ast_str *paramname;
907         char *enumname, *ret;
908         int first = 1;
909
910         paramname = ast_str_create(128);
911         if (!paramname) {
912                 return ast_strdup("{<unkown>}");
913         }
914
915         ast_str_append(&paramname, 0, "{");
916
917         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
918                 if (strcasecmp(ast_xml_node_get_name(node), "enum")) {
919                         continue;
920                 }
921
922                 enumname = xmldoc_get_syntax_cmd(node, "", 0);
923                 if (!enumname) {
924                         continue;
925                 }
926                 if (!first) {
927                         ast_str_append(&paramname, 0, "|");
928                 }
929                 ast_str_append(&paramname, 0, "%s", enumname);
930                 first = 0;
931                 ast_free(enumname);
932         }
933
934         ast_str_append(&paramname, 0, "}");
935
936         ret = ast_strdup(ast_str_buffer(paramname));
937         ast_free(paramname);
938
939         return ret;
940 }
941
942 /*! \internal
943  *  \brief Generate a syntax of COMMAND type.
944  *  \param fixnode The <syntax> node pointer.
945  *  \param name The name of the 'command'.
946  *  \param printname Print the name of the command before the paramters?
947  *  \retval On error, return just 'name'.
948  *  \retval On success return the generated syntax.
949  */
950 static char *xmldoc_get_syntax_cmd(struct ast_xml_node *fixnode, const char *name, int printname)
951 {
952         struct ast_str *syntax;
953         struct ast_xml_node *tmpnode, *node = fixnode;
954         char *ret, *paramname;
955         const char *paramtype, *attrname, *literal;
956         int required, isenum, first = 1, isliteral;
957
958         syntax = ast_str_create(128);
959         if (!syntax) {
960                 /* at least try to return something... */
961                 return ast_strdup(name);
962         }
963
964         /* append name to output string. */
965         if (printname) {
966                 ast_str_append(&syntax, 0, "%s", name);
967                 first = 0;
968         }
969
970         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
971                 if (strcasecmp(ast_xml_node_get_name(node), "parameter")) {
972                         continue;
973                 }
974
975                 if (xmldoc_has_inside(node, "parameter")) {
976                         /* is this a recursive parameter. */
977                         paramname = xmldoc_get_syntax_cmd(node, "", 0);
978                         isenum = 1;
979                 } else if (!xmldoc_has_inside(node, "enumlist")) {
980                         /* this is a simple parameter. */
981                         attrname = ast_xml_get_attribute(node, "name");
982                         if (!attrname) {
983                                 /* ignore this bogus parameter and continue. */
984                                 continue;
985                         }
986                         paramname = ast_strdup(attrname);
987                         ast_xml_free_attr(attrname);
988                         isenum = 0;
989                 } else {
990                         /* parse enumlist (note that this is a special enumlist
991                         that is used to describe a syntax like {<param1>|<param2>|...} */
992                         for (tmpnode = ast_xml_node_get_children(node); tmpnode; tmpnode = ast_xml_node_get_next(tmpnode)) {
993                                 if (!strcasecmp(ast_xml_node_get_name(tmpnode), "enumlist")) {
994                                         break;
995                                 }
996                         }
997                         paramname = xmldoc_parse_cmd_enumlist(tmpnode);
998                         isenum = 1;
999                 }
1000
1001                 /* Is this parameter required? */
1002                 required = 0;
1003                 paramtype = ast_xml_get_attribute(node, "required");
1004                 if (paramtype) {
1005                         required = ast_true(paramtype);
1006                         ast_xml_free_attr(paramtype);
1007                 }
1008
1009                 /* Is this a replaceable value or a fixed parameter value? */
1010                 isliteral = 0;
1011                 literal = ast_xml_get_attribute(node, "literal");
1012                 if (literal) {
1013                         isliteral = ast_true(literal);
1014                         ast_xml_free_attr(literal);
1015                 }
1016
1017                 /* if required="false" print with [...].
1018                  * if literal="true" or is enum print without <..>.
1019                  * if not first print a space at the beginning.
1020                  */
1021                 ast_str_append(&syntax, 0, "%s%s%s%s%s%s",
1022                                 (first ? "" : " "),
1023                                 (required ? "" : "["),
1024                                 (isenum || isliteral ? "" : "<"),
1025                                 paramname,
1026                                 (isenum || isliteral ? "" : ">"),
1027                                 (required ? "" : "]"));
1028                 first = 0;
1029                 ast_free(paramname);
1030         }
1031
1032         /* return a common string. */
1033         ret = ast_strdup(ast_str_buffer(syntax));
1034         ast_free(syntax);
1035
1036         return ret;
1037 }
1038
1039 /*! \internal
1040  *  \brief Generate an AMI action syntax.
1041  *  \param fixnode The manager action node pointer.
1042  *  \param name The name of the manager action.
1043  *  \retval The generated syntax.
1044  *  \retval NULL on error.
1045  */
1046 static char *xmldoc_get_syntax_manager(struct ast_xml_node *fixnode, const char *name)
1047 {
1048         struct ast_str *syntax;
1049         struct ast_xml_node *node = fixnode;
1050         const char *paramtype, *attrname;
1051         int required;
1052         char *ret;
1053
1054         syntax = ast_str_create(128);
1055         if (!syntax) {
1056                 return ast_strdup(name);
1057         }
1058
1059         ast_str_append(&syntax, 0, "Action: %s", name);
1060
1061         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1062                 if (strcasecmp(ast_xml_node_get_name(node), "parameter")) {
1063                         continue;
1064                 }
1065
1066                 /* Is this parameter required? */
1067                 required = 0;
1068                 paramtype = ast_xml_get_attribute(node, "required");
1069                 if (paramtype) {
1070                         required = ast_true(paramtype);
1071                         ast_xml_free_attr(paramtype);
1072                 }
1073
1074                 attrname = ast_xml_get_attribute(node, "name");
1075                 if (!attrname) {
1076                         /* ignore this bogus parameter and continue. */
1077                         continue;
1078                 }
1079
1080                 ast_str_append(&syntax, 0, "\n%s%s:%s <value>",
1081                         (required ? "" : "["),
1082                         attrname,
1083                         (required ? "" : "]"));
1084
1085                 ast_xml_free_attr(attrname);
1086         }
1087
1088         /* return a common string. */
1089         ret = ast_strdup(ast_str_buffer(syntax));
1090         ast_free(syntax);
1091
1092         return ret;
1093 }
1094
1095 /*! \brief Types of syntax that we are able to generate. */
1096 enum syntaxtype {
1097         FUNCTION_SYNTAX,
1098         MANAGER_SYNTAX,
1099         COMMAND_SYNTAX
1100 };
1101
1102 /*! \brief Mapping between type of node and type of syntax to generate. */
1103 static struct strsyntaxtype {
1104         const char *type;
1105         enum syntaxtype stxtype;
1106 } stxtype[] = {
1107         { "function",           FUNCTION_SYNTAX },
1108         { "application",        FUNCTION_SYNTAX },
1109         { "manager",            MANAGER_SYNTAX  },
1110         { "agi",                COMMAND_SYNTAX  }
1111 };
1112
1113 /*! \internal
1114  *  \brief Get syntax type based on type of node.
1115  *  \param type Type of node.
1116  *  \retval The type of syntax to generate based on the type of node.
1117  */
1118 static enum syntaxtype xmldoc_get_syntax_type(const char *type)
1119 {
1120         int i;
1121         for (i=0; i < ARRAY_LEN(stxtype); i++) {
1122                 if (!strcasecmp(stxtype[i].type, type)) {
1123                         return stxtype[i].stxtype;
1124                 }
1125         }
1126
1127         return FUNCTION_SYNTAX;
1128 }
1129
1130 char *ast_xmldoc_build_syntax(const char *type, const char *name, const char *module)
1131 {
1132         struct ast_xml_node *node;
1133         char *syntax = NULL;
1134
1135         node = xmldoc_get_node(type, name, module, documentation_language);
1136         if (!node) {
1137                 return NULL;
1138         }
1139
1140         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1141                 if (!strcasecmp(ast_xml_node_get_name(node), "syntax")) {
1142                         break;
1143                 }
1144         }
1145
1146         if (node) {
1147                 switch (xmldoc_get_syntax_type(type)) {
1148                 case FUNCTION_SYNTAX:
1149                         syntax = xmldoc_get_syntax_fun(node, name, "parameter", 1, 1);
1150                         break;
1151                 case COMMAND_SYNTAX:
1152                         syntax = xmldoc_get_syntax_cmd(node, name, 1);
1153                         break;
1154                 case MANAGER_SYNTAX:
1155                         syntax = xmldoc_get_syntax_manager(node, name);
1156                         break;
1157                 default:
1158                         syntax = xmldoc_get_syntax_fun(node, name, "parameter", 1, 1);
1159                 }
1160         }
1161         return syntax;
1162 }
1163
1164 /*! \internal
1165  *  \brief Parse a <para> element.
1166  *  \param node The <para> element pointer.
1167  *  \param tabs Added this string before the content of the <para> element.
1168  *  \param posttabs Added this string after the content of the <para> element.
1169  *  \param buffer This must be an already allocated ast_str. It will be used
1170  *         to store the result (if already has something it will be appended to the current
1171  *         string).
1172  *  \retval 1 If 'node' is a named 'para'.
1173  *  \retval 2 If data is appended in buffer.
1174  *  \retval 0 on error.
1175  */
1176 static int xmldoc_parse_para(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer)
1177 {
1178         const char *tmptext;
1179         struct ast_xml_node *tmp;
1180         int ret = 0;
1181         struct ast_str *tmpstr;
1182
1183         if (!node || !ast_xml_node_get_children(node)) {
1184                 return ret;
1185         }
1186
1187         if (strcasecmp(ast_xml_node_get_name(node), "para")) {
1188                 return ret;
1189         }
1190
1191         ast_str_append(buffer, 0, "%s", tabs);
1192
1193         ret = 1;
1194
1195         for (tmp = ast_xml_node_get_children(node); tmp; tmp = ast_xml_node_get_next(tmp)) {
1196                 /* Get the text inside the <para> element and append it to buffer. */
1197                 tmptext = ast_xml_get_text(tmp);
1198                 if (tmptext) {
1199                         /* Strip \n etc. */
1200                         xmldoc_string_cleanup(tmptext, &tmpstr, 0);
1201                         ast_xml_free_text(tmptext);
1202                         if (tmpstr) {
1203                                 if (strcasecmp(ast_xml_node_get_name(tmp), "text")) {
1204                                         ast_str_append(buffer, 0, "<%s>%s</%s>", ast_xml_node_get_name(tmp),
1205                                                         ast_str_buffer(tmpstr), ast_xml_node_get_name(tmp));
1206                                 } else {
1207                                         ast_str_append(buffer, 0, "%s", ast_str_buffer(tmpstr));
1208                                 }
1209                                 ast_free(tmpstr);
1210                                 ret = 2;
1211                         }
1212                 }
1213         }
1214
1215         ast_str_append(buffer, 0, "%s", posttabs);
1216
1217         return ret;
1218 }
1219
1220 /*! \internal
1221  *  \brief Parse special elements defined in 'struct special_tags' special elements must have a <para> element inside them.
1222  *  \param fixnode special tag node pointer.
1223  *  \param tabs put tabs before printing the node content.
1224  *  \param posttabs put posttabs after printing node content.
1225  *  \param buffer Output buffer, the special tags will be appended here.
1226  *  \retval 0 if no special element is parsed.
1227  *  \retval 1 if a special element is parsed (data is appended to buffer).
1228  *  \retval 2 if a special element is parsed and also a <para> element is parsed inside the specialtag.
1229  */
1230 static int xmldoc_parse_specialtags(struct ast_xml_node *fixnode, const char *tabs, const char *posttabs, struct ast_str **buffer)
1231 {
1232         struct ast_xml_node *node = fixnode;
1233         int ret = 0, i, count = 0;
1234
1235         if (!node || !ast_xml_node_get_children(node)) {
1236                 return ret;
1237         }
1238
1239         for (i = 0; i < ARRAY_LEN(special_tags); i++) {
1240                 if (strcasecmp(ast_xml_node_get_name(node), special_tags[i].tagname)) {
1241                         continue;
1242                 }
1243
1244                 ret = 1;
1245                 /* This is a special tag. */
1246
1247                 /* concat data */
1248                 if (!ast_strlen_zero(special_tags[i].init)) {
1249                         ast_str_append(buffer, 0, "%s%s", tabs, special_tags[i].init);
1250                 }
1251
1252                 /* parse <para> elements inside special tags. */
1253                 for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1254                         /* first <para> just print it without tabs at the begining. */
1255                         if (xmldoc_parse_para(node, (!count ? "" : tabs), posttabs, buffer) == 2) {
1256                                 ret = 2;
1257                         }
1258                 }
1259
1260                 if (!ast_strlen_zero(special_tags[i].end)) {
1261                         ast_str_append(buffer, 0, "%s%s", special_tags[i].end, posttabs);
1262                 }
1263
1264                 break;
1265         }
1266
1267         return ret;
1268 }
1269
1270 /*! \internal
1271  *  \brief Parse an <argument> element from the xml documentation.
1272  *  \param fixnode Pointer to the 'argument' xml node.
1273  *  \param insideparameter If we are parsing an <argument> inside a <parameter>.
1274  *  \param paramtabs pre tabs if we are inside a parameter element.
1275  *  \param tabs What to be printed before the argument name.
1276  *  \param buffer Output buffer to put values found inside the <argument> element.
1277  *  \retval 1 If there is content inside the argument.
1278  *  \retval 0 If the argument element is not parsed, or there is no content inside it.
1279  */
1280 static int xmldoc_parse_argument(struct ast_xml_node *fixnode, int insideparameter, const char *paramtabs, const char *tabs, struct ast_str **buffer)
1281 {
1282         struct ast_xml_node *node = fixnode;
1283         const char *argname;
1284         int count = 0, ret = 0;
1285
1286         if (!node || !ast_xml_node_get_children(node)) {
1287                 return ret;
1288         }
1289
1290         /* Print the argument names */
1291         argname = ast_xml_get_attribute(node, "name");
1292         if (!argname) {
1293                 return 0;
1294         }
1295         if (xmldoc_has_inside(node, "para") || xmldoc_has_specialtags(node)) {
1296                 ast_str_append(buffer, 0, "%s%s%s", tabs, argname, (insideparameter ? "\n" : ""));
1297                 ast_xml_free_attr(argname);
1298         } else {
1299                 ast_xml_free_attr(argname);
1300                 return 0;
1301         }
1302
1303         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1304                 if (xmldoc_parse_para(node, (insideparameter ? paramtabs : (!count ? " - " : tabs)), "\n", buffer) == 2) {
1305                         count++;
1306                         ret = 1;
1307                 } else if (xmldoc_parse_specialtags(node, (insideparameter ? paramtabs : (!count ? " - " : tabs)), "\n", buffer) == 2) {
1308                         count++;
1309                         ret = 1;
1310                 }
1311         }
1312
1313         return ret;
1314 }
1315
1316 /*! \internal
1317  *  \brief Parse a <variable> node inside a <variablelist> node.
1318  *  \param node The variable node to parse.
1319  *  \param tabs A string to be appended at the begining of the output that will be stored
1320  *         in buffer.
1321  *  \param buffer This must be an already created ast_str. It will be used
1322  *         to store the result (if already has something it will be appended to the current
1323  *         string).
1324  *  \retval 0 if no data is appended.
1325  *  \retval 1 if data is appended.
1326  */
1327 static int xmldoc_parse_variable(struct ast_xml_node *node, const char *tabs, struct ast_str **buffer)
1328 {
1329         struct ast_xml_node *tmp;
1330         const char *valname;
1331         const char *tmptext;
1332         struct ast_str *cleanstr;
1333         int ret = 0, printedpara=0;
1334
1335         for (tmp = ast_xml_node_get_children(node); tmp; tmp = ast_xml_node_get_next(tmp)) {
1336                 if (xmldoc_parse_para(tmp, (ret ? tabs : ""), "\n", buffer)) {
1337                         printedpara = 1;
1338                         continue;
1339                 } else if (xmldoc_parse_specialtags(tmp, (ret ? tabs : ""), "\n", buffer)) {
1340                         printedpara = 1;
1341                         continue;
1342                 }
1343
1344                 if (strcasecmp(ast_xml_node_get_name(tmp), "value")) {
1345                         continue;
1346                 }
1347
1348                 /* Parse a <value> tag only. */
1349                 if (!printedpara) {
1350                         ast_str_append(buffer, 0, "\n");
1351                         printedpara = 1;
1352                 }
1353                 /* Parse each <value name='valuename'>desciption</value> */
1354                 valname = ast_xml_get_attribute(tmp, "name");
1355                 if (valname) {
1356                         ret = 1;
1357                         ast_str_append(buffer, 0, "%s<value>%s</value>", tabs, valname);
1358                         ast_xml_free_attr(valname);
1359                 }
1360                 tmptext = ast_xml_get_text(tmp);
1361                 /* Check inside this node for any explanation about its meaning. */
1362                 if (tmptext) {
1363                         /* Cleanup text. */
1364                         xmldoc_string_cleanup(tmptext, &cleanstr, 1);
1365                         ast_xml_free_text(tmptext);
1366                         if (cleanstr && ast_str_strlen(cleanstr) > 0) {
1367                                 ast_str_append(buffer, 0, ":%s", ast_str_buffer(cleanstr));
1368                         }
1369                         ast_free(cleanstr);
1370                 }
1371                 ast_str_append(buffer, 0, "\n");
1372         }
1373
1374         return ret;
1375 }
1376
1377 /*! \internal
1378  *  \brief Parse a <variablelist> node and put all the output inside 'buffer'.
1379  *  \param node The variablelist node pointer.
1380  *  \param tabs A string to be appended at the begining of the output that will be stored
1381  *         in buffer.
1382  *  \param buffer This must be an already created ast_str. It will be used
1383  *         to store the result (if already has something it will be appended to the current
1384  *         string).
1385  *  \retval 1 If a <variablelist> element is parsed.
1386  *  \retval 0 On error.
1387  */
1388 static int xmldoc_parse_variablelist(struct ast_xml_node *node, const char *tabs, struct ast_str **buffer)
1389 {
1390         struct ast_xml_node *tmp;
1391         const char *varname;
1392         char *vartabs;
1393         int ret = 0;
1394
1395         if (!node || !ast_xml_node_get_children(node)) {
1396                 return ret;
1397         }
1398
1399         if (strcasecmp(ast_xml_node_get_name(node), "variablelist")) {
1400                 return ret;
1401         }
1402
1403         /* use this spacing (add 4 spaces) inside a variablelist node. */
1404         ast_asprintf(&vartabs, "%s    ", tabs);
1405         if (!vartabs) {
1406                 return ret;
1407         }
1408         for (tmp = ast_xml_node_get_children(node); tmp; tmp = ast_xml_node_get_next(tmp)) {
1409                 /* We can have a <para> element inside the variable list */
1410                 if ((xmldoc_parse_para(tmp, (ret ? tabs : ""), "\n", buffer))) {
1411                         ret = 1;
1412                         continue;
1413                 } else if ((xmldoc_parse_specialtags(tmp, (ret ? tabs : ""), "\n", buffer))) {
1414                         ret = 1;
1415                         continue;
1416                 }
1417
1418                 if (!strcasecmp(ast_xml_node_get_name(tmp), "variable")) {
1419                         /* Store the variable name in buffer. */
1420                         varname = ast_xml_get_attribute(tmp, "name");
1421                         if (varname) {
1422                                 ast_str_append(buffer, 0, "%s<variable>%s</variable>: ", tabs, varname);
1423                                 ast_xml_free_attr(varname);
1424                                 /* Parse the <variable> possible values. */
1425                                 xmldoc_parse_variable(tmp, vartabs, buffer);
1426                                 ret = 1;
1427                         }
1428                 }
1429         }
1430
1431         ast_free(vartabs);
1432
1433         return ret;
1434 }
1435
1436 char *ast_xmldoc_build_seealso(const char *type, const char *name, const char *module)
1437 {
1438         struct ast_str *outputstr;
1439         char *output;
1440         struct ast_xml_node *node;
1441         const char *typename;
1442         const char *content;
1443         int first = 1;
1444
1445         if (ast_strlen_zero(type) || ast_strlen_zero(name)) {
1446                 return NULL;
1447         }
1448
1449         /* get the application/function root node. */
1450         node = xmldoc_get_node(type, name, module, documentation_language);
1451         if (!node || !ast_xml_node_get_children(node)) {
1452                 return NULL;
1453         }
1454
1455         /* Find the <see-also> node. */
1456         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1457                 if (!strcasecmp(ast_xml_node_get_name(node), "see-also")) {
1458                         break;
1459                 }
1460         }
1461
1462         if (!node || !ast_xml_node_get_children(node)) {
1463                 /* we couldnt find a <see-also> node. */
1464                 return NULL;
1465         }
1466
1467         /* prepare the output string. */
1468         outputstr = ast_str_create(128);
1469         if (!outputstr) {
1470                 return NULL;
1471         }
1472
1473         /* get into the <see-also> node. */
1474         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1475                 if (strcasecmp(ast_xml_node_get_name(node), "ref")) {
1476                         continue;
1477                 }
1478
1479                 /* parse the <ref> node. 'type' attribute is required. */
1480                 typename = ast_xml_get_attribute(node, "type");
1481                 if (!typename) {
1482                         continue;
1483                 }
1484                 content = ast_xml_get_text(node);
1485                 if (!content) {
1486                         ast_xml_free_attr(typename);
1487                         continue;
1488                 }
1489                 if (!strcasecmp(typename, "application")) {
1490                         ast_str_append(&outputstr, 0, "%s%s()", (first ? "" : ", "), content);
1491                 } else if (!strcasecmp(typename, "function")) {
1492                         ast_str_append(&outputstr, 0, "%s%s", (first ? "" : ", "), content);
1493                 } else if (!strcasecmp(typename, "astcli")) {
1494                         ast_str_append(&outputstr, 0, "%s<astcli>%s</astcli>", (first ? "" : ", "), content);
1495                 } else {
1496                         ast_str_append(&outputstr, 0, "%s%s", (first ? "" : ", "), content);
1497                 }
1498                 first = 0;
1499                 ast_xml_free_text(content);
1500                 ast_xml_free_attr(typename);
1501         }
1502
1503         output = ast_strdup(ast_str_buffer(outputstr));
1504         ast_free(outputstr);
1505
1506         return output;
1507 }
1508
1509 /*! \internal
1510  *  \brief Parse a <enum> node.
1511  *  \brief fixnode An ast_xml_node pointer to the <enum> node.
1512  *  \bried buffer The output buffer.
1513  *  \retval 0 if content is not found inside the enum element (data is not appended to buffer).
1514  *  \retval 1 if content is found and data is appended to buffer.
1515  */
1516 static int xmldoc_parse_enum(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
1517 {
1518         struct ast_xml_node *node = fixnode;
1519         int ret = 0;
1520         char *optiontabs;
1521
1522         ast_asprintf(&optiontabs, "%s    ", tabs);
1523
1524         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1525                 if ((xmldoc_parse_para(node, (ret ? tabs : " - "), "\n", buffer))) {
1526                         ret = 1;
1527                 } else if ((xmldoc_parse_specialtags(node, (ret ? tabs : " - "), "\n", buffer))) {
1528                         ret = 1;
1529                 }
1530
1531                 xmldoc_parse_enumlist(node, optiontabs, buffer);
1532         }
1533
1534         ast_free(optiontabs);
1535
1536         return ret;
1537 }
1538
1539 /*! \internal
1540  *  \brief Parse a <enumlist> node.
1541  *  \param fixnode As ast_xml pointer to the <enumlist> node.
1542  *  \param buffer The ast_str output buffer.
1543  *  \retval 0 if no <enumlist> node was parsed.
1544  *  \retval 1 if a <enumlist> node was parsed.
1545  */
1546 static int xmldoc_parse_enumlist(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
1547 {
1548         struct ast_xml_node *node = fixnode;
1549         const char *enumname;
1550         int ret = 0;
1551
1552         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1553                 if (strcasecmp(ast_xml_node_get_name(node), "enum")) {
1554                         continue;
1555                 }
1556
1557                 enumname = ast_xml_get_attribute(node, "name");
1558                 if (enumname) {
1559                         ast_str_append(buffer, 0, "%s<enum>%s</enum>", tabs, enumname);
1560                         ast_xml_free_attr(enumname);
1561
1562                         /* parse only enum elements inside a enumlist node. */
1563                         if ((xmldoc_parse_enum(node, tabs, buffer))) {
1564                                 ret = 1;
1565                         } else {
1566                                 ast_str_append(buffer, 0, "\n");
1567                         }
1568                 }
1569         }
1570         return ret;
1571 }
1572
1573 /*! \internal
1574  *  \brief Parse an <option> node.
1575  *  \param fixnode An ast_xml pointer to the <option> node.
1576  *  \param tabs A string to be appended at the begining of each line being added to the
1577  *              buffer string.
1578  *  \param buffer The output buffer.
1579  *  \retval 0 if no option node is parsed.
1580  *  \retval 1 if an option node is parsed.
1581  */
1582 static int xmldoc_parse_option(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
1583 {
1584         struct ast_xml_node *node;
1585         int ret = 0;
1586         char *optiontabs;
1587
1588         ast_asprintf(&optiontabs, "%s    ", tabs);
1589         if (!optiontabs) {
1590                 return ret;
1591         }
1592         for (node = ast_xml_node_get_children(fixnode); node; node = ast_xml_node_get_next(node)) {
1593                 if (!strcasecmp(ast_xml_node_get_name(node), "argument")) {
1594                         /* if this is the first data appended to buffer, print a \n*/
1595                         if (!ret && ast_xml_node_get_children(node)) {
1596                                 /* print \n */
1597                                 ast_str_append(buffer, 0, "\n");
1598                         }
1599                         if (xmldoc_parse_argument(node, 0, NULL, optiontabs, buffer)) {
1600                                 ret = 1;
1601                         }
1602                         continue;
1603                 }
1604
1605                 if (xmldoc_parse_para(node, (ret ? tabs :  ""), "\n", buffer)) {
1606                         ret = 1;
1607                 } else if (xmldoc_parse_specialtags(node, (ret ? tabs :  ""), "\n", buffer)) {
1608                         ret = 1;
1609                 }
1610
1611                 xmldoc_parse_variablelist(node, optiontabs, buffer);
1612
1613                 xmldoc_parse_enumlist(node, optiontabs, buffer);
1614         }
1615         ast_free(optiontabs);
1616
1617         return ret;
1618 }
1619
1620 /*! \internal
1621  *  \brief Parse an <optionlist> element from the xml documentation.
1622  *  \param fixnode Pointer to the optionlist xml node.
1623  *  \param tabs A string to be appended at the begining of each line being added to the
1624  *              buffer string.
1625  *  \param buffer Output buffer to put what is inside the optionlist tag.
1626  */
1627 static void xmldoc_parse_optionlist(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
1628 {
1629         struct ast_xml_node *node;
1630         const char *optname, *hasparams;
1631         char *optionsyntax;
1632         int optparams;
1633
1634         for (node = ast_xml_node_get_children(fixnode); node; node = ast_xml_node_get_next(node)) {
1635                 /* Start appending every option tag. */
1636                 if (strcasecmp(ast_xml_node_get_name(node), "option")) {
1637                         continue;
1638                 }
1639
1640                 /* Get the option name. */
1641                 optname = ast_xml_get_attribute(node, "name");
1642                 if (!optname) {
1643                         continue;
1644                 }
1645
1646                 optparams = 1;
1647                 hasparams = ast_xml_get_attribute(node, "hasparams");
1648                 if (hasparams && !strcasecmp(hasparams, "optional")) {
1649                         optparams = 2;
1650                 }
1651
1652                 optionsyntax = xmldoc_get_syntax_fun(node, optname, "argument", 0, optparams);
1653                 if (!optionsyntax) {
1654                         ast_xml_free_attr(optname);
1655                         ast_xml_free_attr(hasparams);
1656                         continue;
1657                 }
1658
1659                 ast_str_append(buffer, 0, "%s%s: ", tabs, optionsyntax);
1660
1661                 if (!xmldoc_parse_option(node, tabs, buffer)) {
1662                         ast_str_append(buffer, 0, "\n");
1663                 }
1664                 ast_str_append(buffer, 0, "\n");
1665                 ast_xml_free_attr(optname);
1666                 ast_xml_free_attr(hasparams);
1667         }
1668 }
1669
1670 /*! \internal
1671  *  \brief Parse a 'parameter' tag inside a syntax element.
1672  *  \param fixnode A pointer to the 'parameter' xml node.
1673  *  \param tabs A string to be appended at the beginning of each line being printed inside
1674  *              'buffer'.
1675  *  \param buffer String buffer to put values found inside the parameter element.
1676  */
1677 static void xmldoc_parse_parameter(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
1678 {
1679         const char *paramname;
1680         struct ast_xml_node *node = fixnode;
1681         int hasarguments, printed = 0;
1682         char *internaltabs;
1683
1684         if (strcasecmp(ast_xml_node_get_name(node), "parameter")) {
1685                 return;
1686         }
1687
1688         hasarguments = xmldoc_has_inside(node, "argument");
1689         if (!(paramname = ast_xml_get_attribute(node, "name"))) {
1690                 /* parameter MUST have an attribute name. */
1691                 return;
1692         }
1693
1694         ast_asprintf(&internaltabs, "%s    ", tabs);
1695         if (!internaltabs) {
1696                 return;
1697         }
1698
1699         if (!hasarguments && xmldoc_has_nodes(node)) {
1700                 ast_str_append(buffer, 0, "%s\n", paramname);
1701                 ast_xml_free_attr(paramname);
1702                 printed = 1;
1703         }
1704
1705         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1706                 if (!strcasecmp(ast_xml_node_get_name(node), "optionlist")) {
1707                         xmldoc_parse_optionlist(node, internaltabs, buffer);
1708                 } else if (!strcasecmp(ast_xml_node_get_name(node), "enumlist")) {
1709                         xmldoc_parse_enumlist(node, internaltabs, buffer);
1710                 } else if (!strcasecmp(ast_xml_node_get_name(node), "argument")) {
1711                         xmldoc_parse_argument(node, 1, internaltabs, (!hasarguments ? "        " : ""), buffer);
1712                 } else if (!strcasecmp(ast_xml_node_get_name(node), "para")) {
1713                         if (!printed) {
1714                                 ast_str_append(buffer, 0, "%s\n", paramname);
1715                                 ast_xml_free_attr(paramname);
1716                                 printed = 1;
1717                         }
1718                         xmldoc_parse_para(node, internaltabs, "\n", buffer);
1719                         continue;
1720                 } else if ((xmldoc_parse_specialtags(node, internaltabs, "\n", buffer))) {
1721                         continue;
1722                 }
1723         }
1724         if (!printed) {
1725                 ast_xml_free_attr(paramname);
1726         }
1727         ast_free(internaltabs);
1728 }
1729
1730 char *ast_xmldoc_build_arguments(const char *type, const char *name, const char *module)
1731 {
1732         struct ast_xml_node *node;
1733         struct ast_str *ret = ast_str_create(128);
1734         char *retstr = NULL;
1735
1736         if (ast_strlen_zero(type) || ast_strlen_zero(name)) {
1737                 return NULL;
1738         }
1739
1740         node = xmldoc_get_node(type, name, module, documentation_language);
1741
1742         if (!node || !ast_xml_node_get_children(node)) {
1743                 return NULL;
1744         }
1745
1746         /* Find the syntax field. */
1747         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1748                 if (!strcasecmp(ast_xml_node_get_name(node), "syntax")) {
1749                         break;
1750                 }
1751         }
1752
1753         if (!node || !ast_xml_node_get_children(node)) {
1754                 /* We couldn't find the syntax node. */
1755                 return NULL;
1756         }
1757
1758         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1759                 xmldoc_parse_parameter(node, "", &ret);
1760         }
1761
1762         if (ast_str_strlen(ret) > 0) {
1763                 /* remove last '\n' */
1764                 char *buf = ast_str_buffer(ret);
1765                 if (buf[ast_str_strlen(ret) - 1] == '\n') {
1766                         ast_str_truncate(ret, -1);
1767                 }
1768                 retstr = ast_strdup(ast_str_buffer(ret));
1769         }
1770         ast_free(ret);
1771
1772         return retstr;
1773 }
1774
1775 /*! \internal
1776  *  \brief Return the string within a node formatted with <para> and <variablelist> elements.
1777  *  \param node Parent node where content resides.
1778  *  \param raw If set, return the node's content without further processing.
1779  *  \param raw_wrap Wrap raw text.
1780  *  \retval NULL on error
1781  *  \retval Node content on success.
1782  */
1783 static struct ast_str *xmldoc_get_formatted(struct ast_xml_node *node, int raw_output, int raw_wrap)
1784 {
1785         struct ast_xml_node *tmp;
1786         const char *notcleanret, *tmpstr;
1787         struct ast_str *ret = ast_str_create(128);
1788
1789         if (raw_output) {
1790                 notcleanret = ast_xml_get_text(node);
1791                 tmpstr = notcleanret;
1792                 xmldoc_string_cleanup(ast_skip_blanks(notcleanret), &ret, 0);
1793                 ast_xml_free_text(tmpstr);
1794         } else {
1795                 for (tmp = ast_xml_node_get_children(node); tmp; tmp = ast_xml_node_get_next(tmp)) {
1796                         /* if found, parse a <para> element. */
1797                         if (xmldoc_parse_para(tmp, "", "\n", &ret)) {
1798                                 continue;
1799                         } else if (xmldoc_parse_specialtags(tmp, "", "\n", &ret)) {
1800                                 continue;
1801                         }
1802                         /* if found, parse a <variablelist> element. */
1803                         xmldoc_parse_variablelist(tmp, "", &ret);
1804                         xmldoc_parse_enumlist(tmp, "    ", &ret);
1805                 }
1806                 /* remove last '\n' */
1807                 /* XXX Don't modify ast_str internals manually */
1808                 tmpstr = ast_str_buffer(ret);
1809                 if (tmpstr[ast_str_strlen(ret) - 1] == '\n') {
1810                         ast_str_truncate(ret, -1);
1811                 }
1812         }
1813         return ret;
1814 }
1815
1816 /*!
1817  *  \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree
1818  *  \param type Type of element (application, function, ...).
1819  *  \param name Name of element (Dial, Echo, Playback, ...).
1820  *  \param var Name of field to return (synopsis, description, etc).
1821  *  \param raw Field only contains text, no other elements inside it.
1822  *  \retval NULL On error.
1823  *  \retval Field text content on success.
1824  */
1825 static char *xmldoc_build_field(const char *type, const char *name, const char *module, const char *var, int raw)
1826 {
1827         struct ast_xml_node *node;
1828         char *ret = NULL;
1829         struct ast_str *formatted;
1830
1831         if (ast_strlen_zero(type) || ast_strlen_zero(name)) {
1832                 ast_log(LOG_ERROR, "Tried to look in XML tree with faulty values.\n");
1833                 return ret;
1834         }
1835
1836         node = xmldoc_get_node(type, name, module, documentation_language);
1837
1838         if (!node) {
1839                 ast_log(LOG_WARNING, "Couldn't find %s %s in XML documentation\n", type, name);
1840                 return ret;
1841         }
1842
1843         node = ast_xml_find_element(ast_xml_node_get_children(node), var, NULL, NULL);
1844
1845         if (!node || !ast_xml_node_get_children(node)) {
1846                 ast_debug(1, "Cannot find variable '%s' in tree '%s'\n", var, name);
1847                 return ret;
1848         }
1849
1850         formatted = xmldoc_get_formatted(node, raw, raw);
1851         if (ast_str_strlen(formatted) > 0) {
1852                 ret = ast_strdup(ast_str_buffer(formatted));
1853         }
1854         ast_free(formatted);
1855
1856         return ret;
1857 }
1858
1859 char *ast_xmldoc_build_synopsis(const char *type, const char *name, const char *module)
1860 {
1861         return xmldoc_build_field(type, name, module, "synopsis", 1);
1862 }
1863
1864 char *ast_xmldoc_build_description(const char *type, const char *name, const char *module)
1865 {
1866         return xmldoc_build_field(type, name, module, "description", 0);
1867 }
1868
1869 #if !defined(HAVE_GLOB_NOMAGIC) || !defined(HAVE_GLOB_BRACE) || defined(DEBUG_NONGNU)
1870 static int xml_pathmatch(char *xmlpattern, int xmlpattern_maxlen, glob_t *globbuf)
1871 {
1872         int globret;
1873
1874         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/thirdparty/*-%s.xml",
1875                 ast_config_AST_DATA_DIR, documentation_language);
1876         if((globret = glob(xmlpattern, GLOB_NOCHECK, NULL, globbuf))) {
1877                 return globret;
1878         }
1879
1880         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/thirdparty/*-%.2s_??.xml",
1881                 ast_config_AST_DATA_DIR, documentation_language);
1882         if((globret = glob(xmlpattern, GLOB_APPEND | GLOB_NOCHECK, NULL, globbuf))) {
1883                 return globret;
1884         }
1885
1886         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/thirdparty/*-%s.xml",
1887                 ast_config_AST_DATA_DIR, default_documentation_language);
1888         if((globret = glob(xmlpattern, GLOB_APPEND | GLOB_NOCHECK, NULL, globbuf))) {
1889                 return globret;
1890         }
1891
1892         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/*-%s.xml",
1893                 ast_config_AST_DATA_DIR, documentation_language);
1894         if((globret = glob(xmlpattern, GLOB_APPEND | GLOB_NOCHECK, NULL, globbuf))) {
1895                 return globret;
1896         }
1897
1898         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/*-%.2s_??.xml",
1899                 ast_config_AST_DATA_DIR, documentation_language);
1900         if((globret = glob(xmlpattern, GLOB_APPEND | GLOB_NOCHECK, NULL, globbuf))) {
1901                 return globret;
1902         }
1903
1904         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/*-%s.xml",
1905                 ast_config_AST_DATA_DIR, default_documentation_language);
1906         globret = glob(xmlpattern, GLOB_APPEND | GLOB_NOCHECK, NULL, globbuf);
1907
1908         return globret;
1909 }
1910 #endif
1911
1912 /*! \brief Close and unload XML documentation. */
1913 static void xmldoc_unload_documentation(void)
1914 {
1915         struct documentation_tree *doctree;
1916
1917         AST_RWLIST_WRLOCK(&xmldoc_tree);
1918         while ((doctree = AST_RWLIST_REMOVE_HEAD(&xmldoc_tree, entry))) {
1919                 ast_free(doctree->filename);
1920                 ast_xml_close(doctree->doc);
1921         }
1922         AST_RWLIST_UNLOCK(&xmldoc_tree);
1923
1924         ast_xml_finish();
1925 }
1926
1927 int ast_xmldoc_load_documentation(void)
1928 {
1929         struct ast_xml_node *root_node;
1930         struct ast_xml_doc *tmpdoc;
1931         struct documentation_tree *doc_tree;
1932         char *xmlpattern;
1933         struct ast_config *cfg = NULL;
1934         struct ast_variable *var = NULL;
1935         struct ast_flags cnfflags = { 0 };
1936         int globret, i, dup, duplicate;
1937         glob_t globbuf;
1938 #if !defined(HAVE_GLOB_NOMAGIC) || !defined(HAVE_GLOB_BRACE) || defined(DEBUG_NONGNU)
1939         int xmlpattern_maxlen;
1940 #endif
1941
1942         /* setup default XML documentation language */
1943         snprintf(documentation_language, sizeof(documentation_language), default_documentation_language);
1944
1945         if ((cfg = ast_config_load2("asterisk.conf", "" /* core can't reload */, cnfflags)) && cfg != CONFIG_STATUS_FILEINVALID) {
1946                 for (var = ast_variable_browse(cfg, "options"); var; var = var->next) {
1947                         if (!strcasecmp(var->name, "documentation_language")) {
1948                                 if (!ast_strlen_zero(var->value)) {
1949                                         snprintf(documentation_language, sizeof(documentation_language), "%s", var->value);
1950                                 }
1951                         }
1952                 }
1953                 ast_config_destroy(cfg);
1954         }
1955
1956         /* initialize the XML library. */
1957         ast_xml_init();
1958
1959         /* register function to be run when asterisk finish. */
1960         ast_register_atexit(xmldoc_unload_documentation);
1961
1962         globbuf.gl_offs = 0;    /* slots to reserve in gl_pathv */
1963
1964 #if !defined(HAVE_GLOB_NOMAGIC) || !defined(HAVE_GLOB_BRACE) || defined(DEBUG_NONGNU)
1965         xmlpattern_maxlen = strlen(ast_config_AST_DATA_DIR) + strlen("/documentation/thirdparty") + strlen("/*-??_??.xml") + 1;
1966         xmlpattern = ast_malloc(xmlpattern_maxlen);
1967         globret = xml_pathmatch(xmlpattern, xmlpattern_maxlen, &globbuf);
1968 #else
1969         /* Get every *-LANG.xml file inside $(ASTDATADIR)/documentation */
1970         ast_asprintf(&xmlpattern, "%s/documentation{/thirdparty/,/}*-{%s,%.2s_??,%s}.xml", ast_config_AST_DATA_DIR,
1971                 documentation_language, documentation_language, default_documentation_language);
1972         globret = glob(xmlpattern, MY_GLOB_FLAGS, NULL, &globbuf);
1973 #endif
1974
1975         ast_debug(3, "gl_pathc %zd\n", globbuf.gl_pathc);
1976         if (globret == GLOB_NOSPACE) {
1977                 ast_log(LOG_WARNING, "XML load failure, glob expansion of pattern '%s' failed: Not enough memory\n", xmlpattern);
1978                 ast_free(xmlpattern);
1979                 return 1;
1980         } else if (globret  == GLOB_ABORTED) {
1981                 ast_log(LOG_WARNING, "XML load failure, glob expansion of pattern '%s' failed: Read error\n", xmlpattern);
1982                 ast_free(xmlpattern);
1983                 return 1;
1984         }
1985         ast_free(xmlpattern);
1986
1987         AST_RWLIST_WRLOCK(&xmldoc_tree);
1988         /* loop over expanded files */
1989         for (i = 0; i < globbuf.gl_pathc; i++) {
1990                 /* check for duplicates (if we already [try to] open the same file. */
1991                 duplicate = 0;
1992                 for (dup = 0; dup < i; dup++) {
1993                         if (!strcmp(globbuf.gl_pathv[i], globbuf.gl_pathv[dup])) {
1994                                 duplicate = 1;
1995                                 break;
1996                         }
1997                 }
1998                 if (duplicate || strchr(globbuf.gl_pathv[i], '*')) {
1999                 /* skip duplicates as well as pathnames not found
2000                  * (due to use of GLOB_NOCHECK in xml_pathmatch) */
2001                         continue;
2002                 }
2003                 tmpdoc = NULL;
2004                 tmpdoc = ast_xml_open(globbuf.gl_pathv[i]);
2005                 if (!tmpdoc) {
2006                         ast_log(LOG_ERROR, "Could not open XML documentation at '%s'\n", globbuf.gl_pathv[i]);
2007                         continue;
2008                 }
2009                 /* Get doc root node and check if it starts with '<docs>' */
2010                 root_node = ast_xml_get_root(tmpdoc);
2011                 if (!root_node) {
2012                         ast_log(LOG_ERROR, "Error getting documentation root node");
2013                         ast_xml_close(tmpdoc);
2014                         continue;
2015                 }
2016                 /* Check root node name for malformed xmls. */
2017                 if (strcmp(ast_xml_node_get_name(root_node), "docs")) {
2018                         ast_log(LOG_ERROR, "Documentation file is not well formed!\n");
2019                         ast_xml_close(tmpdoc);
2020                         continue;
2021                 }
2022                 doc_tree = ast_calloc(1, sizeof(*doc_tree));
2023                 if (!doc_tree) {
2024                         ast_log(LOG_ERROR, "Unable to allocate documentation_tree structure!\n");
2025                         ast_xml_close(tmpdoc);
2026                         continue;
2027                 }
2028                 doc_tree->doc = tmpdoc;
2029                 doc_tree->filename = ast_strdup(globbuf.gl_pathv[i]);
2030                 AST_RWLIST_INSERT_TAIL(&xmldoc_tree, doc_tree, entry);
2031         }
2032         AST_RWLIST_UNLOCK(&xmldoc_tree);
2033
2034         globfree(&globbuf);
2035
2036         return 0;
2037 }
2038
2039 #endif /* AST_XML_DOCS */
2040
2041