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