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