funcs/func_moh.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2006, Digium, Inc.
   5  *
   6  * Russell Bryant <russelb@clemson.edu>
   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 Functions for reading or setting the MusicOnHold class
  22  *
  23  * \author Russell Bryant <russelb@clemson.edu>
  24  */
  25
  26 #include "asterisk.h"
  27
  28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  29
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32
  33 #include "asterisk/module.h"
  34 #include "asterisk/channel.h"
  35 #include "asterisk/pbx.h"
  36 #include "asterisk/utils.h"
  37 #include "asterisk/stringfields.h"
  38
  39 static int depwarning = 0;
  40
  41 static int moh_read(struct ast_channel *chan, char *cmd, char *data,
  42                     char *buf, size_t len)
  43 {
  44         if (!depwarning) {
  45                 depwarning = 1;
  46                 ast_log(LOG_WARNING, "MUSICCLASS() is deprecated; use CHANNEL(musicclass) instead.\n");
  47         }
  48
  49         ast_copy_string(buf, chan->musicclass, len);
  50
  51         return 0;
  52 }
  53
  54 static int moh_write(struct ast_channel *chan, char *cmd, char *data,
  55                      const char *value)
  56 {
  57         if (!depwarning) {
  58                 depwarning = 1;
  59                 ast_log(LOG_WARNING, "MUSICCLASS() is deprecated; use CHANNEL(musicclass) instead.\n");
  60         }
  61
  62         ast_string_field_set(chan, musicclass, value);
  63
  64         return 0;
  65 }
  66
  67 static struct ast_custom_function moh_function = {
  68         .name = "MUSICCLASS",
  69         .synopsis = "Read or Set the MusicOnHold class",
  70         .syntax = "MUSICCLASS()",
  71         .desc = "Deprecated. Use CHANNEL(musicclass) instead.\n",
  72         .read = moh_read,
  73         .write = moh_write,
  74 };
  75
  76 static int unload_module(void)
  77 {
  78         return ast_custom_function_unregister(&moh_function);
  79 }
  80
  81 static int load_module(void)
  82 {
  83         return ast_custom_function_register(&moh_function);
  84 }
  85
  86 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Music-on-hold dialplan function");