Commit e06f408a authored by Graham Leggett's avatar Graham Leggett
Browse files

mod_include: Add support for application/x-www-form-urlencoded encoding 

and decoding.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1194870 13f79535-47bb-0310-9956-ffa450edef68
parent 6cf82fb0

CHANGES

+3 −0
Changes for CHANGES: 3 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -12,6 +12,9 @@ Changes with Apache 2.3.15 
     PR 51714. [Stefan Fritsch, Jim Jagielski, Ruediger Pluem, Eric Covener,

     <lowprio20 gmail.com>]



  *) mod_include: Add support for application/x-www-form-urlencoded encoding

     and decoding. [Graham Leggett]



  *) rotatelogs: Add -c option to force logfile creation in every rotation 

     interval, even if empty.  [Jan Kaluža <jkaluza redhat.com>]

docs/manual/mod/mod_include.xml

+40 −32
Changes for docs/manual/mod/mod_include.xml: 40 added lines, 32 removed lines.
Original line number Diff line number Diff line
@@ -186,13 +186,15 @@ 
      is <code>none</code>, where no decoding will be done. If set to

      <code>url</code>, then URL decoding (also known as %-encoding;

      this is appropriate for use within URLs in links, etc.) will be

      performed. If set to <code>base64</code>, base64 will be decoded,

      and if set to <code>entity</code>, HTML entity encoding will be

      stripped. Decoding is done prior to any further encoding on the

      variable. Multiple encodings can be stripped by specifying more

      than one comma separated encoding. The decoding setting will

      remain in effect until the next decoding attribute is encountered,

      or the element ends.</p>

      performed. If set to <code>urlencoded</code>,

      application/x-www-form-urlencoded compatible encoding (found in

      query strings) will be stripped. If set to <code>base64</code>,

      base64 will be decoded, and if set to <code>entity</code>, HTML

      entity encoding will be stripped. Decoding is done prior to any

      further encoding on the variable. Multiple encodings can be

      stripped by specifying more than one comma separated encoding.

      The decoding setting will remain in effect until the next decoding

      attribute is encountered, or the element ends.</p>



      <p>The <code>decoding</code> attribute must <em>precede</em> the

      corresponding <code>var</code> attribute to be effective.</p>
@@ -204,14 +206,17 @@ 
      to <code>none</code>, no encoding will be done. If set to

      <code>url</code>, then URL encoding (also known as %-encoding;

      this is appropriate for use within URLs in links, etc.) will be

      performed. If set to <code>base64</code>, base64 encoding will

      be performed. At the start of an <code>echo</code> element,

      the default is set to <code>entity</code>, resulting in entity

      encoding (which is appropriate in the context of a block-level

      HTML element, <em>e.g.</em> a paragraph of text). This can be

      changed by adding an <code>encoding</code> attribute, which will

      remain in effect until the next <code>encoding</code> attribute

      is encountered or the element ends, whichever comes first.</p>

      performed. If set to <code>urlencoded</code>,

      application/x-www-form-urlencoded compatible encoding will be

      performed instead, and should be used with query strings. If set

      to <code>base64</code>, base64 encoding will be performed. At

      the start of an <code>echo</code> element, the default is set to

      <code>entity</code>, resulting in entity encoding (which is

      appropriate in the context of a block-level HTML element,

      <em>e.g.</em> a paragraph of text). This can be changed by adding

      an <code>encoding</code> attribute, which will remain in effect

      until the next <code>encoding</code> attribute is encountered or

      the element ends, whichever comes first.</p>



      <p>The <code>encoding</code> attribute must <em>precede</em> the

      corresponding <code>var</code> attribute to be effective.</p>
@@ -425,29 +430,32 @@ 
      <dd><p>Specifies whether Apache should strip an encoding from

      the variable before processing the variable further. The default

      is <code>none</code>, where no decoding will be done. If set to

      <code>url</code>, <code>base64</code> or <code>entity</code>,

      URL decoding, base64 decoding or HTML entity decoding will be

      performed respectively. More than one decoding can be specified

      by separating with commas. The decoding setting will remain in

      effect until the next decoding attribute is encountered, or the

      element ends. The <code>decoding</code> attribute must

      <em>precede</em> the corresponding <code>var</code> attribute to

      be effective.</p>

      <code>url</code>, <code>urlencoded</code>, <code>base64</code>

      or <code>entity</code>, URL decoding,

      application/x-www-form-urlencoded decoding, base64 decoding or HTML

      entity decoding will be performed respectively. More than one

      decoding can be specified by separating with commas. The decoding

      setting will remain in effect until the next decoding attribute

      is encountered, or the element ends. The <code>decoding</code>

      attribute must <em>precede</em> the corresponding

      <code>var</code> attribute to be effective.</p>

      </dd>



      <dt><code>encoding</code></dt>

      <dd><p>Specifies how Apache should encode special characters

      contained in the variable before setting them. The default is

      <code>none</code>, where no encoding will be done. If set to

      <code>url</code>, <code>base64</code> or <code>entity</code>,

      URL encoding, base64 encoding or HTML entity encoding will be

      performed respectively. More than one encoding can be specified

      by separating with commas. The encoding setting will remain in

      effect until the next encoding attribute is encountered, or the

      element ends. The <code>encoding</code> attribute must

      <em>precede</em> the corresponding <code>var</code> attribute

      to be effective. Encodings are applied after all decodings have

      been stripped.</p>

      <code>url</code>, <code>urlencoding</code>, <code>base64</code>

      or <code>entity</code>, URL encoding,

      application/x-www-form-urlencoded encoding, base64 encoding or

      HTML entity encoding will be performed respectively. More than

      one encoding can be specified by separating with commas. The

      encoding setting will remain in effect until the next encoding

      attribute is encountered, or the element ends. The

      <code>encoding</code> attribute must <em>precede</em> the

      corresponding <code>var</code> attribute to be effective.

      Encodings are applied after all decodings have been

      stripped.</p>

      </dd>

      </dl>

