Merge pull request #618

Author: jmikola

config.m4

@@ -168,6 +168,7 @@ if test "$MONGODB" != "no"; then
     src/BSON/TypeWrapper.c \
     src/BSON/Unserializable.c \
     src/BSON/UTCDateTime.c \
+    src/BSON/functions.c \
     src/MongoDB/BulkWrite.c \
     src/MongoDB/Command.c \
     src/MongoDB/Cursor.c \

config.w32

@@ -84,7 +84,7 @@ if (PHP_MONGODB != "no") {
 
   EXTENSION("mongodb", "php_phongo.c phongo_compat.c", null, PHP_MONGODB_CFLAGS);
   ADD_SOURCES(configure_module_dirname + "/src", "bson.c bson-encode.c", "mongodb");
-  ADD_SOURCES(configure_module_dirname + "/src/BSON", "Binary.c Decimal128.c Javascript.c MaxKey.c MinKey.c ObjectID.c Persistable.c Regex.c Serializable.c Timestamp.c Type.c TypeWrapper.c Unserializable.c UTCDateTime.c", "mongodb");
+  ADD_SOURCES(configure_module_dirname + "/src/BSON", "Binary.c Decimal128.c Javascript.c MaxKey.c MinKey.c ObjectID.c Persistable.c Regex.c Serializable.c Timestamp.c Type.c TypeWrapper.c Unserializable.c UTCDateTime.c functions.c", "mongodb");
   ADD_SOURCES(configure_module_dirname + "/src/MongoDB", "BulkWrite.c Command.c Cursor.c CursorId.c Manager.c Query.c ReadConcern.c ReadPreference.c Server.c WriteConcern.c WriteConcernError.c WriteError.c WriteResult.c", "mongodb");
   ADD_SOURCES(configure_module_dirname + "/src/MongoDB/Exception", "AuthenticationException.c BulkWriteException.c ConnectionException.c ConnectionTimeoutException.c Exception.c ExecutionTimeoutException.c InvalidArgumentException.c LogicException.c RuntimeException.c SSLConnectionException.c UnexpectedValueException.c WriteException.c", "mongodb");
   ADD_SOURCES(configure_module_dirname + "/src/MongoDB/Monitoring", "CommandFailedEvent.c CommandStartedEvent.c CommandSubscriber.c CommandSucceededEvent.c Subscriber.c functions.c", "mongodb");

php_bson.h

@@ -84,12 +84,6 @@ bool php_phongo_bson_to_zval(const unsigned char *data, int data_len, zval **out
 #endif
 bool php_phongo_bson_typemap_to_state(zval *typemap, php_phongo_bson_typemap *map TSRMLS_DC);
 
-PHP_FUNCTION(MongoDB_BSON_toPHP);
-PHP_FUNCTION(MongoDB_BSON_fromPHP);
-PHP_FUNCTION(MongoDB_BSON_toJSON);
-PHP_FUNCTION(MongoDB_BSON_toExtendedJSON);
-PHP_FUNCTION(MongoDB_BSON_fromJSON);
-
 #endif	/* PHONGO_BSON_H */
 
 

php_phongo.c

@@ -67,6 +67,7 @@
 /* Our stuffz */
 #include "php_phongo.h"
 #include "php_bson.h"
+#include "src/BSON/functions.h"
 #include "src/MongoDB/Monitoring/functions.h"
 
 #undef MONGOC_LOG_DOMAIN
@@ -2402,10 +2403,6 @@ ZEND_BEGIN_ARG_INFO_EX(ai_bson_toJSON, 0, 0, 1)
 	ZEND_ARG_INFO(0, bson)
 ZEND_END_ARG_INFO();
 
-ZEND_BEGIN_ARG_INFO_EX(ai_bson_toExtendedJSON, 0, 0, 1)
-	ZEND_ARG_INFO(0, bson)
-ZEND_END_ARG_INFO();
-
 ZEND_BEGIN_ARG_INFO_EX(ai_bson_fromJSON, 0, 0, 1)
 	ZEND_ARG_INFO(0, json)
 ZEND_END_ARG_INFO();
@@ -2418,7 +2415,8 @@ static const zend_function_entry mongodb_functions[] = {
 	ZEND_NS_NAMED_FE("MongoDB\\BSON", fromPHP, PHP_FN(MongoDB_BSON_fromPHP), ai_bson_fromPHP)
 	ZEND_NS_NAMED_FE("MongoDB\\BSON", toPHP, PHP_FN(MongoDB_BSON_toPHP), ai_bson_toPHP)
 	ZEND_NS_NAMED_FE("MongoDB\\BSON", toJSON, PHP_FN(MongoDB_BSON_toJSON), ai_bson_toJSON)
-	ZEND_NS_NAMED_FE("MongoDB\\BSON", toExtendedJSON, PHP_FN(MongoDB_BSON_toExtendedJSON), ai_bson_toExtendedJSON)
+	ZEND_NS_NAMED_FE("MongoDB\\BSON", toCanonicalJSON, PHP_FN(MongoDB_BSON_toCanonicalJSON), ai_bson_toJSON)
+	ZEND_NS_NAMED_FE("MongoDB\\BSON", toRelaxedJSON, PHP_FN(MongoDB_BSON_toRelaxedJSON), ai_bson_toJSON)
 	ZEND_NS_NAMED_FE("MongoDB\\BSON", fromJSON, PHP_FN(MongoDB_BSON_fromJSON), ai_bson_fromJSON)
 	ZEND_NS_NAMED_FE("MongoDB\\Driver\\Monitoring", addSubscriber, PHP_FN(MongoDB_Driver_Monitoring_addSubscriber), ai_mongodb_driver_monitoring_subscriber)
 	ZEND_NS_NAMED_FE("MongoDB\\Driver\\Monitoring", removeSubscriber, PHP_FN(MongoDB_Driver_Monitoring_removeSubscriber), ai_mongodb_driver_monitoring_subscriber)

scripts/convert-bson-corpus-tests.php

@@ -2,6 +2,18 @@
 
 require_once __DIR__ . '/../tests/utils/tools.php';
 
+$expectedFailures = [
+    'Double type: 1.23456789012345677E+18' => 'Variation in double\'s string representation (SPEC-850)',
+    'Double type: -1.23456789012345677E+18' => 'Variation in double\'s string representation (SPEC-850)',
+    'Int64 type: -1' => 'PHP encodes integers as 32-bit if range allows',
+    'Int64 type: 0' => 'PHP encodes integers as 32-bit if range allows',
+    'Int64 type: 1' => 'PHP encodes integers as 32-bit if range allows',
+    'Javascript Code with Scope: bad scope doc (field has bad string length)' => 'Depends on PHPC-889',
+    'Javascript Code with Scope: Unicode and embedded null in code string, empty scope' => 'Embedded null in code string is not supported in libbson (CDRIVER-1879)',
+    'Multiple types within the same document: All BSON types' => 'PHP encodes integers as 32-bit if range allows',
+    'Top-level document validity: Bad $date (number, not string or hash)' => 'Legacy extended JSON $date syntax uses numbers (CDRIVER-2223)',
+];
+
 $outputPath = realpath(__DIR__ . '/../tests') . '/bson-corpus/';
 
 if ( ! is_dir($outputPath) && ! mkdir($outputPath, 0755, true)) {
@@ -35,7 +47,7 @@
         foreach ($test['valid'] as $i => $case) {
             $outputFile = sprintf('%s-valid-%03d.phpt', pathinfo($inputFile, PATHINFO_FILENAME), $i + 1);
             try {
-                $output = renderPhpt(getParamsForValid($test, $case));
+                $output = renderPhpt(getParamsForValid($test, $case), $expectedFailures);
             } catch (Exception $e) {
                 printf("Error processing valid[%d] in %s: %s\n", $i, $inputFile, $e->getMessage());
                 continue;
@@ -52,7 +64,7 @@
         foreach ($test['decodeErrors'] as $i => $case) {
             $outputFile = sprintf('%s-decodeError-%03d.phpt', pathinfo($inputFile, PATHINFO_FILENAME), $i + 1);
             try {
-                $output = renderPhpt(getParamsForDecodeError($test, $case));
+                $output = renderPhpt(getParamsForDecodeError($test, $case), $expectedFailures);
             } catch (Exception $e) {
                 printf("Error processing decodeErrors[%d] in %s: %s\n", $i, $inputFile, $e->getMessage());
                 continue;
@@ -69,7 +81,7 @@
         foreach ($test['parseErrors'] as $i => $case) {
             $outputFile = sprintf('%s-parseError-%03d.phpt', pathinfo($inputFile, PATHINFO_FILENAME), $i + 1);
             try {
-                $output = renderPhpt(getParamsForParseError($test, $case));
+                $output = renderPhpt(getParamsForParseError($test, $case), $expectedFailures);
             } catch (Exception $e) {
                 printf("Error processing parseErrors[%d] in %s: %s\n", $i, $inputFile, $e->getMessage());
                 continue;
@@ -139,12 +151,12 @@ function getParamsForValid(array $test, array $case)
     $expect .= $expectedCanonicalBson . "\n";
 
     $code .= "\n// Canonical BSON -> Canonical extJSON \n";
-    $code .= 'echo json_canonicalize(toExtendedJSON($canonicalBson)), "\n";' . "\n";;
+    $code .= 'echo json_canonicalize(toCanonicalJSON($canonicalBson)), "\n";' . "\n";;
     $expect .= $expectedCanonicalExtJson . "\n";
 
     if (isset($relaxedExtJson)) {
         $code .= "\n// Canonical BSON -> Relaxed extJSON \n";
-        $code .= 'echo json_canonicalize(toJSON($canonicalBson)), "\n";' . "\n";;
+        $code .= 'echo json_canonicalize(toRelaxedJSON($canonicalBson)), "\n";' . "\n";;
         $expect .= $expectedRelaxedExtJson . "\n";
     }
 
@@ -160,12 +172,12 @@ function getParamsForValid(array $test, array $case)
         $expect .= $expectedCanonicalBson . "\n";
 
         $code .= "\n// Degenerate BSON -> Canonical extJSON \n";
-        $code .= 'echo json_canonicalize(toExtendedJSON($degenerateBson)), "\n";' . "\n";;
+        $code .= 'echo json_canonicalize(toCanonicalJSON($degenerateBson)), "\n";' . "\n";;
         $expect .= $expectedCanonicalExtJson . "\n";
 
         if (isset($relaxedExtJson)) {
             $code .= "\n// Degenerate BSON -> Relaxed extJSON \n";
-            $code .= 'echo json_canonicalize(toJSON($degenerateBson)), "\n";' . "\n";;
+            $code .= 'echo json_canonicalize(toRelaxedJSON($degenerateBson)), "\n";' . "\n";;
             $expect .= $expectedRelaxedExtJson . "\n";
         }
     }
@@ -178,7 +190,7 @@ function getParamsForValid(array $test, array $case)
 
     if (isset($relaxedExtJson)) {
         $code .= "\n// Relaxed extJSON -> BSON -> Relaxed extJSON \n";
-        $code .= 'echo json_canonicalize(toJSON(fromJSON($relaxedExtJson))), "\n";' . "\n";
+        $code .= 'echo json_canonicalize(toRelaxedJSON(fromJSON($relaxedExtJson))), "\n";' . "\n";
         $expect .= $expectedRelaxedExtJson . "\n";
     }
 
@@ -256,12 +268,16 @@ function getParamsForParseError(array $test, array $case)
     ];
 }
 
-function renderPhpt(array $params)
+function renderPhpt(array $params, array $expectedFailures)
 {
+     $params['%XFAIL%'] = isset($expectedFailures[$params['%NAME%']])
+        ? "--XFAIL--\n" . $expectedFailures[$params['%NAME%']] . "\n"
+        : '';
+
     $template = <<< 'TEMPLATE'
 --TEST--
 %NAME%
---DESCRIPTION--
+%XFAIL%--DESCRIPTION--
 Generated by scripts/convert-bson-corpus-tests.php
 
 DO NOT EDIT THIS FILE

src/BSON/functions.c

@@ -0,0 +1,183 @@
+/*
+ * Copyright 2014-2017 MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <php.h>
+#include "phongo_compat.h"
+#include "php_phongo.h"
+#include "php_bson.h"
+
+typedef enum {
+   PHONGO_JSON_MODE_LEGACY,
+   PHONGO_JSON_MODE_CANONICAL,
+   PHONGO_JSON_MODE_RELAXED,
+} php_phongo_json_mode_t;
+
+/* {{{ proto string MongoDB\BSON\fromPHP(array|object $value)
+   Returns the BSON representation of a PHP value */
+PHP_FUNCTION(MongoDB_BSON_fromPHP)
+{
+	zval   *data;
+	bson_t *bson;
+
+	SUPPRESS_UNUSED_WARNING(return_value_ptr) SUPPRESS_UNUSED_WARNING(this_ptr) SUPPRESS_UNUSED_WARNING(return_value_used) /* We don't use these */
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "A", &data) == FAILURE) {
+		return;
+	}
+
+	bson = bson_new();
+	php_phongo_zval_to_bson(data, PHONGO_BSON_NONE, bson, NULL TSRMLS_CC);
+
+	PHONGO_RETVAL_STRINGL((const char *) bson_get_data(bson), bson->len);
+	bson_destroy(bson);
+} /* }}} */
+
+/* {{{ proto array|object MongoDB\BSON\toPHP(string $bson [, array $typemap = array()])
+   Returns the PHP representation of a BSON value, optionally converting it into a custom class */
+PHP_FUNCTION(MongoDB_BSON_toPHP)
+{
+	char                  *data;
+	phongo_zpp_char_len    data_len;
+	zval                  *typemap = NULL;
+	php_phongo_bson_state  state = PHONGO_BSON_STATE_INITIALIZER;
+
+	SUPPRESS_UNUSED_WARNING(return_value_ptr) SUPPRESS_UNUSED_WARNING(this_ptr) SUPPRESS_UNUSED_WARNING(return_value_used) /* We don't use these */
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a!", &data, &data_len, &typemap) == FAILURE) {
+		return;
+	}
+
+	if (!php_phongo_bson_typemap_to_state(typemap, &state.map TSRMLS_CC)) {
+		return;
+	}
+
+	if (!php_phongo_bson_to_zval_ex((const unsigned char *)data, data_len, &state)) {
+		zval_ptr_dtor(&state.zchild);
+		RETURN_NULL();
+	}
+
+#if PHP_VERSION_ID >= 70000
+	RETURN_ZVAL(&state.zchild, 0, 1);
+#else
+	RETURN_ZVAL(state.zchild, 0, 1);
+#endif
+} /* }}} */
+
+/* {{{ proto string MongoDB\BSON\fromJSON(string $json)
+   Returns the BSON representation of a JSON value */
+PHP_FUNCTION(MongoDB_BSON_fromJSON)
+{
+	char                *json;
+	phongo_zpp_char_len  json_len;
+	bson_t               bson = BSON_INITIALIZER;
+	bson_error_t         error;
+
+	SUPPRESS_UNUSED_WARNING(return_value_ptr) SUPPRESS_UNUSED_WARNING(this_ptr) SUPPRESS_UNUSED_WARNING(return_value_used) /* We don't use these */
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &json, &json_len) == FAILURE) {
+		return;
+	}
+
+	if (bson_init_from_json(&bson, (const char *)json, json_len, &error)) {
+		PHONGO_RETVAL_STRINGL((const char *) bson_get_data(&bson), bson.len);
+		bson_destroy(&bson);
+	} else {
+		phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE TSRMLS_CC, "%s", error.domain == BSON_ERROR_JSON ? error.message : "Error parsing JSON");
+	}
+} /* }}} */
+
+static void phongo_bson_to_json(INTERNAL_FUNCTION_PARAMETERS, php_phongo_json_mode_t mode)
+{
+	char                *data;
+	phongo_zpp_char_len  data_len;
+	const bson_t        *bson;
+	bool                 eof = false;
+	bson_reader_t       *reader;
+	char                *json = NULL;
+	size_t               json_len;
+
+	SUPPRESS_UNUSED_WARNING(return_value_ptr) SUPPRESS_UNUSED_WARNING(this_ptr) SUPPRESS_UNUSED_WARNING(return_value_used) /* We don't use these */
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &data, &data_len) == FAILURE) {
+		return;
+	}
+
+	reader = bson_reader_new_from_data((const unsigned char *)data, data_len);
+	bson = bson_reader_read(reader, NULL);
+
+	if (!bson) {
+		phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE TSRMLS_CC, "Could not read document from BSON reader");
+		bson_reader_destroy(reader);
+		return;
+	}
+
+	if (mode == PHONGO_JSON_MODE_LEGACY) {
+		json = bson_as_json(bson, &json_len);
+	} else if (mode == PHONGO_JSON_MODE_CANONICAL) {
+		json = bson_as_canonical_json(bson, &json_len);
+	} else if (mode == PHONGO_JSON_MODE_RELAXED) {
+		json = bson_as_relaxed_json(bson, &json_len);
+	}
+
+	if (!json) {
+		phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE TSRMLS_CC, "Could not convert BSON document to a JSON string");
+		bson_reader_destroy(reader);
+		return;
+	}
+
+	PHONGO_RETVAL_STRINGL(json, json_len);
+	bson_free(json);
+
+	if (bson_reader_read(reader, &eof) || !eof) {
+		phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE TSRMLS_CC, "Reading document did not exhaust input buffer");
+	}
+
+	bson_reader_destroy(reader);
+} /* }}} */
+
+/* {{{ proto string MongoDB\BSON\toJSON(string $bson)
+   Returns the legacy extended JSON representation of a BSON value */
+PHP_FUNCTION(MongoDB_BSON_toJSON)
+{
+	phongo_bson_to_json(INTERNAL_FUNCTION_PARAM_PASSTHRU, PHONGO_JSON_MODE_LEGACY);
+} /* }}} */
+
+/* {{{ proto string MongoDB\BSON\toCanonicalJSON(string $bson)
+   Returns the canonical JSON representation of a BSON value */
+PHP_FUNCTION(MongoDB_BSON_toCanonicalJSON)
+{
+	phongo_bson_to_json(INTERNAL_FUNCTION_PARAM_PASSTHRU, PHONGO_JSON_MODE_CANONICAL);
+} /* }}} */
+
+/* {{{ proto string MongoDB\BSON\toRelaxedJSON(string $bson)
+   Returns the relaxed JSON representation of a BSON value */
+PHP_FUNCTION(MongoDB_BSON_toRelaxedJSON)
+{
+	phongo_bson_to_json(INTERNAL_FUNCTION_PARAM_PASSTHRU, PHONGO_JSON_MODE_RELAXED);
+} /* }}} */
+
+/*
+ * Local variables:
+ * tab-width: 4
+ * c-basic-offset: 4
+ * End:
+ * vim600: noet sw=4 ts=4 fdm=marker
+ * vim<600: noet sw=4 ts=4
+ */

src/BSON/functions.h

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2014-2017 MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef PHONGO_BSON_FUNCTIONS_H
+#define PHONGO_BSON_FUNCTIONS_H
+
+#include <php.h>
+
+PHP_FUNCTION(MongoDB_BSON_fromPHP);
+PHP_FUNCTION(MongoDB_BSON_toPHP);
+
+PHP_FUNCTION(MongoDB_BSON_fromJSON);
+PHP_FUNCTION(MongoDB_BSON_toJSON);
+PHP_FUNCTION(MongoDB_BSON_toCanonicalJSON);
+PHP_FUNCTION(MongoDB_BSON_toRelaxedJSON);
+
+#endif /* PHONGO_BSON_FUNCTIONS_H */
+
+
+/*
+ * Local variables:
+ * tab-width: 4
+ * c-basic-offset: 4
+ * End:
+ * vim600: noet sw=4 ts=4 fdm=marker
+ * vim<600: noet sw=4 ts=4
+ */