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