CHANNEL(callid): Give dialplan access to the callid.
[asterisk/asterisk.git] / main / media_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 indexer.
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/media_index.h"
33 #include "asterisk/file.h"
34
35 /*** MODULEINFO
36         <support_level>core</support_level>
37  ***/
38
39 /*! \brief The number of buckets to be used for storing variant-keyed objects */
40 #define VARIANT_BUCKETS 7
41
42 /*! \brief The number of buckets to be used for storing media filename-keyed objects */
43 #define INDEX_BUCKETS 157
44
45 /*! \brief Structure to hold a list of the format variations for a media file for a specific variant */
46 struct media_variant {
47         AST_DECLARE_STRING_FIELDS(
48                 AST_STRING_FIELD(variant);      /*!< The variant this media is available in */
49                 AST_STRING_FIELD(description);  /*!< The description of the media */
50         );
51         struct ast_format_cap *formats; /*!< The formats this media is available in for this variant */
52 };
53
54 static void media_variant_destroy(void *obj)
55 {
56         struct media_variant *variant = obj;
57
58         ast_string_field_free_memory(variant);
59         ao2_cleanup(variant->formats);
60 }
61
62 static struct media_variant *media_variant_alloc(const char *variant_str)
63 {
64         RAII_VAR(struct media_variant *, variant, ao2_alloc(sizeof(*variant), media_variant_destroy), ao2_cleanup);
65
66         if (!variant || ast_string_field_init(variant, 8)) {
67                 return NULL;
68         }
69
70         variant->formats = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
71         if (!variant->formats) {
72                 return NULL;
73         }
74
75         ast_string_field_set(variant, variant, variant_str);
76
77         ao2_ref(variant, 1);
78         return variant;
79 }
80
81 static int media_variant_hash(const void *obj, const int flags)
82 {
83         const char *variant = (flags & OBJ_KEY) ? obj : ((struct media_variant*) obj)->variant;
84         return ast_str_case_hash(variant);
85 }
86
87 static int media_variant_cmp(void *obj, void *arg, int flags)
88 {
89         struct media_variant *opt1 = obj, *opt2 = arg;
90         const char *variant = (flags & OBJ_KEY) ? arg : opt2->variant;
91         return strcasecmp(opt1->variant, variant) ? 0 : CMP_MATCH | CMP_STOP;
92 }
93
94 /*! \brief Structure to hold information about a media file */
95 struct media_info {
96         AST_DECLARE_STRING_FIELDS(
97                 AST_STRING_FIELD(name);         /*!< The file name of the media */
98         );
99         struct ao2_container *variants; /*!< The variants for which this media is available */
100 };
101
102 static void media_info_destroy(void *obj)
103 {
104         struct media_info *info = obj;
105
106         ast_string_field_free_memory(info);
107         ao2_cleanup(info->variants);
108         info->variants = NULL;
109 }
110
111 static struct media_info *media_info_alloc(const char *name)
112 {
113         RAII_VAR(struct media_info *, info, ao2_alloc(sizeof(*info), media_info_destroy), ao2_cleanup);
114
115         if (!info || ast_string_field_init(info, 128)) {
116                 return NULL;
117         }
118
119         info->variants = ao2_container_alloc(VARIANT_BUCKETS, media_variant_hash, media_variant_cmp);
120         if (!info->variants) {
121                 return NULL;
122         }
123
124         ast_string_field_set(info, name, name);
125
126         ao2_ref(info, 1);
127         return info;
128 }
129
130 static int media_info_hash(const void *obj, const int flags)
131 {
132         const char *name = (flags & OBJ_KEY) ? obj : ((struct media_info*) obj)->name;
133         return ast_str_case_hash(name);
134 }
135
136 static int media_info_cmp(void *obj, void *arg, int flags)
137 {
138         struct media_info *opt1 = obj, *opt2 = arg;
139         const char *name = (flags & OBJ_KEY) ? arg : opt2->name;
140         return strcasecmp(opt1->name, name) ? 0 : CMP_MATCH | CMP_STOP;
141 }
142
143 struct ast_media_index {
144         AST_DECLARE_STRING_FIELDS(
145                 AST_STRING_FIELD(base_dir); /*!< Base directory for indexing */
146         );
147         struct ao2_container *index;            /*!< The index of media that has requested */
148         struct ao2_container *media_list_cache; /*!< Cache of filenames to prevent them from being regenerated so often */
149 };
150
151 static void media_index_dtor(void *obj)
152 {
153         struct ast_media_index *index = obj;
154         ao2_cleanup(index->index);
155         index->index = NULL;
156         ao2_cleanup(index->media_list_cache);
157         index->media_list_cache = NULL;
158         ast_string_field_free_memory(index);
159 }
160
161 struct ast_media_index *ast_media_index_create(const char *base_dir)
162 {
163         RAII_VAR(struct ast_media_index *, index, ao2_alloc(sizeof(*index), media_index_dtor), ao2_cleanup);
164         if (!index || ast_string_field_init(index, 64)) {
165                 return NULL;
166         }
167
168         ast_string_field_set(index, base_dir, base_dir);
169
170         index->index = ao2_container_alloc(INDEX_BUCKETS, media_info_hash, media_info_cmp);
171         if (!index->index) {
172                 return NULL;
173         }
174
175         ao2_ref(index, +1);
176         return index;
177 }
178
179 static struct media_variant *find_variant(struct ast_media_index *index, const char *filename, const char *variant)
180 {
181         RAII_VAR(struct media_info *, info, NULL, ao2_cleanup);
182
183         info = ao2_find(index->index, filename, OBJ_KEY);
184         if (!info) {
185                 return NULL;
186         }
187
188         return ao2_find(info->variants, variant, OBJ_KEY);
189 }
190
191 /*! \brief create the appropriate media_variant and any necessary structures */
192 static struct media_variant *alloc_variant(struct ast_media_index *index, const char *filename, const char *variant_str)
193 {
194         RAII_VAR(struct media_info *, info, NULL, ao2_cleanup);
195         RAII_VAR(struct media_variant *, variant, NULL, ao2_cleanup);
196
197         info = ao2_find(index->index, filename, OBJ_KEY);
198         if (!info) {
199                 /* This is the first time the index has seen this filename,
200                  * allocate and link */
201                 info = media_info_alloc(filename);
202                 if (!info) {
203                         return NULL;
204                 }
205
206                 ao2_link(index->index, info);
207         }
208
209         variant = ao2_find(info->variants, variant_str, OBJ_KEY);
210         if (!variant) {
211                 /* This is the first time the index has seen this variant for
212                  * this filename, allocate and link */
213                 variant = media_variant_alloc(variant_str);
214                 if (!variant) {
215                         return NULL;
216                 }
217
218                 ao2_link(info->variants, variant);
219         }
220
221         ao2_ref(variant, +1);
222         return variant;
223 }
224
225 const char *ast_media_get_description(struct ast_media_index *index, const char *filename, const char *variant_str)
226 {
227         RAII_VAR(struct media_variant *, variant, NULL, ao2_cleanup);
228         if (ast_strlen_zero(filename) || ast_strlen_zero(variant_str)) {
229                 return NULL;
230         }
231
232         variant = find_variant(index, filename, variant_str);
233         if (!variant) {
234                 return NULL;
235         }
236
237         return variant->description;
238 }
239
240 struct ast_format_cap *ast_media_get_format_cap(struct ast_media_index *index, const char *filename, const char *variant_str)
241 {
242         struct ast_format_cap *dupcap;
243         RAII_VAR(struct media_variant *, variant, NULL, ao2_cleanup);
244         if (ast_strlen_zero(filename) || ast_strlen_zero(variant_str)) {
245                 return NULL;
246         }
247
248         variant = find_variant(index, filename, variant_str);
249         if (!variant) {
250                 return NULL;
251         }
252
253         dupcap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
254         if (dupcap) {
255                 ast_format_cap_append_from_cap(dupcap, variant->formats, AST_MEDIA_TYPE_UNKNOWN);
256         }
257         return dupcap;
258 }
259
260 /*! \brief Add the variant to the list of variants requested */
261 static int add_variant_cb(void *obj, void *arg, int flags)
262 {
263         struct media_variant *variant = obj;
264         struct ao2_container *variants= arg;
265         ast_str_container_add(variants, variant->variant);
266         return 0;
267 }
268
269 struct ao2_container *ast_media_get_variants(struct ast_media_index *index, const char *filename)
270 {
271         RAII_VAR(struct media_info *, info, NULL, ao2_cleanup);
272         RAII_VAR(struct ao2_container *, variants, NULL, ao2_cleanup);
273         if (!filename) {
274                 return NULL;
275         }
276
277         variants = ast_str_container_alloc(VARIANT_BUCKETS);
278         if (!variants) {
279                 return NULL;
280         }
281
282         info = ao2_find(index->index, filename, OBJ_KEY);
283         if (!info) {
284                 return NULL;
285         }
286
287         ao2_callback(info->variants, OBJ_NODATA, add_variant_cb, variants);
288
289         ao2_ref(variants, +1);
290         return variants;
291 }
292
293 /*! \brief Add the media_info's filename to the container of filenames requested */
294 static int add_media_cb(void *obj, void *arg, int flags)
295 {
296         struct media_info *info = obj;
297         struct ao2_container *media = arg;
298         ast_str_container_add(media, info->name);
299         return 0;
300 }
301
302 struct ao2_container *ast_media_get_media(struct ast_media_index *index)
303 {
304         RAII_VAR(struct ao2_container *, media, NULL, ao2_cleanup);
305
306         if (!index->media_list_cache) {
307                 media = ast_str_container_alloc(INDEX_BUCKETS);
308                 if (!media) {
309                         return NULL;
310                 }
311
312                 ao2_callback(index->index, OBJ_NODATA, add_media_cb, media);
313
314                 /* Ref to the cache */
315                 ao2_ref(media, +1);
316                 index->media_list_cache = media;
317         }
318
319         /* Ref to the caller */
320         ao2_ref(index->media_list_cache, +1);
321         return index->media_list_cache;
322 }
323
324 /*! \brief Update an index with new format/variant information */
325 static int update_file_format_info(struct ast_media_index *index, const char *filename, const char *variant_str, struct ast_format *file_format)
326 {
327         RAII_VAR(struct media_variant *, variant, find_variant(index, filename, variant_str), ao2_cleanup);
328         if (!variant) {
329                 variant = alloc_variant(index, filename, variant_str);
330                 if (!variant) {
331                         return -1;
332                 }
333         }
334
335         ast_format_cap_append(variant->formats, file_format, 0);
336         return 0;
337 }
338
339 /*! \brief Process a media file into the index */
340 static int process_media_file(struct ast_media_index *index, const char *variant, const char *subdir, const char *filename_stripped, const char *ext)
341 {
342         struct ast_format *file_format;
343         const char *file_identifier = filename_stripped;
344         RAII_VAR(struct ast_str *, file_id_str, NULL, ast_free);
345
346         file_format = ast_get_format_for_file_ext(ext);
347         if (!file_format) {
348                 /* extension not registered */
349                 return 0;
350         }
351
352         /* handle updating the file information */
353         if (subdir) {
354                 file_id_str = ast_str_create(64);
355                 if (!file_id_str) {
356                         return -1;
357                 }
358
359                 ast_str_set(&file_id_str, 0, "%s/%s", subdir, filename_stripped);
360                 file_identifier = ast_str_buffer(file_id_str);
361         }
362
363         if (update_file_format_info(index, file_identifier, variant, file_format)) {
364                 return -1;
365         }
366         return 0;
367 }
368
369 /*!
370  * \brief Process a media description text file
371  *
372  * This currently processes core-sounds-*.txt and extra-sounds-*.txt, but will
373  * process others if present.
374  */
375 static int process_description_file(struct ast_media_index *index,
376         const char *subdir,
377         const char *variant_str,
378         const char *filename)
379 {
380         RAII_VAR(struct ast_str *, description_file_path, ast_str_create(64), ast_free);
381         RAII_VAR(struct ast_str *, cumulative_description, ast_str_create(64), ast_free);
382         char *file_id_persist = NULL;
383         int res = 0;
384         FILE *f = NULL;
385 #if defined(LOW_MEMORY)
386         char buf[256];
387 #else
388         char buf[2048];
389 #endif
390
391         if (!description_file_path || !cumulative_description) {
392                 return -1;
393         }
394
395         if (ast_strlen_zero(subdir)) {
396                 ast_str_set(&description_file_path, 0, "%s/%s/%s", index->base_dir, variant_str, filename);
397         } else {
398                 ast_str_set(&description_file_path, 0, "%s/%s/%s/%s", index->base_dir, variant_str, subdir, filename);
399         }
400         f = fopen(ast_str_buffer(description_file_path), "r");
401         if (!f) {
402                 ast_log(LOG_WARNING, "Could not open media description file '%s': %s\n", ast_str_buffer(description_file_path), strerror(errno));
403                 return -1;
404         }
405
406         while (!feof(f)) {
407                 char *file_identifier, *description;
408                 if (!fgets(buf, sizeof(buf), f)) {
409                         if (ferror(f)) {
410                                 ast_log(LOG_ERROR, "Error reading from file %s: %s\n", ast_str_buffer(description_file_path), strerror(errno));
411                         }
412                         continue;
413                 }
414
415                 /* Skip lines that are too long */
416                 if (strlen(buf) == sizeof(buf) - 1 && buf[sizeof(buf) - 1] != '\n') {
417                         ast_log(LOG_WARNING, "Line too long, skipping. It begins with: %.32s...\n", buf);
418                         while (fgets(buf, sizeof(buf), f)) {
419                                 if (strlen(buf) != sizeof(buf) - 1 || buf[sizeof(buf) - 1] == '\n') {
420                                         break;
421                                 }
422                         }
423                         if (ferror(f)) {
424                                 ast_log(LOG_ERROR, "Error reading from file %s: %s\n", ast_str_buffer(description_file_path), strerror(errno));
425                         }
426                         continue;
427                 }
428
429                 if (buf[0] == ';') {
430                         /* ignore comments */
431                         continue;
432                 }
433
434                 ast_trim_blanks(buf);
435                 description = buf;
436                 file_identifier = strsep(&description, ":");
437                 if (!description) {
438                         /* no ':' means this is a continuation */
439                         if (file_id_persist) {
440                                 ast_str_append(&cumulative_description, 0, "\n%s", file_identifier);
441                         }
442                         continue;
443                 } else {
444                         /* if there's text in cumulative_description, archive it and start anew */
445                         if (file_id_persist && !ast_strlen_zero(ast_str_buffer(cumulative_description))) {
446                                 RAII_VAR(struct media_variant *, variant, NULL, ao2_cleanup);
447
448                                 variant = find_variant(index, file_id_persist, variant_str);
449                                 if (!variant) {
450                                         variant = alloc_variant(index, file_id_persist, variant_str);
451                                         if (!variant) {
452                                                 res = -1;
453                                                 break;
454                                         }
455                                 }
456
457                                 ast_string_field_set(variant, description, ast_str_buffer(cumulative_description));
458
459                                 ast_str_reset(cumulative_description);
460                         }
461
462                         ast_free(file_id_persist);
463                         file_id_persist = ast_strdup(file_identifier);
464                         description = ast_skip_blanks(description);
465                         ast_str_set(&cumulative_description, 0, "%s", description);
466                 }
467         }
468
469         /* handle the last one */
470         if (file_id_persist && !ast_strlen_zero(ast_str_buffer(cumulative_description))) {
471                 RAII_VAR(struct media_variant *, variant, NULL, ao2_cleanup);
472
473                 variant = find_variant(index, file_id_persist, variant_str);
474                 if (!variant) {
475                         variant = alloc_variant(index, file_id_persist, variant_str);
476                 }
477
478                 if (variant) {
479                         ast_string_field_set(variant, description, ast_str_buffer(cumulative_description));
480                 } else {
481                         res = -1;
482                 }
483         }
484
485         ast_free(file_id_persist);
486         fclose(f);
487         return res;
488 }
489
490 /*! \brief process an individual file listing */
491 static int process_file(struct ast_media_index *index, const char *variant_str, const char *subdir, const char *filename)
492 {
493         RAII_VAR(char *, filename_stripped, ast_strdup(filename), ast_free);
494         char *ext;
495
496         if (!filename_stripped) {
497                 return -1;
498         }
499
500         ext = strrchr(filename_stripped, '.');
501         if (!ext) {
502                 /* file has no extension */
503                 return 0;
504         }
505
506         *ext++ = '\0';
507         if (!strcmp(ext, "txt")) {
508                 if (process_description_file(index, subdir, variant_str, filename)) {
509                         return -1;
510                 }
511         } else {
512                 if (process_media_file(index, variant_str, subdir, filename_stripped, ext)) {
513                         return -1;
514                 }
515         }
516         return 0;
517 }
518
519 /*! \brief internal function for updating the index, recursive */
520 static int media_index_update(struct ast_media_index *index,
521         const char *variant,
522         const char *subdir)
523 {
524         struct dirent* dent;
525         DIR* srcdir;
526         RAII_VAR(struct ast_str *, index_dir, ast_str_create(64), ast_free);
527         RAII_VAR(struct ast_str *, statfile, ast_str_create(64), ast_free);
528         int res = 0;
529
530         if (!index_dir) {
531                 return 0;
532         }
533
534         ast_str_set(&index_dir, 0, "%s", index->base_dir);
535         if (!ast_strlen_zero(variant)) {
536                 ast_str_append(&index_dir, 0, "/%s", variant);
537         }
538         if (!ast_strlen_zero(subdir)) {
539                 ast_str_append(&index_dir, 0, "/%s", subdir);
540         }
541
542         srcdir = opendir(ast_str_buffer(index_dir));
543         if (srcdir == NULL) {
544                 ast_log(LOG_ERROR, "Failed to open %s: %s\n", ast_str_buffer(index_dir), strerror(errno));
545                 return -1;
546         }
547
548         while((dent = readdir(srcdir)) != NULL) {
549                 struct stat st;
550
551                 if(!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, "..")) {
552                         continue;
553                 }
554
555                 ast_str_reset(statfile);
556                 ast_str_set(&statfile, 0, "%s/%s", ast_str_buffer(index_dir), dent->d_name);
557
558                 if (stat(ast_str_buffer(statfile), &st) < 0) {
559                         ast_log(LOG_WARNING, "Failed to stat %s: %s\n", ast_str_buffer(statfile), strerror(errno));
560                         continue;
561                 }
562
563                 if (S_ISDIR(st.st_mode)) {
564                         if (ast_strlen_zero(subdir)) {
565                                 res = media_index_update(index, variant, dent->d_name);
566                         } else {
567                                 RAII_VAR(struct ast_str *, new_subdir, ast_str_create(64), ast_free);
568                                 ast_str_set(&new_subdir, 0, "%s/%s", subdir, dent->d_name);
569                                 res = media_index_update(index, variant, ast_str_buffer(new_subdir));
570                         }
571
572                         if (res) {
573                                 break;
574                         }
575                         continue;
576                 }
577
578                 if (!S_ISREG(st.st_mode)) {
579                         continue;
580                 }
581
582                 if (process_file(index, variant, subdir, dent->d_name)) {
583                         res = -1;
584                         break;
585                 }
586         }
587
588         closedir(srcdir);
589         return res;
590 }
591
592 int ast_media_index_update(struct ast_media_index *index,
593         const char *variant)
594 {
595         return media_index_update(index, variant, NULL);
596 }
597