sounds.c

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 2013, Digium, Inc.
 *
 * Kinsey Moore <[email protected]>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

/*! \file
 * \brief Sound file format and description index.
 */

#include "asterisk.h"

#include <dirent.h>
#include <sys/stat.h>

#include "asterisk/utils.h"
#include "asterisk/lock.h"
#include "asterisk/format.h"
#include "asterisk/format_cap.h"
#include "asterisk/paths.h"   /* use ast_config_AST_DATA_DIR */
#include "asterisk/media_index.h"
#include "asterisk/sounds_index.h"
#include "asterisk/file.h"
#include "asterisk/cli.h"
#include "asterisk/module.h"
#include "asterisk/stasis_message_router.h"
#include "asterisk/stasis_system.h"

/*** MODULEINFO
   <support_level>core</support_level>
 ***/

/*! \brief The number of buckets to be used for storing language-keyed objects */
#define LANGUAGE_BUCKETS 7

/*! \brief Get the languages in which sound files are available */
static struct ao2_container *get_languages(void)
{
   RAII_VAR(struct ao2_container *, lang_dirs, NULL, ao2_cleanup);
   struct dirent* dent;
   DIR* srcdir;
   RAII_VAR(struct ast_str *, media_dir, ast_str_create(64), ast_free);
   RAII_VAR(struct ast_str *, variant_dir, ast_str_create(64), ast_free);

   lang_dirs = ast_str_container_alloc(LANGUAGE_BUCKETS);
   if (!media_dir || !lang_dirs) {
      return NULL;
   }

   ast_str_set(&media_dir, 0, "%s/sounds", ast_config_AST_DATA_DIR);

   srcdir = opendir(ast_str_buffer(media_dir));

   if (srcdir == NULL) {
      ast_log(LOG_ERROR, "Failed to open %s\n", ast_str_buffer(media_dir));
      return NULL;
   }

   while((dent = readdir(srcdir)) != NULL) {
      struct stat st;

      if(!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, "..")) {
         continue;
      }

      ast_str_reset(variant_dir);
      ast_str_set(&variant_dir, 0, "%s/%s", ast_str_buffer(media_dir), dent->d_name);

      if (stat(ast_str_buffer(variant_dir), &st) < 0) {
         ast_log(LOG_ERROR, "Failed to stat %s\n", ast_str_buffer(variant_dir));
         continue;
      }

      if (S_ISDIR(st.st_mode)) {
         ast_str_container_add(lang_dirs, dent->d_name);
      }
   }

   closedir(srcdir);
   ao2_ref(lang_dirs, +1);
   return lang_dirs;
}

static int show_sounds_cb(void *obj, void *arg, int flags)
{
   char *name = obj;
   struct ast_cli_args *a = arg;
   ast_cli(a->fd, "%s\n", name);
   return 0;
}

static int show_sound_info_cb(void *obj, void *arg, void *data, int flags)
{
   char *language = obj;
   struct ast_cli_args *a = arg;
   struct ast_format *format;
   int formats_shown = 0;
   struct ast_media_index *local_index = data;
   struct ast_format_cap *cap;
   const char *description = ast_media_get_description(local_index, a->argv[3], language);

   ast_cli(a->fd, "  Language %s:\n", language);
   if (!ast_strlen_zero(description)) {
      ast_cli(a->fd, "    Description: %s\n", description);
   }

   cap = ast_media_get_format_cap(local_index, a->argv[3], language);
   if (cap) {
      int x;
      for (x = 0; x < ast_format_cap_count(cap); x++) {
         format = ast_format_cap_get_format(cap, x);
         ast_cli(a->fd, "    Format: %s\n", ast_format_get_name(format));
         ao2_ref(format, -1);
         formats_shown = 1;
      }
      ao2_ref(cap, -1);
   }

   if (!formats_shown) {
      ast_cli(a->fd, "    No Formats Available\n");
   }

   return 0;
}

static int sound_sorter(const void *obj_left, const void *obj_right, int flags)
{
   return strcmp(obj_left, obj_right);
}

/*! \brief Show a list of sounds available on the system */
static char *handle_cli_sounds_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
   switch (cmd) {
   case CLI_INIT:
      e->command = "core show sounds";
      e->usage =
         "Usage: core show sounds\n"
         "       Shows a listing of sound files available on the system.\n";
      return NULL;
   case CLI_GENERATE:
      return NULL;
   }

   if (a->argc == 3) {
      struct ast_media_index *sounds_index = ast_sounds_get_index();
      struct ao2_container *sound_files;
      struct ao2_container *sorted;

      if (!sounds_index) {
         return CLI_FAILURE;
      }

      sound_files = ast_media_get_media(sounds_index);
      ao2_ref(sounds_index, -1);
      if (!sound_files) {
         return CLI_FAILURE;
      }

      sorted = ao2_container_alloc_rbtree(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
         sound_sorter, NULL);
      if (!sorted
         || ao2_container_dup(sorted, sound_files, 0)) {
         ao2_cleanup(sorted);
         ao2_cleanup(sound_files);
         return CLI_FAILURE;
      }

      ast_cli(a->fd, "Available audio files:\n");
      ao2_callback(sorted, OBJ_MULTIPLE | OBJ_NODATA, show_sounds_cb, a);
      ao2_ref(sorted, -1);
      ao2_ref(sound_files, -1);

      return CLI_SUCCESS;
   }

   return CLI_SHOWUSAGE;
}

