Adjust url_code_map[] so spaces are replaced with %20 instead of '+'
[privoxy.git] / encode.c
index 7e82acd..5203a98 100644 (file)
--- a/encode.c
+++ b/encode.c
@@ -1,4 +1,4 @@
-const char encode_rcs[] = "$Id: encode.c,v 1.1.1.1 2001/05/15 13:58:51 oes Exp $";
+const char encode_rcs[] = "$Id: encode.c,v 1.21 2011/11/06 11:42:14 fabiankeil Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/encode.c,v $
@@ -6,14 +6,14 @@ const char encode_rcs[] = "$Id: encode.c,v 1.1.1.1 2001/05/15 13:58:51 oes Exp $
  * Purpose     :  Functions to encode and decode URLs, and also to
  *                encode cookies and HTML text.
  *
- * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
- *                IJBSWA team.  http://ijbswa.sourceforge.net
+ * Copyright   :  Written by and Copyright (C) 2001 the
+ *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
- *                by and Copyright (C) 1997 Anonymous Coders and 
+ *                by and Copyright (C) 1997 Anonymous Coders and
  *                Junkbusters Corporation.  http://www.junkbusters.com
  *
- *                This program is free software; you can redistribute it 
+ *                This program is free software; you can redistribute it
  *                and/or modify it under the terms of the GNU General
  *                Public License as published by the Free Software
  *                Foundation; either version 2 of the License, or (at
@@ -31,21 +31,17 @@ const char encode_rcs[] = "$Id: encode.c,v 1.1.1.1 2001/05/15 13:58:51 oes Exp $
  *                or write to the Free Software Foundation, Inc., 59
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  *
- * Revisions   :
- *    $Log: encode.c,v $
- *    Revision 1.1.1.1  2001/05/15 13:58:51  oes
- *    Initial import of version 2.9.3 source tree
- *
- *
  *********************************************************************/
-\f
+
 
 #include "config.h"
 
 #include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
-#include <malloc.h>
+#include <assert.h>
 
+#include "miscutil.h"
 #include "encode.h"
 
 const char encode_h_rcs[] = ENCODE_H_VERSION;
@@ -55,7 +51,7 @@ static const char * const url_code_map[256] = {
    NULL, "%01", "%02", "%03", "%04", "%05", "%06", "%07", "%08", "%09",
    "%0A", "%0B", "%0C", "%0D", "%0E", "%0F", "%10", "%11", "%12", "%13",
    "%14", "%15", "%16", "%17", "%18", "%19", "%1A", "%1B", "%1C", "%1D",
-   "%1E", "%1F", "+",   "%21", "%22", "%23", "%24", "%25", "%26", "%27",
+   "%1E", "%1F", "%20", "%21", "%22", "%23", "%24", "%25", "%26", "%27",
    "%28", "%29", NULL,  "%2B", "%2C", NULL,  NULL,  "%2F", NULL,  NULL,
    NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  "%3A", "%3B",
    "%3C", "%3D", "%3E", "%3F", NULL,  NULL,  NULL,  NULL,  NULL,  NULL,
@@ -80,12 +76,12 @@ static const char * const url_code_map[256] = {
    "%FA", "%FB", "%FC", "%FD", "%FE", "%FF"
 };
 
-/* Maps special characters in HTML to their equivalent entites. */
+/* Maps special characters in HTML to their equivalent entities. */
 static const char * const html_code_map[256] = {
    NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
    NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
    NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL,"&quot;",NULL,NULL,NULL,"&amp;",NULL,
+   NULL, NULL, NULL, NULL,"&quot;",NULL,NULL,NULL,"&amp;","&#39;",
    NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
    NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
    "&lt;",NULL,"&gt;",NULL,NULL, NULL, NULL, NULL, NULL, NULL,
@@ -110,36 +106,6 @@ static const char * const html_code_map[256] = {
    NULL, NULL, NULL, NULL, NULL, NULL
 };
 
-/* Maps special characters in a cookie to their equivalent % codes. */
-static const char * const cookie_code_map[256] = {
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, "+",  NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, "%2C",NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, "%3B",
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-   NULL, NULL, NULL, NULL, NULL, NULL
-};
-
 
 /*********************************************************************
  *
@@ -153,14 +119,24 @@ static const char * const cookie_code_map[256] = {
  * Parameters  :
  *          1  :  s = String to encode.  Null-terminated.
  *
- * Returns     :  Encoded string, newly allocated on the heap. 
+ * Returns     :  Encoded string, newly allocated on the heap.
  *                Caller is responsible for freeing it with free().
+ *                If s is NULL, or on out-of memory, returns NULL.
  *
  *********************************************************************/
 char * html_encode(const char *s)
 {
+   char * buf;
+   size_t buf_size;
+
+   if (s == NULL)
+   {
+      return NULL;
+   }
+
    /* each input char can expand to at most 6 chars */
-   char * buf = (char *) malloc((strlen(s) * 6) + 1);
+   buf_size = (strlen(s) * 6) + 1;
+   buf = (char *) malloc(buf_size);
 
    if (buf)
    {
@@ -171,8 +147,9 @@ char * html_encode(const char *s)
          const char * replace_with = html_code_map[(unsigned char) c];
          if(replace_with != NULL)
          {
-            strcpy(p, replace_with);
-            p += strlen(replace_with);
+            const size_t bytes_written = (size_t)(p - buf);
+            assert(bytes_written < buf_size);
+            p += strlcpy(p, replace_with, buf_size - bytes_written);
          }
          else
          {
@@ -183,53 +160,45 @@ char * html_encode(const char *s)
       *p = '\0';
    }
 
+   assert(strlen(buf) < buf_size);
    return(buf);
 }
 
+
 /*********************************************************************
  *
- * Function    :  cookie_encode
+ * Function    :  html_encode_and_free_original
  *
- * Description :  Encodes a string so it can be used in a cookie.
- *                Replaces " ", ",", and ";" with the appropriate
- *                codes.
+ * Description :  Encodes a string so it's not interpreted as
+ *                containing HTML tags or entities.
+ *                Replaces <, >, &, and " with the appropriate HTML
+ *                entities.  Free()s original string.
+ *                If original string is NULL, simply returns NULL.
  *
  * Parameters  :
  *          1  :  s = String to encode.  Null-terminated.
  *
- * Returns     :  Encoded string, newly allocated on the heap. 
+ * Returns     :  Encoded string, newly allocated on the heap.
  *                Caller is responsible for freeing it with free().
+ *                If s is NULL, or on out-of memory, returns NULL.
  *
  *********************************************************************/
-char * cookie_encode(const char *s)
+char * html_encode_and_free_original(char *s)
 {
-   /* each input char can expand to at most 3 chars */
-   char * buf = (char *) malloc((strlen(s) * 3) + 1);
+   char * result;
 
-   if (buf)
+   if (s == NULL)
    {
-      char c;
-      char * p = buf;
-      while ( (c = *s++) != '\0')
-      {
-         const char * replace_with = cookie_code_map[(unsigned char) c];
-         if (replace_with != NULL)
-         {
-            strcpy(p, replace_with);
-            p += strlen(replace_with);
-         }
-         else
-         {
-            *p++ = c;
-         }
-      }
-
-      *p = '\0';
+      return NULL;
    }
 
-   return(buf);
+   result = html_encode(s);
+   free(s);
+
+   return result;
 }
 
+
 /*********************************************************************
  *
  * Function    :  url_encode
@@ -238,17 +207,30 @@ char * cookie_encode(const char *s)
  *                query string.  Replaces special characters with
  *                the appropriate %xx codes.
  *
+ *                XXX: url_query_encode() would be a more fitting
+ *                     name.
+ *
  * Parameters  :
  *          1  :  s = String to encode.  Null-terminated.
  *
- * Returns     :  Encoded string, newly allocated on the heap. 
+ * Returns     :  Encoded string, newly allocated on the heap.
  *                Caller is responsible for freeing it with free().
+ *                If s is NULL, or on out-of memory, returns NULL.
  *
  *********************************************************************/
 char * url_encode(const char *s)
 {
+   char * buf;
+   size_t buf_size;
+
+   if (s == NULL)
+   {
+      return NULL;
+   }
+
    /* each input char can expand to at most 3 chars */
-   char * buf = (char *) malloc((strlen(s) * 3) + 1);
+   buf_size = (strlen(s) * 3) + 1;
+   buf = (char *) malloc(buf_size);
 
    if (buf)
    {
@@ -259,8 +241,9 @@ char * url_encode(const char *s)
          const char * replace_with = url_code_map[(unsigned char) c];
          if (replace_with != NULL)
          {
-            strcpy(p, replace_with);
-            p += strlen(replace_with);
+            const size_t bytes_written = (size_t)(p - buf);
+            assert(bytes_written < buf_size);
+            p += strlcpy(p, replace_with, buf_size - bytes_written);
          }
          else
          {
@@ -272,6 +255,7 @@ char * url_encode(const char *s)
 
    }
 
+   assert(strlen(buf) < buf_size);
    return(buf);
 }
 
@@ -288,13 +272,13 @@ char * url_encode(const char *s)
  * Returns     :  The integer value, or -1 for non-hex characters.
  *
  *********************************************************************/
-static int xdtoi(char d)
+static int xdtoi(const int d)
 {
    if ((d >= '0') && (d <= '9'))
    {
       return(d - '0');
    }
-   else if ((d >= 'a') && (d <= 'f')) 
+   else if ((d >= 'a') && (d <= 'f'))
    {
       return(d - 'a' + 10);
    }
@@ -322,14 +306,14 @@ static int xdtoi(char d)
  * Returns     :  The integer value, or 0 for non-hex strings.
  *
  *********************************************************************/
-static int xtoi(const char *s)
+int xtoi(const char *s)
 {
-   int d1, d2;
+   int d1;
 
-   d1 = xdtoi(*s++);
+   d1 = xdtoi(*s);
    if(d1 >= 0)
    {
-      d2 = xdtoi(*s);
+      int d2 = xdtoi(*(s+1));
       if(d2 >= 0)
       {
          return (d1 << 4) + d2;
@@ -350,7 +334,7 @@ static int xtoi(const char *s)
  * Parameters  :
  *          1  :  s = String to decode.  Null-terminated.
  *
- * Returns     :  Decoded string, newly allocated on the heap. 
+ * Returns     :  Decoded string, newly allocated on the heap.
  *                Caller is responsible for freeing it with free().
  *
  *********************************************************************/
@@ -371,7 +355,7 @@ char *url_decode(const char * s)
                break;
 
             case '%':
-               if ((*q = xtoi(s + 1)))
+               if ((*q = (char)xtoi(s + 1)) != '\0')
                {
                   s += 3;
                   q++;