Add "Buffer" type to allow passing PHP output as buffers to Node.

Author: cscott

src/messages.h

@@ -111,6 +111,9 @@ class JsInvokeMethodMsg : public MessageToJs {
         name_.SetOwnedString(name, strlen(name));
     }
     virtual ~JsInvokeMethodMsg() { delete[] argv_; }
+    // this is a bit of a hack to allow constructing a call with a Buffer
+    // as an argument.
+    Value &Argv(int n) { return argv_[n]; }
  protected:
     virtual void InJs(ObjectMapper *m) {
         Nan::MaybeLocal<v8::Object> o = Nan::To<v8::Object>(obj_.ToJs(m));

src/node_php_embed.cc

@@ -115,12 +115,12 @@ static int node_php_embed_ub_write(const char *str, unsigned int str_length TSRM
         (messageChannel->GetWorker());
     ZVal stream(ZEND_FILE_LINE_C);
     worker->GetStream().ToPhp(messageChannel, stream TSRMLS_CC);
-    // Creating buf "the hard way" to avoid unnecessary copying of str.
-    zval buf;
-    INIT_ZVAL(buf); ZVAL_STRINGL(&buf, str, str_length, 0);
+    zval buf; INIT_ZVAL(buf); // stack allocate a null zval as a placeholder
     zval *args[] = { &buf };
-    // XXX, would be better to pass this as a buffer, not a string.
     JsInvokeMethodMsg msg(messageChannel, stream.Ptr(), "write", 1, args);
+    // hack the message to pass a buffer, not a string
+    // (and avoid unnecessary copying by not using an "owned buffer")
+    msg.Argv(0).SetBuffer(str, str_length);
     messageChannel->Send(&msg);
     // XXX wait for response
     msg.WaitForResponse(); // XXX optional?

src/values.h

@@ -187,6 +187,22 @@ class ZVal : public NonAssignable {
             }
         }
     };
+    class Buf : public Str {
+    public:
+        Buf(const char *data, std::size_t length) : Str(data, length) { }
+        virtual v8::Local<v8::Value> ToJs(ObjectMapper *m) const {
+            Nan::EscapableHandleScope scope;
+            return scope.Escape(Nan::CopyBuffer(data_, length_).ToLocalChecked());
+        }
+    };
+    class OBuf : public OStr {
+    public:
+        OBuf(const char *data, std::size_t length) : OStr(data, length) { }
+        virtual v8::Local<v8::Value> ToJs(ObjectMapper *m) const {
+            Nan::EscapableHandleScope scope;
+            return scope.Escape(Nan::CopyBuffer(data_, length_).ToLocalChecked());
+        }
+    };
     class Obj : public Base {
         objid_t id_;
     public:
@@ -252,6 +268,9 @@ class ZVal : public NonAssignable {
                 SetOwnedString(*str, str.length());
                 return;
             }
+        } else if (node::Buffer::HasInstance(v)) {
+            SetOwnedBuffer(node::Buffer::Data(v), node::Buffer::Length(v));
+            return;
         } else if (v->IsObject()) {
             SetJsObject(m, Nan::To<v8::Object>(v).ToLocalChecked());
             return;
@@ -329,6 +348,16 @@ class ZVal : public NonAssignable {
         type_ = VALUE_OSTR;
         new (&ostr_) OStr(data, length);
     }
+    void SetBuffer(const char *data, std::size_t length) {
+        PerhapsDestroy();
+        type_ = VALUE_BUF;
+        new (&buf_) Buf(data, length);
+    }
+    void SetOwnedBuffer(const char *data, std::size_t length) {
+        PerhapsDestroy();
+        type_ = VALUE_OBUF;
+        new (&obuf_) OBuf(data, length);
+    }
     void SetJsObject(ObjectMapper *m, v8::Local<v8::Object> o) {
         SetJsObject(m->IdForJsObj(o));
     }
@@ -380,11 +409,13 @@ class ZVal : public NonAssignable {
     }
     enum ValueTypes {
         VALUE_EMPTY, VALUE_NULL, VALUE_BOOL, VALUE_INT, VALUE_DOUBLE,
-        VALUE_STR, VALUE_OSTR, VALUE_JSOBJ, VALUE_PHPOBJ
+        VALUE_STR, VALUE_OSTR, VALUE_BUF, VALUE_OBUF,
+        VALUE_JSOBJ, VALUE_PHPOBJ
     } type_;
     union {
         int empty_; Null null_; Bool bool_; Int int_; Double double_;
-        Str str_; OStr ostr_; JsObj jsobj_; PhpObj phpobj_;
+        Str str_; OStr ostr_; Buf buf_; OBuf obuf_;
+        JsObj jsobj_; PhpObj phpobj_;
     };
     const Base &AsBase() {
         switch(type_) {
@@ -402,6 +433,10 @@ class ZVal : public NonAssignable {
             return str_;
         case VALUE_OSTR:
             return ostr_;
+        case VALUE_BUF:
+            return buf_;
+        case VALUE_OBUF:
+            return obuf_;
         case VALUE_JSOBJ:
             return jsobj_;
         case VALUE_PHPOBJ:

test/context.js

@@ -33,7 +33,9 @@ describe('Passing context object from JS to PHP', function() {
 				d: (((1<<30)-1)*4),
 				e: 1.5,
 				f: 'abcdef \uD83D\uDCA9',
-				g: { f: 1 }
+				g: { f: 1 },
+				h: function fname(x) { return x; },
+				i: new Buffer('abc', 'utf8')
 			}
 		}).then(function(v) {
 			out.toString().replace(/int\(4294967292\)/,'float(4294967292)')
@@ -44,7 +46,9 @@ describe('Passing context object from JS to PHP', function() {
 				'float(4294967292)\n' +
 				'float(1.5)\n' +
 				'string(11) "abcdef \uD83D\uDCA9"\n' +
-				'int(1)\n'
+				'int(1)\n' +
+				'string(5) "fname"\n' +
+				'string(3) "abc"\n'
 			);
 		});
     });

test/context.php

@@ -7,4 +7,6 @@
 var_dump($c->e);
 var_dump($c->f);
 var_dump($c->g->f);
+var_dump($c->h->name);
+var_dump($c->i);
 ?>