Merge pull request #1493 from microsoft/dev

Prepare for 5.12.0-beta1 release

CHANGELOG.md

@@ -3,6 +3,65 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 
+## 5.12.0-beta1 - 2023-12-08
+Updated PECL release packages. Here is the list of updates:
+
+### Added
+- Support for PHP 8.3
+
+### Removed
+- Support for PHP 8.0
+- Support for Ubuntu 18.04
+
+### Fixed
+- Update connection string keywords set function (#1484)
+- Fix error throw for multiple result sets (#1485)
+
+### Limitations
+- No support for inout / output params when using sql_variant type
+- No support for inout / output params when formatting decimal values
+- In Linux and macOS, setlocale() only takes effect if it is invoked before the first connection. Attempting to set the locale after connecting will not work
+- Always Encrypted requires [MS ODBC Driver 17+](https://docs.microsoft.com/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server)
+  - Only Windows Certificate Store and Azure Key Vault are supported. Custom Keystores are not yet supported
+  - Issue [#716](https://github.com/Microsoft/msphpsql/issues/716) - With Always Encrypted enabled, named parameters in subqueries are not supported
+  - Issue [#1050](https://github.com/microsoft/msphpsql/issues/1050) - With Always Encrypted enabled, insertion requires the column list for any tables with identity columns
+  - [Always Encrypted limitations](https://docs.microsoft.com/sql/connect/php/using-always-encrypted-php-drivers#limitations-of-the-php-drivers-when-using-always-encrypted)
+
+### Known Issues
+- This release requires ODBC Driver 17.4.2 or above. Otherwise, a warning about failing to set an attribute may be suppressed when using an older ODBC driver.
+- Connection pooling on Linux or macOS is not recommended with [unixODBC](http://www.unixodbc.org/) < 2.3.7
+- When pooling is enabled in Linux or macOS
+  - unixODBC <= 2.3.4 (Linux and macOS) might not return proper diagnostic information, such as error messages, warnings and informative messages
+  - due to this unixODBC bug, fetch large data (such as xml, binary) as streams as a workaround. See the examples [here](https://github.com/Microsoft/msphpsql/wiki/Features#pooling)
+
+
+## 5.11.1 - 2023-08-31
+Updated PECL release packages. Here is the list of updates:
+
+### Fixed
+- Reset type after bind param (#1452)
+- Fixed error when using PDO::ATTR_STRINGIFY_FETCHES (#1468) by SakiTakamachi
+- Change connection options to case insensitive (#1460)
+- Bugfix for 1465 Adding a NULL check (#1471)
+
+### Limitations
+- No support for inout / output params when using sql_variant type
+- No support for inout / output params when formatting decimal values
+- In Linux and macOS, setlocale() only takes effect if it is invoked before the first connection. Attempting to set the locale after connecting will not work
+- Always Encrypted requires [MS ODBC Driver 17+](https://docs.microsoft.com/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server)
+  - Only Windows Certificate Store and Azure Key Vault are supported. Custom Keystores are not yet supported
+  - Issue [#716](https://github.com/Microsoft/msphpsql/issues/716) - With Always Encrypted enabled, named parameters in subqueries are not supported
+  - Issue [#1050](https://github.com/microsoft/msphpsql/issues/1050) - With Always Encrypted enabled, insertion requires the column list for any tables with identity columns
+  - [Always Encrypted limitations](https://docs.microsoft.com/sql/connect/php/using-always-encrypted-php-drivers#limitations-of-the-php-drivers-when-using-always-encrypted)
+
+### Known Issues
+- This release requires ODBC Driver 17.4.2 or above. Otherwise, a warning about failing to set an attribute may be suppressed when using an older ODBC driver.
+- Connection pooling on Linux or macOS is not recommended with [unixODBC](http://www.unixodbc.org/) < 2.3.7
+- When pooling is enabled in Linux or macOS
+  - unixODBC <= 2.3.4 (Linux and macOS) might not return proper diagnostic information, such as error messages, warnings and informative messages
+  - due to this unixODBC bug, fetch large data (such as xml, binary) as streams as a workaround. See the examples [here](https://github.com/Microsoft/msphpsql/wiki/Features#pooling)
+
+
 ## 5.11.0 - 2023-02-28
 Updated PECL release packages. Here is the list of updates:
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright(c) 2022 Microsoft Corporation
+Copyright(c) 2023 Microsoft Corporation
 All rights reserved.
 
 MIT License

README.md

@@ -19,8 +19,8 @@ Thank you for taking the time to participate in the [sentiment survey](https://g
 
 [av-image]: https://ci.appveyor.com/api/projects/status/vo4rfei6lxlamrnc?svg=true
 [av-site]: https://ci.appveyor.com/project/msphpsql/msphpsql/branch/dev
-[az-site]: https://dev.azure.com/sqlclientdrivers-ci/msphpsql/_build/latest?definitionId=6&branchName=dev
-[az-image]: https://dev.azure.com/sqlclientdrivers-ci/msphpsql/_apis/build/status/Microsoft.msphpsql?branchName=dev
+[az-site]: https://sqlclientdrivers.visualstudio.com/public/_build/latest?definitionId=1230&branchName=refs%2Fpull%2F1492%2Fmerge
+[az-image]: https://sqlclientdrivers.visualstudio.com/public/_apis/build/status%2FPHP%2Fmicrosoft.msphpsql?branchName=refs%2Fpull%2F1492%2Fmerge
 [Coverage Codecov]: https://codecov.io/gh/microsoft/msphpsql/branch/dev/graph/badge.svg
 [codecov-site]: https://codecov.io/gh/microsoft/msphpsql
 
@@ -37,7 +37,7 @@ Please follow the [Getting started](https://docs.microsoft.com/sql/connect/php/g
 For full details on the system requirements for the drivers, see the [system requirements](https://docs.microsoft.com/sql/connect/php/system-requirements-for-the-php-sql-driver) on Microsoft Docs.
 
 On the client machine:
-- 8.0.x, 8.1.x, 8.2.x
+- 8.1.x, 8.2.x, 8.3.x
 - [Microsoft ODBC Driver 18, 17 or 13][odbcdoc]
 - If using a Web server such as Internet Information Services (IIS) or Apache, it must be configured to run PHP
 

appveyor.yml

@@ -15,16 +15,6 @@ environment:
     APPVEYOR: true
     # For details about Appveyor build worker images (VM template): https://www.appveyor.com/docs/build-environment/#build-worker-images
     matrix:
-      - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
-        BUILD_PLATFORM: x64
-        TEST_PHP_SQL_SERVER: (local)\SQL2017
-        SQL_INSTANCE: SQL2017
-        PHP_VC: vc15
-        PHP_MAJOR_VER: 7.4
-        PHP_MINOR_VER: latest
-        PHP_EXE_PATH: x64\Release_TS
-        THREAD: ts
-        platform: x64
       - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
         BUILD_PLATFORM: x86
         TEST_PHP_SQL_SERVER: (local)\SQL2019
@@ -35,7 +25,16 @@ environment:
         PHP_EXE_PATH: Release
         THREAD: nts
         platform: x86
-
+      - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
+        BUILD_PLATFORM: x86
+        TEST_PHP_SQL_SERVER: (local)\SQL2019
+        SQL_INSTANCE: SQL2019
+        PHP_VC: vs16
+        PHP_MAJOR_VER: 8.1
+        PHP_MINOR_VER: latest
+        PHP_EXE_PATH: Release
+        THREAD: nts
+        platform: x86
 # PHP_MAJOR_VER is PHP major version to build (7.4, 7.3)
 # PHP_MINOR_VER is PHP point release number (or latest for latest release)
 # PHP_VC is the Visual C++ version

azure-pipelines.yml

@@ -62,7 +62,7 @@ jobs:
 
 - job: Linux
   variables:
-    phpver: 8.0
+    phpver: 8.1
   pool:
     vmImage: 'ubuntu-20.04'
   steps:
@@ -185,7 +185,7 @@ jobs:
       sed -i -e 's/TARGET_PASSWORD/'"$(pwd)"'/g' MsSetup.inc
 
       export LC_ALL='en_US.UTF-8'
-      php run-tests.php -P ./*.phpt --no-color 2>&1 | tee ../sqlsrv.log
+      php run-tests.php -P ./*.phpt --no-color --show-diff 2>&1 | tee ../sqlsrv.log
     displayName: 'Run sqlsrv functional tests'
 
   - script: |
@@ -196,7 +196,7 @@ jobs:
       sed -i -e 's/TARGET_PASSWORD/'"$(pwd)"'/g' MsSetup.inc
 
       export LC_ALL='en_US.UTF-8'
-      php run-tests.php -P ./*.phpt --no-color 2>&1 | tee ../pdo_sqlsrv.log
+      php run-tests.php -P ./*.phpt --no-color --show-diff 2>&1 | tee ../pdo_sqlsrv.log
     displayName: 'Run pdo_sqlsrv functional tests'
 
   - script: |
@@ -213,6 +213,7 @@ jobs:
       PYTHONWARNINGS: ignore::yaml.YAMLLoadWarning
      
   - script: |
+      docker logs -t $(host)
       cd $(Build.SourcesDirectory)/test/functional/
       for f in sqlsrv/*.diff; do ls $f 2>/dev/null; cat $f 2>/dev/null; echo ''; done || true
       for f in pdo_sqlsrv/*.diff; do ls $f 2>/dev/null; cat $f 2>/dev/null; echo ''; done || true

buildscripts/buildtools.py

@@ -393,7 +393,7 @@ def build_drivers(self, make_clean = False, dest = None, log_file = None):
 
         batch_file = self.create_local_batch_file(make_clean, cmd_line, log_file)
 
-        # Reference: https://github.com/OSTC/php-sdk-binary-tools
+        # Reference: https://github.com/php/php-sdk-binary-tools
         # Clone the master branch of PHP sdk if the directory does not exist 
         print('Downloading the latest php SDK...')
 
@@ -406,7 +406,7 @@ def build_drivers(self, make_clean = False, dest = None, log_file = None):
 
         phpSDK = os.path.join(sdk_dir, 'php-sdk')
         if not os.path.exists( phpSDK ):
-            os.system('git clone https://github.com/OSTC/php-sdk-binary-tools.git --branch master --single-branch --depth 1 ' + phpSDK)
+            os.system('git clone https://github.com/php/php-sdk-binary-tools.git --branch master --single-branch --depth 1 ' + phpSDK)
         os.chdir(phpSDK)
         os.system('git pull ')
         print('Done cloning the latest php SDK...')

source/pdo_sqlsrv/config.m4

@@ -4,7 +4,7 @@ dnl
 dnl  Contents: the code that will go into the configure script, indicating options, 
 dnl  external libraries and includes, and what source files are to be compiled.
 dnl 
-dnl  Microsoft Drivers 5.11 for PHP for SQL Server
+dnl  Microsoft Drivers 5.12 for PHP for SQL Server
 dnl  Copyright(c) Microsoft Corporation
 dnl  All rights reserved.
 dnl  MIT License

source/pdo_sqlsrv/config.w32

@@ -3,7 +3,7 @@
 //
 // Contents: JScript build configuration used by buildconf.bat
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License
@@ -34,6 +34,8 @@ if( PHP_PDO_SQLSRV != "no" ) {
             ADD_FLAG( "CFLAGS_PDO_SQLSRV", "/EHsc" );
             ADD_FLAG( "CFLAGS_PDO_SQLSRV", "/GS" );
             ADD_FLAG( "CFLAGS_PDO_SQLSRV", "/Zi" );
+            ADD_FLAG( "CFLAGS_PDO_SQLSRV", "/ZH:SHA_256 /sdl /W3" );
+            ADD_FLAG( "LDFLAGS_PDO_SQLSRV", "/CETCOMPAT" );
             if (PHP_DEBUG != "yes") ADD_FLAG( "CFLAGS_PDO_SQLSRV", "/guard:cf /O2" );
             ADD_FLAG( "CFLAGS_PDO_SQLSRV", "/D ZEND_WIN32_FORCE_INLINE" );
             if (VCVERS >= 1913) {

source/pdo_sqlsrv/pdo_dbh.cpp

@@ -3,7 +3,7 @@
 //
 // Contents: Implements the PDO object for PDO_SQLSRV
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License
@@ -151,16 +151,13 @@ struct pdo_encrypt_set_func
         if (found != std::string::npos)
             val_str.erase(found + 1);
 
-        const char TRUE_VALUE_1[] = "true";
-        const char TRUE_VALUE_2[] = "1";
-        const char FALSE_VALUE_1[] = "false";
-        const char FALSE_VALUE_2[] = "0";
+        transform(val_str.begin(), val_str.end(), val_str.begin(), ::tolower);
 
-        // For backward compatibility, convert true/1 to yes and false/0 to no
+        // For backward compatibility, convert true/1 to yes
         std::string attr;
-        if (!val_str.compare(TRUE_VALUE_1) || !val_str.compare(TRUE_VALUE_2)) {
+        if (!val_str.compare("true") || !val_str.compare("1") || !val_str.compare("yes")) {
             attr = "yes";
-        } else if (!val_str.compare(FALSE_VALUE_1) || !val_str.compare(FALSE_VALUE_2)) {
+        } else if (!val_str.compare("false") || !val_str.compare("0") || !val_str.compare("no")) {
             attr = "no";
         } else {
             // simply pass the attribute value to ODBC driver
@@ -978,7 +975,7 @@ zend_long pdo_sqlsrv_dbh_do(_Inout_ pdo_dbh_t *dbh, _In_ const zend_string *sql)
         // since the user can give us a compound statement, we return the row count for the last set, and since the row count
         // isn't guaranteed to be valid until all the results have been fetched, we fetch them all first.
 
-        if ( execReturn != SQL_NO_DATA && core_sqlsrv_has_any_result( driver_stmt )) {
+        if ( core_sqlsrv_has_any_result( driver_stmt )) {
 
             SQLRETURN r = SQL_SUCCESS;
 
@@ -990,7 +987,6 @@ zend_long pdo_sqlsrv_dbh_do(_Inout_ pdo_dbh_t *dbh, _In_ const zend_string *sql)
 
             } while ( r != SQL_NO_DATA );
         }
-
         // returning -1 forces PDO to return false, which signals an error occurred.  SQLRowCount returns -1 for a number of cases
         // naturally, so we override that here with no rows returned.
         if( rows == -1 ) {
@@ -1323,6 +1319,12 @@ bool pdo_sqlsrv_dbh_set_attr(_Inout_ pdo_dbh_t *dbh, _In_ zend_long attr, _Inout
             break;
 #endif
 
+            case PDO_ATTR_STRINGIFY_FETCHES:
+            {
+                // do nothing
+            }
+            break;
+
             // Not supported
             case PDO_ATTR_FETCH_TABLE_NAMES:
             case PDO_ATTR_FETCH_CATALOG_NAMES:

source/pdo_sqlsrv/pdo_init.cpp

@@ -3,7 +3,7 @@
 //
 // Contents: initialization routines for PDO_SQLSRV
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/pdo_sqlsrv/pdo_parser.cpp

@@ -5,7 +5,7 @@
 //
 // Copyright Microsoft Corporation
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/pdo_sqlsrv/pdo_stmt.cpp

@@ -3,7 +3,7 @@
 //
 // Contents: Implements the PDOStatement object for the PDO_SQLSRV
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/pdo_sqlsrv/pdo_util.cpp

@@ -3,7 +3,7 @@
 //
 // Contents: Utility functions used by both connection or statement functions
 // 
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License
@@ -679,23 +679,18 @@ void format_or_get_all_errors(_Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int
         strcpy_s(error_code, sizeof(pdo_error_type), reinterpret_cast<const char*>(error->sqlstate));
     }
     else {
-        bool result = core_sqlsrv_get_odbc_error(ctx, 1, error, SEV_ERROR, true);
-        if (result) {
-            // Check if there exist more errors
-            int rec_number = 2;
+        if(core_sqlsrv_get_odbc_error(ctx, 1, error, SEV_ERROR, true)) {
+            unsigned int rec_number = 2;
             sqlsrv_error_auto_ptr err;
             sqlsrv_error *p = error;
 
-            do {
-                result = core_sqlsrv_get_odbc_error(ctx, rec_number++, err, SEV_ERROR, true);
-                if (result) {
-                    p->next = err.get();
-                    err.transferred();
-                    p = p->next;
-                }
-            } while (result);
+            while(core_sqlsrv_get_odbc_error(ctx, rec_number++, err, SEV_ERROR, true)) {
+                p->next = err.get();
+                err.transferred();
+                p = p->next;
+            }
         }
-        
+
         // core_sqlsrv_get_odbc_error() returns the error_code of size SQL_SQLSTATE_BUFSIZE,
         // which is the same size as pdo_error_type
         strcpy_s(error_code, sizeof(pdo_error_type), reinterpret_cast<const char*>(error->sqlstate));

source/pdo_sqlsrv/php_pdo_sqlsrv.h

@@ -6,7 +6,7 @@
 //
 // Contents: Declarations for the extension
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/pdo_sqlsrv/php_pdo_sqlsrv_int.h

@@ -6,7 +6,7 @@
 //
 // Contents: Internal declarations for the extension
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/pdo_sqlsrv/template.rc

@@ -3,7 +3,7 @@
 //
 // Contents: Version resource
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/shared/FormattedPrint.cpp

@@ -6,7 +6,7 @@
 // Contents:    Contains functions for handling Windows format strings
 //              and UTF-16 on non-Windows platforms
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/shared/FormattedPrint.h

@@ -4,7 +4,7 @@
 // Contents: Contains functions for handling Windows format strings
 //			 and UTF-16 on non-Windows platforms
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/shared/StringFunctions.cpp

@@ -3,7 +3,7 @@
 //
 // Contents: Contains functions for handling UTF-16 on non-Windows platforms
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/shared/StringFunctions.h

@@ -3,7 +3,7 @@
 //
 // Contents: Contains functions for handling UTF-16 on non-Windows platforms
 //
-// Microsoft Drivers 5.11 for PHP for SQL Server
+// Microsoft Drivers 5.12 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License