Changeset 1366 for trunk/src/core/RpEncode.cc

Timestamp:

Mar 27, 2009 4:54:09 PM (14 years ago)

Author:

gah

Message:

Begin reorganizing Rappture C++ API, starting with the use of
Rappture::Outcome.

Instead of returning an Outcome and expecting every routine to
save it, pass it as a reference. Let's strip it down to what's
needed right now and add back functionality as required.

Right now too many return values are ignored in the rappture library.
We need to check all results and return the error messages via
the Outcome. At the topmost level where is touches the developer
API we can drop the error checking or turn it on via an environment
variable.

Example. Not enough checks are made for memory allocation failure.
If the application is running on an over-committed server memory
allocation errors will be silently passed on. It's okay to be
fault tolerant where possible, but if we fail to check in the internal
library functions, it's too late.

--gah

File:

• trunk/src/core/RpEncode.cc (modified) (6 diffs)

trunk/src/core/RpEncode.cc

@@ -15 +15 @@
 #include <cstring>
 
-#ifdef __cplusplus
-extern "C" {
-#endif // ifdef __cplusplus
-
-using namespace Rappture::encoding;
-
 /**********************************************************************/
 // FUNCTION: Rappture::encoding::isbinary()
@@ -32 +26 @@
 
 int
-isbinary(const char* buf, int size)
+Rappture::encoding::isbinary(const char* buf, int size)
 {
     if (buf == NULL) {
@@ -70 +64 @@
 
 size_t
-isencoded(const char* buf, int size)
+Rappture::encoding::isencoded(const char* buf, int size)
 {
     size_t flags = 0;
@@ -117 +111 @@
         }
     }
-
     return flags;
 }
@@ -131 +124 @@
  */
 
-Rappture::Outcome
-encode (Rappture::Buffer& buf, size_t flags)
-{
-
-    int compress              = 0;
-    int base64                = 0;
-    int addHeader             = 0;
-    Rappture::Outcome err;
+bool
+Rappture::encoding::encode(Rappture::Outcome &err, Rappture::Buffer& buf, 
+        size_t flags)
+{
     Rappture::Buffer outData;
 
-    if ((flags & RPENC_Z) == RPENC_Z ) {
-        compress = 1;
-    }
-    if ((flags & RPENC_B64) == RPENC_B64 ) {
-        base64 = 1;
-    }
-    if ((flags & RPENC_HDR) == RPENC_HDR ) {
-        addHeader = 1;
-    }
-
-    outData.append(buf.bytes(),buf.size());
-    err = outData.encode(compress,base64);
-    if (!err) {
+    bool compress, base64, addHeader;
+    compress  = (flags & RPENC_Z);
+    base64    = (flags & RPENC_B64);
+    addHeader = (flags & RPENC_HDR);
+
+    if (outData.append(buf.bytes(), buf.size()) != (int)buf.size()) {
+        err.addError("can't append %d bytes", buf.size());
+        return false;
+    }
+    if (outData.encode(err, compress, base64)) {
         buf.clear();
-        if (addHeader == 1) {
-            if ((compress == 1) && (base64 == 0)) {
-                buf.append("@@RP-ENC:z\n",11);
-            }
-            else if ((compress == 0) && (base64 == 1)) {
-                buf.append("@@RP-ENC:b64\n",13);
-            }
-            else if ((compress == 1) && (base64 == 1)) {
-                buf.append("@@RP-ENC:zb64\n",14);
-            }
-            else {
+        if (addHeader) {
+            if ((compress) && (!base64)) {
+                buf.append("@@RP-ENC:z\n", 11);
+            } else if ((!compress) && (base64)) {
+                buf.append("@@RP-ENC:b64\n", 13);
+            } else if ((compress) && (base64)) {
+                buf.append("@@RP-ENC:zb64\n", 14);
+            } else {
                 // do nothing
             }
-        }
-        else {
+        } else {
             // do nothing
         }
-        buf.append(outData.bytes(),outData.size());
-    }
-
-    return err;
+        if (buf.append(outData.bytes(),outData.size()) != (int)outData.size()) {
+            err.addError("can't append %d bytes", outData.size());
+            return false;
+        }
+    }
+    return true;
 }
 
@@ -190 +174 @@
  */
 
-Rappture::Outcome
-decode (Rappture::Buffer& buf, size_t flags)
-{
-
-    int decompress            = 0;
-    int base64                = 0;
-    int checkHDR              = 0;
-    Rappture::Outcome err;
+bool
+Rappture::encoding::decode(Rappture::Outcome &err, Rappture::Buffer& buf, 
+                           size_t flags)
+{
     Rappture::Buffer outData;
 
-    if ((flags & RPENC_Z) == RPENC_Z ) {
-        decompress = 1;
-    }
-    if ((flags & RPENC_B64) == RPENC_B64 ) {
-        base64 = 1;
-    }
-    if ((flags & RPENC_HDR) == RPENC_HDR ) {
-        checkHDR = 1;
-    }
-
-    if ((buf.size() > 11) && (strncmp(buf.bytes(),"@@RP-ENC:z\n",11) == 0)) {
-        outData.append(buf.bytes()+11,buf.size()-11);
-        if ( (checkHDR == 1) || ( (decompress == 0) && (base64 == 0) ) ) {
-            decompress = 1;
-            base64 = 0;
-        }
-    }
-    else if ((buf.size() > 13) && (strncmp(buf.bytes(),"@@RP-ENC:b64\n",13) == 0)) {
-        outData.append(buf.bytes()+13,buf.size()-13);
-        if ( (checkHDR == 1) || ( (decompress == 0) && (base64 == 0) ) ) {
-            decompress = 0;
-            base64 = 1;
-        }
-    }
-    else if ((buf.size() > 14) && (strncmp(buf.bytes(),"@@RP-ENC:zb64\n",14) == 0)) {
-        outData.append(buf.bytes()+14,buf.size()-14);
-        if ( (checkHDR == 1) || ( (decompress == 0) && (base64 == 0) ) ) {
-            decompress = 1;
-            base64 = 1;
-        }
-    }
-    else {
-        // no special recognized tags
-        outData.append(buf.bytes(),buf.size());
-    }
-
-    err = outData.decode(decompress,base64);
-    if (!err) {
-        buf.move(outData);
-    }
-
-    return err;
-}
-
-#ifdef __cplusplus
-}
-#endif // ifdef __cplusplus
+    bool decompress, base64, checkHDR;
+    decompress = (flags & RPENC_Z);
+    base64     = (flags & RPENC_B64);
+    checkHDR   = (flags & RPENC_HDR);
+
+    off_t offset;
+    if ((buf.size() > 11) && (strncmp(buf.bytes(),"@@RP-ENC:z\n", 11) == 0)) {
+        offset = 11;
+        if ((checkHDR) || ((!decompress) && (!base64))) {
+            decompress = true;
+            base64 = false;
+        }
+    } else if ((buf.size() > 13) && 
+               (strncmp(buf.bytes(),"@@RP-ENC:b64\n",13) == 0)) {
+        offset = 13;
+        if ((checkHDR) || ((!decompress) && (!base64) )) {
+            decompress = false;
+            base64 = true;
+        }
+    } else if ((buf.size() > 14) && 
+               (strncmp(buf.bytes(), "@@RP-ENC:zb64\n",14) == 0)) {
+        offset = 14;
+        if ((checkHDR) || ((!decompress) && (!base64))) {
+            decompress = true;
+            base64 = true;
+        }
+    } else {
+        offset = 0;
+    }
+    int nBytes = buf.size() - offset;
+    if (outData.append(buf.bytes() + offset, nBytes) != nBytes) {
+        err.addError("can't append %d bytes to buffer", nBytes);
+        return false;
+    }
+    if (!outData.decode(err, decompress, base64)) {
+        return false;
+    }
+    buf.move(outData);
+    return true;
+}
+