Changeset 1264

Timestamp:

Jan 7, 2009 9:31:14 AM (14 years ago)

Author:

dkearney

Message:

fixing rp library's get() function for retrieving encoded data. if the data is encoded there is no need to do xml entity translation. adding a function rappture's encode class for checking to see if a string has a proper header encode header. adding corresponding tcl functions and tests. also adjusting some of the int declarations to size_t.

Location:

trunk

Files:

• lang/tcl/src/RpEncodeTclInterface.cc (modified) (3 diffs)
• lang/tcl/tests/encode.test (modified) (2 diffs)
• src/core/RpEncode.cc (modified) (4 diffs)
• src/core/RpEncode.h (modified) (1 diff)
• src/core/RpLibrary.cc (modified) (3 diffs)

trunk/lang/tcl/src/RpEncodeTclInterface.cc

@@ -68 +68 @@
         Tcl_AppendResult(interp,
             "wrong # args: should be \"",
-            Tcl_GetString(objv[0])," binary <string>\"",
+            Tcl_GetString(objv[0])," binary|encoded <string>\"",
             (char*)NULL);
         return TCL_ERROR;
@@ -78 +78 @@
     const char *buf = (const char*) Tcl_GetByteArrayFromObj(objv[2],&bufLen);
 
-    if (strcmp(type,"binary") == 0) {
+    if (('b' == *type) && (strcmp(type,"binary") == 0)) {
         if (Rappture::encoding::isbinary(buf,bufLen) != 0) {
             // non-ascii character found, return yes
@@ -86 +86 @@
         }
         return TCL_OK;
+    } else if (('e' == *type) && (strcmp(type,"encoded") == 0)) {
+        if (Rappture::encoding::isencoded(buf,bufLen) != 0) {
+            // valid "@@RP-ENC:" header found, return yes
+            Tcl_AppendResult(interp, "yes", (char*)NULL);
+        } else {
+            Tcl_AppendResult(interp, "no",(char*)NULL);
+        }
+        return TCL_OK;
     }
     Tcl_AppendResult(interp, "bad option \"", type,
-            "\": should be binary",
+            "\": should be one of binary, encoded",
             (char*)NULL);
     return TCL_ERROR;

trunk/lang/tcl/tests/encode.test

@@ -29 +29 @@
 test is-1.0.1 {Rappture::encoding::is, 0 arguments} {
     list [catch {Rappture::encoding::is} msg] $msg
-} {1 {wrong # args: should be "Rappture::encoding::is binary <string>"}}
+} {1 {wrong # args: should be "Rappture::encoding::is binary|encoded <string>"}}
 
 test is-1.1.1 {Rappture::encoding::is, 1 incomplete subcommand} {
     list [catch {Rappture::encoding::is binary} msg] $msg
-} {1 {wrong # args: should be "Rappture::encoding::is binary <string>"}}
+} {1 {wrong # args: should be "Rappture::encoding::is binary|encoded <string>"}}
 
 test is-1.1.2 {Rappture::encoding::is, 1 subcommand w/ string} {
@@ -47 +47 @@
 test is-1.2.0 {Rappture::encoding::is, 1 invalid subcommand} {
     list [catch {Rappture::encoding::is binaryy "hi"} msg] $msg
-} {1 {bad option "binaryy": should be binary}}
+} {1 {bad option "binaryy": should be one of binary, encoded}}
 
 test is-1.2.1 {Rappture::encoding::is, too many arguments} {
     list [catch {Rappture::encoding::is binary binary "hi"} msg] $msg
-} {1 {wrong # args: should be "Rappture::encoding::is binary <string>"}}
+} {1 {wrong # args: should be "Rappture::encoding::is binary|encoded <string>"}}
 
 test is-1.2.2 {Rappture::encoding::is, with an embedded null} {
     list [catch {Rappture::encoding::is binary "x\000x"} msg] $msg
+} {0 yes}
+
+test is-1.3.1 {Rappture::encoding::is, encoded subcommand w/ false string} {
+    list [catch {Rappture::encoding::is encoded "hi"} msg] $msg
+} {0 no}
+
+test is-1.3.2 {Rappture::encoding::is, encoded b64 flag and extra string} {
+    set h "@@RP-ENC:b64\nH4sIAAAAAAAAA8vIBACsKpPYAgAAAA=="
+    list [catch {Rappture::encoding::is encoded $h} msg] $msg
+} {0 yes}
+
+test is-1.3.3 {Rappture::encoding::is, encoded zb64 flag and extra string} {
+    set h "@@RP-ENC:zb64\nH4sIAAAAAAAAA8vIBACsKpPYAgAAAA=="
+    list [catch {Rappture::encoding::is encoded $h} msg] $msg
+} {0 yes}
+
+test is-1.3.4 {Rappture::encoding::is, encoded z flag and extra string} {
+    set h "@@RP-ENC:z\nH4sIAAAAAAAAA8vIBACsKpPYAgAAAA=="
+    list [catch {Rappture::encoding::is encoded $h} msg] $msg
+} {0 yes}
+
+test is-1.3.5 {Rappture::encoding::is, encoded z flag newline no string} {
+    set h "@@RP-ENC:z\n"
+    list [catch {Rappture::encoding::is encoded $h} msg] $msg
+} {0 yes}
+
+test is-1.3.6 {Rappture::encoding::is, encoded b64 flag newline no string} {
+    set h "@@RP-ENC:b64\n"
+    list [catch {Rappture::encoding::is encoded $h} msg] $msg
+} {0 yes}
+
+test is-1.3.7 {Rappture::encoding::is, encoded zb64 flag newline no string} {
+    set h "@@RP-ENC:zb64\n"
+    list [catch {Rappture::encoding::is encoded $h} msg] $msg
+} {0 yes}
+
+test is-1.3.7 {Rappture::encoding::is, encoded z flag no newline no string} {
+    set h "@@RP-ENC:zb64"
+    list [catch {Rappture::encoding::is encoded $h} msg] $msg
+} {0 no}
+
+test is-1.3.8 {Rappture::encoding::is, encoded b64 flag no newline no string} {
+    set h "@@RP-ENC:b64"
+    list [catch {Rappture::encoding::is encoded $h} msg] $msg
+} {0 no}
+
+test is-1.3.9 {Rappture::encoding::is, encoded zb64 flag no newline no string} {
+    set h "@@RP-ENC:zb64"
+    list [catch {Rappture::encoding::is encoded $h} msg] $msg
+} {0 no}
+
+test is-1.3.10 {Rappture::encoding::is, encoded with an embedded null} {
+    list [catch {Rappture::encoding::is encoded "@@RP-ENC:zb64\nx\000x"} msg] $msg
 } {0 yes}
 

trunk/src/core/RpEncode.cc

@@ -34 +34 @@
 isbinary(const char* buf, int size)
 {
+    if (buf == NULL) {
+        return 0;
+    }
+
     if (size < 0) {
         size = strlen(buf);
@@ -51 +55 @@
 }
 
-
-
-
+/**********************************************************************/
+// FUNCTION: Rappture::encoding::isencoded()
+/// checks header of given string to determine if it was encoded by rappture.
+/**
+ * Checks to see if the string buf was encoded by rappture
+ * and contains the proper "@@RP-ENC:" header.
+ * rappture encoded strings start with the string "@@RP-ENC:X\n"
+ * where X is one of z, b64, zb64
+ * This function will not work for strings that do not have the header.
+ * Full function call:
+ * Rappture::encoding::isencoded(buf,size);
+ *
+ */
+
+size_t
+isencoded(const char* buf, int size)
+{
+    size_t flags = 0;
+    size_t len = 0;
+
+    if (buf == NULL) {
+        return flags;
+    }
+
+    if (size < 0) {
+        len = strlen(buf);
+    } else {
+        len = size;
+    }
+
+    // check the following for valid rappture encoded string:
+    // all strings encoded by rappture are at least 11 characters
+    // rappture encoded strings start with the '@' character
+    // rappture encoded strings start with the string "@@RP-ENC:X\n"
+    // where X is one of z, b64, zb64
+    if (    (len >= 11)
+        &&  ('@' == *buf)
+        &&  (strncmp("@@RP-ENC:",buf,9) == 0) ) {
+
+        size_t idx = 9;
+
+        // check the string length and if the z flag was specified
+        // add 1 for \n
+        if (    (len >= (idx + 1))
+            &&  (buf[idx] == 'z') ) {
+            flags |= RPENC_Z;
+            ++idx;
+        }
+        // check the string length and if the b64 flag was specified
+        // add 1 for \n
+        if (    (len >= (idx + 2 + 1))
+            &&  (buf[idx]   == 'b')
+            &&  (buf[idx+1] == '6')
+            &&  (buf[idx+2] == '4') ) {
+            flags |= RPENC_B64;
+            idx += 3;
+        }
+        // check for the '\n' at the end of the header
+        if (buf[idx] != '\n') {
+            flags = 0;
+        }
+    }
+
+    return flags;
+}
 
 /**********************************************************************/
@@ -66 +132 @@
 
 Rappture::Outcome
-encode (Rappture::Buffer& buf, int flags)
+encode (Rappture::Buffer& buf, size_t flags)
 {
 
@@ -125 +191 @@
 
 Rappture::Outcome
-decode (Rappture::Buffer& buf, int flags)
+decode (Rappture::Buffer& buf, size_t flags)
 {
 

trunk/src/core/RpEncode.h

@@ -29 +29 @@
 
 int isbinary(const char* buf, int size);
-Rappture::Outcome encode (Rappture::Buffer& buf, int flags);
-Rappture::Outcome decode (Rappture::Buffer& buf, int flags);
+size_t isencoded(const char* buf, int size);
+Rappture::Outcome encode (Rappture::Buffer& buf, size_t flags);
+Rappture::Outcome decode (Rappture::Buffer& buf, size_t flags);
 
 #ifdef __cplusplus

trunk/src/core/RpLibrary.cc

@@ -1457 +1457 @@
         int myChildCount = 0;
 
-        parentNode = NULL;
+        parentNode = NULL;
         if (path.empty()) {
             // an empty path uses the current RpLibrary as parent
@@ -1539 +1539 @@
 
     inData = Rappture::Buffer(retCStr);
-    status &= Rappture::encoding::decode(inData,0);
-    status.addContext("RpLibrary::getSting");
-    // inData.append("\0",1);
-
-    if (translateFlag == RPLIB_TRANSLATE) {
-        translatedContents = ERTranslator.decode(inData.bytes(),inData.size());
-        if (translatedContents == NULL) {
-            // translation failed
-            if (!status) {
-                status.error("Error while translating entity references");
-                status.addContext("RpLibrary::getSting");
-            }
-        }
-        else {
-            // subtract 1 from size because ERTranslator adds extra NULL
-            retStr = std::string(translatedContents,ERTranslator.size()-1);
-            translatedContents = NULL;
-        }
-    }
-    else {
+
+    if (Rappture::encoding::isencoded(inData.bytes(),inData.size()) != 0) {
+        // data is encoded,
+        // coming from an rplib, this means it was at least base64 encoded
+        // there is no reason to do entity translation
+        // because base64 character set does not include xml entity chars
+        status &= Rappture::encoding::decode(inData,0);
+        status.addContext("RpLibrary::getSting");
         retStr = std::string(inData.bytes(),inData.size());
+    } else {
+        // check translateFlag to see if we need to translate entity refs
+        if (translateFlag == RPLIB_TRANSLATE) {
+            translatedContents = ERTranslator.decode(inData.bytes(),inData.size());
+            if (translatedContents == NULL) {
+                // translation failed
+                if (!status) {
+                    status.error("Error while translating entity references");
+                    status.addContext("RpLibrary::getSting");
+                }
+            } else {
+                // subtract 1 from size because ERTranslator adds extra NULL
+                retStr = std::string(translatedContents,ERTranslator.size()-1);
+                translatedContents = NULL;
+            }
+        }
     }
 
@@ -1957 +1961 @@
     Rappture::Buffer inData;
     unsigned int bytesWritten = 0;
-    int flags = 0;
+    size_t flags = 0;
 
     if (!this->root) {