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