Files
asterisk/funcs/func_uri.c
George Joseph ce550fc1b0 docs: Add version information to application and function XML elements
* Do a git blame on the embedded XML application or function element.

* From the commit hash, grab the summary line.

* Do a git log --grep <summary> to find the cherry-pick commits in all
  branches that match.

* Do a git patch-id to ensure the commits are all related and didn't get
  a false match on the summary.

* Do a git tag --contains <commit> to find the tags that contain each
  commit.

* Weed out all tags not ..0.

* Sort and discard any .0.0 and following tags where the commit
  appeared in an earlier branch.

* The result is a single tag for each branch where the application or function
  was defined.

The applications and functions defined in the following files were done by
hand because the XML was extracted from the C source file relatively recently.
* channels/pjsip/dialplan_functions_doc.xml
* main/logger_doc.xml
* main/manager_doc.xml
* res/res_geolocation/geoloc_doc.xml
* res/res_stir_shaken/stir_shaken_doc.xml

(cherry picked from commit f6a193e87e)
2025-01-23 18:42:29 +00:00

126 lines
3.1 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 1999 - 2006, Digium, Inc.
*
* Created by Olle E. Johansson, Edvina.net
*
* 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 URI encoding / decoding
*
* \author Olle E. Johansson <oej@edvina.net>
*
* \note For now this code only supports 8 bit characters, not unicode,
which we ultimately will need to support.
*
* \ingroup functions
*/
/*** MODULEINFO
<support_level>core</support_level>
***/
#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"
/*** DOCUMENTATION
<function name="URIENCODE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Encodes a string to URI-safe encoding according to RFC 2396.
</synopsis>
<syntax>
<parameter name="data" required="true">
<para>Input string to be encoded.</para>
</parameter>
</syntax>
<description>
<para>Returns the encoded string defined in <replaceable>data</replaceable>.</para>
</description>
</function>
<function name="URIDECODE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Decodes a URI-encoded string according to RFC 2396.
</synopsis>
<syntax>
<parameter name="data" required="true">
<para>Input string to be decoded.</para>
</parameter>
</syntax>
<description>
<para>Returns the decoded URI-encoded <replaceable>data</replaceable> string.</para>
</description>
</function>
***/
/*! \brief uriencode: Encode URL according to RFC 2396 */
static int uriencode(struct ast_channel *chan, const char *cmd, char *data,
char *buf, size_t len)
{
if (ast_strlen_zero(data)) {
buf[0] = '\0';
return 0;
}
ast_uri_encode(data, buf, len, ast_uri_http);
return 0;
}
/*!\brief uridecode: Decode URI according to RFC 2396 */
static int uridecode(struct ast_channel *chan, const char *cmd, char *data,
char *buf, size_t len)
{
if (ast_strlen_zero(data)) {
buf[0] = '\0';
return 0;
}
ast_copy_string(buf, data, len);
ast_uri_decode(buf, ast_uri_http);
return 0;
}
static struct ast_custom_function urldecode_function = {
.name = "URIDECODE",
.read = uridecode,
};
static struct ast_custom_function urlencode_function = {
.name = "URIENCODE",
.read = uriencode,
};
static int unload_module(void)
{
return ast_custom_function_unregister(&urldecode_function)
|| ast_custom_function_unregister(&urlencode_function);
}
static int load_module(void)
{
return ast_custom_function_register(&urldecode_function)
|| ast_custom_function_register(&urlencode_function);
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "URI encode/decode dialplan functions");