Ensure cookies are passed to PHP request.

Author: cscott

src/node_php_embed.cc

@@ -139,6 +139,12 @@ static void node_php_embed_send_header(sapi_header_struct *sapi_header,
   TRACE("<");
 }
 
+static char * node_php_embed_read_cookies(TSRMLS_D) {
+  // This is a hack to prevent the SAPI from overwriting the
+  // cookie data we set up in the PhpRequestWorker constructor.
+  return SG(request_info).cookie_data;
+}
+
 static void node_php_embed_register_server_variables(
     zval *track_vars_array TSRMLS_DC) {
   TRACE(">");
@@ -275,15 +281,7 @@ static void node_php_embed_ensure_init(void) {
   // Shutdown the initially-created request; we'll create our own request
   // objects inside PhpRequestWorker.
   php_request_shutdown(nullptr);
-#define CHECK_NULL(requestvar)                                          \
-  if (SG(request_info).requestvar) {                                    \
-    NPE_ERROR("OOPS! " #requestvar " is set!");                         \
-    SG(request_info).requestvar = nullptr;                              \
-  }
-  CHECK_NULL(request_method);
-  CHECK_NULL(query_string);
-  CHECK_NULL(path_translated);
-  CHECK_NULL(request_uri);
+  PhpRequestWorker::CheckRequestInfo(TSRMLS_C);
   node::AtExit(ModuleShutdown, nullptr);
   TRACE("<");
 }
@@ -294,10 +292,13 @@ NAN_MODULE_INIT(ModuleInit) {
   php_embed_module.php_ini_ignore = true;
   php_embed_module.php_ini_ignore_cwd = true;
   php_embed_module.ini_defaults = nullptr;
+  // The following initialization statements are kept in the same
+  // order as the fields in `struct _sapi_module_struct` (SAPI.h)
   php_embed_module.startup = node_php_embed_startup;
-  php_embed_module.send_header = node_php_embed_send_header;
   php_embed_module.ub_write = node_php_embed_ub_write;
   php_embed_module.flush = node_php_embed_flush;
+  php_embed_module.send_header = node_php_embed_send_header;
+  php_embed_module.read_cookies = node_php_embed_read_cookies;
   php_embed_module.register_server_variables =
     node_php_embed_register_server_variables;
   // Most of init will be done lazily in node_php_embed_ensure_init()

src/phprequestworker.cc

@@ -83,10 +83,16 @@ void PhpRequestWorker::Execute(MapperChannel *channel TSRMLS_DC) {
     efree(const_cast<char*>(SG(request_info).requestvar));      \
     SG(request_info).requestvar = nullptr;                      \
   }
+#define CHECK_REQUEST_INFO(requestvar)                                  \
+  if (SG(request_info).requestvar) {                                    \
+    NPE_ERROR("OOPS! " #requestvar " is set!");                         \
+    SG(request_info).requestvar = nullptr;                              \
+  }
   SET_REQUEST_INFO("REQUEST_METHOD", request_method);
   SET_REQUEST_INFO("QUERY_STRING", query_string);
   SET_REQUEST_INFO("PATH_TRANSLATED", path_translated);
   SET_REQUEST_INFO("REQUEST_URI", request_uri);
+  SET_REQUEST_INFO("HTTP_COOKIE", cookie_data);
   // xxx set proto_num ?
   // xxx set cookie_data ?
   server_vars_.clear();  // We don't need to keep this around any more.
@@ -148,9 +154,17 @@ void PhpRequestWorker::AfterExecute(TSRMLS_D) {
   FREE_REQUEST_INFO(query_string);
   FREE_REQUEST_INFO(path_translated);
   FREE_REQUEST_INFO(request_uri);
+  FREE_REQUEST_INFO(cookie_data);
   php_request_shutdown(nullptr);
   TRACE("< PhpRequestWorker");
 }
+void PhpRequestWorker::CheckRequestInfo(TSRMLS_D) {
+  CHECK_REQUEST_INFO(request_method);
+  CHECK_REQUEST_INFO(query_string);
+  CHECK_REQUEST_INFO(path_translated);
+  CHECK_REQUEST_INFO(request_uri);
+  CHECK_REQUEST_INFO(cookie_data);
+}
 
 // Executed when the async work is complete.
 // This function will be run inside the main event loop

src/phprequestworker.h

@@ -35,8 +35,13 @@ class PhpRequestWorker : public AsyncMessageWorker {
   void Execute(MapperChannel *channel TSRMLS_DC) override;
   void AfterAsyncLoop(TSRMLS_D) override;
   void AfterExecute(TSRMLS_D) override;
+
+  // Executed in the JS thread.
   void HandleOKCallback(JsObjectMapper *m) override;
 
+  // Used during module startup to check SG(request_info)
+  static void CheckRequestInfo(TSRMLS_D);
+
  private:
   Value source_;
   Value result_;