major dialplan functions update
[asterisk/asterisk.git] / 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 <stdlib.h>
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/module.h"
33 #include "asterisk/channel.h"
34 #include "asterisk/pbx.h"
35 #include "asterisk/utils.h"
36 #include "asterisk/stringfields.h"
37
38 static int depwarning = 0;
39
40 static int moh_read(struct ast_channel *chan, char *cmd, char *data,
41                     char *buf, size_t len)
42 {
43         if (!depwarning) {
44                 depwarning = 1;
45                 ast_log(LOG_WARNING, "MUSICCLASS() is deprecated; use CHANNEL(musicclass) instead.\n");
46         }
47
48         ast_copy_string(buf, chan->musicclass, len);
49
50         return 0;
51 }
52
53 static int moh_write(struct ast_channel *chan, char *cmd, char *data,
54                      const char *value)
55 {
56         if (!depwarning) {
57                 depwarning = 1;
58                 ast_log(LOG_WARNING, "MUSICCLASS() is deprecated; use CHANNEL(musicclass) instead.\n");
59         }
60
61         ast_string_field_set(chan, musicclass, value);
62
63         return 0;
64 }
65
66 static struct ast_custom_function moh_function = {
67         .name = "MUSICCLASS",
68         .synopsis = "Read or Set the MusicOnHold class",
69         .syntax = "MUSICCLASS()",
70         .desc = "Deprecated. Use CHANNEL(musicclass) instead.\n",
71         .read = moh_read,
72         .write = moh_write,
73 };
74
75 static char *tdesc = "Music-on-hold dialplan function";
76
77 int unload_module(void)
78 {
79         return ast_custom_function_unregister(&moh_function);
80 }
81
82 int load_module(void)
83 {
84         return ast_custom_function_register(&moh_function);
85 }
86
87 char *description(void)
88 {
89         return tdesc;
90 }
91
92 int usecount(void)
93 {
94         return 0;
95 }
96
97 char *key()
98 {
99         return ASTERISK_GPL_KEY;
100 }