ast_json_pack(): Use safer json ref mechanism.
[asterisk/asterisk.git] / main / stasis_message.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@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 /*! \file
20  *
21  * \brief Stasis Message API.
22  *
23  * \author David M. Lee, II <dlee@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 #include "asterisk/astobj2.h"
33 #include "asterisk/stasis.h"
34 #include "asterisk/utils.h"
35
36 /*! \internal */
37 struct stasis_message_type {
38         struct stasis_message_vtable *vtable;
39         char *name;
40 };
41
42 static struct stasis_message_vtable null_vtable = {};
43
44 static void message_type_dtor(void *obj)
45 {
46         struct stasis_message_type *type = obj;
47         ast_free(type->name);
48         type->name = NULL;
49 }
50
51 int stasis_message_type_create(const char *name,
52         struct stasis_message_vtable *vtable,
53         struct stasis_message_type **result)
54 {
55         struct stasis_message_type *type;
56
57         /* Check for declination */
58         if (name && stasis_message_type_declined(name)) {
59                 return STASIS_MESSAGE_TYPE_DECLINED;
60         }
61
62         type = ao2_t_alloc(sizeof(*type), message_type_dtor, name);
63         if (!type) {
64                 return STASIS_MESSAGE_TYPE_ERROR;
65         }
66         if (!vtable) {
67                 /* Null object pattern, FTW! */
68                 vtable = &null_vtable;
69         }
70
71         type->name = ast_strdup(name);
72         if (!type->name) {
73                 ao2_cleanup(type);
74                 return STASIS_MESSAGE_TYPE_ERROR;
75         }
76         type->vtable = vtable;
77         *result = type;
78
79         return STASIS_MESSAGE_TYPE_SUCCESS;
80 }
81
82 const char *stasis_message_type_name(const struct stasis_message_type *type)
83 {
84         return type->name;
85 }
86
87 /*! \internal */
88 struct stasis_message {
89         /*! Time the message was created */
90         struct timeval timestamp;
91         /*! Type of the message */
92         struct stasis_message_type *type;
93         /*! Where this message originated.  NULL if aggregate message. */
94         const struct ast_eid *eid_ptr;
95         /*! Message content */
96         void *data;
97         /*! Where this message originated. */
98         struct ast_eid eid;
99 };
100
101 static void stasis_message_dtor(void *obj)
102 {
103         struct stasis_message *message = obj;
104         ao2_cleanup(message->type);
105         ao2_cleanup(message->data);
106 }
107
108 struct stasis_message *stasis_message_create_full(struct stasis_message_type *type, void *data, const struct ast_eid *eid)
109 {
110         struct stasis_message *message;
111
112         if (type == NULL || data == NULL) {
113                 return NULL;
114         }
115
116         message = ao2_t_alloc(sizeof(*message), stasis_message_dtor, type->name);
117         if (message == NULL) {
118                 return NULL;
119         }
120
121         message->timestamp = ast_tvnow();
122         ao2_ref(type, +1);
123         message->type = type;
124         ao2_ref(data, +1);
125         message->data = data;
126         if (eid) {
127                 message->eid_ptr = &message->eid;
128                 message->eid = *eid;
129         }
130
131         return message;
132 }
133
134 struct stasis_message *stasis_message_create(struct stasis_message_type *type, void *data)
135 {
136         return stasis_message_create_full(type, data, &ast_eid_default);
137 }
138
139 const struct ast_eid *stasis_message_eid(const struct stasis_message *msg)
140 {
141         if (msg == NULL) {
142                 return NULL;
143         }
144         return msg->eid_ptr;
145 }
146
147 struct stasis_message_type *stasis_message_type(const struct stasis_message *msg)
148 {
149         if (msg == NULL) {
150                 return NULL;
151         }
152         return msg->type;
153 }
154
155 void *stasis_message_data(const struct stasis_message *msg)
156 {
157         if (msg == NULL) {
158                 return NULL;
159         }
160         return msg->data;
161 }
162
163 const struct timeval *stasis_message_timestamp(const struct stasis_message *msg)
164 {
165         if (msg == NULL) {
166                 return NULL;
167         }
168         return &msg->timestamp;
169 }
170
171 #define INVOKE_VIRTUAL(fn, ...)                                 \
172         ({                                                                                      \
173                 if (!msg) {                                                             \
174                         return NULL;                                            \
175                 }                                                                               \
176                 ast_assert(msg->type != NULL);                  \
177                 ast_assert(msg->type->vtable != NULL);  \
178                 if (!msg->type->vtable->fn) {                   \
179                         return NULL;                                            \
180                 }                                                                               \
181                 msg->type->vtable->fn(__VA_ARGS__);             \
182         })
183
184 struct ast_manager_event_blob *stasis_message_to_ami(struct stasis_message *msg)
185 {
186         return INVOKE_VIRTUAL(to_ami, msg);
187 }
188
189 struct ast_json *stasis_message_to_json(
190         struct stasis_message *msg,
191         struct stasis_message_sanitizer *sanitize)
192 {
193         return INVOKE_VIRTUAL(to_json, msg, sanitize);
194 }
195
196 struct ast_event *stasis_message_to_event(struct stasis_message *msg)
197 {
198         return INVOKE_VIRTUAL(to_event, msg);
199 }
200
201 #define HAS_VIRTUAL(fn, msg)                                    \
202         ({                                                                                      \
203                 if (!msg) {                                                             \
204                         return 0;                                                       \
205                 }                                                                               \
206                 ast_assert(msg->type != NULL);                  \
207                 ast_assert(msg->type->vtable != NULL);  \
208                 !!msg->type->vtable->fn;                                \
209         })
210
211 int stasis_message_can_be_ami(struct stasis_message *msg)
212 {
213         return HAS_VIRTUAL(to_ami, msg);
214 }