Add CLI configuration documentation
[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  * 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/config.h"
38 #include "asterisk/term.h"
39 #include "asterisk/astobj2.h"
40 #include "asterisk/xmldoc.h"
41 #include "asterisk/cli.h"
42
43 #ifdef AST_XML_DOCS
44
45 /*! \brief Default documentation language. */
46 static const char default_documentation_language[] = "en_US";
47
48 /*! \brief Number of columns to print when showing the XML documentation with a
49  *         'core show application/function *' CLI command. Used in text wrapping.*/
50 static const int xmldoc_text_columns = 74;
51
52 /*! \brief This is a value that we will use to let the wrapping mechanism move the cursor
53  *         backward and forward xmldoc_max_diff positions before cutting the middle of a
54  *         word, trying to find a space or a \n. */
55 static const int xmldoc_max_diff = 5;
56
57 /*! \brief XML documentation language. */
58 static char documentation_language[6];
59
60 /*! \brief XML documentation tree */
61 struct documentation_tree {
62         char *filename;                                 /*!< XML document filename. */
63         struct ast_xml_doc *doc;                        /*!< Open document pointer. */
64         AST_RWLIST_ENTRY(documentation_tree) entry;
65 };
66
67 static char *xmldoc_get_syntax_cmd(struct ast_xml_node *fixnode, const char *name, int printname);
68 static int xmldoc_parse_enumlist(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer);
69 static int xmldoc_parse_info(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer);
70 static int xmldoc_parse_para(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer);
71 static int xmldoc_parse_specialtags(struct ast_xml_node *fixnode, const char *tabs, const char *posttabs, struct ast_str **buffer);
72
73
74 /*!
75  * \brief Container of documentation trees
76  *
77  * \note A RWLIST is a sufficient container type to use here for now.
78  *       However, some changes will need to be made to implement ref counting
79  *       if reload support is added in the future.
80  */
81 static AST_RWLIST_HEAD_STATIC(xmldoc_tree, documentation_tree);
82
83 static const struct strcolorized_tags {
84         const char *init;      /*!< Replace initial tag with this string. */
85         const char *end;       /*!< Replace end tag with this string. */
86         const int colorfg;     /*!< Foreground color. */
87         const char *inittag;   /*!< Initial tag description. */
88         const char *endtag;    /*!< Ending tag description. */
89 } colorized_tags[] = {
90         { "<",  ">",  COLOR_GREEN,  "<replaceable>", "</replaceable>" },
91         { "\'", "\'", COLOR_BLUE,   "<literal>",     "</literal>" },
92         { "*",  "*",  COLOR_RED,    "<emphasis>",    "</emphasis>" },
93         { "\"", "\"", COLOR_YELLOW, "<filename>",    "</filename>" },
94         { "\"", "\"", COLOR_CYAN,   "<directory>",   "</directory>" },
95         { "${", "}",  COLOR_GREEN,  "<variable>",    "</variable>" },
96         { "",   "",   COLOR_BLUE,   "<value>",       "</value>" },
97         { "",   "",   COLOR_BLUE,   "<enum>",        "</enum>" },
98         { "\'", "\'", COLOR_GRAY,   "<astcli>",      "</astcli>" },
99
100         /* Special tags */
101         { "", "", COLOR_YELLOW, "<note>",   "</note>" },
102         { "", "", COLOR_RED,   "<warning>", "</warning>" }
103 };
104
105 static const struct strspecial_tags {
106         const char *tagname;            /*!< Special tag name. */
107         const char *init;               /*!< Print this at the beginning. */
108         const char *end;                /*!< Print this at the end. */
109 } special_tags[] = {
110         { "note",    "<note>NOTE:</note> ",             "" },
111         { "warning", "<warning>WARNING!!!:</warning> ", "" }
112 };
113
114 /*! \internal
115  *  \brief Calculate the space in bytes used by a format string
116  *         that will be passed to a sprintf function.
117  *  \param postbr The format string to use to calculate the length.
118  *  \retval The postbr length.
119  */
120 static int xmldoc_postbrlen(const char *postbr)
121 {
122         int postbrreallen = 0, i;
123         size_t postbrlen;
124
125         if (!postbr) {
126                 return 0;
127         }
128         postbrlen = strlen(postbr);
129         for (i = 0; i < postbrlen; i++) {
130                 if (postbr[i] == '\t') {
131                         postbrreallen += 8 - (postbrreallen % 8);
132                 } else {
133                         postbrreallen++;
134                 }
135         }
136         return postbrreallen;
137 }
138
139 /*! \internal
140  *  \brief Setup postbr to be used while wrapping the text.
141  *         Add to postbr array all the spaces and tabs at the beginning of text.
142  *  \param postbr output array.
143  *  \param len text array length.
144  *  \param text Text with format string before the actual string.
145  */
146 static void xmldoc_setpostbr(char *postbr, size_t len, const char *text)
147 {
148         int c, postbrlen = 0;
149
150         if (!text) {
151                 return;
152         }
153
154         for (c = 0; c < len; c++) {
155                 if (text[c] == '\t' || text[c] == ' ') {
156                         postbr[postbrlen++] = text[c];
157                 } else {
158                         break;
159                 }
160         }
161         postbr[postbrlen] = '\0';
162 }
163
164 /*! \internal
165  *  \brief Try to find a space or a break in text starting at currentpost
166  *         and moving at most maxdiff positions.
167  *         Helper for xmldoc_string_wrap().
168  *  \param text Input string where it will search.
169  *  \param currentpos Current position within text.
170  *  \param maxdiff Not move more than maxdiff inside text.
171  *  \retval 1 if a space or break is found inside text while moving.
172  *  \retval 0 if no space or break is found.
173  */
174 static int xmldoc_wait_nextspace(const char *text, int currentpos, int maxdiff)
175 {
176         int i, textlen;
177
178         if (!text) {
179                 return 0;
180         }
181
182         textlen = strlen(text);
183         for (i = currentpos; i < textlen; i++) {
184                 if (text[i] == ESC) {
185                         /* Move to the end of the escape sequence */
186                         while (i < textlen && text[i] != 'm') {
187                                 i++;
188                         }
189                 } else if (text[i] == ' ' || text[i] == '\n') {
190                         /* Found the next space or linefeed */
191                         return 1;
192                 } else if (i - currentpos > maxdiff) {
193                         /* We have looked the max distance and didn't find it */
194                         return 0;
195                 }
196         }
197
198         /* Reached the end and did not find it */
199
200         return 0;
201 }
202
203 /*! \internal
204  *  \brief Helper function for xmldoc_string_wrap().
205  *         Try to found a space or a break inside text moving backward
206  *         not more than maxdiff positions.
207  *  \param text The input string where to search for a space.
208  *  \param currentpos The current cursor position.
209  *  \param maxdiff The max number of positions to move within text.
210  *  \retval 0 If no space is found (Notice that text[currentpos] is not a space or a break)
211  *  \retval > 0 If a space or a break is found, and the result is the position relative to
212  *              currentpos.
213  */
214 static int xmldoc_foundspace_backward(const char *text, int currentpos, int maxdiff)
215 {
216         int i;
217
218         for (i = currentpos; i > 0; i--) {
219                 if (text[i] == ' ' || text[i] == '\n') {
220                         return (currentpos - i);
221                 } else if (text[i] == 'm' && (text[i - 1] >= '0' || text[i - 1] <= '9')) {
222                         /* give up, we found the end of a possible ESC sequence. */
223                         return 0;
224                 } else if (currentpos - i > maxdiff) {
225                         /* give up, we can't move anymore. */
226                         return 0;
227                 }
228         }
229
230         /* we found the beginning of the text */
231
232         return 0;
233 }
234
235 /*! \internal
236  *  \brief Justify a text to a number of columns.
237  *  \param text Input text to be justified.
238  *  \param columns Number of columns to preserve in the text.
239  *  \param maxdiff Try to not cut a word when goinf down.
240  *  \retval NULL on error.
241  *  \retval The wrapped text.
242  */
243 static char *xmldoc_string_wrap(const char *text, int columns, int maxdiff)
244 {
245         struct ast_str *tmp;
246         char *ret, postbr[160];
247         int count = 1, i, backspace, needtobreak = 0, colmax, textlen;
248
249         /* sanity check */
250         if (!text || columns <= 0 || maxdiff < 0) {
251                 ast_log(LOG_WARNING, "Passing wrong arguments while trying to wrap the text\n");
252                 return NULL;
253         }
254
255         tmp = ast_str_create(strlen(text) * 3);
256
257         if (!tmp) {
258                 return NULL;
259         }
260
261         /* Check for blanks and tabs and put them in postbr. */
262         xmldoc_setpostbr(postbr, sizeof(postbr), text);
263         colmax = columns - xmldoc_postbrlen(postbr);
264
265         textlen = strlen(text);
266         for (i = 0; i < textlen; i++) {
267                 if (needtobreak || !(count % colmax)) {
268                         if (text[i] == ' ') {
269                                 ast_str_append(&tmp, 0, "\n%s", postbr);
270                                 needtobreak = 0;
271                                 count = 1;
272                         } else if (text[i] != '\n') {
273                                 needtobreak = 1;
274                                 if (xmldoc_wait_nextspace(text, i, maxdiff)) {
275                                         /* wait for the next space */
276                                         ast_str_append(&tmp, 0, "%c", text[i]);
277                                         continue;
278                                 }
279                                 /* Try to look backwards */
280                                 backspace = xmldoc_foundspace_backward(text, i, maxdiff);
281                                 if (backspace) {
282                                         needtobreak = 1;
283                                         ast_str_truncate(tmp, -backspace);
284                                         i -= backspace + 1;
285                                         continue;
286                                 }
287                                 ast_str_append(&tmp, 0, "\n%s", postbr);
288                                 needtobreak = 0;
289                                 count = 1;
290                         }
291                         /* skip blanks after a \n */
292                         while (text[i] == ' ') {
293                                 i++;
294                         }
295                 }
296                 if (text[i] == '\n') {
297                         xmldoc_setpostbr(postbr, sizeof(postbr), &text[i] + 1);
298                         colmax = columns - xmldoc_postbrlen(postbr);
299                         needtobreak = 0;
300                         count = 1;
301                 }
302                 if (text[i] == ESC) {
303                         /* Ignore Escape sequences. */
304                         do {
305                                 ast_str_append(&tmp, 0, "%c", text[i]);
306                                 i++;
307                         } while (i < textlen && text[i] != 'm');
308                 } else {
309                         count++;
310                 }
311                 ast_str_append(&tmp, 0, "%c", text[i]);
312         }
313
314         ret = ast_strdup(ast_str_buffer(tmp));
315         ast_free(tmp);
316
317         return ret;
318 }
319
320 char *ast_xmldoc_printable(const char *bwinput, int withcolors)
321 {
322         struct ast_str *colorized;
323         char *wrapped = NULL;
324         int i, c, len, colorsection;
325         char *tmp;
326         size_t bwinputlen;
327         static const int base_fg = COLOR_CYAN;
328
329         if (!bwinput) {
330                 return NULL;
331         }
332
333         bwinputlen = strlen(bwinput);
334
335         if (!(colorized = ast_str_create(256))) {
336                 return NULL;
337         }
338
339         if (withcolors) {
340                 ast_term_color_code(&colorized, base_fg, 0);
341                 if (!colorized) {
342                         return NULL;
343                 }
344         }
345
346         for (i = 0; i < bwinputlen; i++) {
347                 colorsection = 0;
348                 /* Check if we are at the beginning of a tag to be colorized. */
349                 for (c = 0; c < ARRAY_LEN(colorized_tags); c++) {
350                         if (strncasecmp(bwinput + i, colorized_tags[c].inittag, strlen(colorized_tags[c].inittag))) {
351                                 continue;
352                         }
353
354                         if (!(tmp = strcasestr(bwinput + i + strlen(colorized_tags[c].inittag), colorized_tags[c].endtag))) {
355                                 continue;
356                         }
357
358                         len = tmp - (bwinput + i + strlen(colorized_tags[c].inittag));
359
360                         /* Setup color */
361                         if (withcolors) {
362                                 if (ast_opt_light_background) {
363                                         /* Turn off *bright* colors */
364                                         ast_term_color_code(&colorized, colorized_tags[c].colorfg & 0x7f, 0);
365                                 } else {
366                                         /* Turn on *bright* colors */
367                                         ast_term_color_code(&colorized, colorized_tags[c].colorfg | 0x80, 0);
368                                 }
369                                 if (!colorized) {
370                                         return NULL;
371                                 }
372                         }
373
374                         /* copy initial string replace */
375                         ast_str_append(&colorized, 0, "%s", colorized_tags[c].init);
376                         if (!colorized) {
377                                 return NULL;
378                         }
379                         {
380                                 char buf[len + 1];
381                                 ast_copy_string(buf, bwinput + i + strlen(colorized_tags[c].inittag), sizeof(buf));
382                                 ast_str_append(&colorized, 0, "%s", buf);
383                         }
384                         if (!colorized) {
385                                 return NULL;
386                         }
387
388                         /* copy the ending string replace */
389                         ast_str_append(&colorized, 0, "%s", colorized_tags[c].end);
390                         if (!colorized) {
391                                 return NULL;
392                         }
393
394                         /* Continue with the last color. */
395                         if (withcolors) {
396                                 ast_term_color_code(&colorized, base_fg, 0);
397                                 if (!colorized) {
398                                         return NULL;
399                                 }
400                         }
401
402                         i += len + strlen(colorized_tags[c].endtag) + strlen(colorized_tags[c].inittag) - 1;
403                         colorsection = 1;
404                         break;
405                 }
406
407                 if (!colorsection) {
408                         ast_str_append(&colorized, 0, "%c", bwinput[i]);
409                         if (!colorized) {
410                                 return NULL;
411                         }
412                 }
413         }
414
415         if (withcolors) {
416                 ast_str_append(&colorized, 0, "%s", term_end());
417                 if (!colorized) {
418                         return NULL;
419                 }
420         }
421
422         /* Wrap the text, notice that string wrap will avoid cutting an ESC sequence. */
423         wrapped = xmldoc_string_wrap(ast_str_buffer(colorized), xmldoc_text_columns, xmldoc_max_diff);
424
425         ast_free(colorized);
426
427         return wrapped;
428 }
429
430 /*! \internal
431  *  \brief Cleanup spaces and tabs after a \n
432  *  \param text String to be cleaned up.
433  *  \param output buffer (not already allocated).
434  *  \param lastspaces Remove last spaces in the string.
435  */
436 static void xmldoc_string_cleanup(const char *text, struct ast_str **output, int lastspaces)
437 {
438         int i;
439         size_t textlen;
440
441         if (!text) {
442                 *output = NULL;
443                 return;
444         }
445
446         textlen = strlen(text);
447
448         *output = ast_str_create(textlen);
449         if (!(*output)) {
450                 ast_log(LOG_ERROR, "Problem allocating output buffer\n");
451                 return;
452         }
453
454         for (i = 0; i < textlen; i++) {
455                 if (text[i] == '\n' || text[i] == '\r') {
456                         /* remove spaces/tabs/\n after a \n. */
457                         while (text[i + 1] == '\t' || text[i + 1] == '\r' || text[i + 1] == '\n') {
458                                 i++;
459                         }
460                         ast_str_append(output, 0, " ");
461                         continue;
462                 } else {
463                         ast_str_append(output, 0, "%c", text[i]);
464                 }
465         }
466
467         /* remove last spaces (we don't want always to remove the trailing spaces). */
468         if (lastspaces) {
469                 ast_str_trim_blanks(*output);
470         }
471 }
472
473 /*! \internal
474  * \brief Check if the given attribute on the given node matches the given value.
475  * \param node the node to match
476  * \param attr the name of the attribute
477  * \param value the expected value of the attribute
478  * \retval true if the given attribute contains the given value
479  * \retval false if the given attribute does not exist or does not contain the given value
480  */
481 static int xmldoc_attribute_match(struct ast_xml_node *node, const char *attr, const char *value)
482 {
483         const char *attr_value = ast_xml_get_attribute(node, attr);
484         int match = attr_value && !strcmp(attr_value, value);
485         ast_xml_free_attr(attr_value);
486         return match;
487 }
488
489 /*! \internal
490  *  \brief Get the application/function node for 'name' application/function with language 'language'
491  *         and module 'module' if we don't find any, get the first application
492  *         with 'name' no matter which language or module.
493  *  \param type 'application', 'function', ...
494  *  \param name Application or Function name.
495  *  \param module Module item is in.
496  *  \param language Try to get this language (if not found try with en_US)
497  *  \retval NULL on error.
498  *  \retval A node of type ast_xml_node.
499  */
500 static struct ast_xml_node *xmldoc_get_node(const char *type, const char *name, const char *module, const char *language)
501 {
502         struct ast_xml_node *node = NULL;
503         struct ast_xml_node *first_match = NULL;
504         struct ast_xml_node *lang_match = NULL;
505         struct documentation_tree *doctree;
506
507         AST_RWLIST_RDLOCK(&xmldoc_tree);
508         AST_LIST_TRAVERSE(&xmldoc_tree, doctree, entry) {
509                 /* the core xml documents have priority over thirdparty document. */
510                 node = ast_xml_get_root(doctree->doc);
511                 if (!node) {
512                         break;
513                 }
514
515                 node = ast_xml_node_get_children(node);
516                 while ((node = ast_xml_find_element(node, type, "name", name))) {
517                         if (!ast_xml_node_get_children(node)) {
518                                 /* ignore empty nodes */
519                                 node = ast_xml_node_get_next(node);
520                                 continue;
521                         }
522
523                         if (!first_match) {
524                                 first_match = node;
525                         }
526
527                         /* Check language */
528                         if (xmldoc_attribute_match(node, "language", language)) {
529                                 if (!lang_match) {
530                                         lang_match = node;
531                                 }
532
533                                 /* if module is empty we have a match */
534                                 if (ast_strlen_zero(module)) {
535                                         break;
536                                 }
537
538                                 /* Check module */
539                                 if (xmldoc_attribute_match(node, "module", module)) {
540                                         break;
541                                 }
542                         }
543
544                         node = ast_xml_node_get_next(node);
545                 }
546
547                 /* if we matched lang and module return this match */
548                 if (node) {
549                         break;
550                 }
551
552                 /* we didn't match lang and module, just return the first
553                  * result with a matching language if we have one */
554                 if (lang_match) {
555                         node = lang_match;
556                         break;
557                 }
558
559                 /* we didn't match with only the language, just return the
560                  * first match */
561                 if (first_match) {
562                         node = first_match;
563                         break;
564                 }
565         }
566         AST_RWLIST_UNLOCK(&xmldoc_tree);
567
568         return node;
569 }
570
571 /*! \internal
572  *  \brief Helper function used to build the syntax, it allocates the needed buffer (or reallocates it),
573  *         and based on the reverse value it makes use of fmt to print the parameter list inside the
574  *         realloced buffer (syntax).
575  *  \param reverse We are going backwards while generating the syntax?
576  *  \param len Current length of 'syntax' buffer.
577  *  \param syntax Output buffer for the concatenated values.
578  *  \param fmt A format string that will be used in a sprintf call.
579  */
580 static void __attribute__((format(printf, 4, 5))) xmldoc_reverse_helper(int reverse, int *len, char **syntax, const char *fmt, ...)
581 {
582         int totlen, tmpfmtlen;
583         char *tmpfmt, tmp;
584         va_list ap;
585
586         va_start(ap, fmt);
587         if (ast_vasprintf(&tmpfmt, fmt, ap) < 0) {
588                 va_end(ap);
589                 return;
590         }
591         va_end(ap);
592
593         tmpfmtlen = strlen(tmpfmt);
594         totlen = *len + tmpfmtlen + 1;
595
596         *syntax = ast_realloc(*syntax, totlen);
597
598         if (!*syntax) {
599                 ast_free(tmpfmt);
600                 return;
601         }
602
603         if (reverse) {
604                 memmove(*syntax + tmpfmtlen, *syntax, *len);
605                 /* Save this char, it will be overwritten by the \0 of strcpy. */
606                 tmp = (*syntax)[0];
607                 strcpy(*syntax, tmpfmt);
608                 /* Restore the already saved char. */
609                 (*syntax)[tmpfmtlen] = tmp;
610                 (*syntax)[totlen - 1] = '\0';
611         } else {
612                 strcpy(*syntax + *len, tmpfmt);
613         }
614
615         *len = totlen - 1;
616         ast_free(tmpfmt);
617 }
618
619 /*! \internal
620  *  \brief Check if the passed node has 'what' tags inside it.
621  *  \param node Root node to search 'what' elements.
622  *  \param what node name to search inside node.
623  *  \retval 1 If a 'what' element is found inside 'node'.
624  *  \retval 0 If no 'what' is found inside 'node'.
625  */
626 static int xmldoc_has_inside(struct ast_xml_node *fixnode, const char *what)
627 {
628         struct ast_xml_node *node = fixnode;
629
630         for (node = ast_xml_node_get_children(fixnode); node; node = ast_xml_node_get_next(node)) {
631                 if (!strcasecmp(ast_xml_node_get_name(node), what)) {
632                         return 1;
633                 }
634         }
635         return 0;
636 }
637
638 /*! \internal
639  *  \brief Check if the passed node has at least one node inside it.
640  *  \param node Root node to search node elements.
641  *  \retval 1 If a node element is found inside 'node'.
642  *  \retval 0 If no node is found inside 'node'.
643  */
644 static int xmldoc_has_nodes(struct ast_xml_node *fixnode)
645 {
646         struct ast_xml_node *node = fixnode;
647
648         for (node = ast_xml_node_get_children(fixnode); node; node = ast_xml_node_get_next(node)) {
649                 if (strcasecmp(ast_xml_node_get_name(node), "text")) {
650                         return 1;
651                 }
652         }
653         return 0;
654 }
655
656 /*! \internal
657  *  \brief Check if the passed node has at least one specialtag.
658  *  \param node Root node to search "specialtags" elements.
659  *  \retval 1 If a "specialtag" element is found inside 'node'.
660  *  \retval 0 If no "specialtag" is found inside 'node'.
661  */
662 static int xmldoc_has_specialtags(struct ast_xml_node *fixnode)
663 {
664         struct ast_xml_node *node = fixnode;
665         int i;
666
667         for (node = ast_xml_node_get_children(fixnode); node; node = ast_xml_node_get_next(node)) {
668                 for (i = 0; i < ARRAY_LEN(special_tags); i++) {
669                         if (!strcasecmp(ast_xml_node_get_name(node), special_tags[i].tagname)) {
670                                 return 1;
671                         }
672                 }
673         }
674         return 0;
675 }
676
677 /*! \internal
678  *  \brief Build the syntax for a specified starting node.
679  *  \param rootnode A pointer to the ast_xml root node.
680  *  \param rootname Name of the application, function, option, etc. to build the syntax.
681  *  \param childname The name of each parameter node.
682  *  \param printparenthesis Boolean if we must print parenthesis if not parameters are found in the rootnode.
683  *  \param printrootname Boolean if we must print the rootname before the syntax and parenthesis at the begining/end.
684  *  \retval NULL on error.
685  *  \retval An ast_malloc'ed string with the syntax generated.
686  */
687 static char *xmldoc_get_syntax_fun(struct ast_xml_node *rootnode, const char *rootname, const char *childname, int printparenthesis, int printrootname)
688 {
689 #define GOTONEXT(__rev, __a) (__rev ? ast_xml_node_get_prev(__a) : ast_xml_node_get_next(__a))
690 #define ISLAST(__rev, __a)  (__rev == 1 ? (ast_xml_node_get_prev(__a) ? 0 : 1) : (ast_xml_node_get_next(__a) ? 0 : 1))
691 #define MP(__a) ((multiple ? __a : ""))
692         struct ast_xml_node *node = NULL, *firstparam = NULL, *lastparam = NULL;
693         const char *paramtype, *multipletype, *paramnameattr, *attrargsep, *parenthesis, *argname;
694         int reverse, required, paramcount = 0, openbrackets = 0, len = 0, hasparams=0;
695         int reqfinode = 0, reqlanode = 0, optmidnode = 0, prnparenthesis, multiple;
696         char *syntax = NULL, *argsep, *paramname;
697
698         if (ast_strlen_zero(rootname) || ast_strlen_zero(childname)) {
699                 ast_log(LOG_WARNING, "Tried to look in XML tree with faulty rootname or childname while creating a syntax.\n");
700                 return NULL;
701         }
702
703         if (!rootnode || !ast_xml_node_get_children(rootnode)) {
704                 /* If the rootnode field is not found, at least print name. */
705                 if (ast_asprintf(&syntax, "%s%s", (printrootname ? rootname : ""), (printparenthesis ? "()" : "")) < 0) {
706                         syntax = NULL;
707                 }
708                 return syntax;
709         }
710
711         /* Get the argument separator from the root node attribute name 'argsep', if not found
712         defaults to ','. */
713         attrargsep = ast_xml_get_attribute(rootnode, "argsep");
714         if (attrargsep) {
715                 argsep = ast_strdupa(attrargsep);
716                 ast_xml_free_attr(attrargsep);
717         } else {
718                 argsep = ast_strdupa(",");
719         }
720
721         /* Get order of evaluation. */
722         for (node = ast_xml_node_get_children(rootnode); node; node = ast_xml_node_get_next(node)) {
723                 if (strcasecmp(ast_xml_node_get_name(node), childname)) {
724                         continue;
725                 }
726                 required = 0;
727                 hasparams = 1;
728                 if ((paramtype = ast_xml_get_attribute(node, "required"))) {
729                         if (ast_true(paramtype)) {
730                                 required = 1;
731                         }
732                         ast_xml_free_attr(paramtype);
733                 }
734
735                 lastparam = node;
736                 reqlanode = required;
737
738                 if (!firstparam) {
739                         /* first parameter node */
740                         firstparam = node;
741                         reqfinode = required;
742                 }
743         }
744
745         if (!hasparams) {
746                 /* This application, function, option, etc, doesn't have any params. */
747                 if (ast_asprintf(&syntax, "%s%s", (printrootname ? rootname : ""), (printparenthesis ? "()" : "")) < 0) {
748                         syntax = NULL;
749                 }
750                 return syntax;
751         }
752
753         if (reqfinode && reqlanode) {
754                 /* check midnode */
755                 for (node = ast_xml_node_get_children(rootnode); node; node = ast_xml_node_get_next(node)) {
756                         if (strcasecmp(ast_xml_node_get_name(node), childname)) {
757                                 continue;
758                         }
759                         if (node != firstparam && node != lastparam) {
760                                 if ((paramtype = ast_xml_get_attribute(node, "required"))) {
761                                         if (!ast_true(paramtype)) {
762                                                 optmidnode = 1;
763                                                 break;
764                                         }
765                                         ast_xml_free_attr(paramtype);
766                                 }
767                         }
768                 }
769         }
770
771         if ((!reqfinode && reqlanode) || (reqfinode && reqlanode && optmidnode)) {
772                 reverse = 1;
773                 node = lastparam;
774         } else {
775                 reverse = 0;
776                 node = firstparam;
777         }
778
779         /* init syntax string. */
780         if (reverse) {
781                 xmldoc_reverse_helper(reverse, &len, &syntax,
782                         (printrootname ? (printrootname == 2 ? ")]" : ")"): ""));
783         } else {
784                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s", (printrootname ? rootname : ""),
785                         (printrootname ? (printrootname == 2 ? "[(" : "(") : ""));
786         }
787
788         for (; node; node = GOTONEXT(reverse, node)) {
789                 if (strcasecmp(ast_xml_node_get_name(node), childname)) {
790                         continue;
791                 }
792
793                 /* Get the argument name, if it is not the leaf, go inside that parameter. */
794                 if (xmldoc_has_inside(node, "argument")) {
795                         parenthesis = ast_xml_get_attribute(node, "hasparams");
796                         prnparenthesis = 0;
797                         if (parenthesis) {
798                                 prnparenthesis = ast_true(parenthesis);
799                                 if (!strcasecmp(parenthesis, "optional")) {
800                                         prnparenthesis = 2;
801                                 }
802                                 ast_xml_free_attr(parenthesis);
803                         }
804                         argname = ast_xml_get_attribute(node, "name");
805                         if (argname) {
806                                 paramname = xmldoc_get_syntax_fun(node, argname, "argument", prnparenthesis, prnparenthesis);
807                                 ast_xml_free_attr(argname);
808                         } else {
809                                 /* Malformed XML, print **UNKOWN** */
810                                 paramname = ast_strdup("**unknown**");
811                         }
812                 } else {
813                         paramnameattr = ast_xml_get_attribute(node, "name");
814                         if (!paramnameattr) {
815                                 ast_log(LOG_WARNING, "Malformed XML %s: no %s name\n", rootname, childname);
816                                 if (syntax) {
817                                         /* Free already allocated syntax */
818                                         ast_free(syntax);
819                                 }
820                                 /* to give up is ok? */
821                                 if (ast_asprintf(&syntax, "%s%s", (printrootname ? rootname : ""), (printparenthesis ? "()" : "")) < 0) {
822                                         syntax = NULL;
823                                 }
824                                 return syntax;
825                         }
826                         paramname = ast_strdup(paramnameattr);
827                         ast_xml_free_attr(paramnameattr);
828                 }
829
830                 if (!paramname) {
831                         return NULL;
832                 }
833
834                 /* Defaults to 'false'. */
835                 multiple = 0;
836                 if ((multipletype = ast_xml_get_attribute(node, "multiple"))) {
837                         if (ast_true(multipletype)) {
838                                 multiple = 1;
839                         }
840                         ast_xml_free_attr(multipletype);
841                 }
842
843                 required = 0;   /* Defaults to 'false'. */
844                 if ((paramtype = ast_xml_get_attribute(node, "required"))) {
845                         if (ast_true(paramtype)) {
846                                 required = 1;
847                         }
848                         ast_xml_free_attr(paramtype);
849                 }
850
851                 /* build syntax core. */
852
853                 if (required) {
854                         /* First parameter */
855                         if (!paramcount) {
856                                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s%s%s", paramname, MP("["), MP(argsep), MP("...]"));
857                         } else {
858                                 /* Time to close open brackets. */
859                                 while (openbrackets > 0) {
860                                         xmldoc_reverse_helper(reverse, &len, &syntax, (reverse ? "[" : "]"));
861                                         openbrackets--;
862                                 }
863                                 if (reverse) {
864                                         xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s", paramname, argsep);
865                                 } else {
866                                         xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s", argsep, paramname);
867                                 }
868                                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s%s", MP("["), MP(argsep), MP("...]"));
869                         }
870                 } else {
871                         /* First parameter */
872                         if (!paramcount) {
873                                 xmldoc_reverse_helper(reverse, &len, &syntax, "[%s%s%s%s]", paramname, MP("["), MP(argsep), MP("...]"));
874                         } else {
875                                 if (ISLAST(reverse, node)) {
876                                         /* This is the last parameter. */
877                                         if (reverse) {
878                                                 xmldoc_reverse_helper(reverse, &len, &syntax, "[%s%s%s%s]%s", paramname,
879                                                                         MP("["), MP(argsep), MP("...]"), argsep);
880                                         } else {
881                                                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s[%s%s%s%s]", argsep, paramname,
882                                                                         MP("["), MP(argsep), MP("...]"));
883                                         }
884                                 } else {
885                                         if (reverse) {
886                                                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s%s%s%s]", paramname, argsep,
887                                                                         MP("["), MP(argsep), MP("...]"));
888                                         } else {
889                                                 xmldoc_reverse_helper(reverse, &len, &syntax, "[%s%s%s%s%s", argsep, paramname,
890                                                                         MP("["), MP(argsep), MP("...]"));
891                                         }
892                                         openbrackets++;
893                                 }
894                         }
895                 }
896                 ast_free(paramname);
897
898                 paramcount++;
899         }
900
901         /* Time to close open brackets. */
902         while (openbrackets > 0) {
903                 xmldoc_reverse_helper(reverse, &len, &syntax, (reverse ? "[" : "]"));
904                 openbrackets--;
905         }
906
907         /* close syntax string. */
908         if (reverse) {
909                 xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s", (printrootname ? rootname : ""),
910                         (printrootname ? (printrootname == 2 ? "[(" : "(") : ""));
911         } else {
912                 xmldoc_reverse_helper(reverse, &len, &syntax, (printrootname ? (printrootname == 2 ? ")]" : ")") : ""));
913         }
914
915         return syntax;
916 #undef ISLAST
917 #undef GOTONEXT
918 #undef MP
919 }
920
921 /*! \internal
922  *  \brief Parse an enumlist inside a <parameter> to generate a COMMAND
923  *         syntax.
924  *  \param fixnode A pointer to the <enumlist> node.
925  *  \retval {<unknown>} on error.
926  *  \retval A string inside brackets {} with the enum's separated by pipes |.
927  */
928 static char *xmldoc_parse_cmd_enumlist(struct ast_xml_node *fixnode)
929 {
930         struct ast_xml_node *node = fixnode;
931         struct ast_str *paramname;
932         char *enumname, *ret;
933         int first = 1;
934
935         paramname = ast_str_create(128);
936         if (!paramname) {
937                 return ast_strdup("{<unkown>}");
938         }
939
940         ast_str_append(&paramname, 0, "{");
941
942         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
943                 if (strcasecmp(ast_xml_node_get_name(node), "enum")) {
944                         continue;
945                 }
946
947                 enumname = xmldoc_get_syntax_cmd(node, "", 0);
948                 if (!enumname) {
949                         continue;
950                 }
951                 if (!first) {
952                         ast_str_append(&paramname, 0, "|");
953                 }
954                 ast_str_append(&paramname, 0, "%s", enumname);
955                 first = 0;
956                 ast_free(enumname);
957         }
958
959         ast_str_append(&paramname, 0, "}");
960
961         ret = ast_strdup(ast_str_buffer(paramname));
962         ast_free(paramname);
963
964         return ret;
965 }
966
967 /*! \internal
968  *  \brief Generate a syntax of COMMAND type.
969  *  \param fixnode The <syntax> node pointer.
970  *  \param name The name of the 'command'.
971  *  \param printname Print the name of the command before the paramters?
972  *  \retval On error, return just 'name'.
973  *  \retval On success return the generated syntax.
974  */
975 static char *xmldoc_get_syntax_cmd(struct ast_xml_node *fixnode, const char *name, int printname)
976 {
977         struct ast_str *syntax;
978         struct ast_xml_node *tmpnode, *node = fixnode;
979         char *ret, *paramname;
980         const char *paramtype, *attrname, *literal;
981         int required, isenum, first = 1, isliteral;
982
983         if (!fixnode) {
984                 return NULL;
985         }
986
987         syntax = ast_str_create(128);
988         if (!syntax) {
989                 /* at least try to return something... */
990                 return ast_strdup(name);
991         }
992
993         /* append name to output string. */
994         if (printname) {
995                 ast_str_append(&syntax, 0, "%s", name);
996                 first = 0;
997         }
998
999         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1000                 if (strcasecmp(ast_xml_node_get_name(node), "parameter")) {
1001                         continue;
1002                 }
1003
1004                 if (xmldoc_has_inside(node, "parameter")) {
1005                         /* is this a recursive parameter. */
1006                         paramname = xmldoc_get_syntax_cmd(node, "", 0);
1007                         isenum = 1;
1008                 } else {
1009                         for (tmpnode = ast_xml_node_get_children(node); tmpnode; tmpnode = ast_xml_node_get_next(tmpnode)) {
1010                                 if (!strcasecmp(ast_xml_node_get_name(tmpnode), "enumlist")) {
1011                                         break;
1012                                 }
1013                         }
1014                         if (tmpnode) {
1015                                 /* parse enumlist (note that this is a special enumlist
1016                                 that is used to describe a syntax like {<param1>|<param2>|...} */
1017                                 paramname = xmldoc_parse_cmd_enumlist(tmpnode);
1018                                 isenum = 1;
1019                         } else {
1020                                 /* this is a simple parameter. */
1021                                 attrname = ast_xml_get_attribute(node, "name");
1022                                 if (!attrname) {
1023                                         /* ignore this bogus parameter and continue. */
1024                                         continue;
1025                                 }
1026                                 paramname = ast_strdup(attrname);
1027                                 ast_xml_free_attr(attrname);
1028                                 isenum = 0;
1029                         }
1030                 }
1031
1032                 /* Is this parameter required? */
1033                 required = 0;
1034                 paramtype = ast_xml_get_attribute(node, "required");
1035                 if (paramtype) {
1036                         required = ast_true(paramtype);
1037                         ast_xml_free_attr(paramtype);
1038                 }
1039
1040                 /* Is this a replaceable value or a fixed parameter value? */
1041                 isliteral = 0;
1042                 literal = ast_xml_get_attribute(node, "literal");
1043                 if (literal) {
1044                         isliteral = ast_true(literal);
1045                         ast_xml_free_attr(literal);
1046                 }
1047
1048                 /* if required="false" print with [...].
1049                  * if literal="true" or is enum print without <..>.
1050                  * if not first print a space at the beginning.
1051                  */
1052                 ast_str_append(&syntax, 0, "%s%s%s%s%s%s",
1053                                 (first ? "" : " "),
1054                                 (required ? "" : "["),
1055                                 (isenum || isliteral ? "" : "<"),
1056                                 paramname,
1057                                 (isenum || isliteral ? "" : ">"),
1058                                 (required ? "" : "]"));
1059                 first = 0;
1060                 ast_free(paramname);
1061         }
1062
1063         /* return a common string. */
1064         ret = ast_strdup(ast_str_buffer(syntax));
1065         ast_free(syntax);
1066
1067         return ret;
1068 }
1069
1070 /*! \internal
1071  *  \brief Generate an AMI action/event syntax.
1072  *  \param fixnode The manager action/event node pointer.
1073  *  \param name The name of the manager action/event.
1074  *  \param manager_type "Action" or "Event"
1075  *  \retval The generated syntax.
1076  *  \retval NULL on error.
1077  */
1078 static char *xmldoc_get_syntax_manager(struct ast_xml_node *fixnode, const char *name, const char *manager_type)
1079 {
1080         struct ast_str *syntax;
1081         struct ast_xml_node *node = fixnode;
1082         const char *paramtype, *attrname;
1083         int required;
1084         char *ret;
1085
1086         if (!fixnode) {
1087                 return NULL;
1088         }
1089
1090         syntax = ast_str_create(128);
1091         if (!syntax) {
1092                 return ast_strdup(name);
1093         }
1094
1095         ast_str_append(&syntax, 0, "%s: %s", manager_type, name);
1096
1097         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1098                 if (strcasecmp(ast_xml_node_get_name(node), "parameter")) {
1099                         continue;
1100                 }
1101
1102                 /* Is this parameter required? */
1103                 required = !strcasecmp(manager_type, "event") ? 1 : 0;
1104                 paramtype = ast_xml_get_attribute(node, "required");
1105                 if (paramtype) {
1106                         required = ast_true(paramtype);
1107                         ast_xml_free_attr(paramtype);
1108                 }
1109
1110                 attrname = ast_xml_get_attribute(node, "name");
1111                 if (!attrname) {
1112                         /* ignore this bogus parameter and continue. */
1113                         continue;
1114                 }
1115
1116                 ast_str_append(&syntax, 0, "\n%s%s:%s <value>",
1117                         (required ? "" : "["),
1118                         attrname,
1119                         (required ? "" : "]"));
1120                 ast_xml_free_attr(attrname);
1121         }
1122
1123         /* return a common string. */
1124         ret = ast_strdup(ast_str_buffer(syntax));
1125         ast_free(syntax);
1126
1127         return ret;
1128 }
1129
1130 static char *xmldoc_get_syntax_config_object(struct ast_xml_node *fixnode, const char *name)
1131 {
1132         struct ast_xml_node *matchinfo, *tmp;
1133         int match;
1134         const char *attr_value;
1135         const char *text;
1136         RAII_VAR(struct ast_str *, syntax, ast_str_create(128), ast_free);
1137
1138         if (!syntax || !fixnode) {
1139                 return NULL;
1140         }
1141         if (!(matchinfo = ast_xml_find_element(ast_xml_node_get_children(fixnode), "matchInfo", NULL, NULL))) {
1142                 return NULL;
1143         }
1144         if (!(tmp  = ast_xml_find_element(ast_xml_node_get_children(matchinfo), "category", NULL, NULL))) {
1145                 return NULL;
1146         }
1147         attr_value = ast_xml_get_attribute(tmp, "match");
1148         if (attr_value) {
1149                 match = ast_true(attr_value);
1150                 text = ast_xml_get_text(tmp);
1151                 ast_str_set(&syntax, 0, "category %s /%s/", match ? "=~" : "!~", text);
1152                 ast_xml_free_attr(attr_value);
1153         }
1154
1155         if ((tmp = ast_xml_find_element(ast_xml_node_get_children(matchinfo), "field", NULL, NULL))) {
1156                 text = ast_xml_get_text(tmp);
1157                 attr_value = ast_xml_get_attribute(tmp, "name");
1158                 ast_str_append(&syntax, 0, " matchfield: %s = %s", S_OR(attr_value, "Unknown"), text);
1159                 ast_xml_free_attr(attr_value);
1160         }
1161         return ast_strdup(ast_str_buffer(syntax));
1162 }
1163
1164 static char *xmldoc_get_syntax_config_option(struct ast_xml_node *fixnode, const char *name)
1165 {
1166         const char *type;
1167         const char *default_value;
1168         const char *regex;
1169         RAII_VAR(struct ast_str *, syntax, ast_str_create(128), ast_free);
1170
1171         if (!syntax || !fixnode) {
1172                 return NULL;
1173         }
1174         type = ast_xml_get_attribute(fixnode, "type");
1175         default_value = ast_xml_get_attribute(fixnode, "default");
1176
1177         regex = ast_xml_get_attribute(fixnode, "regex");
1178         ast_str_set(&syntax, 0, "%s = [%s] (Default: %s) (Regex: %s)\n",
1179                 name,
1180                 type,
1181                 default_value,
1182                 regex ? regex : "False");
1183
1184         ast_xml_free_attr(type);
1185         ast_xml_free_attr(default_value);
1186         ast_xml_free_attr(regex);
1187
1188         return ast_strdup(ast_str_buffer(syntax));
1189 }
1190
1191 /*! \brief Types of syntax that we are able to generate. */
1192 enum syntaxtype {
1193         FUNCTION_SYNTAX,
1194         MANAGER_SYNTAX,
1195         MANAGER_EVENT_SYNTAX,
1196         CONFIG_INFO_SYNTAX,
1197         CONFIG_FILE_SYNTAX,
1198         CONFIG_OPTION_SYNTAX,
1199         CONFIG_OBJECT_SYNTAX,
1200         COMMAND_SYNTAX
1201 };
1202
1203 /*! \brief Mapping between type of node and type of syntax to generate. */
1204 static struct strsyntaxtype {
1205         const char *type;
1206         enum syntaxtype stxtype;
1207 } stxtype[] = {
1208     { "function",     FUNCTION_SYNTAX      },
1209     { "application",  FUNCTION_SYNTAX      },
1210     { "manager",      MANAGER_SYNTAX       },
1211     { "managerEvent", MANAGER_EVENT_SYNTAX },
1212     { "configInfo",   CONFIG_INFO_SYNTAX   },
1213     { "configFile",   CONFIG_FILE_SYNTAX   },
1214     { "configOption", CONFIG_OPTION_SYNTAX },
1215     { "configObject", CONFIG_OBJECT_SYNTAX },
1216     { "agi",          COMMAND_SYNTAX       },
1217 };
1218
1219 /*! \internal
1220  *  \brief Get syntax type based on type of node.
1221  *  \param type Type of node.
1222  *  \retval The type of syntax to generate based on the type of node.
1223  */
1224 static enum syntaxtype xmldoc_get_syntax_type(const char *type)
1225 {
1226         int i;
1227         for (i=0; i < ARRAY_LEN(stxtype); i++) {
1228                 if (!strcasecmp(stxtype[i].type, type)) {
1229                         return stxtype[i].stxtype;
1230                 }
1231         }
1232
1233         return FUNCTION_SYNTAX;
1234 }
1235
1236 /*!
1237  * \internal
1238  * \brief Build syntax information for an item
1239  * \param node  The syntax node to parse
1240  * \param type  The source type
1241  * \param name  The name of the item that the syntax describes
1242  *
1243  * \note This method exists for when you already have the node.  This
1244  * prevents having to lock the documentation tree twice
1245  *
1246  * \returns A malloc'd character pointer to the syntax of the item
1247  * \returns NULL on failure
1248  *
1249  * \since 11
1250  */
1251 static char *_ast_xmldoc_build_syntax(struct ast_xml_node *root_node, const char *type, const char *name)
1252 {
1253         char *syntax = NULL;
1254         struct ast_xml_node *node = root_node;
1255
1256         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1257                 if (!strcasecmp(ast_xml_node_get_name(node), "syntax")) {
1258                         break;
1259                 }
1260         }
1261
1262         switch (xmldoc_get_syntax_type(type)) {
1263         case FUNCTION_SYNTAX:
1264                 syntax = xmldoc_get_syntax_fun(node, name, "parameter", 1, 1);
1265                 break;
1266         case COMMAND_SYNTAX:
1267                 syntax = xmldoc_get_syntax_cmd(node, name, 1);
1268                 break;
1269         case MANAGER_SYNTAX:
1270                 syntax = xmldoc_get_syntax_manager(node, name, "Action");
1271                 break;
1272         case MANAGER_EVENT_SYNTAX:
1273                 syntax = xmldoc_get_syntax_manager(node, name, "Event");
1274                 break;
1275         case CONFIG_OPTION_SYNTAX:
1276                 syntax = xmldoc_get_syntax_config_option(root_node, name);
1277                 break;
1278         case CONFIG_OBJECT_SYNTAX:
1279                 syntax = xmldoc_get_syntax_config_object(node, name);
1280                 break;
1281         default:
1282                 syntax = xmldoc_get_syntax_fun(node, name, "parameter", 1, 1);
1283         }
1284
1285         return syntax;
1286 }
1287
1288 char *ast_xmldoc_build_syntax(const char *type, const char *name, const char *module)
1289 {
1290         struct ast_xml_node *node;
1291
1292         node = xmldoc_get_node(type, name, module, documentation_language);
1293         if (!node) {
1294                 return NULL;
1295         }
1296
1297         return _ast_xmldoc_build_syntax(node, type, name);
1298 }
1299
1300 /*! \internal
1301  *  \brief Parse common internal elements.  This includes paragraphs, special
1302  *         tags, and information nodes.
1303  *  \param node The element to parse
1304  *  \param tabs Add this string before the content of the parsed element.
1305  *  \param posttabs Add this string after the content of the parsed element.
1306  *  \param buffer This must be an already allocated ast_str. It will be used to
1307  *                store the result (if something has already been placed in the
1308  *                buffer, the parsed elements will be appended)
1309  *  \retval 1 if any data was appended to the buffer
1310  *  \retval 2 if the data appended to the buffer contained a text paragraph
1311  *  \retval 0 if no data was appended to the buffer
1312  */
1313 static int xmldoc_parse_common_elements(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer)
1314 {
1315         return (xmldoc_parse_para(node, tabs, posttabs, buffer)
1316                 || xmldoc_parse_specialtags(node, tabs, posttabs, buffer)
1317                 || xmldoc_parse_info(node, tabs, posttabs, buffer));
1318 }
1319
1320 /*! \internal
1321  *  \brief Parse a <para> element.
1322  *  \param node The <para> element pointer.
1323  *  \param tabs Added this string before the content of the <para> element.
1324  *  \param posttabs Added this string after the content of the <para> element.
1325  *  \param buffer This must be an already allocated ast_str. It will be used
1326  *         to store the result (if already has something it will be appended to the current
1327  *         string).
1328  *  \retval 1 If 'node' is a named 'para'.
1329  *  \retval 2 If data is appended in buffer.
1330  *  \retval 0 on error.
1331  */
1332 static int xmldoc_parse_para(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer)
1333 {
1334         const char *tmptext;
1335         struct ast_xml_node *tmp;
1336         int ret = 0;
1337         struct ast_str *tmpstr;
1338
1339         if (!node || !ast_xml_node_get_children(node)) {
1340                 return ret;
1341         }
1342
1343         if (strcasecmp(ast_xml_node_get_name(node), "para")) {
1344                 return ret;
1345         }
1346
1347         ast_str_append(buffer, 0, "%s", tabs);
1348
1349         ret = 1;
1350
1351         for (tmp = ast_xml_node_get_children(node); tmp; tmp = ast_xml_node_get_next(tmp)) {
1352                 /* Get the text inside the <para> element and append it to buffer. */
1353                 tmptext = ast_xml_get_text(tmp);
1354                 if (tmptext) {
1355                         /* Strip \n etc. */
1356                         xmldoc_string_cleanup(tmptext, &tmpstr, 0);
1357                         ast_xml_free_text(tmptext);
1358                         if (tmpstr) {
1359                                 if (strcasecmp(ast_xml_node_get_name(tmp), "text")) {
1360                                         ast_str_append(buffer, 0, "<%s>%s</%s>", ast_xml_node_get_name(tmp),
1361                                                         ast_str_buffer(tmpstr), ast_xml_node_get_name(tmp));
1362                                 } else {
1363                                         ast_str_append(buffer, 0, "%s", ast_str_buffer(tmpstr));
1364                                 }
1365                                 ast_free(tmpstr);
1366                                 ret = 2;
1367                         }
1368                 }
1369         }
1370
1371         ast_str_append(buffer, 0, "%s", posttabs);
1372
1373         return ret;
1374 }
1375
1376 /*! \internal
1377  *  \brief Parse special elements defined in 'struct special_tags' special elements must have a <para> element inside them.
1378  *  \param fixnode special tag node pointer.
1379  *  \param tabs put tabs before printing the node content.
1380  *  \param posttabs put posttabs after printing node content.
1381  *  \param buffer Output buffer, the special tags will be appended here.
1382  *  \retval 0 if no special element is parsed.
1383  *  \retval 1 if a special element is parsed (data is appended to buffer).
1384  *  \retval 2 if a special element is parsed and also a <para> element is parsed inside the specialtag.
1385  */
1386 static int xmldoc_parse_specialtags(struct ast_xml_node *fixnode, const char *tabs, const char *posttabs, struct ast_str **buffer)
1387 {
1388         struct ast_xml_node *node = fixnode;
1389         int ret = 0, i, count = 0;
1390
1391         if (!node || !ast_xml_node_get_children(node)) {
1392                 return ret;
1393         }
1394
1395         for (i = 0; i < ARRAY_LEN(special_tags); i++) {
1396                 if (strcasecmp(ast_xml_node_get_name(node), special_tags[i].tagname)) {
1397                         continue;
1398                 }
1399
1400                 ret = 1;
1401                 /* This is a special tag. */
1402
1403                 /* concat data */
1404                 if (!ast_strlen_zero(special_tags[i].init)) {
1405                         ast_str_append(buffer, 0, "%s%s", tabs, special_tags[i].init);
1406                 }
1407
1408                 /* parse <para> elements inside special tags. */
1409                 for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1410                         /* first <para> just print it without tabs at the begining. */
1411                         if ((xmldoc_parse_para(node, (!count ? "" : tabs), posttabs, buffer) == 2)
1412                                 || (xmldoc_parse_info(node, (!count ? "": tabs), posttabs, buffer) == 2)) {
1413                                 ret = 2;
1414                         }
1415                 }
1416
1417                 if (!ast_strlen_zero(special_tags[i].end)) {
1418                         ast_str_append(buffer, 0, "%s%s", special_tags[i].end, posttabs);
1419                 }
1420
1421                 break;
1422         }
1423
1424         return ret;
1425 }
1426
1427 /*! \internal
1428  *  \brief Parse an 'info' tag inside an element.
1429  *  \param node A pointer to the 'info' xml node.
1430  *  \param tabs A string to be appended at the beginning of each line being printed
1431  *              inside 'buffer'
1432  *  \param posttabs Add this string after the content of the <para> element, if one exists
1433  *  \param String buffer to put values found inide the info element.
1434  *  \ret 2 if the information contained a para element, and it returned a value of 2
1435  *  \ret 1 if information was put into the buffer
1436  *  \ret 0 if no information was put into the buffer or error
1437  */
1438 static int xmldoc_parse_info(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer)
1439 {
1440         const char *tech;
1441         char *internaltabs;
1442         int internal_ret;
1443         int ret = 0;
1444
1445         if (strcasecmp(ast_xml_node_get_name(node), "info")) {
1446                 return ret;
1447         }
1448
1449         ast_asprintf(&internaltabs, "%s    ", tabs);
1450         if (!internaltabs) {
1451                 return ret;
1452         }
1453
1454         tech = ast_xml_get_attribute(node, "tech");
1455         if (tech) {
1456                 ast_str_append(buffer, 0, "%s<note>Technology: %s</note>\n", internaltabs, tech);
1457                 ast_xml_free_attr(tech);
1458         }
1459
1460         ret = 1;
1461
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), "enumlist")) {
1464                         xmldoc_parse_enumlist(node, internaltabs, buffer);
1465                 } else if ((internal_ret = xmldoc_parse_common_elements(node, internaltabs, posttabs, buffer))) {
1466                         if (internal_ret > ret) {
1467                                 ret = internal_ret;
1468                         }
1469                 }
1470         }
1471         ast_free(internaltabs);
1472
1473         return ret;
1474 }
1475
1476 /*! \internal
1477  *  \brief Parse an <argument> element from the xml documentation.
1478  *  \param fixnode Pointer to the 'argument' xml node.
1479  *  \param insideparameter If we are parsing an <argument> inside a <parameter>.
1480  *  \param paramtabs pre tabs if we are inside a parameter element.
1481  *  \param tabs What to be printed before the argument name.
1482  *  \param buffer Output buffer to put values found inside the <argument> element.
1483  *  \retval 1 If there is content inside the argument.
1484  *  \retval 0 If the argument element is not parsed, or there is no content inside it.
1485  */
1486 static int xmldoc_parse_argument(struct ast_xml_node *fixnode, int insideparameter, const char *paramtabs, const char *tabs, struct ast_str **buffer)
1487 {
1488         struct ast_xml_node *node = fixnode;
1489         const char *argname;
1490         int count = 0, ret = 0;
1491
1492         if (!node || !ast_xml_node_get_children(node)) {
1493                 return ret;
1494         }
1495
1496         /* Print the argument names */
1497         argname = ast_xml_get_attribute(node, "name");
1498         if (!argname) {
1499                 return 0;
1500         }
1501         if (xmldoc_has_inside(node, "para") || xmldoc_has_inside(node, "info") || xmldoc_has_specialtags(node)) {
1502                 ast_str_append(buffer, 0, "%s%s%s", tabs, argname, (insideparameter ? "\n" : ""));
1503                 ast_xml_free_attr(argname);
1504         } else {
1505                 ast_xml_free_attr(argname);
1506                 return 0;
1507         }
1508
1509         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1510                 if (xmldoc_parse_common_elements(node, (insideparameter ? paramtabs : (!count ? " - " : tabs)), "\n", buffer) == 2) {
1511                         count++;
1512                         ret = 1;
1513                 }
1514         }
1515
1516         return ret;
1517 }
1518
1519 /*! \internal
1520  *  \brief Parse a <variable> node inside a <variablelist> node.
1521  *  \param node The variable node to parse.
1522  *  \param tabs A string to be appended at the begining of the output that will be stored
1523  *         in buffer.
1524  *  \param buffer This must be an already created ast_str. It will be used
1525  *         to store the result (if already has something it will be appended to the current
1526  *         string).
1527  *  \retval 0 if no data is appended.
1528  *  \retval 1 if data is appended.
1529  */
1530 static int xmldoc_parse_variable(struct ast_xml_node *node, const char *tabs, struct ast_str **buffer)
1531 {
1532         struct ast_xml_node *tmp;
1533         const char *valname;
1534         const char *tmptext;
1535         struct ast_str *cleanstr;
1536         int ret = 0, printedpara=0;
1537
1538         for (tmp = ast_xml_node_get_children(node); tmp; tmp = ast_xml_node_get_next(tmp)) {
1539                 if (xmldoc_parse_common_elements(tmp, (ret ? tabs : ""), "\n", buffer)) {
1540                         printedpara = 1;
1541                         continue;
1542                 }
1543
1544                 if (strcasecmp(ast_xml_node_get_name(tmp), "value")) {
1545                         continue;
1546                 }
1547
1548                 /* Parse a <value> tag only. */
1549                 if (!printedpara) {
1550                         ast_str_append(buffer, 0, "\n");
1551                         printedpara = 1;
1552                 }
1553                 /* Parse each <value name='valuename'>desciption</value> */
1554                 valname = ast_xml_get_attribute(tmp, "name");
1555                 if (valname) {
1556                         ret = 1;
1557                         ast_str_append(buffer, 0, "%s<value>%s</value>", tabs, valname);
1558                         ast_xml_free_attr(valname);
1559                 }
1560                 tmptext = ast_xml_get_text(tmp);
1561                 /* Check inside this node for any explanation about its meaning. */
1562                 if (tmptext) {
1563                         /* Cleanup text. */
1564                         xmldoc_string_cleanup(tmptext, &cleanstr, 1);
1565                         ast_xml_free_text(tmptext);
1566                         if (cleanstr && ast_str_strlen(cleanstr) > 0) {
1567                                 ast_str_append(buffer, 0, ":%s", ast_str_buffer(cleanstr));
1568                         }
1569                         ast_free(cleanstr);
1570                 }
1571                 ast_str_append(buffer, 0, "\n");
1572         }
1573
1574         return ret;
1575 }
1576
1577 /*! \internal
1578  *  \brief Parse a <variablelist> node and put all the output inside 'buffer'.
1579  *  \param node The variablelist node pointer.
1580  *  \param tabs A string to be appended at the begining of the output that will be stored
1581  *         in buffer.
1582  *  \param buffer This must be an already created ast_str. It will be used
1583  *         to store the result (if already has something it will be appended to the current
1584  *         string).
1585  *  \retval 1 If a <variablelist> element is parsed.
1586  *  \retval 0 On error.
1587  */
1588 static int xmldoc_parse_variablelist(struct ast_xml_node *node, const char *tabs, struct ast_str **buffer)
1589 {
1590         struct ast_xml_node *tmp;
1591         const char *varname;
1592         char *vartabs;
1593         int ret = 0;
1594
1595         if (!node || !ast_xml_node_get_children(node)) {
1596                 return ret;
1597         }
1598
1599         if (strcasecmp(ast_xml_node_get_name(node), "variablelist")) {
1600                 return ret;
1601         }
1602
1603         /* use this spacing (add 4 spaces) inside a variablelist node. */
1604         if (ast_asprintf(&vartabs, "%s    ", tabs) < 0) {
1605                 return ret;
1606         }
1607         for (tmp = ast_xml_node_get_children(node); tmp; tmp = ast_xml_node_get_next(tmp)) {
1608                 /* We can have a <para> element inside the variable list */
1609                 if (xmldoc_parse_common_elements(tmp, (ret ? tabs : ""), "\n", buffer)) {
1610                         ret = 1;
1611                         continue;
1612                 }
1613
1614                 if (!strcasecmp(ast_xml_node_get_name(tmp), "variable")) {
1615                         /* Store the variable name in buffer. */
1616                         varname = ast_xml_get_attribute(tmp, "name");
1617                         if (varname) {
1618                                 ast_str_append(buffer, 0, "%s<variable>%s</variable>: ", tabs, varname);
1619                                 ast_xml_free_attr(varname);
1620                                 /* Parse the <variable> possible values. */
1621                                 xmldoc_parse_variable(tmp, vartabs, buffer);
1622                                 ret = 1;
1623                         }
1624                 }
1625         }
1626
1627         ast_free(vartabs);
1628
1629         return ret;
1630 }
1631
1632 /*!
1633  * \internal
1634  * \brief Build seealso information for an item
1635  * \param node  The seealso node to parse
1636  *
1637  * \note This method exists for when you already have the node.  This
1638  * prevents having to lock the documentation tree twice
1639  *
1640  * \returns A malloc'd character pointer to the seealso information of the item
1641  * \returns NULL on failure
1642  *
1643  * \since 11
1644  */
1645 static char *_ast_xmldoc_build_seealso(struct ast_xml_node *node)
1646 {
1647         char *output;
1648         struct ast_str *outputstr;
1649         const char *typename;
1650         const char *content;
1651         int first = 1;
1652
1653         /* Find the <see-also> node. */
1654         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1655                 if (!strcasecmp(ast_xml_node_get_name(node), "see-also")) {
1656                         break;
1657                 }
1658         }
1659
1660         if (!node || !ast_xml_node_get_children(node)) {
1661                 /* we couldnt find a <see-also> node. */
1662                 return NULL;
1663         }
1664
1665         /* prepare the output string. */
1666         outputstr = ast_str_create(128);
1667         if (!outputstr) {
1668                 return NULL;
1669         }
1670
1671         /* get into the <see-also> node. */
1672         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1673                 if (strcasecmp(ast_xml_node_get_name(node), "ref")) {
1674                         continue;
1675                 }
1676
1677                 /* parse the <ref> node. 'type' attribute is required. */
1678                 typename = ast_xml_get_attribute(node, "type");
1679                 if (!typename) {
1680                         continue;
1681                 }
1682                 content = ast_xml_get_text(node);
1683                 if (!content) {
1684                         ast_xml_free_attr(typename);
1685                         continue;
1686                 }
1687                 if (!strcasecmp(typename, "application")) {
1688                         ast_str_append(&outputstr, 0, "%s%s()", (first ? "" : ", "), content);
1689                 } else if (!strcasecmp(typename, "function")) {
1690                         ast_str_append(&outputstr, 0, "%s%s", (first ? "" : ", "), content);
1691                 } else if (!strcasecmp(typename, "astcli")) {
1692                         ast_str_append(&outputstr, 0, "%s<astcli>%s</astcli>", (first ? "" : ", "), content);
1693                 } else {
1694                         ast_str_append(&outputstr, 0, "%s%s", (first ? "" : ", "), content);
1695                 }
1696                 first = 0;
1697                 ast_xml_free_text(content);
1698                 ast_xml_free_attr(typename);
1699         }
1700
1701         output = ast_strdup(ast_str_buffer(outputstr));
1702         ast_free(outputstr);
1703
1704         return output;
1705 }
1706
1707 char *ast_xmldoc_build_seealso(const char *type, const char *name, const char *module)
1708 {
1709         char *output;
1710         struct ast_xml_node *node;
1711
1712         if (ast_strlen_zero(type) || ast_strlen_zero(name)) {
1713                 return NULL;
1714         }
1715
1716         /* get the application/function root node. */
1717         node = xmldoc_get_node(type, name, module, documentation_language);
1718         if (!node || !ast_xml_node_get_children(node)) {
1719                 return NULL;
1720         }
1721
1722         output = _ast_xmldoc_build_seealso(node);
1723
1724         return output;
1725 }
1726
1727 /*! \internal
1728  *  \brief Parse a <enum> node.
1729  *  \brief fixnode An ast_xml_node pointer to the <enum> node.
1730  *  \bried buffer The output buffer.
1731  *  \retval 0 if content is not found inside the enum element (data is not appended to buffer).
1732  *  \retval 1 if content is found and data is appended to buffer.
1733  */
1734 static int xmldoc_parse_enum(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
1735 {
1736         struct ast_xml_node *node = fixnode;
1737         int ret = 0;
1738         char *optiontabs;
1739
1740         if (ast_asprintf(&optiontabs, "%s    ", tabs) < 0) {
1741                 return ret;
1742         }
1743
1744         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1745                 if (xmldoc_parse_common_elements(node, (ret ? tabs : " - "), "\n", buffer)) {
1746                         ret = 1;
1747                 }
1748
1749                 xmldoc_parse_enumlist(node, optiontabs, buffer);
1750         }
1751
1752         ast_free(optiontabs);
1753
1754         return ret;
1755 }
1756
1757 /*! \internal
1758  *  \brief Parse a <enumlist> node.
1759  *  \param fixnode As ast_xml pointer to the <enumlist> node.
1760  *  \param buffer The ast_str output buffer.
1761  *  \retval 0 if no <enumlist> node was parsed.
1762  *  \retval 1 if a <enumlist> node was parsed.
1763  */
1764 static int xmldoc_parse_enumlist(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
1765 {
1766         struct ast_xml_node *node = fixnode;
1767         const char *enumname;
1768         int ret = 0;
1769
1770         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1771                 if (strcasecmp(ast_xml_node_get_name(node), "enum")) {
1772                         continue;
1773                 }
1774
1775                 enumname = ast_xml_get_attribute(node, "name");
1776                 if (enumname) {
1777                         ast_str_append(buffer, 0, "%s<enum>%s</enum>", tabs, enumname);
1778                         ast_xml_free_attr(enumname);
1779
1780                         /* parse only enum elements inside a enumlist node. */
1781                         if ((xmldoc_parse_enum(node, tabs, buffer))) {
1782                                 ret = 1;
1783                         } else {
1784                                 ast_str_append(buffer, 0, "\n");
1785                         }
1786                 }
1787         }
1788         return ret;
1789 }
1790
1791 /*! \internal
1792  *  \brief Parse an <option> node.
1793  *  \param fixnode An ast_xml pointer to the <option> node.
1794  *  \param tabs A string to be appended at the begining of each line being added to the
1795  *              buffer string.
1796  *  \param buffer The output buffer.
1797  *  \retval 0 if no option node is parsed.
1798  *  \retval 1 if an option node is parsed.
1799  */
1800 static int xmldoc_parse_option(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
1801 {
1802         struct ast_xml_node *node;
1803         int ret = 0;
1804         char *optiontabs;
1805
1806         if (ast_asprintf(&optiontabs, "%s    ", tabs) < 0) {
1807                 return ret;
1808         }
1809         for (node = ast_xml_node_get_children(fixnode); node; node = ast_xml_node_get_next(node)) {
1810                 if (!strcasecmp(ast_xml_node_get_name(node), "argument")) {
1811                         /* if this is the first data appended to buffer, print a \n*/
1812                         if (!ret && ast_xml_node_get_children(node)) {
1813                                 /* print \n */
1814                                 ast_str_append(buffer, 0, "\n");
1815                         }
1816                         if (xmldoc_parse_argument(node, 0, NULL, optiontabs, buffer)) {
1817                                 ret = 1;
1818                         }
1819                         continue;
1820                 }
1821
1822                 if (xmldoc_parse_common_elements(node, (ret ? tabs :  ""), "\n", buffer)) {
1823                         ret = 1;
1824                 }
1825
1826                 xmldoc_parse_variablelist(node, optiontabs, buffer);
1827
1828                 xmldoc_parse_enumlist(node, optiontabs, buffer);
1829         }
1830         ast_free(optiontabs);
1831
1832         return ret;
1833 }
1834
1835 /*! \internal
1836  *  \brief Parse an <optionlist> element from the xml documentation.
1837  *  \param fixnode Pointer to the optionlist xml node.
1838  *  \param tabs A string to be appended at the begining of each line being added to the
1839  *              buffer string.
1840  *  \param buffer Output buffer to put what is inside the optionlist tag.
1841  */
1842 static void xmldoc_parse_optionlist(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
1843 {
1844         struct ast_xml_node *node;
1845         const char *optname, *hasparams;
1846         char *optionsyntax;
1847         int optparams;
1848
1849         for (node = ast_xml_node_get_children(fixnode); node; node = ast_xml_node_get_next(node)) {
1850                 /* Start appending every option tag. */
1851                 if (strcasecmp(ast_xml_node_get_name(node), "option")) {
1852                         continue;
1853                 }
1854
1855                 /* Get the option name. */
1856                 optname = ast_xml_get_attribute(node, "name");
1857                 if (!optname) {
1858                         continue;
1859                 }
1860
1861                 optparams = 1;
1862                 hasparams = ast_xml_get_attribute(node, "hasparams");
1863                 if (hasparams && !strcasecmp(hasparams, "optional")) {
1864                         optparams = 2;
1865                 }
1866
1867                 optionsyntax = xmldoc_get_syntax_fun(node, optname, "argument", 0, optparams);
1868                 if (!optionsyntax) {
1869                         ast_xml_free_attr(optname);
1870                         ast_xml_free_attr(hasparams);
1871                         continue;
1872                 }
1873
1874                 ast_str_append(buffer, 0, "%s%s: ", tabs, optionsyntax);
1875
1876                 if (!xmldoc_parse_option(node, tabs, buffer)) {
1877                         ast_str_append(buffer, 0, "\n");
1878                 }
1879                 ast_str_append(buffer, 0, "\n");
1880                 ast_xml_free_attr(optname);
1881                 ast_xml_free_attr(hasparams);
1882                 ast_free(optionsyntax);
1883         }
1884 }
1885
1886 /*! \internal
1887  *  \brief Parse a 'parameter' tag inside a syntax element.
1888  *  \param fixnode A pointer to the 'parameter' xml node.
1889  *  \param tabs A string to be appended at the beginning of each line being printed inside
1890  *              'buffer'.
1891  *  \param buffer String buffer to put values found inside the parameter element.
1892  */
1893 static void xmldoc_parse_parameter(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
1894 {
1895         const char *paramname;
1896         struct ast_xml_node *node = fixnode;
1897         int hasarguments, printed = 0;
1898         char *internaltabs;
1899
1900         if (strcasecmp(ast_xml_node_get_name(node), "parameter")) {
1901                 return;
1902         }
1903
1904         hasarguments = xmldoc_has_inside(node, "argument");
1905         if (!(paramname = ast_xml_get_attribute(node, "name"))) {
1906                 /* parameter MUST have an attribute name. */
1907                 return;
1908         }
1909
1910         if (ast_asprintf(&internaltabs, "%s    ", tabs) < 0) {
1911                 ast_xml_free_attr(paramname);
1912                 return;
1913         }
1914
1915         if (!hasarguments && xmldoc_has_nodes(node)) {
1916                 ast_str_append(buffer, 0, "%s\n", paramname);
1917                 ast_xml_free_attr(paramname);
1918                 printed = 1;
1919         }
1920
1921         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1922                 if (!strcasecmp(ast_xml_node_get_name(node), "optionlist")) {
1923                         xmldoc_parse_optionlist(node, internaltabs, buffer);
1924                 } else if (!strcasecmp(ast_xml_node_get_name(node), "enumlist")) {
1925                         xmldoc_parse_enumlist(node, internaltabs, buffer);
1926                 } else if (!strcasecmp(ast_xml_node_get_name(node), "argument")) {
1927                         xmldoc_parse_argument(node, 1, internaltabs, (!hasarguments ? "        " : ""), buffer);
1928                 } else if (!strcasecmp(ast_xml_node_get_name(node), "para")) {
1929                         if (!printed) {
1930                                 ast_str_append(buffer, 0, "%s\n", paramname);
1931                                 ast_xml_free_attr(paramname);
1932                                 printed = 1;
1933                         }
1934                         if (xmldoc_parse_para(node, internaltabs, "\n", buffer)) {
1935                                 /* If anything ever goes in below this condition before the continue below,
1936                                  * we should probably continue immediately. */
1937                                 continue;
1938                         }
1939                         continue;
1940                 } else if (!strcasecmp(ast_xml_node_get_name(node), "info")) {
1941                         if (!printed) {
1942                                 ast_str_append(buffer, 0, "%s\n", paramname);
1943                                 ast_xml_free_attr(paramname);
1944                                 printed = 1;
1945                         }
1946                         if (xmldoc_parse_info(node, internaltabs, "\n", buffer)) {
1947                                 /* If anything ever goes in below this condition before the continue below,
1948                                  * we should probably continue immediately. */
1949                                 continue;
1950                         }
1951                         continue;
1952                 } else if ((xmldoc_parse_specialtags(node, internaltabs, "\n", buffer))) {
1953                         continue;
1954                 }
1955         }
1956         if (!printed) {
1957                 ast_xml_free_attr(paramname);
1958         }
1959         ast_free(internaltabs);
1960 }
1961
1962 /*!
1963  * \internal
1964  * \brief Build the arguments for an item
1965  * \param node  The arguments node to parse
1966  *
1967  * \note This method exists for when you already have the node.  This
1968  * prevents having to lock the documentation tree twice
1969  *
1970  * \returns A malloc'd character pointer to the arguments for the item
1971  * \returns NULL on failure
1972  *
1973  * \since 11
1974  */
1975 static char *_ast_xmldoc_build_arguments(struct ast_xml_node *node)
1976 {
1977         char *retstr = NULL;
1978         struct ast_str *ret;
1979
1980         ret = ast_str_create(128);
1981         if (!ret) {
1982                 return NULL;
1983         }
1984
1985         /* Find the syntax field. */
1986         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1987                 if (!strcasecmp(ast_xml_node_get_name(node), "syntax")) {
1988                         break;
1989                 }
1990         }
1991
1992         if (!node || !ast_xml_node_get_children(node)) {
1993                 /* We couldn't find the syntax node. */
1994                 ast_free(ret);
1995                 return NULL;
1996         }
1997
1998         for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
1999                 xmldoc_parse_parameter(node, "", &ret);
2000         }
2001
2002         if (ast_str_strlen(ret) > 0) {
2003                 /* remove last '\n' */
2004                 char *buf = ast_str_buffer(ret);
2005                 if (buf[ast_str_strlen(ret) - 1] == '\n') {
2006                         ast_str_truncate(ret, -1);
2007                 }
2008                 retstr = ast_strdup(ast_str_buffer(ret));
2009         }
2010         ast_free(ret);
2011
2012         return retstr;
2013 }
2014
2015 char *ast_xmldoc_build_arguments(const char *type, const char *name, const char *module)
2016 {
2017         struct ast_xml_node *node;
2018
2019         if (ast_strlen_zero(type) || ast_strlen_zero(name)) {
2020                 return NULL;
2021         }
2022
2023         node = xmldoc_get_node(type, name, module, documentation_language);
2024
2025         if (!node || !ast_xml_node_get_children(node)) {
2026                 return NULL;
2027         }
2028
2029         return _ast_xmldoc_build_arguments(node);
2030 }
2031
2032 /*! \internal
2033  *  \brief Return the string within a node formatted with <para> and <variablelist> elements.
2034  *  \param node Parent node where content resides.
2035  *  \param raw If set, return the node's content without further processing.
2036  *  \param raw_wrap Wrap raw text.
2037  *  \retval NULL on error
2038  *  \retval Node content on success.
2039  */
2040 static struct ast_str *xmldoc_get_formatted(struct ast_xml_node *node, int raw_output, int raw_wrap)
2041 {
2042         struct ast_xml_node *tmp;
2043         const char *notcleanret, *tmpstr;
2044         struct ast_str *ret;
2045
2046         if (raw_output) {
2047                 /* xmldoc_string_cleanup will allocate the ret object */
2048                 notcleanret = ast_xml_get_text(node);
2049                 tmpstr = notcleanret;
2050                 xmldoc_string_cleanup(ast_skip_blanks(notcleanret), &ret, 0);
2051                 ast_xml_free_text(tmpstr);
2052         } else {
2053                 ret = ast_str_create(128);
2054                 for (tmp = ast_xml_node_get_children(node); tmp; tmp = ast_xml_node_get_next(tmp)) {
2055                         /* if found, parse a <para> element. */
2056                         if (xmldoc_parse_common_elements(tmp, "", "\n", &ret)) {
2057                                 continue;
2058                         }
2059                         /* if found, parse a <variablelist> element. */
2060                         xmldoc_parse_variablelist(tmp, "", &ret);
2061                         xmldoc_parse_enumlist(tmp, "    ", &ret);
2062                 }
2063                 /* remove last '\n' */
2064                 /* XXX Don't modify ast_str internals manually */
2065                 tmpstr = ast_str_buffer(ret);
2066                 if (tmpstr[ast_str_strlen(ret) - 1] == '\n') {
2067                         ast_str_truncate(ret, -1);
2068                 }
2069         }
2070         return ret;
2071 }
2072
2073 /*!
2074  *  \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree node
2075  *  \param node The node to obtain the information from
2076  *  \param var Name of field to return (synopsis, description, etc).
2077  *  \param raw Field only contains text, no other elements inside it.
2078  *  \retval NULL On error.
2079  *  \retval Field text content on success.
2080  *  \since 11
2081  */
2082 static char *_xmldoc_build_field(struct ast_xml_node *node, const char *var, int raw)
2083 {
2084         char *ret = NULL;
2085         struct ast_str *formatted;
2086
2087         node = ast_xml_find_element(ast_xml_node_get_children(node), var, NULL, NULL);
2088
2089         if (!node || !ast_xml_node_get_children(node)) {
2090                 ast_debug(1, "Cannot find variable '%s' in tree\n", var);
2091                 return ret;
2092         }
2093
2094         formatted = xmldoc_get_formatted(node, raw, raw);
2095         if (ast_str_strlen(formatted) > 0) {
2096                 ret = ast_strdup(ast_str_buffer(formatted));
2097         }
2098         ast_free(formatted);
2099
2100         return ret;
2101 }
2102
2103 /*!
2104  * \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree
2105  * \param type Type of element (application, function, ...).
2106  * \param name Name of element (Dial, Echo, Playback, ...).
2107  * \param var Name of field to return (synopsis, description, etc).
2108  * \param module
2109  * \param raw Field only contains text, no other elements inside it.
2110  * \retval NULL On error.
2111  * \retval Field text content on success.
2112  */
2113 static char *xmldoc_build_field(const char *type, const char *name, const char *module, const char *var, int raw)
2114 {
2115         struct ast_xml_node *node;
2116
2117         if (ast_strlen_zero(type) || ast_strlen_zero(name)) {
2118                 ast_log(LOG_ERROR, "Tried to look in XML tree with faulty values.\n");
2119                 return NULL;
2120         }
2121
2122         node = xmldoc_get_node(type, name, module, documentation_language);
2123
2124         if (!node) {
2125                 ast_log(LOG_WARNING, "Couldn't find %s %s in XML documentation\n", type, name);
2126                 return NULL;
2127         }
2128
2129         return _xmldoc_build_field(node, var, raw);
2130 }
2131
2132 /* \internal
2133  * \brief Build the synopsis for an item
2134  * \param node The synopsis node
2135  *
2136  * \note This method exists for when you already have the node.  This
2137  * prevents having to lock the documentation tree twice
2138  *
2139  * \returns A malloc'd character pointer to the synopsis information
2140  * \returns NULL on failure
2141  * \since 11
2142  */
2143 static char *_ast_xmldoc_build_synopsis(struct ast_xml_node *node)
2144 {
2145         return _xmldoc_build_field(node, "synopsis", 1);
2146 }
2147
2148 char *ast_xmldoc_build_synopsis(const char *type, const char *name, const char *module)
2149 {
2150         return xmldoc_build_field(type, name, module, "synopsis", 1);
2151 }
2152
2153 /*!
2154  * \internal
2155  * \brief Build the descripton for an item
2156  * \param node  The description node to parse
2157  *
2158  * \note This method exists for when you already have the node.  This
2159  * prevents having to lock the documentation tree twice
2160  *
2161  * \returns A malloc'd character pointer to the arguments for the item
2162  * \returns NULL on failure
2163  * \since 11
2164  */
2165 static char *_ast_xmldoc_build_description(struct ast_xml_node *node)
2166 {
2167         return _xmldoc_build_field(node, "description", 0);
2168 }
2169
2170 char *ast_xmldoc_build_description(const char *type, const char *name, const char *module)
2171 {
2172         return xmldoc_build_field(type, name, module, "description", 0);
2173 }
2174
2175 /*! \internal \brief ast_xml_doc_item ao2 destructor
2176  * \since 11
2177  */
2178 static void ast_xml_doc_item_destructor(void *obj)
2179 {
2180         struct ast_xml_doc_item *doc = obj;
2181
2182         if (!doc) {
2183                 return;
2184         }
2185
2186         ast_free(doc->syntax);
2187         ast_free(doc->seealso);
2188         ast_free(doc->arguments);
2189         ast_free(doc->synopsis);
2190         ast_free(doc->description);
2191         ast_string_field_free_memory(doc);
2192
2193         if (doc->next) {
2194                 ao2_ref(doc->next, -1);
2195                 doc->next = NULL;
2196         }
2197 }
2198
2199 /*! \internal
2200  * \brief Create an ao2 ref counted ast_xml_doc_item
2201  * \param name The name of the item
2202  * \param type The item's source type
2203  * \since 11
2204  */
2205 static struct ast_xml_doc_item *ast_xml_doc_item_alloc(const char *name, const char *type)
2206 {
2207         struct ast_xml_doc_item *item;
2208
2209         if (!(item = ao2_alloc(sizeof(*item), ast_xml_doc_item_destructor))) {
2210                 ast_log(AST_LOG_ERROR, "Failed to allocate memory for ast_xml_doc_item instance\n");
2211                 return NULL;
2212         }
2213
2214         if (   !(item->syntax = ast_str_create(128))
2215                 || !(item->seealso = ast_str_create(128))
2216                 || !(item->arguments = ast_str_create(128))
2217                 || !(item->synopsis = ast_str_create(128))
2218                 || !(item->description = ast_str_create(128))) {
2219                 ast_log(AST_LOG_ERROR, "Failed to allocate strings for ast_xml_doc_item instance\n");
2220                 goto ast_xml_doc_item_failure;
2221         }
2222
2223         if (ast_string_field_init(item, 64)) {
2224                 ast_log(AST_LOG_ERROR, "Failed to initialize string field for ast_xml_doc_item instance\n");
2225                 goto ast_xml_doc_item_failure;
2226         }
2227         ast_string_field_set(item, name, name);
2228         ast_string_field_set(item, type, type);
2229
2230         return item;
2231
2232 ast_xml_doc_item_failure:
2233         ao2_ref(item, -1);
2234         return NULL;
2235 }
2236
2237 /*! \internal
2238  * \brief ao2 item hash function for ast_xml_doc_item
2239  * \since 11
2240  */
2241 static int ast_xml_doc_item_hash(const void *obj, const int flags)
2242 {
2243         const struct ast_xml_doc_item *item = obj;
2244         const char *name = (flags & OBJ_KEY) ? obj : item->name;
2245         return ast_str_case_hash(name);
2246 }
2247
2248 /*! \internal
2249  * \brief ao2 item comparison function for ast_xml_doc_item
2250  * \since 11
2251  */
2252 static int ast_xml_doc_item_cmp(void *obj, void *arg, int flags)
2253 {
2254         struct ast_xml_doc_item *left = obj;
2255         struct ast_xml_doc_item *right = arg;
2256         const char *match = (flags & OBJ_KEY) ? arg : right->name;
2257         return strcasecmp(left->name, match) ? 0 : (CMP_MATCH | CMP_STOP);
2258 }
2259
2260 /* \internal
2261  * \brief Build an XML documentation item
2262  * \param node The root node for the item
2263  * \param name The name of the item
2264  * \param type The item's source type
2265  *
2266  * \returns NULL on failure
2267  * \returns An ao2 ref counted object
2268  * \since 11
2269  */
2270 static struct ast_xml_doc_item *xmldoc_build_documentation_item(struct ast_xml_node *node, const char *name, const char *type)
2271 {
2272         struct ast_xml_doc_item *item;
2273         char *syntax;
2274         char *seealso;
2275         char *arguments;
2276         char *synopsis;
2277         char *description;
2278
2279         if (!(item = ast_xml_doc_item_alloc(name, type))) {
2280                 return NULL;
2281         }
2282         item->node = node;
2283
2284         syntax = _ast_xmldoc_build_syntax(node, type, name);
2285         seealso = _ast_xmldoc_build_seealso(node);
2286         arguments = _ast_xmldoc_build_arguments(node);
2287         synopsis = _ast_xmldoc_build_synopsis(node);
2288         description = _ast_xmldoc_build_description(node);
2289
2290         if (syntax) {
2291                 ast_str_set(&item->syntax, 0, "%s", syntax);
2292         }
2293         if (seealso) {
2294                 ast_str_set(&item->seealso, 0, "%s", seealso);
2295         }
2296         if (arguments) {
2297                 ast_str_set(&item->arguments, 0, "%s", arguments);
2298         }
2299         if (synopsis) {
2300                 ast_str_set(&item->synopsis, 0, "%s", synopsis);
2301         }
2302         if (description) {
2303                 ast_str_set(&item->description, 0, "%s", description);
2304         }
2305
2306         ast_free(syntax);
2307         ast_free(seealso);
2308         ast_free(arguments);
2309         ast_free(synopsis);
2310         ast_free(description);
2311
2312         return item;
2313 }
2314
2315 struct ast_xml_xpath_results *__attribute__((format(printf, 1, 2))) ast_xmldoc_query(const char *fmt, ...)
2316 {
2317         struct ast_xml_xpath_results *results = NULL;
2318         struct documentation_tree *doctree;
2319         RAII_VAR(struct ast_str *, xpath_str, ast_str_create(128), ast_free);
2320         va_list ap;
2321
2322         if (!xpath_str) {
2323                 return NULL;
2324         }
2325
2326         va_start(ap, fmt);
2327         ast_str_set_va(&xpath_str, 0, fmt, ap);
2328         va_end(ap);
2329
2330         AST_RWLIST_RDLOCK(&xmldoc_tree);
2331         AST_LIST_TRAVERSE(&xmldoc_tree, doctree, entry) {
2332                 if (!(results = ast_xml_query(doctree->doc, ast_str_buffer(xpath_str)))) {
2333                         continue;
2334                 }
2335                 break;
2336         }
2337         AST_RWLIST_UNLOCK(&xmldoc_tree);
2338
2339         return results;
2340 }
2341
2342 static void build_config_docs(struct ast_xml_node *cur, struct ast_xml_doc_item **tail)
2343 {
2344         struct ast_xml_node *iter;
2345         struct ast_xml_doc_item *item;
2346
2347         for (iter = ast_xml_node_get_children(cur); iter; iter = ast_xml_node_get_next(iter)) {
2348                 if (strncasecmp(ast_xml_node_get_name(iter), "config", 6)) {
2349                         continue;
2350                 }
2351                 /* Now add all of the child config-related items to the list */
2352                 if (!(item = xmldoc_build_documentation_item(iter, ast_xml_get_attribute(iter, "name"), ast_xml_node_get_name(iter)))) {
2353                         ast_log(LOG_ERROR, "Could not build documentation for '%s:%s'\n", ast_xml_node_get_name(iter), ast_xml_get_attribute(iter, "name"));
2354                         break;
2355                 }
2356                 if (!strcasecmp(ast_xml_node_get_name(iter), "configOption")) {
2357                         ast_string_field_set(item, ref, ast_xml_get_attribute(cur, "name"));
2358                 }
2359                 (*tail)->next = item;
2360                 *tail = (*tail)->next;
2361                 build_config_docs(iter, tail);
2362         }
2363 }
2364
2365 int ast_xmldoc_regenerate_doc_item(struct ast_xml_doc_item *item)
2366 {
2367         const char *name;
2368         char *syntax;
2369         char *seealso;
2370         char *arguments;
2371         char *synopsis;
2372         char *description;
2373
2374         if (!item || !item->node) {
2375                 return -1;
2376         }
2377
2378         name = ast_xml_get_attribute(item->node, "name");
2379         if (!name) {
2380                 return -1;
2381         }
2382
2383         syntax = _ast_xmldoc_build_syntax(item->node, item->type, name);
2384         seealso = _ast_xmldoc_build_seealso(item->node);
2385         arguments = _ast_xmldoc_build_arguments(item->node);
2386         synopsis = _ast_xmldoc_build_synopsis(item->node);
2387         description = _ast_xmldoc_build_description(item->node);
2388
2389         if (syntax) {
2390                 ast_str_set(&item->syntax, 0, "%s", syntax);
2391         }
2392         if (seealso) {
2393                 ast_str_set(&item->seealso, 0, "%s", seealso);
2394         }
2395         if (arguments) {
2396                 ast_str_set(&item->arguments, 0, "%s", arguments);
2397         }
2398         if (synopsis) {
2399                 ast_str_set(&item->synopsis, 0, "%s", synopsis);
2400         }
2401         if (description) {
2402                 ast_str_set(&item->description, 0, "%s", description);
2403         }
2404
2405         ast_free(syntax);
2406         ast_free(seealso);
2407         ast_free(arguments);
2408         ast_free(synopsis);
2409         ast_free(description);
2410         ast_xml_free_attr(name);
2411         return 0;
2412 }
2413
2414 struct ao2_container *ast_xmldoc_build_documentation(const char *type)
2415 {
2416         struct ao2_container *docs;
2417         struct ast_xml_doc_item *item = NULL, *root = NULL;
2418         struct ast_xml_node *node = NULL, *instance = NULL;
2419         struct documentation_tree *doctree;
2420         const char *name;
2421
2422         if (!(docs = ao2_container_alloc(127, ast_xml_doc_item_hash, ast_xml_doc_item_cmp))) {
2423                 ast_log(AST_LOG_ERROR, "Failed to create container for xml document item instances\n");
2424                 return NULL;
2425         }
2426
2427         AST_RWLIST_RDLOCK(&xmldoc_tree);
2428         AST_LIST_TRAVERSE(&xmldoc_tree, doctree, entry) {
2429                 /* the core xml documents have priority over thirdparty document. */
2430                 node = ast_xml_get_root(doctree->doc);
2431                 if (!node) {
2432                         break;
2433                 }
2434
2435                 for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
2436                         /* Ignore empty nodes or nodes that aren't of the type requested */
2437                         if (!ast_xml_node_get_children(node) || strcasecmp(ast_xml_node_get_name(node), type)) {
2438                                 continue;
2439                         }
2440                         name = ast_xml_get_attribute(node, "name");
2441                         if (!name) {
2442                                 continue;
2443                         }
2444
2445                         switch (xmldoc_get_syntax_type(type)) {
2446                         case MANAGER_EVENT_SYNTAX:
2447                                 for (instance = ast_xml_node_get_children(node); instance; instance = ast_xml_node_get_next(instance)) {
2448                                         struct ast_xml_doc_item *temp;
2449                                         if (!ast_xml_node_get_children(instance) || strcasecmp(ast_xml_node_get_name(instance), "managerEventInstance")) {
2450                                                 continue;
2451                                         }
2452                                         temp = xmldoc_build_documentation_item(instance, name, type);
2453                                         if (!temp) {
2454                                                 break;
2455                                         }
2456                                         if (!item) {
2457                                                 item = temp;
2458                                                 root = item;
2459                                         } else {
2460                                                 item->next = temp;
2461                                                 item = temp;
2462                                         }
2463                                 }
2464                                 item = root;
2465                                 break;
2466                         case CONFIG_INFO_SYNTAX:
2467                         {
2468                                 struct ast_xml_doc_item *tail;
2469                                 if (item || !ast_xml_node_get_children(node) || strcasecmp(ast_xml_node_get_name(node), "configInfo")) {
2470                                         break;
2471                                 }
2472                                 if (!(item = xmldoc_build_documentation_item(node, ast_xml_get_attribute(node, "name"), "configInfo"))) {
2473                                         break;
2474                                 }
2475                                 tail = item;
2476                                 build_config_docs(node, &tail);
2477                                 break;
2478                         }
2479                         default:
2480                                 item = xmldoc_build_documentation_item(node, name, type);
2481                         }
2482                         ast_xml_free_attr(name);
2483
2484                         if (item) {
2485                                 ao2_link(docs, item);
2486                                 ao2_t_ref(item, -1, "Dispose of creation ref");
2487                                 item = NULL;
2488                         }
2489                 }
2490         }
2491         AST_RWLIST_UNLOCK(&xmldoc_tree);
2492
2493         return docs;
2494 }
2495
2496 int ast_xmldoc_regenerate_doc_item(struct ast_xml_doc_item *item);
2497
2498
2499 #if !defined(HAVE_GLOB_NOMAGIC) || !defined(HAVE_GLOB_BRACE) || defined(DEBUG_NONGNU)
2500 static int xml_pathmatch(char *xmlpattern, int xmlpattern_maxlen, glob_t *globbuf)
2501 {
2502         int globret;
2503
2504         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/thirdparty/*-%s.xml",
2505                 ast_config_AST_DATA_DIR, documentation_language);
2506         if((globret = glob(xmlpattern, GLOB_NOCHECK, NULL, globbuf))) {
2507                 return globret;
2508         }
2509
2510         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/thirdparty/*-%.2s_??.xml",
2511                 ast_config_AST_DATA_DIR, documentation_language);
2512         if((globret = glob(xmlpattern, GLOB_APPEND | GLOB_NOCHECK, NULL, globbuf))) {
2513                 return globret;
2514         }
2515
2516         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/thirdparty/*-%s.xml",
2517                 ast_config_AST_DATA_DIR, default_documentation_language);
2518         if((globret = glob(xmlpattern, GLOB_APPEND | GLOB_NOCHECK, NULL, globbuf))) {
2519                 return globret;
2520         }
2521
2522         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/*-%s.xml",
2523                 ast_config_AST_DATA_DIR, documentation_language);
2524         if((globret = glob(xmlpattern, GLOB_APPEND | GLOB_NOCHECK, NULL, globbuf))) {
2525                 return globret;
2526         }
2527
2528         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/*-%.2s_??.xml",
2529                 ast_config_AST_DATA_DIR, documentation_language);
2530         if((globret = glob(xmlpattern, GLOB_APPEND | GLOB_NOCHECK, NULL, globbuf))) {
2531                 return globret;
2532         }
2533
2534         snprintf(xmlpattern, xmlpattern_maxlen, "%s/documentation/*-%s.xml",
2535                 ast_config_AST_DATA_DIR, default_documentation_language);
2536         globret = glob(xmlpattern, GLOB_APPEND | GLOB_NOCHECK, NULL, globbuf);
2537
2538         return globret;
2539 }
2540 #endif
2541
2542 static char *handle_dump_docs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2543 {
2544         struct documentation_tree *doctree;
2545         FILE *f;
2546
2547         switch (cmd) {
2548         case CLI_INIT:
2549                 e->command = "xmldoc dump";
2550                 e->usage =
2551                         "Usage: xmldoc dump <filename>\n"
2552                         "  Dump XML documentation to a file\n";
2553                 return NULL;
2554         case CLI_GENERATE:
2555                 return NULL;
2556         }
2557
2558         if (a->argc != 3) {
2559                 return CLI_SHOWUSAGE;
2560         }
2561         if (!(f = fopen(a->argv[2], "w"))) {
2562                 ast_log(LOG_ERROR, "Could not open file '%s': %s\n", a->argv[2], strerror(errno));
2563                 return CLI_FAILURE;
2564         }
2565         AST_RWLIST_RDLOCK(&xmldoc_tree);
2566         AST_LIST_TRAVERSE(&xmldoc_tree, doctree, entry) {
2567                 ast_xml_doc_dump_file(f, doctree->doc);
2568         }
2569         AST_RWLIST_UNLOCK(&xmldoc_tree);
2570         fclose(f);
2571         return CLI_SUCCESS;
2572 }
2573
2574 static struct ast_cli_entry cli_dump_xmldocs = AST_CLI_DEFINE(handle_dump_docs, "Dump the XML docs to the specified file");
2575
2576 /*! \brief Close and unload XML documentation. */
2577 static void xmldoc_unload_documentation(void)
2578 {
2579         struct documentation_tree *doctree;
2580
2581         ast_cli_unregister(&cli_dump_xmldocs);
2582
2583         AST_RWLIST_WRLOCK(&xmldoc_tree);
2584         while ((doctree = AST_RWLIST_REMOVE_HEAD(&xmldoc_tree, entry))) {
2585                 ast_free(doctree->filename);
2586                 ast_xml_close(doctree->doc);
2587                 ast_free(doctree);
2588         }
2589         AST_RWLIST_UNLOCK(&xmldoc_tree);
2590
2591         ast_xml_finish();
2592 }
2593
2594 int ast_xmldoc_load_documentation(void)
2595 {
2596         struct ast_xml_node *root_node;
2597         struct ast_xml_doc *tmpdoc;
2598         struct documentation_tree *doc_tree;
2599         char *xmlpattern;
2600         struct ast_config *cfg = NULL;
2601         struct ast_variable *var = NULL;
2602         struct ast_flags cnfflags = { 0 };
2603         int globret, i, dup, duplicate;
2604         glob_t globbuf;
2605 #if !defined(HAVE_GLOB_NOMAGIC) || !defined(HAVE_GLOB_BRACE) || defined(DEBUG_NONGNU)
2606         int xmlpattern_maxlen;
2607 #endif
2608
2609         /* setup default XML documentation language */
2610         snprintf(documentation_language, sizeof(documentation_language), default_documentation_language);
2611
2612         if ((cfg = ast_config_load2("asterisk.conf", "" /* core can't reload */, cnfflags)) && cfg != CONFIG_STATUS_FILEINVALID) {
2613                 for (var = ast_variable_browse(cfg, "options"); var; var = var->next) {
2614                         if (!strcasecmp(var->name, "documentation_language")) {
2615                                 if (!ast_strlen_zero(var->value)) {
2616                                         snprintf(documentation_language, sizeof(documentation_language), "%s", var->value);
2617                                 }
2618                         }
2619                 }
2620                 ast_config_destroy(cfg);
2621         }
2622
2623         /* initialize the XML library. */
2624         ast_xml_init();
2625
2626         ast_cli_register(&cli_dump_xmldocs);
2627         /* register function to be run when asterisk finish. */
2628         ast_register_atexit(xmldoc_unload_documentation);
2629
2630         globbuf.gl_offs = 0;    /* slots to reserve in gl_pathv */
2631
2632 #if !defined(HAVE_GLOB_NOMAGIC) || !defined(HAVE_GLOB_BRACE) || defined(DEBUG_NONGNU)
2633         xmlpattern_maxlen = strlen(ast_config_AST_DATA_DIR) + strlen("/documentation/thirdparty") + strlen("/*-??_??.xml") + 1;
2634         xmlpattern = ast_malloc(xmlpattern_maxlen);
2635         globret = xml_pathmatch(xmlpattern, xmlpattern_maxlen, &globbuf);
2636 #else
2637         /* Get every *-LANG.xml file inside $(ASTDATADIR)/documentation */
2638         if (ast_asprintf(&xmlpattern, "%s/documentation{/thirdparty/,/}*-{%s,%.2s_??,%s}.xml", ast_config_AST_DATA_DIR,
2639                 documentation_language, documentation_language, default_documentation_language) < 0) {
2640                 return 1;
2641         }
2642         globret = glob(xmlpattern, MY_GLOB_FLAGS, NULL, &globbuf);
2643 #endif
2644
2645         ast_debug(3, "gl_pathc %zd\n", globbuf.gl_pathc);
2646         if (globret == GLOB_NOSPACE) {
2647                 ast_log(LOG_WARNING, "XML load failure, glob expansion of pattern '%s' failed: Not enough memory\n", xmlpattern);
2648                 ast_free(xmlpattern);
2649                 return 1;
2650         } else if (globret  == GLOB_ABORTED) {
2651                 ast_log(LOG_WARNING, "XML load failure, glob expansion of pattern '%s' failed: Read error\n", xmlpattern);
2652                 ast_free(xmlpattern);
2653                 return 1;
2654         }
2655         ast_free(xmlpattern);
2656
2657         AST_RWLIST_WRLOCK(&xmldoc_tree);
2658         /* loop over expanded files */
2659         for (i = 0; i < globbuf.gl_pathc; i++) {
2660                 /* check for duplicates (if we already [try to] open the same file. */
2661                 duplicate = 0;
2662                 for (dup = 0; dup < i; dup++) {
2663                         if (!strcmp(globbuf.gl_pathv[i], globbuf.gl_pathv[dup])) {
2664                                 duplicate = 1;
2665                                 break;
2666                         }
2667                 }
2668                 if (duplicate || strchr(globbuf.gl_pathv[i], '*')) {
2669                 /* skip duplicates as well as pathnames not found
2670                  * (due to use of GLOB_NOCHECK in xml_pathmatch) */
2671                         continue;
2672                 }
2673                 tmpdoc = NULL;
2674                 tmpdoc = ast_xml_open(globbuf.gl_pathv[i]);
2675                 if (!tmpdoc) {
2676                         ast_log(LOG_ERROR, "Could not open XML documentation at '%s'\n", globbuf.gl_pathv[i]);
2677                         continue;
2678                 }
2679                 /* Get doc root node and check if it starts with '<docs>' */
2680                 root_node = ast_xml_get_root(tmpdoc);
2681                 if (!root_node) {
2682                         ast_log(LOG_ERROR, "Error getting documentation root node\n");
2683                         ast_xml_close(tmpdoc);
2684                         continue;
2685                 }
2686                 /* Check root node name for malformed xmls. */
2687                 if (strcmp(ast_xml_node_get_name(root_node), "docs")) {
2688                         ast_log(LOG_ERROR, "Documentation file is not well formed!\n");
2689                         ast_xml_close(tmpdoc);
2690                         continue;
2691                 }
2692                 doc_tree = ast_calloc(1, sizeof(*doc_tree));
2693                 if (!doc_tree) {
2694                         ast_log(LOG_ERROR, "Unable to allocate documentation_tree structure!\n");
2695                         ast_xml_close(tmpdoc);
2696                         continue;
2697                 }
2698                 doc_tree->doc = tmpdoc;
2699                 doc_tree->filename = ast_strdup(globbuf.gl_pathv[i]);
2700                 AST_RWLIST_INSERT_TAIL(&xmldoc_tree, doc_tree, entry);
2701         }
2702         AST_RWLIST_UNLOCK(&xmldoc_tree);
2703
2704         globfree(&globbuf);
2705
2706         return 0;
2707 }
2708
2709 #endif /* AST_XML_DOCS */
2710
2711