include/ap_mmn.h

+3 −1
Changes for include/ap_mmn.h: 3 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -362,6 +362,8 @@ 
 *                         proxy_dir_conf

 * 20111025.0 (2.3.15-dev) Add return value and maxlen to ap_varbuf_regsub(),

 *                         add ap_pregsub_ex()

 * 20111025.1 (2.3.15-dev) Add ap_escape_urlencoded(), ap_escape_urlencoded_buffer()

 *                         and ap_unescape_urlencoded().

 */



#define MODULE_MAGIC_COOKIE 0x41503234UL /* "AP24" */
@@ -369,7 +371,7 @@ 
#ifndef MODULE_MAGIC_NUMBER_MAJOR

#define MODULE_MAGIC_NUMBER_MAJOR 20111025

#endif

#define MODULE_MAGIC_NUMBER_MINOR 0                   /* 0...n */

#define MODULE_MAGIC_NUMBER_MINOR 1                   /* 0...n */



/**

 * Determine if the server's current MODULE_MAGIC_NUMBER is at least a

include/httpd.h

+23 −0
Changes for include/httpd.h: 23 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -1539,6 +1539,13 @@ AP_DECLARE(int) ap_unescape_url(char *url); 
 */

AP_DECLARE(int) ap_unescape_url_keep2f(char *url, int decode_slashes);



/**

 * Unescape an application/x-www-form-urlencoded string

 * @param query The query to unescape

 * @return 0 on success, non-zero otherwise

 */

AP_DECLARE(int) ap_unescape_urlencoded(char *query);



/**

 * Convert all double slashes to single slashes

 * @param name The string to convert
@@ -1581,6 +1588,22 @@ AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partia 
/** @see ap_os_escape_path */

#define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)



/**

 * Escape a string as application/x-www-form-urlencoded

 * @param p The pool to allocate from

 * @param s The path to convert

 * @return The converted URL

 */

AP_DECLARE(char *) ap_escape_urlencoded(apr_pool_t *p, const char *s);



/**

 * Escape a string as application/x-www-form-urlencoded, to a preallocated buffer

 * @param c The preallocated buffer to write to

 * @param s The path to convert

 * @return The converted URL (c)

 */

AP_DECLARE(char *) ap_escape_urlencoded_buffer(char *c, const char *s);



/**

 * Escape an html string

 * @param p The pool to allocate from

modules/filters/mod_include.c

+16 −0
Changes for modules/filters/mod_include.c: 16 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -1957,6 +1957,11 @@ static apr_status_t handle_echo(include_ctx_t *ctx, ap_filter_t *f, 
                        ap_unescape_url(buf);

                        echo_text = buf;

                    }

                    else if (!strcasecmp(token, "urlencoded")) {

                        char *buf = apr_pstrdup(ctx->pool, echo_text);

                        ap_unescape_urlencoded(buf);

                        echo_text = buf;

                    }

                    else if (!strcasecmp(token, "entity")) {

                        char *buf = apr_pstrdup(ctx->pool, echo_text);

                        decodehtml(buf);
@@ -1986,6 +1991,9 @@ static apr_status_t handle_echo(include_ctx_t *ctx, ap_filter_t *f, 
                    else if (!strcasecmp(token, "url")) {

                        echo_text = ap_escape_uri(ctx->dpool, echo_text);

                    }

                    else if (!strcasecmp(token, "urlencoded")) {

                        echo_text = ap_escape_urlencoded(ctx->dpool, echo_text);

                    }

                    else if (!strcasecmp(token, "entity")) {

                        echo_text = ap_escape_html2(ctx->dpool, echo_text, 0);

                    }
@@ -2576,6 +2584,11 @@ static apr_status_t handle_set(include_ctx_t *ctx, ap_filter_t *f, 
                        ap_unescape_url(buf);

                        parsed_string = buf;

                    }

                    else if (!strcasecmp(token, "urlencoded")) {

                        char *buf = apr_pstrdup(ctx->pool, parsed_string);

                        ap_unescape_urlencoded(buf);

                        parsed_string = buf;

                    }

                    else if (!strcasecmp(token, "entity")) {

                        char *buf = apr_pstrdup(ctx->pool, parsed_string);

                        decodehtml(buf);
@@ -2605,6 +2618,9 @@ static apr_status_t handle_set(include_ctx_t *ctx, ap_filter_t *f, 
                    else if (!strcasecmp(token, "url")) {

                        parsed_string = ap_escape_uri(ctx->dpool, parsed_string);

                    }

                    else if (!strcasecmp(token, "urlencoded")) {

                        parsed_string = ap_escape_urlencoded(ctx->dpool, parsed_string);

                    }

                    else if (!strcasecmp(token, "entity")) {

                        parsed_string = ap_escape_html2(ctx->dpool, parsed_string, 0);

                    }