Index installed sounds and implement ARI sounds queries
[asterisk/asterisk.git] / res / stasis_http / resource_sounds.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 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 /api-docs/sounds.{format} implementation- Sound resources
22  *
23  * \author David M. Lee, II <dlee@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include "resource_sounds.h"
31 #include "asterisk/media_index.h"
32 #include "asterisk/sounds_index.h"
33 #include "asterisk/format.h"
34 #include "asterisk/format_cap.h"
35 #include "asterisk/json.h"
36
37 /*! \brief arguments that are necessary for adding format/lang pairs */
38 struct lang_format_info {
39         struct ast_json *format_list;   /*!< The embedded array to which format/lang pairs should be added */
40         const char *filename;           /*!< Name of the file for which to add format/lang pairs */
41         const char *format_filter;      /*!< Format filter provided in the request */
42 };
43
44 /*! \brief Add format/lang pairs to the array embedded in the sound object */
45 static int add_format_information_cb(void *obj, void *arg, int flags)
46 {
47         char *language = obj;
48         struct lang_format_info *args = arg;
49         struct ast_format format;
50         RAII_VAR(struct ast_format_cap *, cap, NULL, ast_format_cap_destroy);
51         RAII_VAR(struct ast_media_index *, sounds_index, ast_sounds_get_index(), ao2_cleanup);
52
53         if (!sounds_index) {
54                 return CMP_STOP;
55         }
56
57         cap = ast_media_get_format_cap(sounds_index, args->filename, language);
58         if (!cap) {
59                 return CMP_STOP;
60         }
61
62         ast_format_cap_iter_start(cap);
63         while (!ast_format_cap_iter_next(cap, &format)) {
64                 struct ast_json *lang_format_pair;
65                 const char *format_name = ast_getformatname(&format);
66
67                 if (!ast_strlen_zero(args->format_filter)
68                         && strcmp(args->format_filter, format_name)) {
69                         continue;
70                 }
71
72                 lang_format_pair = ast_json_pack("{s: s, s: s}",
73                         "language", language,
74                         "format", format_name);
75                 if (!lang_format_pair) {
76                         ast_format_cap_iter_end(cap);
77                         return CMP_STOP;
78                 }
79
80                 ast_json_array_append(args->format_list, lang_format_pair);
81         }
82         ast_format_cap_iter_end(cap);
83         return 0;
84 }
85
86 /*! \brief Filter out all languages not matching the specified language */
87 static int filter_langs_cb(void *obj, void *arg, int flags)
88 {
89         char *lang_filter = arg;
90         char *lang = obj;
91         if (strcmp(lang, lang_filter)) {
92                 return CMP_MATCH;
93         }
94         return 0;
95 }
96
97 /*! \brief Generate a Sound structure as documented in sounds.json for the specified filename */
98 static struct ast_json *create_sound_blob(const char *filename, struct ast_get_sounds_args *args)
99 {
100         RAII_VAR(struct ast_json *, sound, NULL, ast_json_unref);
101         RAII_VAR(struct ao2_container *, languages, NULL, ao2_cleanup);
102         const char *description;
103         struct ast_json *format_lang_list;
104         struct lang_format_info info;
105         RAII_VAR(struct ast_media_index *, sounds_index, ast_sounds_get_index(), ao2_cleanup);
106
107         if (!sounds_index) {
108                 return NULL;
109         }
110
111         description = ast_media_get_description(sounds_index, filename, "en");
112         if (ast_strlen_zero(description)) {
113                 sound = ast_json_pack("{s: s, s: []}",
114                         "id", filename,
115                         "formats");
116         } else {
117                 sound = ast_json_pack("{s: s, s: s, s: []}",
118                         "id", filename,
119                         "text", description,
120                         "formats");
121         }
122         if (!sound) {
123                 return NULL;
124         }
125
126         format_lang_list = ast_json_object_get(sound, "formats");
127         if (!format_lang_list) {
128                 return NULL;
129         }
130
131         languages = ast_media_get_variants(sounds_index, filename);
132         if (!languages || !ao2_container_count(languages)) {
133                 return NULL;
134         }
135
136         /* filter requested languages */
137         if (args && !ast_strlen_zero(args->lang)) {
138                 char *lang_filter = ast_strdupa(args->lang);
139                 ao2_callback(languages, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, filter_langs_cb, lang_filter);
140                 if (!languages || !ao2_container_count(languages)) {
141                         return NULL;
142                 }
143         }
144
145         info.filename = filename;
146         info.format_list = format_lang_list;
147         info.format_filter = NULL;
148         if (args) {
149                 info.format_filter = args->format;
150         }
151         ao2_callback(languages, OBJ_NODATA, add_format_information_cb, &info);
152
153         /* no format/lang pairs for this sound so nothing to return */
154         if (!ast_json_array_size(format_lang_list)) {
155                 return NULL;
156         }
157
158         return ast_json_ref(sound);
159 }
160
161 /*! \brief Generate a Sound structure and append it to the output blob */
162 static int append_sound_cb(void *obj, void *arg, void *data, int flags)
163 {
164         struct ast_json *sounds_array = arg;
165         char *filename = obj;
166         struct ast_get_sounds_args *args = data;
167         struct ast_json *sound_blob = create_sound_blob(filename, args);
168         if (!sound_blob) {
169                 return 0;
170         }
171
172         ast_json_array_append(sounds_array, sound_blob);
173         return 0;
174 }
175
176 void stasis_http_get_sounds(struct ast_variable *headers, struct ast_get_sounds_args *args, struct stasis_http_response *response)
177 {
178         RAII_VAR(struct ao2_container *, sound_files, NULL, ao2_cleanup);
179         struct ast_json *sounds_blob;
180         RAII_VAR(struct ast_media_index *, sounds_index, ast_sounds_get_index(), ao2_cleanup);
181
182         if (!sounds_index) {
183                 stasis_http_response_error(response, 500, "Internal Error", "Sounds index not available");
184                 return;
185         }
186
187         sound_files = ast_media_get_media(sounds_index);
188         if (!sound_files) {
189                 stasis_http_response_error(response, 500, "Internal Error", "Allocation Error");
190                 return;
191         }
192
193         sounds_blob = ast_json_array_create();
194         if (!sounds_blob) {
195                 stasis_http_response_error(response, 500, "Internal Error", "Allocation Error");
196                 return;
197         }
198
199         ao2_callback_data(sound_files, OBJ_NODATA, append_sound_cb, sounds_blob, args);
200
201         if (!ast_json_array_size(sounds_blob)) {
202                 stasis_http_response_error(response, 404, "Not Found", "No sounds found that matched the query");
203                 return;
204         }
205
206         stasis_http_response_ok(response, sounds_blob);
207 }
208
209 void stasis_http_get_stored_sound(struct ast_variable *headers, struct ast_get_stored_sound_args *args, struct stasis_http_response *response)
210 {
211         struct ast_json *sound_blob;
212
213         sound_blob = create_sound_blob(args->sound_id, NULL);
214         if (!sound_blob) {
215                 stasis_http_response_error(response, 404, "Not Found", "Sound not found");
216                 return;
217         }
218
219         stasis_http_response_ok(response, sound_blob);
220 }