Merge pull request #1221 from microsoft/dev

5.9.0-beta2

Author: yitam

.travis.yml

@@ -1,7 +1,7 @@
 sudo: required
 
 os: linux
-dist: trusty
+dist: bionic
 
 group: edge
 
@@ -20,10 +20,10 @@ env:
   - TEST_PHP_SQL_PWD=Password123
 
 before_install:
-  - docker pull mcr.microsoft.com/mssql/server:2019-latest
+  - docker pull mcr.microsoft.com/mssql/server:2017-latest
 
 install:
-  - docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=Password123' -p 1433:1433 --name=$TEST_PHP_SQL_SERVER -d mcr.microsoft.com/mssql/server:2019-latest
+  - docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=Password123' -p 1433:1433 --name=$TEST_PHP_SQL_SERVER -d mcr.microsoft.com/mssql/server:2017-latest
   - docker build --build-arg PHPSQLDIR=$PHPSQLDIR -t msphpsql-dev -f Dockerfile-msphpsql .
 
 before_script:
@@ -43,7 +43,6 @@ script:
   - docker exec client bash -c 'for f in ./test/functional/pdo_sqlsrv/*.out; do ls $f 2>/dev/null; cat $f 2>/dev/null; done || true' 
   - docker exec client python ./test/functional/setup/cleanup_dbs.py -dbname $SQLSRV_DBNAME
   - docker exec client python ./test/functional/setup/cleanup_dbs.py -dbname $PDOSQLSRV_DBNAME
-  - docker exec client coveralls -i ./source/ -e ./source/shared/ -e ./test/ --gcov-options '\-lp'
   - docker stop client
   - docker ps -a 
 

CHANGELOG.md

