ARI: Add ability to raise arbitrary User Events
[asterisk/asterisk.git] / main / sounds_index.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Kinsey Moore <markster@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  * \brief Sound file format and description index.
21  */
22
23 #include "asterisk.h"
24
25 #include <dirent.h>
26 #include <sys/stat.h>
27
28 #include "asterisk/utils.h"
29 #include "asterisk/lock.h"
30 #include "asterisk/format.h"
31 #include "asterisk/format_cap.h"
32 #include "asterisk/paths.h"     /* use ast_config_AST_DATA_DIR */
33 #include "asterisk/media_index.h"
34 #include "asterisk/sounds_index.h"
35 #include "asterisk/file.h"
36 #include "asterisk/cli.h"
37 #include "asterisk/_private.h"
38 #include "asterisk/stasis_message_router.h"
39 #include "asterisk/stasis_system.h"
40
41 /*** MODULEINFO
42         <support_level>core</support_level>
43  ***/
44
45 /*! \brief The number of buckets to be used for storing language-keyed objects */
46 #define LANGUAGE_BUCKETS 7
47
48 static struct ast_media_index *sounds_index;
49
50 static struct stasis_message_router *sounds_system_router;
51
52 /*! \brief Get the languages in which sound files are available */
53 static struct ao2_container *get_languages(void)
54 {
55         RAII_VAR(struct ao2_container *, lang_dirs, NULL, ao2_cleanup);
56         struct dirent* dent;
57         DIR* srcdir;
58         RAII_VAR(struct ast_str *, media_dir, ast_str_create(64), ast_free);
59         RAII_VAR(struct ast_str *, variant_dir, ast_str_create(64), ast_free);
60
61         lang_dirs = ast_str_container_alloc(LANGUAGE_BUCKETS);
62         if (!media_dir || !lang_dirs) {
63                 return NULL;
64         }
65
66         ast_str_set(&media_dir, 0, "%s/sounds", ast_config_AST_DATA_DIR);
67
68         srcdir = opendir(ast_str_buffer(media_dir));
69
70         if (srcdir == NULL) {
71                 ast_log(LOG_ERROR, "Failed to open %s\n", ast_str_buffer(media_dir));
72                 return NULL;
73         }
74
75         while((dent = readdir(srcdir)) != NULL) {
76                 struct stat st;
77
78                 if(!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, "..")) {
79                         continue;
80                 }
81
82                 ast_str_reset(variant_dir);
83                 ast_str_set(&variant_dir, 0, "%s/%s", ast_str_buffer(media_dir), dent->d_name);
84
85                 if (stat(ast_str_buffer(variant_dir), &st) < 0) {
86                         ast_log(LOG_ERROR, "Failed to stat %s\n", ast_str_buffer(variant_dir));
87                         continue;
88                 }
89
90                 if (S_ISDIR(st.st_mode)) {
91                         ast_str_container_add(lang_dirs, dent->d_name);
92                 }
93         }
94
95         closedir(srcdir);
96         ao2_ref(lang_dirs, +1);
97         return lang_dirs;
98 }
99
100 /*! \brief Callback to process an individual language directory or subdirectory */
101 static int update_index_cb(void *obj, void *arg, int flags)
102 {
103         char *lang = obj;
104         struct ast_media_index *index = arg;
105
106         if (ast_media_index_update(index, lang)) {
107                 return CMP_MATCH;
108         }
109         return 0;
110 }
111
112 AST_MUTEX_DEFINE_STATIC(reload_lock);
113
114 int ast_sounds_reindex(void)
115 {
116         RAII_VAR(struct ast_str *, sounds_dir, NULL, ast_free);
117         RAII_VAR(struct ao2_container *, languages, NULL, ao2_cleanup);
118         RAII_VAR(char *, failed_index, NULL, ao2_cleanup);
119         RAII_VAR(struct ast_media_index *, new_index, NULL, ao2_cleanup);
120         struct ast_media_index *old_index;
121
122         SCOPED_MUTEX(lock, &reload_lock);
123
124         old_index = sounds_index;
125         languages = get_languages();
126         sounds_dir = ast_str_create(64);
127
128         if (!languages || !sounds_dir) {
129                 return -1;
130         }
131
132         ast_str_set(&sounds_dir, 0, "%s/sounds", ast_config_AST_DATA_DIR);
133         new_index = ast_media_index_create(ast_str_buffer(sounds_dir));
134         if (!new_index) {
135                 return -1;
136         }
137
138         failed_index = ao2_callback(languages, 0, update_index_cb, new_index);
139         if (failed_index) {
140                 return -1;
141         }
142
143         ao2_ref(new_index, +1);
144         sounds_index = new_index;
145         ao2_cleanup(old_index);
146         return 0;
147 }
148
149 static int show_sounds_cb(void *obj, void *arg, int flags)
150 {
151         char *name = obj;
152         struct ast_cli_args *a = arg;
153         ast_cli(a->fd, "%s\n", name);
154         return 0;
155 }
156
157 static int show_sound_info_cb(void *obj, void *arg, int flags)
158 {
159         char *language = obj;
160         struct ast_cli_args *a = arg;
161         struct ast_format format;
162         int formats_shown = 0;
163         RAII_VAR(struct ast_media_index *, local_index, ast_sounds_get_index(), ao2_cleanup);
164         RAII_VAR(struct ast_format_cap *, cap, NULL, ast_format_cap_destroy);
165         const char *description = ast_media_get_description(local_index, a->argv[3], language);
166
167         ast_cli(a->fd, "  Language %s:\n", language);
168         if (!ast_strlen_zero(description)) {
169                 ast_cli(a->fd, "    Description: %s\n", description);
170         }
171
172         cap = ast_media_get_format_cap(local_index, a->argv[3], language);
173         if (cap) {
174                 ast_format_cap_iter_start(cap);
175                 while (!ast_format_cap_iter_next(cap, &format)) {
176                         ast_cli(a->fd, "    Format: %s\n", ast_getformatname(&format));
177                         formats_shown = 1;
178                 }
179                 ast_format_cap_iter_end(cap);
180         }
181
182         if (!formats_shown) {
183                 ast_cli(a->fd, "    No Formats Available\n");
184         }
185
186         return 0;
187 }
188
189 /*! \brief Show a list of sounds available on the system */
190 static char *handle_cli_sounds_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
191 {
192         switch (cmd) {
193         case CLI_INIT:
194                 e->command = "core show sounds";
195                 e->usage =
196                         "Usage: core show sounds\n"
197                         "       Shows a listing of sound files available on the system.\n";
198                 return NULL;
199         case CLI_GENERATE:
200                 return NULL;
201         }
202
203         if (a->argc == 3) {
204                 RAII_VAR(struct ao2_container *, sound_files, ast_media_get_media(sounds_index), ao2_cleanup);
205                 if (!sound_files) {
206                         return CLI_FAILURE;
207                 }
208
209                 ast_cli(a->fd, "Available audio files:\n");
210                 ao2_callback(sound_files, OBJ_MULTIPLE | OBJ_NODATA, show_sounds_cb, a);
211                 return CLI_SUCCESS;
212         }
213
214         return CLI_SHOWUSAGE;
215 }
216
217 /*! \brief Show details about a sound available in the system */
218 static char *handle_cli_sound_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
219 {
220         switch (cmd) {
221         case CLI_INIT:
222                 e->command = "core show sound";
223                 e->usage =
224                         "Usage: core show sound [soundid]\n"
225                         "       Shows information about the specified sound.\n";
226                 return NULL;
227         case CLI_GENERATE:
228         {
229                 int length = strlen(a->word);
230                 int which = 0;
231                 struct ao2_iterator it_sounds;
232                 char *match = NULL;
233                 char *filename;
234                 RAII_VAR(struct ao2_container *, sound_files, ast_media_get_media(sounds_index), ao2_cleanup);
235                 if (!sound_files) {
236                         return NULL;
237                 }
238
239                 it_sounds = ao2_iterator_init(sound_files, 0);
240                 while ((filename = ao2_iterator_next(&it_sounds))) {
241                         if (!strncasecmp(a->word, filename, length) && ++which > a->n) {
242                                 match = ast_strdup(filename);
243                                 ao2_ref(filename, -1);
244                                 break;
245                         }
246                         ao2_ref(filename, -1);
247                 }
248                 ao2_iterator_destroy(&it_sounds);
249                 return match;
250         }
251         }
252
253         if (a->argc == 4) {
254                 RAII_VAR(struct ao2_container *, variants, ast_media_get_variants(sounds_index, a->argv[3]), ao2_cleanup);
255                 if (!variants || !ao2_container_count(variants)) {
256                         ast_cli(a->fd, "ERROR: File %s not found in index\n", a->argv[3]);
257                         return CLI_FAILURE;
258                 }
259
260                 ast_cli(a->fd, "Indexed Information for %s:\n", a->argv[3]);
261                 ao2_callback(variants, OBJ_MULTIPLE | OBJ_NODATA, show_sound_info_cb, a);
262                 return CLI_SUCCESS;
263         }
264
265         return CLI_SHOWUSAGE;
266 }
267
268 /*! \brief Struct for registering CLI commands */
269 static struct ast_cli_entry cli_sounds[] = {
270         AST_CLI_DEFINE(handle_cli_sounds_show, "Shows available sounds"),
271         AST_CLI_DEFINE(handle_cli_sound_show, "Shows details about a specific sound"),
272 };
273
274 static void sounds_cleanup(void)
275 {
276         stasis_message_router_unsubscribe_and_join(sounds_system_router);
277         sounds_system_router = NULL;
278         ast_cli_unregister_multiple(cli_sounds, ARRAY_LEN(cli_sounds));
279         ao2_cleanup(sounds_index);
280         sounds_index = NULL;
281 }
282
283 static void format_update_cb(void *data, struct stasis_subscription *sub,
284         struct stasis_message *message)
285 {
286         ast_sounds_reindex();
287 }
288
289 int ast_sounds_index_init(void)
290 {
291         int res = 0;
292         sounds_index = NULL;
293         if (ast_sounds_reindex()) {
294                 return -1;
295         }
296         res |= ast_cli_register_multiple(cli_sounds, ARRAY_LEN(cli_sounds));
297
298         sounds_system_router = stasis_message_router_create(ast_system_topic());
299         if (!sounds_system_router) {
300                 return -1;
301         }
302
303         res |= stasis_message_router_add(
304                 sounds_system_router,
305                 ast_format_register_type(),
306                 format_update_cb,
307                 NULL);
308
309         res |= stasis_message_router_add(
310                 sounds_system_router,
311                 ast_format_unregister_type(),
312                 format_update_cb,
313                 NULL);
314
315         if (res) {
316                 return -1;
317         }
318
319         ast_register_atexit(sounds_cleanup);
320         return 0;
321 }
322
323 struct ast_media_index *ast_sounds_get_index(void)
324 {
325         ao2_ref(sounds_index, +1);
326         return sounds_index;
327 }