<p>Sean Bright has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/13854">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">func_enum.c: Deprecate TXTCIDNAME() and underlying ast_get_txt() API function.<br><br>A large code restructuring in 65b8381550a9f46fdce84de79960073e9d51b05d<br>erroneously removed the DNS lookup functionality from<br>ast_get_txt(). Since then, ast_get_txt() and TXTCIDNAME() have<br>invariably returned an empty string regardless of the arguments<br>passed.<br><br>Mark both the dialplan function and the API as deprecated and remove<br>them completely in master.<br><br>ASTERISK-19460 #close<br>Reported by: George Joseph<br><br>Change-Id: Id19db439eecb36128179c5030032db54057b2123<br>---<br>A doc/CHANGES-staging/ast_get_txt.txt<br>M funcs/func_enum.c<br>M include/asterisk/enum.h<br>M main/enum.c<br>4 files changed, 19 insertions(+), 43 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/54/13854/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/CHANGES-staging/ast_get_txt.txt b/doc/CHANGES-staging/ast_get_txt.txt</span><br><span>new file mode 100644</span><br><span>index 0000000..7dce514</span><br><span>--- /dev/null</span><br><span>+++ b/doc/CHANGES-staging/ast_get_txt.txt</span><br><span>@@ -0,0 +1,4 @@</span><br><span style="color: hsl(120, 100%, 40%);">+Subject: func_enum</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The TXTCIDNAME() has not worked since 2008 and has now been marked as</span><br><span style="color: hsl(120, 100%, 40%);">+deprecated. It will be removed completely in Asterisk 18.</span><br><span>diff --git a/funcs/func_enum.c b/funcs/func_enum.c</span><br><span>index 95e8d21..3c88055 100644</span><br><span>--- a/funcs/func_enum.c</span><br><span>+++ b/funcs/func_enum.c</span><br><span>@@ -146,6 +146,8 @@</span><br><span> </parameter></span><br><span> </syntax></span><br><span> <description></span><br><span style="color: hsl(120, 100%, 40%);">+ <note><para>This function is deprecated as it has not worked since</span><br><span style="color: hsl(120, 100%, 40%);">+ 2008-05-09.</para></note></span><br><span> <para>This function looks up the given phone number in DNS to retrieve</span><br><span> the caller id name. The result will either be blank or be the value</span><br><span> found in the TXT record in DNS.</para></span><br><span>@@ -414,6 +416,8 @@</span><br><span> .read = function_enum,</span><br><span> };</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+static int deprecation_warning = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> static int function_txtcidname(struct ast_channel *chan, const char *cmd,</span><br><span> char *data, char *buf, size_t len)</span><br><span> {</span><br><span>@@ -422,6 +426,12 @@</span><br><span> AST_APP_ARG(zone);</span><br><span> );</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ if (!deprecation_warning) {</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(LOG_WARNING, "The TXTCIDNAME() function has not returned anything "</span><br><span style="color: hsl(120, 100%, 40%);">+ "since 2008-05-09 and will be removed in Asterisk 18.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ deprecation_warning = 1;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> buf[0] = '\0';</span><br><span> </span><br><span> if (ast_strlen_zero(data)) {</span><br><span>diff --git a/include/asterisk/enum.h b/include/asterisk/enum.h</span><br><span>index 877c0c3..990c94a 100644</span><br><span>--- a/include/asterisk/enum.h</span><br><span>+++ b/include/asterisk/enum.h</span><br><span>@@ -79,21 +79,10 @@</span><br><span> int ast_get_enum(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology,</span><br><span> int maxtech, char* suffix, char* options, unsigned int record, struct enum_context **argcontext);</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! \brief Lookup DNS TXT record (used by app TXTCIDnum)</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief (Formerly) Lookup DNS TXT record (used by app TXTCIDnum)</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * Really has nothing to do with enum, but anyway...</span><br><span style="color: hsl(0, 100%, 40%);">- * Actually, there is now an internet-draft which describes how callerID should</span><br><span style="color: hsl(0, 100%, 40%);">- * be stored in ENUM domains: draft-ietf-enum-cnam-04.txt</span><br><span style="color: hsl(0, 100%, 40%);">- * The algorithm implemented here will thus be obsolete soon.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param chan Channel</span><br><span style="color: hsl(0, 100%, 40%);">- * \param number E164 number with or without the leading +</span><br><span style="color: hsl(0, 100%, 40%);">- * \param txt Text string (return value)</span><br><span style="color: hsl(0, 100%, 40%);">- * \param maxtxt Max length of "txt"</span><br><span style="color: hsl(0, 100%, 40%);">- * \param suffix Zone suffix</span><br><span style="color: hsl(0, 100%, 40%);">- * \version 1.6.1 new suffix parameter to take into account caller ids that aren't in e164.arpa</span><br><span style="color: hsl(0, 100%, 40%);">- * \version 1.6.1 removed parameters location, maxloc, technology, maxtech as all the information</span><br><span style="color: hsl(0, 100%, 40%);">- * is stored the txt string</span><br><span style="color: hsl(120, 100%, 40%);">+ * This function has done nothing 2008-05-09 and is now deprecated as of Asterisk 13.32.0,</span><br><span style="color: hsl(120, 100%, 40%);">+ * 16.9.0, and 17.3.0. It will no longer be available in Asterisk 18+.</span><br><span> */</span><br><span> int ast_get_txt(struct ast_channel *chan, const char *number, char *txt, int maxtxt, char *suffix);</span><br><span> </span><br><span>diff --git a/main/enum.c b/main/enum.c</span><br><span>index e003f07..7f18fb9 100644</span><br><span>--- a/main/enum.c</span><br><span>+++ b/main/enum.c</span><br><span>@@ -934,35 +934,8 @@</span><br><span> </span><br><span> int ast_get_txt(struct ast_channel *chan, const char *number, char *txt, int txtlen, char *suffix)</span><br><span> {</span><br><span style="color: hsl(0, 100%, 40%);">- struct txt_context context;</span><br><span style="color: hsl(0, 100%, 40%);">- char tmp[259 + 512];</span><br><span style="color: hsl(0, 100%, 40%);">- int pos = strlen(number) - 1;</span><br><span style="color: hsl(0, 100%, 40%);">- int newpos = 0;</span><br><span style="color: hsl(0, 100%, 40%);">- int ret = -1;</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- ast_debug(4, "ast_get_txt: Number = '%s', suffix = '%s'\n", number, suffix);</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- if (pos > 128) {</span><br><span style="color: hsl(0, 100%, 40%);">- pos = 128;</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- while (pos >= 0) {</span><br><span style="color: hsl(0, 100%, 40%);">- if (isdigit(number[pos])) {</span><br><span style="color: hsl(0, 100%, 40%);">- tmp[newpos++] = number[pos];</span><br><span style="color: hsl(0, 100%, 40%);">- tmp[newpos++] = '.';</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(0, 100%, 40%);">- pos--;</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- ast_copy_string(&tmp[newpos], suffix, sizeof(tmp) - newpos);</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- if (ret < 0) {</span><br><span style="color: hsl(0, 100%, 40%);">- ast_debug(2, "No such number found in ENUM: %s (%s)\n", tmp, strerror(errno));</span><br><span style="color: hsl(0, 100%, 40%);">- ret = 0;</span><br><span style="color: hsl(0, 100%, 40%);">- } else {</span><br><span style="color: hsl(0, 100%, 40%);">- ast_copy_string(txt, context.txt, txtlen);</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(0, 100%, 40%);">- return ret;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* This function was an expensive no-op and now it is a cheap no-op */</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span> }</span><br><span> </span><br><span> /*! \brief Initialize the ENUM support subsystem */</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/13854">change 13854</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/13854"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: 13 </div>
<div style="display:none"> Gerrit-Change-Id: Id19db439eecb36128179c5030032db54057b2123 </div>
<div style="display:none"> Gerrit-Change-Number: 13854 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Sean Bright <sean.bright@gmail.com> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>