PHPC-1114: Add template.rc file to embed the right MongoDB version in the Windows binary

Author: derickr

.appveyor/install.cmd

@@ -48,10 +48,10 @@ setlocal enableextensions enabledelayedexpansion
 
 	if "%APPVEYOR_REPO_TAG_NAME%"=="" (
 		set APPVEYOR_REPO_TAG_NAME=%APPVEYOR_REPO_BRANCH%-%APPVEYOR_REPO_COMMIT:~0,8%
-		for /f "delims=" %%l in (php_phongo.h) do (
+		for /f "delims=" %%l in (phongo_version.h) do (
 			if not "%%l"=="" (
 				set line=%%l
-				if "!line:~8,19!"=="PHP_MONGODB_VERSION" (
+				if "!line:~8,20!"=="PHP_MONGODB_VERSION " (
 					set APPVEYOR_REPO_TAG_NAME=!line:~29,-1!-%APPVEYOR_REPO_BRANCH%-%APPVEYOR_REPO_COMMIT:~0,8%
 				)
 			)

CONTRIBUTING.md

@@ -150,31 +150,36 @@ changes in this maintenance branch. This is important because we will later
 merge the ensuing release commits up to master with `--strategy=ours`, which
 will ignore changes from the merged commits.
 
-Update the version and stability constants in `php_phongo.h`. This should entail
-removing the version's "-dev" suffix and changing the stability to "stable":
+Update the version and stability constants in `phongo_version.h`. This should
+entail removing the version's "-dev" suffix, changing the stability to
+"stable", and increasing the last digit for `PHP_MONGO_VERSION_DESC`:
 
 ```
 #define PHP_MONGODB_VERSION "1.1.8-dev"
 #define PHP_MONGODB_STABILITY "devel"
+#define PHP_MONGODB_VERSION_DESC 1,1,8,0
 ```
 
 The above would be changed to:
 
 ```
 #define PHP_MONGODB_VERSION "1.1.8"
 #define PHP_MONGODB_STABILITY "stable"
+#define PHP_MONGODB_VERSION_DESC 1,1,8,1
 ```
 
 The Makefile targets for creating the PECL package depend on these constants, so
-you must rebuild the extension after updating `php_phongo.h`.
+you must rebuild the extension after updating `phongo_version.h`.
 
 > **Note:** If this is an alpha or beta release, the version string should
 > include the X.Y.Z version followed by the stability and an increment. For
 > instance, the first beta release in the 1.4.0 series would be "1.4.0beta1".
 > Alpha and beta releases use "alpha" and "beta" stability strings,
 > respectively. Release candidates (e.g. "1.4.0RC1") also use "beta" stability.
 > See [Documenting release stability and API stability](https://pear.php.net/manual/en/guide.developers.package2.stability.php)
-> for more information.
+> for more information. For each change to the suffixes of
+> `PHP_MONGODB_VERSION`, increment the last digit of
+> `PHP_MONGODB_VERSION_DESC`.
 
 ### Publish PECL package
 
@@ -195,10 +200,10 @@ one chance to confirm the package information after uploading.
 
 ### Commit version update and release notes
 
-Commit the modified `php_phongo.h` file as "Package X.Y.Z"
+Commit the modified `phongo_version.h` file as "Package X.Y.Z"
 
 ```
-$ git add php_phongo.h
+$ git add phongo_version.h
 $ git commit -m "Package X.Y.Z"
 ```
 
@@ -212,25 +217,27 @@ $ git tag -a -m "Release X.Y.Z" X.Y.Z
 
 ### Update version info back to dev
 
-After tagging, the version and stability constants in `php_phongo.h` should be
+After tagging, the version and stability constants in `phongo_version.h` should be
 updated back to development status.
 
 ```
 #define PHP_MONGODB_VERSION "1.1.8"
 #define PHP_MONGODB_STABILITY "stable"
+#define PHP_MONGODB_VERSION_DESC 1,1,8,1
 ```
 
 The above would be changed to:
 
 ```
 #define PHP_MONGODB_VERSION "1.1.9-dev"
 #define PHP_MONGODB_STABILITY "devel"
+#define PHP_MONGODB_VERSION_DESC 1,1,9,0
 ```
 
 Commit this change:
 
 ```
-$ git commit -m "Back to -dev" php_phongo.h
+$ git commit -m "Back to -dev" phongo_version.h
 ```
 
 > **Note:** If this is an alpha, beta, or RC release, the version string should

CREDITS

@@ -1,2 +1,2 @@
 MongoDB Driver for PHP
-Hannes Magnusson, Jeremy Mikola, Derick Rethans
+Hannes Magnusson, Jeremy Mikola, Derick Rethans, Katherine Walker

phongo_version.h

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2014-2018 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_VERSION_H
+#define PHONGO_VERSION_H
+
+#define PHP_MONGODB_VERSION "1.5.0-dev"
+#define PHP_MONGODB_STABILITY "devel"
+#define PHP_MONGODB_VERSION_DESC 1,5,0,0
+
+#endif  /* PHONGO_VERSION_H */

php_phongo.h

@@ -21,16 +21,13 @@
 #include "bson.h"
 #include "mongoc.h"
 
+#include "phongo_version.h"
 #include "phongo_compat.h"
 #include "php_phongo_classes.h"
 
 #define phpext_mongodb_ptr &mongodb_module_entry
 extern zend_module_entry mongodb_module_entry;
 
-/* FIXME: Its annoying to bump version. Move into phongo_version.h.in */
-#define PHP_MONGODB_VERSION "1.5.0-dev"
-#define PHP_MONGODB_STABILITY "devel"
-
 /* Structure for persisted libmongoc clients. The PID is included to ensure that
  * processes do not destroy clients created by other processes (relevant for
  * forking). We avoid using pid_t for Windows compatibility. */

template.rc

@@ -0,0 +1,57 @@
+/* This is a template RC file.
+ * Do not edit with MSVC */
+#ifdef APSTUDIO_INVOKED
+# error dont edit with MSVC
+#endif
+
+#include "winres.h"
+#include "main/php_version.h"
+#include "phongo_version.h"
+
+LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US
+#pragma code_page(1252)
+
+#ifndef THANKS_GUYS
+# define THANKS_GUYS ""
+#endif
+
+//Version
+VS_VERSION_INFO VERSIONINFO
+ FILEVERSION PHP_MONGODB_VERSION_DESC
+ PRODUCTVERSION PHP_MONGODB_VERSION_DESC
+ FILEFLAGSMASK 0x3fL
+#ifdef _DEBUG
+ FILEFLAGS VS_FF_DEBUG
+#else
+ FILEFLAGS 0x0L
+#endif
+ FILEOS VOS__WINDOWS32
+ FILETYPE VFT_DLL
+ FILESUBTYPE VFT2_UNKNOWN
+BEGIN
+    BLOCK "StringFileInfo"
+    BEGIN
+        BLOCK "040904b0"
+        BEGIN
+            VALUE "Comments", THANKS_GUYS "\0"
+            VALUE "CompanyName", "MongoDB, Inc.\0"
+            VALUE "FileDescription", FILE_DESCRIPTION "\0"
+            VALUE "FileVersion", PHP_MONGODB_VERSION "\0"
+            VALUE "InternalName", FILE_NAME "\0"
+            VALUE "LegalCopyright", "Copyright � 2014-present MongoDB, Inc.\0"
+            VALUE "OriginalFilename", FILE_NAME "\0"
+            VALUE "PrivateBuild", "\0"
+            VALUE "ProductName", "MongoDB Driver for PHP\0"
+            VALUE "ProductVersion", PHP_MONGODB_VERSION "\0"
+            VALUE "URL", "https://docs.mongodb.com/ecosystem/drivers/php/"
+        END
+    END
+    BLOCK "VarFileInfo"
+    BEGIN
+        VALUE "Translation", 0x409, 1200
+    END
+END
+
+#ifdef MC_INCLUDE
+#include MC_INCLUDE
+#endif