deed0901e49ebcb02508d3fe0c109f61dda1e0a4
[asterisk/asterisk.git] / include / asterisk / res_pjsip_presence_xml.h
1 /*
2  * asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2014, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \brief Length of the XML prolog when printing presence or other XML in PJSIP.
21  *
22  * When calling any variant of pj_xml_print(), the documentation
23  * claims that it will return -1 if the provided buffer is not
24  * large enough. However, if the XML prolog is requested to be
25  * printed and the buffer is not large enough, then it will
26  * return -1 only if the buffer is not large enough to hold the
27  * XML prolog or return the length of the XML prolog on failure
28  * instead of -1.
29  *
30  * This constant is useful to check against when trying to determine
31  * if printing XML succeeded or failed.
32  */
33 #define AST_PJSIP_XML_PROLOG_LEN 39
34
35 /*!
36  * PIDF state
37  */
38 enum ast_sip_pidf_state {
39         /*! Device is not in use */
40         NOTIFY_OPEN,
41         /*! Device is in use or ringing */
42         NOTIFY_INUSE,
43         /*! Device is unavailable, on hold, or busy */
44         NOTIFY_CLOSED
45 };
46
47 /*!
48  * \brief Replace offensive XML characters with XML entities
49  *
50  * " = &quot;
51  * < = &lt;
52  * > = &gt;
53  * ' = &apos;
54  * & = &amp;
55  *
56  * \param input String to sanitize
57  * \param[out] output Sanitized string
58  * \param len Size of output buffer
59  */
60 void ast_sip_sanitize_xml(const char *input, char *output, size_t len);
61
62 /*!
63  * \brief Convert extension state to relevant PIDF strings
64  *
65  * \param state The extension state
66  * \param[out] statestring
67  * \param[out] pidfstate
68  * \param[out] pidfnote
69  * \param[out] local_state
70  */
71 void ast_sip_presence_exten_state_to_str(int state, char **statestring,
72                 char **pidfstate, char **pidfnote, enum ast_sip_pidf_state *local_state);
73
74 /*!
75  * \brief Create XML attribute
76  *
77  * \param pool Allocation pool
78  * \param node Node to add attribute to
79  * \param name The attribute name
80  * \param value The attribute value
81  *
82  * \return The created attribute
83  */
84 pj_xml_attr *ast_sip_presence_xml_create_attr(pj_pool_t *pool,
85                 pj_xml_node *node, const char *name, const char *value);
86
87 /*!
88  * \brief Create XML node
89  *
90  * \param pool Allocation pool
91  * \param parent Optional node that will be parent to the created node
92  * \param name The name for the new node
93  * \return The created node
94  */
95 pj_xml_node *ast_sip_presence_xml_create_node(pj_pool_t *pool,
96                 pj_xml_node *parent, const char* name);
97
98 /*!
99  * \brief Find an attribute within a given node
100  *
101  * Given a starting node, this will find an attribute that belongs
102  * to a specific node. If the node does not exist, it will be created
103  * under the passed-in parent. If the attribute does not exist, then
104  * it will be created on the node with an empty string as its value.
105  *
106  * \param pool Allocation pool
107  * \param parent Starting node for search
108  * \param node_name Name of node where to find attribute
109  * \param attr_name Name of attribute to find
110  * \param[out] node Node that was found or created
111  * \param[out] attr Attribute that was found or created
112  * \return The found attribute
113  */
114 void ast_sip_presence_xml_find_node_attr(pj_pool_t* pool,
115                 pj_xml_node *parent, const char *node_name, const char *attr_name,
116                 pj_xml_node **node, pj_xml_attr **attr);