/*! \brief Show details about a sound available in the system */
static char *handle_cli_sound_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
   int length;
   struct ao2_iterator it_sounds;
   char *filename;
   struct ast_media_index *sounds_index;
   struct ao2_container *sound_files;

   switch (cmd) {
   case CLI_INIT:
      e->command = "core show sound";
      e->usage =
         "Usage: core show sound [soundid]\n"
         "       Shows information about the specified sound.\n";
      return NULL;
   case CLI_GENERATE:
      if (a->pos != 3) {
         return NULL;
      }

      sounds_index = ast_sounds_get_index();
      if (!sounds_index) {
         return NULL;
      }

      sound_files = ast_media_get_media(sounds_index);
      ao2_ref(sounds_index, -1);
      if (!sound_files) {
         return NULL;
      }

      length = strlen(a->word);
      it_sounds = ao2_iterator_init(sound_files, 0);
      while ((filename = ao2_iterator_next(&it_sounds))) {
         if (!strncasecmp(a->word, filename, length)) {
            if (ast_cli_completion_add(ast_strdup(filename))) {
               ao2_ref(filename, -1);
               break;
            }
         }
         ao2_ref(filename, -1);
      }
      ao2_iterator_destroy(&it_sounds);
      ao2_ref(sound_files, -1);

      return NULL;
   }

   if (a->argc == 4) {
      struct ao2_container *variants;

      sounds_index = ast_sounds_get_index_for_file(a->argv[3]);
      if (!sounds_index) {
         return NULL;
      }

      variants = ast_media_get_variants(sounds_index, a->argv[3]);

      if (!variants || !ao2_container_count(variants)) {
         ao2_ref(sounds_index, -1);
         ao2_cleanup(variants);
         ast_cli(a->fd, "ERROR: File %s not found in index\n", a->argv[3]);
         return CLI_FAILURE;
      }

      ast_cli(a->fd, "Indexed Information for %s:\n", a->argv[3]);
      ao2_callback_data(variants, OBJ_MULTIPLE | OBJ_NODATA, show_sound_info_cb, a, sounds_index);
      ao2_ref(sounds_index, -1);
      ao2_ref(variants, -1);

      return CLI_SUCCESS;
   }

   return CLI_SHOWUSAGE;
}

/*! \brief Struct for registering CLI commands */
static struct ast_cli_entry cli_sounds[] = {
   AST_CLI_DEFINE(handle_cli_sounds_show, "Shows available sounds"),
   AST_CLI_DEFINE(handle_cli_sound_show, "Shows details about a specific sound"),
};

static int unload_module(void)
{
   ast_cli_unregister_multiple(cli_sounds, ARRAY_LEN(cli_sounds));

   return 0;
}

static int load_module(void)
{
   int res;

   res = ast_cli_register_multiple(cli_sounds, ARRAY_LEN(cli_sounds));
   if (res) {
      return AST_MODULE_LOAD_DECLINE;
   }

   return AST_MODULE_LOAD_SUCCESS;
}

/*! \brief Callback to process an individual language directory or subdirectory */
static int update_index_cb(void *obj, void *arg, void *data, int flags)
{
   char *lang = obj;
   char *filename = data;
   struct ast_media_index *index = arg;

   if (ast_media_index_update_for_file(index, lang, filename)) {
      return CMP_MATCH;
   }

   return 0;
}

struct ast_media_index *ast_sounds_get_index(void)
{
   return ast_sounds_get_index_for_file(NULL);
}

struct ast_media_index *ast_sounds_get_index_for_file(const char *filename)
{
   struct ast_str *sounds_dir = ast_str_create(64);
   struct ao2_container *languages;
   char *failed_index;
   struct ast_media_index *new_index;

   if (!sounds_dir) {
      return NULL;
   }

   ast_str_set(&sounds_dir, 0, "%s/sounds", ast_config_AST_DATA_DIR);
   new_index = ast_media_index_create(ast_str_buffer(sounds_dir));
   ast_free(sounds_dir);
   if (!new_index) {
      return NULL;
   }

   languages = get_languages();
   if (!languages) {
      ao2_ref(new_index, -1);
      return NULL;
   }

   failed_index = ao2_callback_data(languages, 0, update_index_cb, new_index, (void *)filename);
   ao2_ref(languages, -1);
   if (failed_index) {
      ao2_ref(failed_index, -1);
      ao2_ref(new_index, -1);
      new_index = NULL;
   }

   return new_index;
}

AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Sounds Index",
   .support_level = AST_MODULE_SUPPORT_CORE,
   .load = load_module,
   .unload = unload_module,
   /* Load after the format modules to reduce processing during startup. */
   .load_pri = AST_MODPRI_APP_DEPEND + 1,
);