diff options
| author | rmudgett <rmudgett@f38db490-d61c-443f-a65b-d21fe96a405b> | 2010-07-14 15:48:36 +0000 |
|---|---|---|
| committer | rmudgett <rmudgett@f38db490-d61c-443f-a65b-d21fe96a405b> | 2010-07-14 15:48:36 +0000 |
| commit | ad58aa92a221bb6cd0a4133112672528a52fd4f8 (patch) | |
| tree | 84df3fc1c9db428d5833e3eed3908a71e32cd513 /funcs | |
| parent | 3c0a99b844ba77d93d3bece0261d729bd5135a6a (diff) | |
ast_callerid restructuring
The purpose of this patch is to eliminate struct ast_callerid since it has
turned into a miscellaneous collection of various party information.
Eliminate struct ast_callerid and replace it with the following struct
organization:
struct ast_party_name {
char *str;
int char_set;
int presentation;
unsigned char valid;
};
struct ast_party_number {
char *str;
int plan;
int presentation;
unsigned char valid;
};
struct ast_party_subaddress {
char *str;
int type;
unsigned char odd_even_indicator;
unsigned char valid;
};
struct ast_party_id {
struct ast_party_name name;
struct ast_party_number number;
struct ast_party_subaddress subaddress;
char *tag;
};
struct ast_party_dialed {
struct {
char *str;
int plan;
} number;
struct ast_party_subaddress subaddress;
int transit_network_select;
};
struct ast_party_caller {
struct ast_party_id id;
char *ani;
int ani2;
};
The new organization adds some new information as well.
* The party name and number now have their own presentation value that can
be manipulated independently. ISDN supplies the presentation value for
the name and number at different times with the possibility that they
could be different.
* The party name and number now have a valid flag. Before this change the
name or number string could be empty if the presentation were restricted.
Most channel drivers assume that the name or number is then simply not
available instead of indicating that the name or number was restricted.
* The party name now has a character set value. SIP and Q.SIG have the
ability to indicate what character set a name string is using so it could
be presented properly.
* The dialed party now has a numbering plan value that could be useful to
have available.
The various channel drivers will need to be updated to support the new
core features as needed. They have simply been converted to supply
current functionality at this time.
The following items of note were either corrected or enhanced:
* The CONNECTEDLINE() and REDIRECTING() dialplan functions were
consolidated into func_callerid.c to share party id handling code.
* CALLERPRES() is now deprecated because the name and number have their
own presentation values.
* Fixed app_alarmreceiver.c write_metadata(). The workstring[] could
contain garbage. It also can only contain the caller id number so using
ast_callerid_parse() on it is silly. There was also a typo in the
CALLERNAME if test.
* Fixed app_rpt.c using ast_callerid_parse() on the channel's caller id
number string. ast_callerid_parse() alters the given buffer which in this
case is the channel's caller id number string. Then using
ast_shrink_phone_number() could alter it even more.
* Fixed caller ID name and number memory leak in chan_usbradio.c.
* Fixed uninitialized char arrays cid_num[] and cid_name[] in
sig_analog.c.
* Protected access to a caller channel with lock in chan_sip.c.
* Clarified intent of code in app_meetme.c sla_ring_station() and
dial_trunk(). Also made save all caller ID data instead of just the name
and number strings.
* Simplified cdr.c set_one_cid(). It hand coded the ast_callerid_merge()
function.
* Corrected some weirdness with app_privacy.c's use of caller
presentation.
Review: https://reviewboard.asterisk.org/r/702/
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@276347 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'funcs')
| -rw-r--r-- | funcs/func_blacklist.c | 8 | ||||
| -rw-r--r-- | funcs/func_callerid.c | 1553 | ||||
| -rw-r--r-- | funcs/func_connectedline.c | 275 | ||||
| -rw-r--r-- | funcs/func_dialplan.c | 8 | ||||
| -rw-r--r-- | funcs/func_redirecting.c | 487 |
5 files changed, 1370 insertions, 961 deletions
diff --git a/funcs/func_blacklist.c b/funcs/func_blacklist.c index a765242d4..b940b5891 100644 --- a/funcs/func_blacklist.c +++ b/funcs/func_blacklist.c @@ -57,12 +57,12 @@ static int blacklist_read(struct ast_channel *chan, const char *cmd, char *data, char blacklist[1]; int bl = 0; - if (chan->cid.cid_num) { - if (!ast_db_get("blacklist", chan->cid.cid_num, blacklist, sizeof (blacklist))) + if (chan->caller.id.number.valid && chan->caller.id.number.str) { + if (!ast_db_get("blacklist", chan->caller.id.number.str, blacklist, sizeof (blacklist))) bl = 1; } - if (chan->cid.cid_name) { - if (!ast_db_get("blacklist", chan->cid.cid_name, blacklist, sizeof (blacklist))) + if (chan->caller.id.name.valid && chan->caller.id.name.str) { + if (!ast_db_get("blacklist", chan->caller.id.name.str, blacklist, sizeof (blacklist))) bl = 1; } diff --git a/funcs/func_callerid.c b/funcs/func_callerid.c index 357055c8c..98d58d07b 100644 --- a/funcs/func_callerid.c +++ b/funcs/func_callerid.c @@ -1,7 +1,7 @@ /* * Asterisk -- An open source telephony toolkit. * - * Copyright (C) 1999-2006, Digium, Inc. + * Copyright (C) 1999-2010, Digium, Inc. * * See http://www.asterisk.org for more information about * the Asterisk project. Please do not directly contact @@ -16,9 +16,12 @@ /*! \file * - * \brief Caller ID related dialplan functions + * \brief Party ID related dialplan functions (Caller-ID, Connected-line, Redirecting) * * \ingroup functions + * + * See Also: + * \arg \ref AstCREDITS */ #include "asterisk.h" @@ -32,6 +35,41 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/app.h" #include "asterisk/callerid.h" +/* + * Do not document the CALLERID(pres) datatype. + * The name and number now have their own presentation value. The pres + * option will simply live on as a historical relic with as best + * as can be managed backward compatible meaning. + * + * Do not document the CALLERID(ton) datatype. + * It is an alias for num-plan. + * + * Do not document the CONNECTEDLINE(source) datatype. + * It has turned out to not be needed. The source value is really + * only useful as a possible tracing aid. + * + * Do not document the CONNECTEDLINE(pres) datatype. + * The name and number now have their own presentation value. The pres + * option will simply live on as a historical relic with as best + * as can be managed backward compatible meaning. + * + * Do not document the CONNECTEDLINE(ton) datatype. + * It is an alias for num-plan. + * + * Do not document the REDIRECTING(pres) datatype. + * It has turned out that the from-pres and to-pres values must be kept + * separate. They represent two different parties and there is a case when + * they are active at the same time. The plain pres option will simply + * live on as a historical relic. + * + * Do not document the REDIRECTING(from-pres) or REDIRECTING(to-pres) datatypes. + * The name and number now have their own presentation value. The from-pres + * and to-pres options will simply live on as a historical relic with as best + * as can be managed backward compatible meaning. + * + * Do not document the REDIRECTING(from-ton) or REDIRECTING(to-ton) datatypes. + * They are aliases for from-num-plan and to-num-plan respectively. + */ /*** DOCUMENTATION <function name="CALLERID" language="en_US"> <synopsis> @@ -41,21 +79,28 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <parameter name="datatype" required="true"> <para>The allowable datatypes are:</para> <enumlist> - <enum name="all" /> - <enum name="num" /> - <enum name="name" /> - <enum name="tag" /> - <enum name="ANI" /> - <enum name="DNID" /> - <enum name="RDNIS" /> - <enum name="pres" /> - <enum name="ton" /> - <enum name="subaddr[-valid]|[-type]|[-odd]"> - <para>ISDN Calling Subaddress</para> - </enum> - <enum name="dnid-subaddr[-valid]|[-type]|[-odd]"> - <para>ISDN Called Subaddress</para> - </enum> + <enum name = "all" /> + <enum name = "name" /> + <enum name = "name-valid" /> + <enum name = "name-charset" /> + <enum name = "name-pres" /> + <enum name = "num" /> + <enum name = "num-valid" /> + <enum name = "num-plan" /> + <enum name = "num-pres" /> + <enum name = "subaddr" /> + <enum name = "subaddr-valid" /> + <enum name = "subaddr-type" /> + <enum name = "subaddr-odd" /> + <enum name = "tag" /> + <enum name = "ANI" /> + <enum name = "RDNIS" /> + <enum name = "DNID" /> + <enum name = "dnid-num-plan" /> + <enum name = "dnid-subaddr" /> + <enum name = "dnid-subaddr-valid" /> + <enum name = "dnid-subaddr-type" /> + <enum name = "dnid-subaddr-odd" /> </enumlist> </parameter> <parameter name="CID"> @@ -63,8 +108,22 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </parameter> </syntax> <description> - <para>Gets or sets Caller*ID data on the channel. Uses channel callerid by default or optional - callerid, if specified.</para> + <para>Gets or sets Caller*ID data on the channel. Uses channel callerid by + default or optional callerid, if specified.</para> + <para>The allowable values for the <replaceable>name-charset</replaceable> + field are the following:</para> + <enumlist> + <enum name = "unknown"><para>Unknown</para></enum> + <enum name = "iso8859-1"><para>ISO8859-1</para></enum> + <enum name = "withdrawn"><para>Withdrawn</para></enum> + <enum name = "iso8859-2"><para>ISO8859-2</para></enum> + <enum name = "iso8859-3"><para>ISO8859-3</para></enum> + <enum name = "iso8859-4"><para>ISO8859-4</para></enum> + <enum name = "iso8859-5"><para>ISO8859-5</para></enum> + <enum name = "iso8859-7"><para>ISO8859-7</para></enum> + <enum name = "bmp"><para>ISO10646 Bmp String</para></enum> + <enum name = "utf8"><para>ISO10646 UTF-8 String</para></enum> + </enumlist> </description> </function> <function name="CALLERPRES" language="en_US"> @@ -73,8 +132,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </synopsis> <syntax /> <description> - <para>Gets or sets Caller*ID presentation on the channel. The following values - are valid:</para> + <para>Gets or sets Caller*ID presentation on the channel. + This function is deprecated in favor of CALLERID(num-pres) + and CALLERID(name-pres). + The following values are valid:</para> <enumlist> <enum name="allowed_not_screened"> <para>Presentation Allowed, Not Screened.</para> @@ -106,47 +167,731 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </enumlist> </description> </function> + <function name="CONNECTEDLINE" language="en_US"> + <synopsis> + Gets or sets Connected Line data on the channel. + </synopsis> + <syntax> + <parameter name="datatype" required="true"> + <para>The allowable datatypes are:</para> + <enumlist> + <enum name = "all" /> + <enum name = "name" /> + <enum name = "name-valid" /> + <enum name = "name-charset" /> + <enum name = "name-pres" /> + <enum name = "num" /> + <enum name = "num-valid" /> + <enum name = "num-plan" /> + <enum name = "num-pres" /> + <enum name = "subaddr" /> + <enum name = "subaddr-valid" /> + <enum name = "subaddr-type" /> + <enum name = "subaddr-odd" /> + <enum name = "tag" /> + </enumlist> + </parameter> + <parameter name="i"> + <para>If set, this will prevent the channel from sending out protocol + messages because of the value being set</para> + </parameter> + </syntax> + <description> + <para>Gets or sets Connected Line data on the channel.</para> + <para>The allowable values for the <replaceable>name-charset</replaceable> + field are the following:</para> + <enumlist> + <enum name = "unknown"><para>Unknown</para></enum> + <enum name = "iso8859-1"><para>ISO8859-1</para></enum> + <enum name = "withdrawn"><para>Withdrawn</para></enum> + <enum name = "iso8859-2"><para>ISO8859-2</para></enum> + <enum name = "iso8859-3"><para>ISO8859-3</para></enum> + <enum name = "iso8859-4"><para>ISO8859-4</para></enum> + <enum name = "iso8859-5"><para>ISO8859-5</para></enum> + <enum name = "iso8859-7"><para>ISO8859-7</para></enum> + <enum name = "bmp"><para>ISO10646 Bmp String</para></enum> + <enum name = "utf8"><para>ISO10646 UTF-8 String</para></enum> + </enumlist> + </description> + </function> + <function name="REDIRECTING" language="en_US"> + <synopsis> + Gets or sets Redirecting data on the channel. + </synopsis> + <syntax> + <parameter name="datatype" required="true"> + <para>The allowable datatypes are:</para> + <enumlist> + <enum name = "from-all" /> + <enum name = "from-name" /> + <enum name = "from-name-valid" /> + <enum name = "from-name-charset" /> + <enum name = "from-name-pres" /> + <enum name = "from-num" /> + <enum name = "from-num-valid" /> + <enum name = "from-num-plan" /> + <enum name = "from-num-pres" /> + <enum name = "from-subaddr" /> + <enum name = "from-subaddr-valid" /> + <enum name = "from-subaddr-type" /> + <enum name = "from-subaddr-odd" /> + <enum name = "from-tag" /> + <enum name = "to-all" /> + <enum name = "to-name" /> + <enum name = "to-name-valid" /> + <enum name = "to-name-charset" /> + <enum name = "to-name-pres" /> + <enum name = "to-num" /> + <enum name = "to-num-valid" /> + <enum name = "to-num-plan" /> + <enum name = "to-num-pres" /> + <enum name = "to-subaddr" /> + <enum name = "to-subaddr-valid" /> + <enum name = "to-subaddr-type" /> + <enum name = "to-subaddr-odd" /> + <enum name = "to-tag" /> + <enum name = "reason" /> + <enum name = "count" /> + </enumlist> + </parameter> + <parameter name="i"> + <para>If set, this will prevent the channel from sending out protocol + messages because of the value being set</para> + </parameter> + </syntax> + <description> + <para>Gets or sets Redirecting data on the channel.</para> + <para>The allowable values for the <replaceable>reason</replaceable> + field are the following:</para> + <enumlist> + <enum name = "unknown"><para>Unknown</para></enum> + <enum name = "cfb"><para>Call Forwarding Busy</para></enum> + <enum name = "cfnr"><para>Call Forwarding No Reply</para></enum> + <enum name = "unavailable"><para>Callee is Unavailable</para></enum> + <enum name = "time_of_day"><para>Time of Day</para></enum> + <enum name = "dnd"><para>Do Not Disturb</para></enum> + <enum name = "deflection"><para>Call Deflection</para></enum> + <enum name = "follow_me"><para>Follow Me</para></enum> + <enum name = "out_of_order"><para>Called DTE Out-Of-Order</para></enum> + <enum name = "away"><para>Callee is Away</para></enum> + <enum name = "cf_dte"><para>Call Forwarding By The Called DTE</para></enum> + <enum name = "cfu"><para>Call Forwarding Unconditional</para></enum> + </enumlist> + <para>The allowable values for the <replaceable>xxx-name-charset</replaceable> + field are the following:</para> + <enumlist> + <enum name = "unknown"><para>Unknown</para></enum> + <enum name = "iso8859-1"><para>ISO8859-1</para></enum> + <enum name = "withdrawn"><para>Withdrawn</para></enum> + <enum name = "iso8859-2"><para>ISO8859-2</para></enum> + <enum name = "iso8859-3"><para>ISO8859-3</para></enum> + <enum name = "iso8859-4"><para>ISO8859-4</para></enum> + <enum name = "iso8859-5"><para>ISO8859-5</para></enum> + <enum name = "iso8859-7"><para>ISO8859-7</para></enum> + <enum name = "bmp"><para>ISO10646 Bmp String</para></enum> + <enum name = "utf8"><para>ISO10646 UTF-8 String</para></enum> + </enumlist> + </description> + </function> ***/ +enum ID_FIELD_STATUS { + ID_FIELD_VALID, + ID_FIELD_INVALID, + ID_FIELD_UNKNOWN +}; + +AST_DEFINE_APP_ARGS_TYPE(ast_party_func_args, + AST_APP_ARG(member); /*!< Member name */ + AST_APP_ARG(opts); /*!< Options token */ + AST_APP_ARG(other); /*!< Any remining unused arguments */ + ); + +AST_DEFINE_APP_ARGS_TYPE(ast_party_members, + AST_APP_ARG(subnames[10]); /*!< Option member subnames */ + ); + +enum CONNECTED_LINE_OPT_FLAGS { + CONNECTED_LINE_OPT_INHIBIT = (1 << 0), +}; +enum CONNECTED_LINE_OPT_ARGS { + CONNECTED_LINE_OPT_DUMMY, /*!< Delete this if CONNECTED_LINE ever gets an option with parameters. */ + + /*! \note This entry _MUST_ be the last one in the enum */ + CONNECTED_LINE_OPT_ARG_ARRAY_SIZE +}; + +AST_APP_OPTIONS(connectedline_opts, BEGIN_OPTIONS + AST_APP_OPTION('i', CONNECTED_LINE_OPT_INHIBIT), +END_OPTIONS); + +enum REDIRECTING_OPT_FLAGS { + REDIRECTING_OPT_INHIBIT = (1 << 0), +}; +enum REDIRECTING_OPT_ARGS { + REDIRECTING_OPT_DUMMY, /*!< Delete this if REDIRECTING ever gets an option with parameters. */ + + /*! \note This entry _MUST_ be the last one in the enum */ + REDIRECTING_OPT_ARG_ARRAY_SIZE +}; + +AST_APP_OPTIONS(redirecting_opts, BEGIN_OPTIONS + AST_APP_OPTION('i', REDIRECTING_OPT_INHIBIT), +END_OPTIONS); + +/*! + * \internal + * \brief Read values from the party name struct. + * \since 1.8 + * + * \param buf Buffer to fill with read value. + * \param len Length of the buffer. + * \param argc Number of party member subnames. + * \param argv Party member subnames given. + * \param name Party name to get values from. + * + * \retval ID_FIELD_VALID on success. + * \retval ID_FIELD_UNKNOWN on unknown field name. + */ +static enum ID_FIELD_STATUS party_name_read(char *buf, size_t len, int argc, char *argv[], const struct ast_party_name *name) +{ + enum ID_FIELD_STATUS status; + + status = ID_FIELD_VALID; + + if (argc == 0) { + /* We want the name string */ + if (name->valid && name->str) { + ast_copy_string(buf, name->str, len); + } + } else if (argc == 1 && !strcasecmp("valid", argv[0])) { + snprintf(buf, len, "%d", name->valid); + } else if (argc == 1 && !strcasecmp("charset", argv[0])) { + ast_copy_string(buf, ast_party_name_charset_str(name->char_set), len); + } else if (argc == 1 && !strncasecmp("pres", argv[0], 4)) { + /* Accept pres[entation] */ + ast_copy_string(buf, ast_named_caller_presentation(name->presentation), len); + } else { + status = ID_FIELD_UNKNOWN; + } + + return status; +} + +/*! + * \internal + * \brief Read values from the party number struct. + * \since 1.8 + * + * \param buf Buffer to fill with read value. + * \param len Length of the buffer. + * \param argc Number of party member subnames. + * \param argv Party member subnames given. + * \param number Party number to get values from. + * + * \retval ID_FIELD_VALID on success. + * \retval ID_FIELD_UNKNOWN on unknown field name. + */ +static enum ID_FIELD_STATUS party_number_read(char *buf, size_t len, int argc, char *argv[], const struct ast_party_number *number) +{ + enum ID_FIELD_STATUS status; + + status = ID_FIELD_VALID; + + if (argc == 0) { + /* We want the number string */ + if (number->valid && number->str) { + ast_copy_string(buf, number->str, len); + } + } else if (argc == 1 && !strcasecmp("valid", argv[0])) { + snprintf(buf, len, "%d", number->valid); + } else if (argc == 1 && !strcasecmp("plan", argv[0])) { + snprintf(buf, len, "%d", number->plan); + } else if (argc == 1 && !strncasecmp("pres", argv[0], 4)) { + /* Accept pres[entation] */ + ast_copy_string(buf, ast_named_caller_presentation(number->presentation), len); + } else { + status = ID_FIELD_UNKNOWN; + } + + return status; +} + +/*! + * \internal + * \brief Read values from the party subaddress struct. + * \since 1.8 + * + * \param buf Buffer to fill with read value. + * \param len Length of the buffer. + * \param argc Number of party member subnames. + * \param argv Party member subnames given. + * \param subaddress Party subaddress to get values from. + * + * \retval ID_FIELD_VALID on success. + * \retval ID_FIELD_UNKNOWN on unknown field name. + */ +static enum ID_FIELD_STATUS party_subaddress_read(char *buf, size_t len, int argc, char *argv[], const struct ast_party_subaddress *subaddress) +{ + enum ID_FIELD_STATUS status; + + status = ID_FIELD_VALID; + + if (argc == 0) { + /* We want the subaddress string */ + if (subaddress->str) { + ast_copy_string(buf, subaddress->str, len); + } + } else if (argc == 1 && !strcasecmp("valid", argv[0])) { + snprintf(buf, len, "%d", subaddress->valid); + } else if (argc == 1 && !strcasecmp("type", argv[0])) { + snprintf(buf, len, "%d", subaddress->type); + } else if (argc == 1 && !strcasecmp("odd", argv[0])) { + snprintf(buf, len, "%d", subaddress->odd_even_indicator); + } else { + status = ID_FIELD_UNKNOWN; + } + + return status; +} + +/*! + * \internal + * \brief Read values from the party id struct. + * \since 1.8 + * + * \param buf Buffer to fill with read value. + * \param len Length of the buffer. + * \param argc Number of party member subnames. + * \param argv Party member subnames given. + * \param id Party id to get values from. + * + * \retval ID_FIELD_VALID on success. + * \retval ID_FIELD_UNKNOWN on unknown field name. + */ +static enum ID_FIELD_STATUS party_id_read(char *buf, size_t len, int argc, char *argv[], const struct ast_party_id *id) +{ + enum ID_FIELD_STATUS status; + + if (argc == 0) { + /* Must have at least one subname. */ + return ID_FIELD_UNKNOWN; + } + + status = ID_FIELD_VALID; + + if (argc == 1 && !strcasecmp("all", argv[0])) { + snprintf(buf, len, "\"%s\" <%s>", + S_COR(id->name.valid, id->name.str, ""), + S_COR(id->number.valid, id->number.str, "")); + } else if (!strcasecmp("name", argv[0])) { + status = party_name_read(buf, len, argc - 1, argv + 1, &id->name); + } else if (!strncasecmp("num", argv[0], 3)) { + /* Accept num[ber] */ + status = party_number_read(buf, len, argc - 1, argv + 1, &id->number); + } else if (!strncasecmp("subaddr", argv[0], 7)) { + /* Accept subaddr[ess] */ + status = party_subaddress_read(buf, len, argc - 1, argv + 1, &id->subaddress); + } else if (argc == 1 && !strcasecmp("tag", argv[0])) { + if (id->tag) { + ast_copy_string(buf, id->tag, len); + } + } else if (argc == 1 && !strcasecmp("ton", argv[0])) { + /* ton is an alias for num-plan */ + snprintf(buf, len, "%d", id->number.plan); + } else if (argc == 1 && !strncasecmp("pres", argv[0], 4)) { + /* + * Accept pres[entation] + * This is the combined name/number presentation. + */ + ast_copy_string(buf, + ast_named_caller_presentation(ast_party_id_presentation(id)), len); + } else { + status = ID_FIELD_UNKNOWN; + } + + return status; +} + +/*! + * \internal + * \brief Write new values to the party name struct + * \since 1.8 + * + * \param name Party name struct to write values + * \param argc Number of party member subnames. + * \param argv Party member subnames given. + * \param value Value to assign to the party name. + * + * \retval ID_FIELD_VALID on success. + * \retval ID_FIELD_INVALID on error with field value. + * \retval ID_FIELD_UNKNOWN on unknown field name. + */ +static enum ID_FIELD_STATUS party_name_write(struct ast_party_name *name, int argc, char *argv[], const char *value) +{ + char *val; + enum ID_FIELD_STATUS status; + + status = ID_FIELD_VALID; + + if (argc == 0) { + /* We are setting the name string */ + name->valid = 1; + name->str = ast_strdup(value); + ast_trim_blanks(name->str); + } else if (argc == 1 && !strcasecmp("valid", argv[0])) { + name->valid = atoi(value) ? 1 : 0; + } else if (argc == 1 && !strcasecmp("charset", argv[0])) { + int char_set; + + val = ast_strdupa(value); + ast_trim_blanks(val); + + if (('0' <= val[0]) && (val[0] <= '9')) { + char_set = atoi(val); + } else { + char_set = ast_party_name_charset_parse(val); + } + + if (char_set < 0) { + ast_log(LOG_ERROR, + "Unknown name char-set '%s', value unchanged\n", val); + status = ID_FIELD_INVALID; + } else { + name->char_set = char_set; + } + } else if (argc == 1 && !strncasecmp("pres", argv[0], 4)) { + int pres; + + /* Accept pres[entation] */ + val = ast_strdupa(value); + ast_trim_blanks(val); + + if (('0' <= val[0]) && (val[0] <= '9')) { + pres = atoi(val); + } else { + pres = ast_parse_caller_presentation(val); + } + + if (pres < 0) { + ast_log(LOG_ERROR, + "Unknown name presentation '%s', value unchanged\n", val); + status = ID_FIELD_INVALID; + } else { + name->presentation = pres; + } + } else { + status = ID_FIELD_UNKNOWN; + } + + return status; +} + +/*! + * \internal + * \brief Write new values to the party number struct + * \since 1.8 + * + * \param number Party number struct to write values + * \param argc Number of party member subnames. + * \param argv Party member subnames given. + * \param value Value to assign to the party number. + * + * \retval ID_FIELD_VALID on success. + * \retval ID_FIELD_INVALID on error with field value. + * \retval ID_FIELD_UNKNOWN on unknown field name. + */ +static enum ID_FIELD_STATUS party_number_write(struct ast_party_number *number, int argc, char *argv[], const char *value) +{ + char *val; + enum ID_FIELD_STATUS status; + + status = ID_FIELD_VALID; + + if (argc == 0) { + /* We are setting the number string */ + number->valid = 1; + number->str = ast_strdup(value); + ast_trim_blanks(number->str); + } else if (argc == 1 && !strcasecmp("valid", argv[0])) { + number->valid = atoi(value) ? 1 : 0; + } else if (argc == 1 && !strcasecmp("plan", argv[0])) { + val = ast_strdupa(value); + ast_trim_blanks(val); + + if (('0' <= val[0]) && (val[0] <= '9')) { + number->plan = atoi(val); + } else { + ast_log(LOG_ERROR, + "Unknown type-of-number/numbering-plan '%s', value unchanged\n", val); + status = ID_FIELD_INVALID; + } + } else if (argc == 1 && !strncasecmp("pres", argv[0], 4)) { + int pres; + + /* Accept pres[entation] */ + val = ast_strdupa(value); + ast_trim_blanks(val); + + if (('0' <= val[0]) && (val[0] <= '9')) { + pres = atoi(val); + } else { + pres = ast_parse_caller_presentation(val); + } + + if (pres < 0) { + ast_log(LOG_ERROR, + "Unknown number presentation '%s', value unchanged\n", val); + status = ID_FIELD_INVALID; + } else { + number->presentation = pres; + } + } else { + status = ID_FIELD_UNKNOWN; + } + + return status; +} + +/*! + * \internal + * \brief Write new values to the party subaddress struct + * \since 1.8 + * + * \param subaddress Party subaddress struct to write values + * \param argc Number of party member subnames. + * \param argv Party member subnames given. + * \param value Value to assign to the party subaddress. + * + * \retval ID_FIELD_VALID on success. + * \retval ID_FIELD_INVALID on error with field value. + * \retval ID_FIELD_UNKNOWN on unknown field name. + */ +static enum ID_FIELD_STATUS party_subaddress_write(struct ast_party_subaddress *subaddress, int argc, char *argv[], const char *value) +{ + enum ID_FIELD_STATUS status; + + status = ID_FIELD_VALID; + + if (argc == 0) { + /* We are setting the subaddress string */ + subaddress->str = ast_strdup(value); + ast_trim_blanks(subaddress->str); + } else if (argc == 1 && !strcasecmp("valid", argv[0])) { + subaddress->valid = atoi(value) ? 1 : 0; + } else if (argc == 1 && !strcasecmp("type", argv[0])) { + subaddress->type = atoi(value) ? 2 : 0; + } else if (argc == 1 && !strcasecmp("odd", argv[0])) { + subaddress->odd_even_indicator = atoi(value) ? 1 : 0; + } else { + status = ID_FIELD_UNKNOWN; + } + + return status; +} + +/*! + * \internal + * \brief Write new values to the party id struct + * \since 1.8 + * + * \param id Party ID struct to write values + * \param argc Number of party member subnames. + * \param argv Party member subnames given. + * \param value Value to assign to the party id. + * + * \retval ID_FIELD_VALID on success. + * \retval ID_FIELD_INVALID on error with field value. + * \retval ID_FIELD_UNKNOWN on unknown field name. + */ +static enum ID_FIELD_STATUS party_id_write(struct ast_party_id *id, int argc, char *argv[], const char *value) +{ + char *val; + enum ID_FIELD_STATUS status; + + if (argc == 0) { + /* Must have at least one subname. */ + return ID_FIELD_UNKNOWN; + } + + status = ID_FIELD_VALID; + + if (argc == 1 && !strcasecmp("all", argv[0])) { + char name[256]; + char num[256]; + + ast_callerid_split(value, name, sizeof(name), num, sizeof(num)); + id->name.valid = 1; + id->name.str = ast_strdup(name); + if (!id->name.str) { + return ID_FIELD_INVALID; + } + id->number.valid = 1; + id->number.str = ast_strdup(num); + if (!id->number.str) { + return ID_FIELD_INVALID; + } + } else if (!strcasecmp("name", argv[0])) { + status = party_name_write(&id->name, argc - 1, argv + 1, value); + } else if (!strncasecmp("num", argv[0], 3)) { + /* Accept num[ber] */ + status = party_number_write(&id->number, argc - 1, argv + 1, value); + } else if (!strncasecmp("subaddr", argv[0], 7)) { + /* Accept subaddr[ess] */ + status = party_subaddress_write(&id->subaddress, argc - 1, argv + 1, value); + } else if (argc == 1 && !strcasecmp("tag", argv[0])) { + id->tag = ast_strdup(value); + ast_trim_blanks(id->tag); + } else if (argc == 1 && !strcasecmp("ton", argv[0])) { + /* ton is an alias for num-plan */ + argv[0] = "plan"; + status = party_number_write(&id->number, argc, argv, value); + } else if (argc == 1 && !strncasecmp("pres", argv[0], 4)) { + int pres; + + /* + * Accept pres[entation] + * This is the combined name/number presentation. + */ + val = ast_strdupa(value); + ast_trim_blanks(val); + + if (('0' <= val[0]) && (val[0] <= '9')) { + pres = atoi(val); + } else { + pres = ast_parse_caller_presentation(val); + } + + if (pres < 0) { + ast_log(LOG_ERROR, + "Unknown combined presentation '%s', value unchanged\n", val); + status = ID_FIELD_INVALID; + } else { + id->name.presentation = pres; + id->number.presentation = pres; + } + } else { + status = ID_FIELD_UNKNOWN; + } + + return status; +} + +/*! TRUE if we have already notified about CALLERPRES being deprecated. */ +static int callerpres_deprecate_notify; + +/*! + * \internal + * \brief Read values from the caller-id presentation information struct. + * + * \param chan Asterisk channel to read + * \param cmd Not used + * \param data Caller-id presentation function datatype string + * \param buf Buffer to fill with read value. + * \param len Length of the buffer + * + * \retval 0 on success. + * \retval -1 on error. + */ static int callerpres_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { - ast_copy_string(buf, ast_named_caller_presentation(chan->cid.cid_pres), len); + if (!callerpres_deprecate_notify) { + callerpres_deprecate_notify = 1; + ast_log(LOG_WARNING, "CALLERPRES is deprecated." + " Use CALLERID(name-pres) or CALLERID(num-pres) instead.\n"); + } + ast_copy_string(buf, + ast_named_caller_presentation(ast_party_id_presentation(&chan->caller.id)), len); return 0; } +/*! + * \internal + * \brief Write new values to the caller-id presentation information struct. + * + * \param chan Asterisk channel to update + * \param cmd Not used + * \param data Caller-id presentation function datatype string + * \param value Value to assign to the caller-id presentation information struct. + * + * \retval 0 on success. + * \retval -1 on error. + */ static int callerpres_write(struct ast_channel *chan, const char *cmd, char *data, const char *value) { - int pres = ast_parse_caller_presentation(value); - if (pres < 0) + int pres; + + if (!callerpres_deprecate_notify) { + callerpres_deprecate_notify = 1; + ast_log(LOG_WARNING, "CALLERPRES is deprecated." + " Use CALLERID(name-pres) or CALLERID(num-pres) instead.\n"); + } + + pres = ast_parse_caller_presentation(value); + if (pres < 0) { ast_log(LOG_WARNING, "'%s' is not a valid presentation (see 'show function CALLERPRES')\n", value); - else - chan->cid.cid_pres = pres; + } else { + chan->caller.id.name.presentation = pres; + chan->caller.id.number.presentation = pres; + } return 0; } -static int callerid_read(struct ast_channel *chan, const char *cmd, char *data, - char *buf, size_t len) +/*! + * \internal + * \brief Read values from the caller-id information struct. + * + * \param chan Asterisk channel to read + * \param cmd Not used + * \param data Caller-id function datatype string + * \param buf Buffer to fill with read value. + * \param len Length of the buffer + * + * \retval 0 on success. + * \retval -1 on error. + */ +static int callerid_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { - char *opt = data; + enum ID_FIELD_STATUS status; + char *parms; + struct ast_party_members member; + AST_DECLARE_APP_ARGS(args, + AST_APP_ARG(member); /*!< Member name */ + AST_APP_ARG(cid); /*!< Optional caller id to parse instead of from the channel. */ + ); /* Ensure that the buffer is empty */ *buf = 0; - if (!chan) + if (!chan) { return -1; + } - if (strchr(opt, ',')) { - char name[80], num[80]; + parms = ast_strdupa(data); + AST_STANDARD_APP_ARGS(args, parms); + if (args.argc == 0) { + /* Must have at least one argument. */ + return -1; + } + + AST_NONSTANDARD_APP_ARGS(member, args.member, '-'); + if (member.argc == 0 || ARRAY_LEN(member.subnames) <= member.argc) { + /* Too few or too many subnames */ + return -1; + } - data = strsep(&opt, ","); - ast_callerid_split(opt, name, sizeof(name), num, sizeof(num)); + if (args.argc == 2) { + char name[80]; + char num[80]; - if (!strncasecmp("all", data, 3)) { + ast_callerid_split(args.cid, name, sizeof(name), num, sizeof(num)); + + if (member.argc == 1 && !strcasecmp("all", member.argv[0])) { snprintf(buf, len, "\"%s\" <%s>", name, num); - } else if (!strncasecmp("name", data, 4)) { + } else if (member.argc == 1 && !strcasecmp("name", member.argv[0])) { ast_copy_string(buf, name, len); - } else if (!strncasecmp("num", data, 3)) { - /* also matches "number" */ + } else if (member.argc == 1 && !strncasecmp("num", member.argv[0], 3)) { + /* Accept num[ber] */ ast_copy_string(buf, num, len); } else { ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); @@ -154,75 +899,67 @@ static int callerid_read(struct ast_channel *chan, const char *cmd, char *data, } else { ast_channel_lock(chan); - if (!strncasecmp("all", data, 3)) { - snprintf(buf, len, "\"%s\" <%s>", - S_OR(chan->cid.cid_name, ""), - S_OR(chan->cid.cid_num, "")); - } else if (!strncasecmp("name", data, 4)) { - if (chan->cid.cid_name) { - ast_copy_string(buf, chan->cid.cid_name, len); - } - } else if (!strncasecmp("tag", data, 3)) { - if (chan->cid.cid_tag) { - ast_copy_string(buf, chan->cid.cid_tag, len); + if (member.argc == 1 && !strcasecmp("rdnis", member.argv[0])) { + if (chan->redirecting.from.number.valid + && chan->redirecting.from.number.str) { + ast_copy_string(buf, chan->redirecting.from.number.str, len); } - } else if (!strncasecmp("num", data, 3)) { - /* also matches "number" */ - if (chan->cid.cid_num) { - ast_copy_string(buf, chan->cid.cid_num, len); + } else if (!strcasecmp("dnid", member.argv[0])) { + if (member.argc == 1) { + /* Setup as if user had given dnid-num instead. */ + member.argc = 2; + member.argv[1] = "num"; } - } else if (!strncasecmp("ani", data, 3)) { - if (!strncasecmp(data + 3, "2", 1)) { - snprintf(buf, len, "%d", chan->cid.cid_ani2); - } else if (chan->cid.cid_ani) { - ast_copy_string(buf, chan->cid.cid_ani, len); - } - } else if (!strncasecmp("dnid", data, 4)) { - /* Called parties info */ - - /* also matches dnid-subaddr-valid, dnid-subaddr-type, dnid-subaddr-odd, dnid-subaddr */ - if (!strncasecmp(data + 4 ,"-subaddr", 8)) { - if (!strncasecmp(data + 12 ,"-valid", 6)) { /* dnid-subaddr-valid */ - snprintf(buf, len, "%d", chan->cid.dialed_subaddress.valid); - } else if (!strncasecmp(data + 12 ,"-type", 5)) { /* dnid-subaddr-type */ - snprintf(buf, len, "%d", chan->cid.dialed_subaddress.type); - } else if (!strncasecmp(data + 12 ,"-odd", 4)) { /* dnid-subaddr-odd */ - snprintf(buf, len, "%d", chan->cid.dialed_subaddress.odd_even_indicator); - } else { /* dnid-subaddr */ - if (chan->cid.dialed_subaddress.str) { - ast_copy_string(buf, chan->cid.dialed_subaddress.str, len); + if (!strncasecmp("num", member.argv[1], 3)) { + /* + * Accept num[ber] + * dnid-num... + */ + if (member.argc == 2) { + /* dnid-num */ + if (chan->dialed.number.str) { + ast_copy_string(buf, chan->dialed.number.str, len); } + } else if (member.argc == 3 && !strcasecmp("plan", member.argv[2])) { + /* dnid-num-plan */ + snprintf(buf, len, "%d", chan->dialed.number.plan); + } else { + ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); } - } else { /* dnid */ - if (chan->cid.cid_dnid) { - ast_copy_string(buf, chan->cid.cid_dnid, len); + } else if (!strncasecmp("subaddr", member.argv[1], 7)) { + /* + * Accept subaddr[ess] + * dnid-subaddr... + */ + status = party_subaddress_read(buf, len, member.argc - 2, member.argv + 2, + &chan->dialed.subaddress); + switch (status) { + case ID_FIELD_VALID: + case ID_FIELD_INVALID: + break; + default: + ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); + break; } + } else { + ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); } - } else if (!strncasecmp("subaddr", data, 7)) { - /* Calling parties info */ - - /* also matches subaddr-valid, subaddr-type, subaddr-odd, subaddr */ - if (!strncasecmp(data + 7 ,"-valid", 6)) { /* subaddr-valid */ - snprintf(buf, len, "%d", chan->cid.subaddress.valid); - } else if (!strncasecmp(data + 7 ,"-type", 5)) { /* subaddr-type */ - snprintf(buf, len, "%d", chan->cid.subaddress.type); - } else if (!strncasecmp(data + 7 ,"-odd", 4)) { /* subaddr-odd */ - snprintf(buf, len, "%d", chan->cid.subaddress.odd_even_indicator); - } else { /* subaddr */ - if (chan->cid.subaddress.str) { - ast_copy_string(buf, chan->cid.subaddress.str, len); - } + } else if (member.argc == 1 && !strcasecmp("ani2", member.argv[0])) { + snprintf(buf, len, "%d", chan->caller.ani2); + } else if (member.argc == 1 && !strcasecmp("ani", member.argv[0])) { + if (chan->caller.ani) { + ast_copy_string(buf, chan->caller.ani, len); } - } else if (!strncasecmp("rdnis", data, 5)) { - if (chan->redirecting.from.number) { - ast_copy_string(buf, chan->redirecting.from.number, len); - } - } else if (!strncasecmp("pres", data, 4)) { - ast_copy_string(buf, ast_named_caller_presentation(chan->cid.cid_pres), len); - } else if (!strncasecmp("ton", data, 3)) { - snprintf(buf, len, "%d", chan->cid.cid_ton); } else { - ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); + status = party_id_read(buf, len, member.argc, member.argv, &chan->caller.id); + switch (status) { + case ID_FIELD_VALID: + case ID_FIELD_INVALID: + break; + default: + ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); + break; + } } ast_channel_unlock(chan); @@ -231,126 +968,525 @@ static int callerid_read(struct ast_channel *chan, const char *cmd, char *data, return 0; } -static int callerid_write(struct ast_channel *chan, const char *cmd, char *data, - const char *value) +/*! + * \internal + * \brief Write new values to the caller-id information struct. + * + * \param chan Asterisk channel to update + * \param cmd Not used + * \param data Caller-id function datatype string + * \param value Value to assign to the caller-id information struct. + * + * \retval 0 on success. + * \retval -1 on error. + */ +static int callerid_write(struct ast_channel *chan, const char *cmd, char *data, const char *value) { - if (!value || !chan) + struct ast_party_caller caller; + struct ast_party_dialed dialed; + enum ID_FIELD_STATUS status; + char *val; + char *parms; + struct ast_party_func_args args; + struct ast_party_members member; + + if (!value || !chan) { return -1; + } - value = ast_skip_blanks(value); + parms = ast_strdupa(data); + AST_STANDARD_APP_ARGS(args, parms); + if (args.argc == 0) { + /* Must have at least one argument. */ + return -1; + } - if (!strncasecmp("all", data, 3)) { - char name[256]; - char num[256]; + AST_NONSTANDARD_APP_ARGS(member, args.member, '-'); + if (member.argc == 0 || ARRAY_LEN(member.subnames) <= member.argc) { + /* Too few or too many subnames */ + return -1; + } - ast_callerid_split(value, name, sizeof(name), num, sizeof(num)); - ast_set_callerid(chan, num, name, num); - if (chan->cdr) { - ast_cdr_setcid(chan->cdr, chan); - } - } else if (!strncasecmp("name", data, 4)) { - ast_set_callerid(chan, NULL, value, NULL); + value = ast_skip_blanks(value); + + ast_channel_lock(chan); + if (member.argc == 1 && !strcasecmp("rdnis", member.argv[0])) { + chan->redirecting.from.number.valid = 1; + ast_free(chan->redirecting.from.number.str); + chan->redirecting.from.number.str = ast_strdup(value); if (chan->cdr) { ast_cdr_setcid(chan->cdr, chan); } - } else if (!strncasecmp("num", data, 3)) { - /* also matches "number" */ - ast_set_callerid(chan, value, NULL, NULL); - if (chan->cdr) { - ast_cdr_setcid(chan->cdr, chan); + } else if (!strcasecmp("dnid", member.argv[0])) { + ast_party_dialed_set_init(&dialed, &chan->dialed); + if (member.argc == 1) { + /* Setup as if user had given dnid-num instead. */ + member.argc = 2; + member.argv[1] = "num"; } - } else if (!strncasecmp("tag", data, 3)) { - ast_channel_lock(chan); - if (chan->cid.cid_tag) { - ast_free(chan->cid.cid_tag); + if (!strncasecmp("num", member.argv[1], 3)) { + /* + * Accept num[ber] + * dnid-num... + */ + if (member.argc == 2) { + /* dnid-num */ + dialed.number.str = ast_strdup(value); + ast_trim_blanks(dialed.number.str); + ast_party_dialed_set(&chan->dialed, &dialed); + if (chan->cdr) { + ast_cdr_setcid(chan->cdr, chan); + } + } else if (member.argc == 3 && !strcasecmp("plan", member.argv[2])) { + /* dnid-num-plan */ + val = ast_strdupa(value); + ast_trim_blanks(val); + + if (('0' <= val[0]) && (val[0] <= '9')) { + chan->dialed.number.plan = atoi(val); + if (chan->cdr) { + ast_cdr_setcid(chan->cdr, chan); + } + } else { + ast_log(LOG_ERROR, + "Unknown type-of-number/numbering-plan '%s', value unchanged\n", val); + } + } else { + ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); + } + } else if (!strncasecmp("subaddr", member.argv[1], 7)) { + /* + * Accept subaddr[ess] + * dnid-subaddr... + */ + status = party_subaddress_write(&dialed.subaddress, member.argc - 2, + member.argv + 2, value); + switch (status) { + case ID_FIELD_VALID: + ast_party_dialed_set(&chan->dialed, &dialed); + if (chan->cdr) { + ast_cdr_setcid(chan->cdr, chan); + } + break; + case ID_FIELD_INVALID: + break; + default: + ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); + break; + } + } else { + ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); } - chan->cid.cid_tag = ast_strdup(value); - ast_channel_unlock(chan); - } else if (!strncasecmp("ani", data, 3)) { - if (!strncasecmp(data + 3, "2", 1)) { - chan->cid.cid_ani2 = atoi(value); + ast_party_dialed_free(&dialed); + } else if (member.argc == 1 && !strcasecmp("ani2", member.argv[0])) { + val = ast_strdupa(value); + ast_trim_blanks(val); + + if (('0' <= val[0]) && (val[0] <= '9')) { + chan->caller.ani2 = atoi(val); + if (chan->cdr) { + ast_cdr_setcid(chan->cdr, chan); + } } else { - ast_set_callerid(chan, NULL, NULL, value); + ast_log(LOG_ERROR, "Unknown callerid ani2 '%s', value unchanged\n", val); } + } else if (member.argc == 1 && !strcasecmp("ani", member.argv[0])) { + ast_party_caller_set_init(&caller, &chan->caller); + caller.ani = ast_strdup(value); + ast_trim_blanks(caller.ani); + ast_party_caller_set(&chan->caller, &caller, NULL); if (chan->cdr) { ast_cdr_setcid(chan->cdr, chan); } - } else if (!strncasecmp("dnid", data, 4)) { - ast_channel_lock(chan); - /* also matches dnid-subaddr-valid, dnid-subaddr-type, dnid-subaddr-odd, dnid-subaddr */ - if (!strncasecmp(data + 4 ,"-subaddr", 8)) { - if (!strncasecmp(data + 12 ,"-valid", 6)) { /* dnid-subaddr-valid */ - chan->cid.dialed_subaddress.valid = atoi(value) ? 1 : 0; - } else if (!strncasecmp(data + 12 ,"-type", 5)) { /* dnid-subaddr-type */ - chan->cid.dialed_subaddress.type = atoi(value) ? 2 : 0; - } else if (!strncasecmp(data + 12 ,"-odd", 4)) { /* dnid-subaddr-odd */ - chan->cid.dialed_subaddress.odd_even_indicator = atoi(value) ? 1 : 0; - } else { /* dnid-subaddr */ - if (chan->cid.dialed_subaddress.str) { - ast_free(chan->cid.dialed_subaddress.str); - } - chan->cid.dialed_subaddress.str = ast_strdup(value); - } - } else { /* dnid */ - if (chan->cid.cid_dnid) { - ast_free(chan->cid.cid_dnid); + ast_party_caller_free(&caller); + } else { + ast_party_caller_set_init(&caller, &chan->caller); + status = party_id_write(&caller.id, member.argc, member.argv, value); + switch (status) { + case ID_FIELD_VALID: + ast_channel_set_caller_event(chan, &caller, NULL); + if (chan->cdr) { + ast_cdr_setcid(chan->cdr, chan); } - chan->cid.cid_dnid = ast_strdup(value); + break; + case ID_FIELD_INVALID: + break; + default: + ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); + break; } + ast_party_caller_free(&caller); + } + ast_channel_unlock(chan); - if (chan->cdr) { - ast_cdr_setcid(chan->cdr, chan); + return 0; +} + +/*! + * \internal + * \brief Read values from the connected line information struct. + * + * \param chan Asterisk channel to read + * \param cmd Not used + * \param data Connected line function datatype string + * \param buf Buffer to fill with read value. + * \param len Length of the buffer + * + * \retval 0 on success. + * \retval -1 on error. + */ +static int connectedline_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) +{ + struct ast_party_members member; + char *read_what; + enum ID_FIELD_STATUS status; + + /* Ensure that the buffer is empty */ + *buf = 0; + + if (!chan) { + return -1; + } + + read_what = ast_strdupa(data); + AST_NONSTANDARD_APP_ARGS(member, read_what, '-'); + if (member.argc == 0 || ARRAY_LEN(member.subnames) <= member.argc) { + /* Too few or too many subnames */ + return -1; + } + + ast_channel_lock(chan); + + if (member.argc == 1 && !strcasecmp("source", member.argv[0])) { + ast_copy_string(buf, ast_connected_line_source_name(chan->connected.source), len); + } else { + status = party_id_read(buf, len, member.argc, member.argv, &chan->connected.id); + switch (status) { + case ID_FIELD_VALID: + case ID_FIELD_INVALID: + break; + default: + ast_log(LOG_ERROR, "Unknown connectedline data type '%s'.\n", data); + break; } - ast_channel_unlock(chan); - } else if (!strncasecmp("subaddr", data, 7)) { - ast_channel_lock(chan); - /* also matches subaddr-valid, subaddr-type, subaddr-odd, subaddr */ - if (!strncasecmp(data + 7 ,"-valid", 6)) { /* subaddr-valid */ - chan->cid.subaddress.valid = atoi(value) ? 1 : 0; - } else if (!strncasecmp(data + 7 ,"-type", 5)) { /* subaddr-type */ - chan->cid.subaddress.type = atoi(value) ? 2 : 0; - } else if (!strncasecmp(data + 7 ,"-odd", 4)) { /* subaddr-odd */ - chan->cid.subaddress.odd_even_indicator = atoi(value) ? 1 : 0; - } else { /* subaddr */ - if (chan->cid.subaddress.str) { - ast_free(chan->cid.subaddress.str); - } - chan->cid.subaddress.str = ast_strdup(value); + } + + ast_channel_unlock(chan); + + return 0; +} + +/*! + * \internal + * \brief Write new values to the connected line information struct. + * + * \param chan Asterisk channel to update + * \param cmd Not used + * \param data Connected line function datatype string + * \param value Value to assign to the connected line information struct. + * + * \retval 0 on success. + * \retval -1 on error. + */ +static int connectedline_write(struct ast_channel *chan, const char *cmd, char *data, const char *value) +{ + struct ast_party_connected_line connected; + enum ID_FIELD_STATUS status; + char *val; + char *parms; + void (*set_it)(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update); + struct ast_party_func_args args; + struct ast_party_members member; + struct ast_flags opts; + char *opt_args[CONNECTED_LINE_OPT_ARG_ARRAY_SIZE]; + + if (!value || !chan) { + return -1; + } + + parms = ast_strdupa(data); + AST_STANDARD_APP_ARGS(args, parms); + if (args.argc == 0) { + /* Must have at least one argument. */ + return -1; + } + + AST_NONSTANDARD_APP_ARGS(member, args.member, '-'); + if (member.argc == 0 || ARRAY_LEN(member.subnames) <= member.argc) { + /* Too few or too many subnames */ + return -1; + } + + if (ast_app_parse_options(connectedline_opts, &opts, opt_args, args.opts)) { + /* General invalid option syntax. */ + return -1; + } + + /* Determine if the update indication inhibit option is present */ + if (ast_test_flag(&opts, CONNECTED_LINE_OPT_INHIBIT)) { + set_it = ast_channel_set_connected_line; + } else { + set_it = ast_channel_update_connected_line; + } + + ast_channel_lock(chan); + ast_party_connected_line_set_init(&connected, &chan->connected); + ast_channel_unlock(chan); + + value = ast_skip_blanks(value); + + if (member.argc == 1 && !strcasecmp("source", member.argv[0])) { + int source; + + val = ast_strdupa(value); + ast_trim_blanks(val); + + if (('0' <= val[0]) && (val[0] <= '9')) { + source = atoi(val); + } else { + source = ast_connected_line_source_parse(val); } - if (chan->cdr) { - ast_cdr_setcid(chan->cdr, chan); + + if (source < 0) { + ast_log(LOG_ERROR, "Unknown connectedline source '%s', value unchanged\n", val); + } else { + connected.source = source; + set_it(chan, &connected, NULL); } - ast_channel_unlock(chan); - } else if (!strncasecmp("rdnis", data, 5)) { - ast_channel_lock(chan); - ast_free(chan->redirecting.from.number); - chan->redirecting.from.number = ast_strdup(value); - if (chan->cdr) { - ast_cdr_setcid(chan->cdr, chan); + } else { + status = party_id_write(&connected.id, member.argc, member.argv, value); + switch (status) { + case ID_FIELD_VALID: + set_it(chan, &connected, NULL); + break; + case ID_FIELD_INVALID: + break; + default: + ast_log(LOG_ERROR, "Unknown connectedline data type '%s'.\n", data); + break; } - ast_channel_unlock(chan); - } else if (!strncasecmp("pres", data, 4)) { - int i; - char *val; + ast_party_connected_line_free(&connected); + } + + return 0; +} + +/*! + * \internal + * \brief Read values from the redirecting information struct. + * + * \param chan Asterisk channel to read + * \param cmd Not used + * \param data Redirecting function datatype string + * \param buf Buffer to fill with read value. + * \param len Length of the buffer + * + * \retval 0 on success. + * \retval -1 on error. + */ +static int redirecting_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) +{ + struct ast_party_members member; + char *read_what; + enum ID_FIELD_STATUS status; + + /* Ensure that the buffer is empty */ + *buf = 0; + + if (!chan) { + return -1; + } + + read_what = ast_strdupa(data); + AST_NONSTANDARD_APP_ARGS(member, read_what, '-'); + if (member.argc == 0 || ARRAY_LEN(member.subnames) <= member.argc) { + /* Too few or too many subnames */ + return -1; + } + + ast_channel_lock(chan); + + if (!strcasecmp("from", member.argv[0])) { + status = party_id_read(buf, len, member.argc - 1, member.argv + 1, + &chan->redirecting.from); + switch (status) { + case ID_FIELD_VALID: + case ID_FIELD_INVALID: + break; + default: + ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); + break; + } + } else if (!strcasecmp("to", member.argv[0])) { + status = party_id_read(buf, len, member.argc - 1, member.argv + 1, + &chan->redirecting.to); + switch (status) { + case ID_FIELD_VALID: + case ID_FIELD_INVALID: + break; + default: + ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); + break; + } + } else if (member.argc == 1 && !strncasecmp("pres", member.argv[0], 4)) { + /* + * Accept pres[entation] + * This is the combined from name/number presentation. + */ + ast_copy_string(buf, + ast_named_caller_presentation( + ast_party_id_presentation(&chan->redirecting.from)), len); + } else if (member.argc == 1 && !strcasecmp("reason", member.argv[0])) { + ast_copy_string(buf, ast_redirecting_reason_name(chan->redirecting.reason), len); + } else if (member.argc == 1 && !strcasecmp("count", member.argv[0])) { + snprintf(buf, len, "%d", chan->redirecting.count); + } else { + ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); + } + + ast_channel_unlock(chan); + + return 0; +} + +/*! + * \internal + * \brief Write new values to the redirecting information struct. + * + * \param chan Asterisk channel to update + * \param cmd Not used + * \param data Redirecting function datatype string + * \param value Value to assign to the redirecting information struct. + * + * \retval 0 on success. + * \retval -1 on error. + */ +static int redirecting_write(struct ast_channel *chan, const char *cmd, char *data, const char *value) +{ + struct ast_party_redirecting redirecting; + enum ID_FIELD_STATUS status; + char *val; + char *parms; + void (*set_it)(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update); + struct ast_party_func_args args; + struct ast_party_members member; + struct ast_flags opts; + char *opt_args[REDIRECTING_OPT_ARG_ARRAY_SIZE]; + + if (!value || !chan) { + return -1; + } + + parms = ast_strdupa(data); + AST_STANDARD_APP_ARGS(args, parms); + if (args.argc == 0) { + /* Must have at least one argument. */ + return -1; + } + + AST_NONSTANDARD_APP_ARGS(member, args.member, '-'); + if (member.argc == 0 || ARRAY_LEN(member.subnames) <= member.argc) { + /* Too few or too many subnames */ + return -1; + } + + if (ast_app_parse_options(redirecting_opts, &opts, opt_args, args.opts)) { + /* General invalid option syntax. */ + return -1; + } + + /* Determine if the update indication inhibit option is present */ + if (ast_test_flag(&opts, REDIRECTING_OPT_INHIBIT)) { + set_it = ast_channel_set_redirecting; + } else { + set_it = ast_channel_update_redirecting; + } + + ast_channel_lock(chan); + ast_party_redirecting_set_init(&redirecting, &chan->redirecting); + ast_channel_unlock(chan); + + value = ast_skip_blanks(value); + + if (!strcasecmp("from", member.argv[0])) { + status = party_id_write(&redirecting.from, member.argc - 1, member.argv + 1, + value); + switch (status) { + case ID_FIELD_VALID: + set_it(chan, &redirecting, NULL); + break; + case ID_FIELD_INVALID: + break; + default: + ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); + break; + } + ast_party_redirecting_free(&redirecting); + } else if (!strcasecmp("to", member.argv[0])) { + status = party_id_write(&redirecting.to, member.argc - 1, member.argv + 1, value); + switch (status) { + case ID_FIELD_VALID: + set_it(chan, &redirecting, NULL); + break; + case ID_FIELD_INVALID: + break; + default: + ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); + break; + } + ast_party_redirecting_free(&redirecting); + } else if (member.argc == 1 && !strncasecmp("pres", member.argv[0], 4)) { + int pres; val = ast_strdupa(value); ast_trim_blanks(val); - if ((val[0] >= '0') && (val[0] <= '9')) { - i = atoi(val); + if (('0' <= val[0]) && (val[0] <= '9')) { + pres = atoi(val); + } else { + pres = ast_parse_caller_presentation(val); + } + + if (pres < 0) { + ast_log(LOG_ERROR, + "Unknown redirecting combined presentation '%s', value unchanged\n", val); + } else { + redirecting.from.name.presentation = pres; + redirecting.from.number.presentation = pres; + redirecting.to.name.presentation = pres; + redirecting.to.number.presentation = pres; + set_it(chan, &redirecting, NULL); + } + } else if (member.argc == 1 && !strcasecmp("reason", member.argv[0])) { + int reason; + + val = ast_strdupa(value); + ast_trim_blanks(val); + + if (('0' <= val[0]) && (val[0] <= '9')) { + reason = atoi(val); + } else { + reason = ast_redirecting_reason_parse(val); + } + + if (reason < 0) { + ast_log(LOG_ERROR, "Unknown redirecting reason '%s', value unchanged\n", val); } else { - i = ast_parse_caller_presentation(val); + redirecting.reason = reason; + set_it(chan, &redirecting, NULL); } + } else if (member.argc == 1 && !strcasecmp("count", member.argv[0])) { + val = ast_strdupa(value); + ast_trim_blanks(val); - if (i < 0) { - ast_log(LOG_ERROR, "Unknown calling number presentation '%s', value unchanged\n", val); + if (('0' <= val[0]) && (val[0] <= '9')) { + redirecting.count = atoi(val); + set_it(chan, &redirecting, NULL); } else { - chan->cid.cid_pres = i; + ast_log(LOG_ERROR, "Unknown redirecting count '%s', value unchanged\n", val); } - } else if (!strncasecmp("ton", data, 3)) { - chan->cid.cid_ton = atoi(value); } else { - ast_log(LOG_ERROR, "Unknown callerid data type '%s'.\n", data); + ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); } return 0; @@ -370,18 +1506,53 @@ static struct ast_custom_function callerpres_function = { .write = callerpres_write, }; +static struct ast_custom_function connectedline_function = { + .name = "CONNECTEDLINE", + .read = connectedline_read, + .write = connectedline_write, +}; + +static struct ast_custom_function redirecting_function = { + .name = "REDIRECTING", + .read = redirecting_read, + .write = redirecting_write, +}; + +/*! + * \internal + * \brief Unload the function module + * + * \retval 0 on success. + * \retval -1 on error. + */ static int unload_module(void) { - int res = ast_custom_function_unregister(&callerpres_function); + int res; + + res = ast_custom_function_unregister(&callerpres_function); res |= ast_custom_function_unregister(&callerid_function); + res |= ast_custom_function_unregister(&connectedline_function); + res |= ast_custom_function_unregister(&redirecting_function); return res; } +/*! + * \internal + * \brief Load and initialize the function module. + * + * \retval AST_MODULE_LOAD_SUCCESS on success. + * \retval AST_MODULE_LOAD_DECLINE on error. + */ static int load_module(void) { - int res = ast_custom_function_register(&callerpres_function); + int res; + + res = ast_custom_function_register(&callerpres_function); res |= ast_custom_function_register(&callerid_function); - return res; + res |= ast_custom_function_register(&connectedline_function); + res |= ast_custom_function_register(&redirecting_function); + return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS; } -AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Caller ID related dialplan functions"); +/* Do not wrap the following line. */ +AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Party ID related dialplan functions (Caller-ID, Connected-line, Redirecting)"); diff --git a/funcs/func_connectedline.c b/funcs/func_connectedline.c deleted file mode 100644 index 95bcb23af..000000000 --- a/funcs/func_connectedline.c +++ /dev/null @@ -1,275 +0,0 @@ -/* - * Asterisk -- An open source telephony toolkit. - * - * Copyright (C) 2007, Gareth Palmer - * - * Gareth Palmer <gareth@acsdata.co.nz> - * - * 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 Connected Line dialplan function - * - * \ingroup functions - */ - -#include "asterisk.h" - -ASTERISK_FILE_VERSION(__FILE__, "$Revision$") - -#include <stdlib.h> -#include <stdio.h> -#include <string.h> -#include <sys/types.h> - -#include "asterisk/module.h" -#include "asterisk/channel.h" -#include "asterisk/pbx.h" -#include "asterisk/logger.h" -#include "asterisk/utils.h" -#include "asterisk/app.h" -#include "asterisk/options.h" -#include "asterisk/callerid.h" - -/* - * Do not document the CONNECTEDLINE(source) datatype. - * It has turned out to not be needed. The source value is really - * only useful as a possible tracing aid. - */ -/*** DOCUMENTATION - <function name="CONNECTEDLINE" language="en_US"> - <synopsis> - Gets or sets Connected Line data on the channel. - </synopsis> - <syntax> - <parameter name="datatype" required="true"> - <para>The allowable datatypes are:</para> - <enumlist> - <enum name = "all" /> - <enum name = "num" /> - <enum name = "name" /> - <enum name = "tag" /> - <enum name = "ton" /> - <enum name = "pres" /> - <enum name = "subaddr[-valid]|[-type]|[-odd]"> - <para>ISDN Connected line subaddress</para> - </enum> - </enumlist> - </parameter> - <parameter name="i"> - <para>If set, this will prevent the channel from sending out protocol - messages because of the value being set</para> - </parameter> - </syntax> - <description> - <para>Gets or sets Connected Line data on the channel.</para> - </description> - </function> - ***/ - -static int connectedline_read(struct ast_channel *chan, const char *cmd, char *data, - char *buf, size_t len) -{ - /* Ensure that the buffer is empty */ - *buf = 0; - - if (!chan) - return -1; - - ast_channel_lock(chan); - - if (!strncasecmp("all", data, 3)) { - snprintf(buf, len, "\"%s\" <%s>", - S_OR(chan->connected.id.name, ""), - S_OR(chan->connected.id.number, "")); - } else if (!strncasecmp("name", data, 4)) { - if (chan->connected.id.name) { - ast_copy_string(buf, chan->connected.id.name, len); - } - } else if (!strncasecmp("num", data, 3)) { - if (chan->connected.id.number) { - ast_copy_string(buf, chan->connected.id.number, len); - } - } else if (!strncasecmp("tag", data, 3)) { - if (chan->connected.id.tag) { - ast_copy_string(buf, chan->connected.id.tag, len); - } - } else if (!strncasecmp("ton", data, 3)) { - snprintf(buf, len, "%d", chan->connected.id.number_type); - } else if (!strncasecmp("pres", data, 4)) { - ast_copy_string(buf, ast_named_caller_presentation(chan->connected.id.number_presentation), len); - } else if (!strncasecmp("source", data, 6)) { - ast_copy_string(buf, ast_connected_line_source_name(chan->connected.source), len); - } else if (!strncasecmp("subaddr", data, 7)) { - /* also matches subaddr-valid, subaddr-type, subaddr-odd, subaddr */ - if (!strncasecmp(data + 7 ,"-valid", 6)) { /* subaddr-valid */ - snprintf(buf, len, "%d", chan->connected.id.subaddress.valid); - } else if (!strncasecmp(data + 7 ,"-type", 5)) { /* subaddr-type */ - snprintf(buf, len, "%d", chan->connected.id.subaddress.type); - } else if (!strncasecmp(data + 7 ,"-odd", 4)) { /* subaddr-odd */ - snprintf(buf, len, "%d", chan->connected.id.subaddress.odd_even_indicator); - } else { /* subaddr */ - if (chan->connected.id.subaddress.str) { - ast_copy_string(buf, chan->connected.id.subaddress.str, len); - } - } - } else { - ast_log(LOG_ERROR, "Unknown connectedline data type '%s'.\n", data); - } - - ast_channel_unlock(chan); - - return 0; -} - -static int connectedline_write(struct ast_channel *chan, const char *cmd, char *data, - const char *value) -{ - struct ast_party_connected_line connected; - char *val; - char *option; - void (*set_it)(struct ast_channel *chan, const struct ast_party_connected_line *connected); - - if (!value || !chan) { - return -1; - } - - /* Determine if the update indication inhibit option is present */ - option = strchr(data, ','); - if (option) { - option = ast_skip_blanks(option + 1); - switch (*option) { - case 'i': - set_it = ast_channel_set_connected_line; - break; - - default: - ast_log(LOG_ERROR, "Unknown connectedline option '%s'.\n", option); - return 0; - } - } - else { - set_it = ast_channel_update_connected_line; - } - - ast_channel_lock(chan); - ast_party_connected_line_set_init(&connected, &chan->connected); - ast_channel_unlock(chan); - - value = ast_skip_blanks(value); - - if (!strncasecmp("all", data, 3)) { - char name[256]; - char num[256]; - - ast_callerid_split(value, name, sizeof(name), num, sizeof(num)); - connected.id.name = name; - connected.id.number = num; - set_it(chan, &connected); - } else if (!strncasecmp("name", data, 4)) { - connected.id.name = ast_strdupa(value); - ast_trim_blanks(connected.id.name); - set_it(chan, &connected); - } else if (!strncasecmp("num", data, 3)) { - connected.id.number = ast_strdupa(value); - ast_trim_blanks(connected.id.number); - set_it(chan, &connected); - } else if (!strncasecmp("tag", data, 3)) { - connected.id.tag = ast_strdupa(value); - ast_trim_blanks(connected.id.tag); - set_it(chan, &connected); - } else if (!strncasecmp("ton", data, 3)) { - val = ast_strdupa(value); - ast_trim_blanks(val); - - if (('0' <= val[0]) && (val[0] <= '9')) { - connected.id.number_type = atoi(val); - set_it(chan, &connected); - } else { - ast_log(LOG_ERROR, "Unknown connectedline type of number '%s', value unchanged\n", val); - } - } else if (!strncasecmp("pres", data, 4)) { - int pres; - - val = ast_strdupa(value); - ast_trim_blanks(val); - - if (('0' <= val[0]) && (val[0] <= '9')) { - pres = atoi(val); - } else { - pres = ast_parse_caller_presentation(val); - } - - if (pres < 0) { - ast_log(LOG_ERROR, "Unknown connectedline number presentation '%s', value unchanged\n", val); - } else { - connected.id.number_presentation = pres; - set_it(chan, &connected); - } - } else if (!strncasecmp("source", data, 6)) { - int source; - - val = ast_strdupa(value); - ast_trim_blanks(val); - - if (('0' <= val[0]) && (val[0] <= '9')) { - source = atoi(val); - } else { - source = ast_connected_line_source_parse(val); - } - - if (source < 0) { - ast_log(LOG_ERROR, "Unknown connectedline source '%s', value unchanged\n", val); - } else { - connected.source = source; - set_it(chan, &connected); - } - } else if (!strncasecmp("subaddr", data, 7)) { /* outbound: set calling subaddress */ - /* also matches subaddr-valid, subaddr-type, subaddr-odd, subaddr */ - if (!strncasecmp(data + 7 ,"-valid", 6)) { /* subaddr-valid */ - connected.id.subaddress.valid = atoi(value) ? 1 : 0; - } else if (!strncasecmp(data + 7 ,"-type", 5)) { /* subaddr-type */ - connected.id.subaddress.type = atoi(value) ? 2 : 0; - } else if (!strncasecmp(data + 7 ,"-odd", 4)) { /* subaddr-odd */ - connected.id.subaddress.odd_even_indicator = atoi(value) ? 1 : 0; - } else { /* subaddr */ - connected.id.subaddress.str = ast_strdupa(value); - ast_trim_blanks(connected.id.subaddress.str); - } - set_it(chan, &connected); - } else { - ast_log(LOG_ERROR, "Unknown connectedline data type '%s'.\n", data); - } - - return 0; -} - -static struct ast_custom_function connectedline_function = { - .name = "CONNECTEDLINE", - .read = connectedline_read, - .write = connectedline_write, -}; - -static int unload_module(void) -{ - return ast_custom_function_unregister(&connectedline_function); -} - -static int load_module(void) -{ - return ast_custom_function_register(&connectedline_function) - ? AST_MODULE_LOAD_DECLINE - : AST_MODULE_LOAD_SUCCESS; -} - -AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Connected Line dialplan function"); diff --git a/funcs/func_dialplan.c b/funcs/func_dialplan.c index 6ad9c1c9b..4e1ab3bed 100644 --- a/funcs/func_dialplan.c +++ b/funcs/func_dialplan.c @@ -75,20 +75,20 @@ static int isexten_function_read(struct ast_channel *chan, const char *cmd, char if (sscanf(args.priority, "%30d", &priority_num) == 1 && priority_num > 0) { int res; res = ast_exists_extension(chan, args.context, args.exten, priority_num, - chan->cid.cid_num); + S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL)); if (res) strcpy(buf, "1"); } else { int res; - res = ast_findlabel_extension(chan, args.context, args.exten, - args.priority, chan->cid.cid_num); + res = ast_findlabel_extension(chan, args.context, args.exten, args.priority, + S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL)); if (res > 0) strcpy(buf, "1"); } } else if (!ast_strlen_zero(args.exten)) { int res; res = ast_exists_extension(chan, args.context, args.exten, 1, - chan->cid.cid_num); + S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL)); if (res) strcpy(buf, "1"); } else if (!ast_strlen_zero(args.context)) { diff --git a/funcs/func_redirecting.c b/funcs/func_redirecting.c deleted file mode 100644 index 2f38c2f3b..000000000 --- a/funcs/func_redirecting.c +++ /dev/null @@ -1,487 +0,0 @@ -/* - * Asterisk -- An open source telephony toolkit. - * - * Copyright (C) 2008 Digium, Inc. - * - * Richard Mudgett <rmudgett@digium.com> - * - * 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 Redirecting data dialplan function - * \ingroup functions - * - * \author Richard Mudgett <rmudgett@digium.com> - * - * See Also: - * \arg \ref AstCREDITS - */ - - -#include "asterisk.h" - -ASTERISK_FILE_VERSION(__FILE__, "$Revision$") - -/* ------------------------------------------------------------------- */ - - -#include <stdlib.h> -#include <stdio.h> -#include <string.h> -#include <sys/types.h> - -#include "asterisk/module.h" -#include "asterisk/channel.h" -#include "asterisk/pbx.h" -#include "asterisk/logger.h" -#include "asterisk/utils.h" -#include "asterisk/app.h" -#include "asterisk/options.h" -#include "asterisk/callerid.h" - -/* - * Do not document the REDIRECTING(pres) datatype. - * It has turned out that the from-pres and to-pres values must be kept - * separate. They represent two different parties and there is a case when - * they are active at the same time. The plain pres option will simply - * live on as a historical relic. - */ -/*** DOCUMENTATION - <function name="REDIRECTING" language="en_US"> - <synopsis> - Gets or sets Redirecting data on the channel. - </synopsis> - <syntax> - <parameter name="datatype" required="true"> - <para>The allowable datatypes are:</para> - <enumlist> - <enum name = "from-all" /> - <enum name = "from-num" /> - <enum name = "from-name" /> - <enum name = "from-tag" /> - <enum name = "from-ton" /> - <enum name = "from-pres" /> - <enum name = "to-all" /> - <enum name = "to-num" /> - <enum name = "to-name" /> - <enum name = "to-tag" /> - <enum name = "to-ton" /> - <enum name = "to-pres" /> - <enum name = "reason" /> - <enum name = "count" /> - </enumlist> - </parameter> - <parameter name="i"> - <para>If set, this will prevent the channel from sending out protocol - messages because of the value being set</para> - </parameter> - </syntax> - <description> - <para>Gets or sets Redirecting data on the channel. The allowable values - for the <replaceable>reason</replaceable> field are the following:</para> - <enumlist> - <enum name = "unknown"><para>Unknown</para></enum> - <enum name = "cfb"><para>Call Forwarding Busy</para></enum> - <enum name = "cfnr"><para>Call Forwarding No Reply</para></enum> - <enum name = "unavailable"><para>Callee is Unavailable</para></enum> - <enum name = "time_of_day"><para>Time of Day</para></enum> - <enum name = "dnd"><para>Do Not Disturb</para></enum> - <enum name = "deflection"><para>Call Deflection</para></enum> - <enum name = "follow_me"><para>Follow Me</para></enum> - <enum name = "out_of_order"><para>Called DTE Out-Of-Order</para></enum> - <enum name = "away"><para>Callee is Away</para></enum> - <enum name = "cf_dte"><para>Call Forwarding By The Called DTE</para></enum> - <enum name = "cfu"><para>Call Forwarding Unconditional</para></enum> - </enumlist> - </description> - </function> - ***/ - -enum ID_FIELD_STATUS { - ID_FIELD_VALID, - ID_FIELD_INVALID, - ID_FIELD_UNKNOWN -}; - - - - -/* ******************************************************************* */ -/*! - * \internal - * \brief Read values from the party id struct. - * - * \param buf Buffer to fill with read value. - * \param len Length of the buffer - * \param data Remaining function datatype string - * - * \retval ID_FIELD_VALID on success. - * \retval ID_FIELD_UNKNOWN on unknown field name. - */ -static enum ID_FIELD_STATUS redirecting_id_read(char *buf, size_t len, char *data, const struct ast_party_id *id) -{ - enum ID_FIELD_STATUS status; - - status = ID_FIELD_VALID; - - if (!strncasecmp("all", data, 3)) { - snprintf(buf, len, "\"%s\" <%s>", - S_OR(id->name, ""), - S_OR(id->number, "")); - } else if (!strncasecmp("name", data, 4)) { - if (id->name) { - ast_copy_string(buf, id->name, len); - } - } else if (!strncasecmp("num", data, 3)) { - if (id->number) { - ast_copy_string(buf, id->number, len); - } - } else if (!strncasecmp("tag", data, 3)) { - if (id->tag) { - ast_copy_string(buf, id->tag, len); - } - } else if (!strncasecmp("ton", data, 3)) { - snprintf(buf, len, "%d", id->number_type); - } else if (!strncasecmp("pres", data, 4)) { - ast_copy_string(buf, ast_named_caller_presentation(id->number_presentation), len); - } else { - status = ID_FIELD_UNKNOWN; - } - - return status; -} - - - - -/* ******************************************************************* */ -/*! - * \internal - * \brief Read values from the redirecting information struct. - * - * \param chan Asterisk channel to read - * \param cmd Not used - * \param data Redirecting function datatype string - * \param buf Buffer to fill with read value. - * \param len Length of the buffer - * - * \retval 0 on success. - * \retval -1 on error. - */ -static int redirecting_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) -{ - /* Ensure that the buffer is empty */ - *buf = 0; - - if (!chan) - return -1; - - ast_channel_lock(chan); - - if (!strncasecmp("from-", data, 5)) { - switch (redirecting_id_read(buf, len, data + 5, &chan->redirecting.from)) { - case ID_FIELD_VALID: - case ID_FIELD_INVALID: - break; - - default: - ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); - break; - } - } else if (!strncasecmp("to-", data, 3)) { - switch (redirecting_id_read(buf, len, data + 3, &chan->redirecting.to)) { - case ID_FIELD_VALID: - case ID_FIELD_INVALID: - break; - - default: - ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); - break; - } - } else if (!strncasecmp("pres", data, 4)) { - ast_copy_string(buf, ast_named_caller_presentation(chan->redirecting.from.number_presentation), len); - } else if (!strncasecmp("reason", data, 6)) { - ast_copy_string(buf, ast_redirecting_reason_name(chan->redirecting.reason), len); - } else if (!strncasecmp("count", data, 5)) { - snprintf(buf, len, "%d", chan->redirecting.count); - } else { - ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); - } - - ast_channel_unlock(chan); - - return 0; -} - - - - -/* ******************************************************************* */ -/*! - * \internal - * \brief Write new values to the party id struct - * - * \param id Party ID struct to write values - * \param data Remaining function datatype string - * \param value Value to assign to the party id. - * - * \retval ID_FIELD_VALID on success. - * \retval ID_FIELD_INVALID on error with field value. - * \retval ID_FIELD_UNKNOWN on unknown field name. - */ -static enum ID_FIELD_STATUS redirecting_id_write(struct ast_party_id *id, char *data, const char *value) -{ - char *val; - enum ID_FIELD_STATUS status; - - status = ID_FIELD_VALID; - - if (!strncasecmp("all", data, 3)) { - char name[256]; - char num[256]; - - ast_callerid_split(value, name, sizeof(name), num, sizeof(num)); - if (!(id->name = ast_strdup(name))) { - return ID_FIELD_INVALID; - } - if (!(id->number = ast_strdup(num))) { - return ID_FIELD_INVALID; - } - } else if (!strncasecmp("name", data, 4)) { - id->name = ast_strdup(value); - ast_trim_blanks(id->name); - } else if (!strncasecmp("num", data, 3)) { - id->number = ast_strdup(value); - ast_trim_blanks(id->number); - } else if (!strncasecmp("tag", data, 3)) { - id->tag = ast_strdup(value); - ast_trim_blanks(id->tag); - } else if (!strncasecmp("ton", data, 3)) { - val = ast_strdupa(value); - ast_trim_blanks(val); - - if (('0' <= val[0]) && (val[0] <= '9')) { - id->number_type = atoi(val); - } else { - ast_log(LOG_ERROR, "Unknown redirecting type of number '%s', value unchanged\n", val); - status = ID_FIELD_INVALID; - } - } else if (!strncasecmp("pres", data, 4)) { - int pres; - - val = ast_strdupa(value); - ast_trim_blanks(val); - - if (('0' <= val[0]) && (val[0] <= '9')) { - pres = atoi(val); - } else { - pres = ast_parse_caller_presentation(val); - } - - if (pres < 0) { - ast_log(LOG_ERROR, "Unknown redirecting number presentation '%s', value unchanged\n", val); - status = ID_FIELD_INVALID; - } else { - id->number_presentation = pres; - } - } else { - status = ID_FIELD_UNKNOWN; - } - - return status; -} - - - - -/* ******************************************************************* */ -/*! - * \internal - * \brief Write new values to the redirecting information struct. - * - * \param chan Asterisk channel to update - * \param cmd Not used - * \param data Redirecting function datatype string - * \param value Value to assign to the redirecting information struct. - * - * \retval 0 on success. - * \retval -1 on error. - */ -static int redirecting_write(struct ast_channel *chan, const char *cmd, char *data, const char *value) -{ - struct ast_party_redirecting redirecting; - char *val; - char *option; - void (*set_it)(struct ast_channel *chan, const struct ast_party_redirecting *redirecting); - - if (!value || !chan) { - return -1; - } - - /* Determine if the update indication inhibit option is present */ - option = strchr(data, ','); - if (option) { - option = ast_skip_blanks(option + 1); - switch (*option) { - case 'i': - set_it = ast_channel_set_redirecting; - break; - - default: - ast_log(LOG_ERROR, "Unknown redirecting option '%s'.\n", option); - return 0; - } - } - else { - set_it = ast_channel_update_redirecting; - } - - ast_channel_lock(chan); - ast_party_redirecting_set_init(&redirecting, &chan->redirecting); - ast_channel_unlock(chan); - - value = ast_skip_blanks(value); - - if (!strncasecmp("from-", data, 5)) { - switch (redirecting_id_write(&redirecting.from, data + 5, value)) { - case ID_FIELD_VALID: - set_it(chan, &redirecting); - break; - - case ID_FIELD_INVALID: - break; - - default: - ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); - break; - } - ast_party_redirecting_free(&redirecting); - } else if (!strncasecmp("to-", data, 3)) { - switch (redirecting_id_write(&redirecting.to, data + 3, value)) { - case ID_FIELD_VALID: - set_it(chan, &redirecting); - break; - - case ID_FIELD_INVALID: - break; - - default: - ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); - break; - } - ast_party_redirecting_free(&redirecting); - } else if (!strncasecmp("pres", data, 4)) { - int pres; - - val = ast_strdupa(value); - ast_trim_blanks(val); - - if (('0' <= val[0]) && (val[0] <= '9')) { - pres = atoi(val); - } else { - pres = ast_parse_caller_presentation(val); - } - - if (pres < 0) { - ast_log(LOG_ERROR, "Unknown redirecting number presentation '%s', value unchanged\n", val); - } else { - redirecting.from.number_presentation = pres; - redirecting.to.number_presentation = pres; - set_it(chan, &redirecting); - } - } else if (!strncasecmp("reason", data, 6)) { - int reason; - - val = ast_strdupa(value); - ast_trim_blanks(val); - - if (('0' <= val[0]) && (val[0] <= '9')) { - reason = atoi(val); - } else { - reason = ast_redirecting_reason_parse(val); - } - - if (reason < 0) { - ast_log(LOG_ERROR, "Unknown redirecting reason '%s', value unchanged\n", val); - } else { - redirecting.reason = reason; - set_it(chan, &redirecting); - } - } else if (!strncasecmp("count", data, 5)) { - val = ast_strdupa(value); - ast_trim_blanks(val); - - if (('0' <= val[0]) && (val[0] <= '9')) { - redirecting.count = atoi(val); - set_it(chan, &redirecting); - } else { - ast_log(LOG_ERROR, "Unknown redirecting count '%s', value unchanged\n", val); - } - } else { - ast_log(LOG_ERROR, "Unknown redirecting data type '%s'.\n", data); - } - - return 0; -} - - - - -static struct ast_custom_function redirecting_function = { - .name = "REDIRECTING", - .read = redirecting_read, - .write = redirecting_write, -}; - - - - -/* ******************************************************************* */ -/*! - * \internal - * \brief Unload the function module - * - * \retval 0 on success. - * \retval -1 on error. - */ -static int unload_module(void) -{ - return ast_custom_function_unregister(&redirecting_function); -} - - - - -/* ******************************************************************* */ -/*! - * \internal - * \brief Load and initialize the function module. - * - * \retval 0 on success. - * \retval -1 on error. - */ -static int load_module(void) -{ - return ast_custom_function_register(&redirecting_function) - ? AST_MODULE_LOAD_DECLINE - : AST_MODULE_LOAD_SUCCESS; -} - - - - -AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Redirecting data dialplan function"); - - -/* ------------------------------------------------------------------- */ -/* end func_redirecting.c */ |