@@ -3,6 +3,38 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 
+## 5.9.0-beta2 - 2020-12-02
+Updated PECL release packages. Here is the list of updates:
+
+### Added
+- Support for PHP 8.0
+
+### Removed
+- Dropped support for PHP 7.2
+
+### Fixed
+- Pull Request [#1205](https://github.com/microsoft/msphpsql/pull/1205) - minimized compilation warnings on Linux and macOS 
+- Pull Request [#1209](https://github.com/microsoft/msphpsql/pull/1209) - fixed a bug in fetching varbinary max fields as char or wide chars
+- Issue [#1210](https://github.com/microsoft/msphpsql/issues/1210) - switched from preview to beta terminology to enable Pickle support
+- Issue [#1213](https://github.com/microsoft/msphpsql/issues/1213) - the MACOSX_DEPLOYMENT_TARGET in config files caused linker errors in macOS Big Sur - Pull Request [#1215](https://github.com/microsoft/msphpsql/pull/1215)
+
+### 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 preview 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.9.0-preview1 - 2020-10-02
 Updated PECL release packages. Here is the list of updates:
 

Linux-mac-install.md

@@ -4,7 +4,7 @@
 
 The Microsoft Drivers for PHP for Microsoft SQL Server are PHP extensions that allow for the reading and writing of SQL Server data from within PHP scripts. The SQLSRV extension provides a procedural interface while the PDO_SQLSRV extension implements PHP Data Objects (PDO) for accessing data in all editions of SQL Server 2012 and later (including Azure SQL DB). These drivers rely on the [Microsoft ODBC Driver for SQL Server][odbcdoc] to handle the low-level communication with SQL Server.
 
-This release contains the SQLSRV and PDO_SQLSRV drivers for PHP 7.2+ with improvements on both drivers and some limitations. Upcoming [releases][releases] will contain additional functionalities, bug fixes, and more.
+This release contains the SQLSRV and PDO_SQLSRV drivers for PHP 7.3+ with improvements on both drivers and some limitations. Upcoming [releases][releases] will contain additional functionalities, bug fixes, and more.
 
 ## Take our survey
 
@@ -45,7 +45,7 @@ Azure Pipelines       | AppVeyor (Windows)       | Travis CI (Linux)        | Co
 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:
-- PHP 7.2.x (7.2.0 and up on Unix, 7.2.1 and up on Windows), 7.3.x, or 7.4.x
+- 7.3.x, 7.4.x, 8.0.x
 - [Microsoft ODBC Driver 17, Microsoft ODBC Driver 13, or Microsoft ODBC Driver 11][odbcdoc]
 - If using a Web server such as Internet Information Services (IIS) or Apache, it must be configured to run PHP
 
@@ -82,8 +82,8 @@ Given a version number MAJOR.MINOR.PATCH,
 
 The version number may have trailing pre-release version identifiers to indicate the stability and/or build metadata.
 
-- Pre-release version is denoted by a hyphen followed by `preview` or `RC` and may be followed by a series of dot separated identifiers. Production quality releases do not contain the pre-release version. `preview` has lower precedence than `RC`. Example of precedence: *preview < preview.1 < RC < RC.1*. Note that the PECL package version numbers do not have the hyphen before the pre-release version, owing to restrictions in PECL. Example of a PECL package version number: 1.2.3preview
-- Build metadata may be denoted by a plus sign followed by 4 or 5 digits, such as  `1.2.3-preview+5678` or `1.2.3+5678`. Build metadata does not figure into the precedence order.
+- Pre-release version is denoted by a hyphen followed by `beta` or `RC` followed by a number. Production quality releases do not contain the pre-release version. `beta` has lower precedence than `RC`. Note that the PECL package version numbers do not have the hyphen before the pre-release version, owing to restrictions in PECL. An example of a PECL package version is `5.9.0beta2`.
+- Build metadata may be denoted by a plus sign followed by a number of digits, such as `5.9.0-beta2+13930`. Build metadata does not affect the precedence order.
 
 ## Future Plans
 - Expand SQL Server feature support (example: Azure Active Directory, Always Encrypted, etc.)

README.md

@@ -30,7 +30,7 @@ environment:
         SQL_INSTANCE: SQL2019
         PHP_VC: vs16
         PHP_MAJOR_VER: 8.0
-        PHP_MINOR_VER: 0rc1
+        PHP_MINOR_VER: 0RC2
         PHP_EXE_PATH: Release
         THREAD: nts
         platform: x86

appveyor.yml

@@ -13,6 +13,9 @@ variables:
 trigger:
 - dev
 
+pr:
+- dev
+
 jobs:
 - job: macOS
   pool:
@@ -30,8 +33,8 @@ jobs:
   - script: |
       brew tap
       brew tap homebrew/core
-      brew install autoconf automake libtool
-      brew install php@$(phpVersion)
+      brew reinstall autoconf automake libtool
+      brew reinstall php@$(phpVersion)
       php -v
     displayName: 'Install PHP'
 
@@ -60,7 +63,7 @@ jobs:
 
 - job: Linux
   variables:
-    phpver: 7.3
+    phpver: 7.4
   pool:
     vmImage: 'ubuntu-18.04'
   steps:
@@ -102,8 +105,15 @@ jobs:
     displayName: 'Install prerequisites'
 
   - script: |
-      docker pull mcr.microsoft.com/mssql/server:2017-latest
-      docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=$(pwd)' -p 1433:1433 -h $(host) --name=$(host) -d mcr.microsoft.com/mssql/server:2017-latest
+      python -m pip install --upgrade pip
+      python -m pip install --upgrade requests
+      python -m pip install PyYAML
+      python -m pip install cpp-coveralls
+    displayName: 'Install coveralls (upgrade both pip and requests first)'
+
+  - script: |
+      docker pull mcr.microsoft.com/mssql/server:2019-latest
+      docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=$(pwd)' -p 1433:1433 -h $(host) --name=$(host) -d mcr.microsoft.com/mssql/server:2019-latest
       docker ps -a
       sleep 10
       docker exec -t $(host) /opt/mssql-tools/bin/sqlcmd -S $(server) -U $(uid) -P $(pwd) -Q 'select @@Version'
@@ -144,7 +154,7 @@ jobs:
 
       cd $(Build.SourcesDirectory)/source/sqlsrv
       ls -al
-      phpize && ./configure && make && sudo make install
+      phpize && ./configure LDFLAGS="-lgcov" CXXFLAGS="-O0 --coverage" && make && sudo make install
       cp run-tests.php $(Build.SourcesDirectory)/test/functional/sqlsrv
       echo extension=sqlsrv.so >> 20-sqlsrv.ini
 
@@ -153,7 +163,7 @@ jobs:
 
       cd $(Build.SourcesDirectory)/source/pdo_sqlsrv
       ls -al
-      phpize && ./configure && make && sudo make install
+      phpize && ./configure LDFLAGS="-lgcov" CXXFLAGS="-O0 --coverage" && make && sudo make install
       cp run-tests.php $(Build.SourcesDirectory)/test/functional/pdo_sqlsrv
       echo extension=pdo_sqlsrv.so >> 30-pdo_sqlsrv.ini
 
@@ -189,6 +199,17 @@ jobs:
       php run-tests.php -P ./*.phpt 2>&1 | tee ../pdo_sqlsrv.log
     displayName: 'Run pdo_sqlsrv functional tests'
 
+  - script: |
+      cd $(Build.SourcesDirectory)
+      echo -e "service_name: Azure Pipelines\n" > .coveralls.yml
+      coveralls -i ./source/ -e ./source/shared/ -e ./test/ -e ./source/pdo_sqlsrv/shared/core_stream.cpp \
+        -E r'.*localization*' -E r'.*globalization*' --gcov-options '\-lp'
+    displayName: 'Invoke coveralls using repo token'
+    env:
+      COVERALLS_REPO_TOKEN: $(repo_token)
+      TRAVIS_JOB_ID: $(Build.BuildId)
+      TRAVIS_BRANCH: $(Build.SourceBranchName)
+     
   - script: |
       cd $(Build.SourcesDirectory)/test/functional/
       for f in sqlsrv/*.diff; do ls $f 2>/dev/null; cat $f 2>/dev/null; echo ''; done || true

azure-pipelines.yml

@@ -79,7 +79,6 @@ if test "$PHP_PDO_SQLSRV" != "no"; then
   HOST_OS_ARCH=`uname`
   if test "${HOST_OS_ARCH}" = "Darwin"; then
     PDO_SQLSRV_SHARED_LIBADD="$PDO_SQLSRV_SHARED_LIBADD -Wl,-bind_at_load"
-    MACOSX_DEPLOYMENT_TARGET=`sw_vers -productVersion`
   else
     PDO_SQLSRV_SHARED_LIBADD="$PDO_SQLSRV_SHARED_LIBADD -Wl,-z,now"
     IS_ALPINE_1=`uname -a | cut -f 4 -d ' ' | cut -f 2 -d '-'`

source/pdo_sqlsrv/config.m4

@@ -912,6 +912,8 @@ int pdo_sqlsrv_dbh_begin( _Inout_ pdo_dbh_t *dbh )
 
         DIE ("pdo_sqlsrv_dbh_begin: Uncaught exception occurred.");
     }
+    // Should not have reached here but adding this due to compilation warnings
+    return 0;
 }
 
 
@@ -954,6 +956,8 @@ int pdo_sqlsrv_dbh_commit( _Inout_ pdo_dbh_t *dbh )
 
         DIE ("pdo_sqlsrv_dbh_commit: Uncaught exception occurred.");
     }
+    // Should not have reached here but adding this due to compilation warnings
+    return 0;
 }
 
 // pdo_sqlsrv_dbh_rollback
@@ -993,6 +997,8 @@ int pdo_sqlsrv_dbh_rollback( _Inout_ pdo_dbh_t *dbh )
 
         DIE ("pdo_sqlsrv_dbh_rollback: Uncaught exception occurred.");
     }
+    // Should not have reached here but adding this due to compilation warnings
+    return 0;
 }
 
 // pdo_sqlsrv_dbh_set_attr

source/pdo_sqlsrv/pdo_dbh.cpp

@@ -116,7 +116,7 @@ void pdo_error_dtor( _Inout_ zval* elem ) {
 
 PHP_MINIT_FUNCTION(pdo_sqlsrv)
 {
-    SQLSRV_UNUSED( type );
+    // SQLSRV_UNUSED( type );
 
     // our global variables are initialized in the RINIT function
 #if defined(ZTS)
@@ -185,7 +185,7 @@ PHP_MSHUTDOWN_FUNCTION(pdo_sqlsrv)
 {
     try {
 
-        SQLSRV_UNUSED( type );
+        // SQLSRV_UNUSED( type );
 
         UNREGISTER_INI_ENTRIES();
 
@@ -213,8 +213,8 @@ PHP_MSHUTDOWN_FUNCTION(pdo_sqlsrv)
 
 PHP_RINIT_FUNCTION(pdo_sqlsrv)
 {
-    SQLSRV_UNUSED( module_number );
-    SQLSRV_UNUSED( type );
+    // SQLSRV_UNUSED( module_number );
+    // SQLSRV_UNUSED( type );
 
 #if defined(ZTS) 
     ZEND_TSRMLS_CACHE_UPDATE();
@@ -247,8 +247,8 @@ PHP_RINIT_FUNCTION(pdo_sqlsrv)
 
 PHP_RSHUTDOWN_FUNCTION(pdo_sqlsrv)
 {
-    SQLSRV_UNUSED( module_number );
-    SQLSRV_UNUSED( type );
+    // SQLSRV_UNUSED( module_number );
+    // SQLSRV_UNUSED( type );
 
     PDO_LOG_NOTICE("pdo_sqlsrv: entering rshutdown");
 

source/pdo_sqlsrv/pdo_init.cpp

@@ -187,7 +187,7 @@ void conn_string_parser::add_key_value_pair( _In_reads_(len) const char* value,
             memcpy_s( option, len + 1, value, len );
             option[len] = '\0';
 
-            valid = core_is_authentication_option_valid( option, len );
+            valid = AzureADOptions::isAuthValid(option, len);
         }
     }
     if( !valid ) {

source/pdo_sqlsrv/pdo_parser.cpp

@@ -724,6 +724,8 @@ int pdo_sqlsrv_stmt_fetch( _Inout_ pdo_stmt_t *stmt, _In_ enum pdo_fetch_orienta
 
         DIE ("pdo_sqlsrv_stmt_fetch: Unexpected exception occurred.");
     }
+    // Should not have reached here but adding this due to compilation warnings
+    return 0;
 }
 
 // pdo_sqlsrv_stmt_get_col_data
@@ -832,15 +834,16 @@ int pdo_sqlsrv_stmt_get_col_data( _Inout_ pdo_stmt_t *stmt, _In_ int colno,
             *len = sizeof(zval);
         }
 
-        return 1;        
-    }
-    
+        return 1;
+    }   
     catch ( core::CoreException& ) {
         return 0;
     }
     catch ( ... ) {
         DIE ("pdo_sqlsrv_stmt_get_col_data: Unexpected exception occurred.");
     }
+    // Should not have reached here but adding this due to compilation warnings
+    return 0;
 }
 
 // pdo_sqlsrv_stmt_set_attr

source/pdo_sqlsrv/pdo_stmt.cpp

@@ -379,7 +379,7 @@ pdo_error PDO_ERRORS[] = {
     },
     {
         PDO_SQLSRV_ERROR_INVALID_AUTHENTICATION_OPTION,
-        { IMSSP, (SQLCHAR*) "Invalid option for the Authentication keyword. Only SqlPassword, ActiveDirectoryPassword, or ActiveDirectoryMsi is supported.", -73, false }
+        { IMSSP, (SQLCHAR*) "Invalid option for the Authentication keyword. Only SqlPassword, ActiveDirectoryPassword, ActiveDirectoryMsi or ActiveDirectorySPA is supported.", -73, false }
     },
     {
         SQLSRV_ERROR_CE_DRIVER_REQUIRED,
@@ -465,7 +465,7 @@ pdo_error PDO_ERRORS[] = {
     { UINT_MAX, {} }
 };
 
-bool pdo_sqlsrv_handle_env_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ bool warning, 
+bool pdo_sqlsrv_handle_env_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ int warning, 
                                   _In_opt_ va_list* print_args )
 {
     SQLSRV_ASSERT((ctx != NULL), "pdo_sqlsrv_handle_env_error: sqlsrv_context was null");
@@ -488,7 +488,7 @@ bool pdo_sqlsrv_handle_env_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned
 }
 
 // pdo error handler for the dbh context.
-bool pdo_sqlsrv_handle_dbh_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ bool warning, 
+bool pdo_sqlsrv_handle_dbh_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ int warning, 
                                   _In_opt_ va_list* print_args )
 {
     pdo_dbh_t* dbh = reinterpret_cast<pdo_dbh_t*>( ctx.driver());
@@ -520,7 +520,7 @@ bool pdo_sqlsrv_handle_dbh_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned
 }
 
 // PDO error handler for the statement context.
-bool pdo_sqlsrv_handle_stmt_error(_Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ bool warning,
+bool pdo_sqlsrv_handle_stmt_error(_Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ int warning,
     _In_opt_ va_list* print_args)
 {
     pdo_stmt_t* pdo_stmt = reinterpret_cast<pdo_stmt_t*>(ctx.driver());
@@ -635,20 +635,9 @@ void add_remaining_errors_to_array (_In_ sqlsrv_error const* error, _Inout_ zval
     if (error->next != NULL && PDO_SQLSRV_G(report_additional_errors)) {
         sqlsrv_error *p = error->next;
         while (p != NULL) {
-            // check if sql state or native message is NULL and handle them accordingly
-            char *state = "";
-            char *msg = "";
-                 
-            if (p->sqlstate != NULL) {
-                state = reinterpret_cast<char*>(p->sqlstate);
-            }
-            if (p->native_message != NULL) {
-                msg = reinterpret_cast<char*>(p->native_message);
-            }
-
-            add_next_index_string(array_z, state);
+            add_next_index_string(array_z, reinterpret_cast<char*>(p->sqlstate));
             add_next_index_long(array_z, p->native_code);
-            add_next_index_string(array_z, msg);
+            add_next_index_string(array_z, reinterpret_cast<char*>(p->native_message));
 
             p = p-> next;
         }

source/pdo_sqlsrv/pdo_util.cpp

@@ -285,11 +285,11 @@ struct pdo_error {
 // called when an error occurs in the core layer.  These routines are set as the error_callback in a
 // context.  The context is passed to this function since it contains the function
 
-bool pdo_sqlsrv_handle_env_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ bool warning, 
+bool pdo_sqlsrv_handle_env_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ int warning, 
                                   _In_opt_ va_list* print_args );
-bool pdo_sqlsrv_handle_dbh_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ bool warning, 
+bool pdo_sqlsrv_handle_dbh_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ int warning, 
                                   _In_opt_ va_list* print_args );
-bool pdo_sqlsrv_handle_stmt_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ bool warning, 
+bool pdo_sqlsrv_handle_stmt_error( _Inout_ sqlsrv_context& ctx, _In_opt_ unsigned int sqlsrv_error_code, _In_opt_ int warning, 
                                    _In_opt_ va_list* print_args );
 
 // common routine to transfer a sqlsrv_context's error to a PDO zval