php-sqlsrv/test/functional/sqlsrv/TC55_StreamScrollable.phpt

--TEST--
Streaming Scrollable ResultSets Test
--DESCRIPTION--
Verifies the streaming behavior with scrollable resultsets.
--ENV--
PHPT_EXEC=true
--SKIPIF--
<?php require('skipif_versions_old.inc'); ?>
--FILE--
<?php
require_once('MsCommon.inc');

function streamScroll($noRows, $startRow)
{
    setup();
    $tableName = "TC55test";

    if (useUTF8Data()) {
        $conn1 = AE\connect(array('CharacterSet'=>'UTF-8'));
    } else {
        $conn1 = AE\connect();
    }

    AE\createTestTable($conn1, $tableName);
    AE\insertTestRowsByRange($conn1, $tableName, $startRow, $startRow + $noRows - 1);

    $query = "SELECT * FROM [$tableName] ORDER BY c27_timestamp";
    $options = array('Scrollable' => SQLSRV_CURSOR_STATIC);
    $stmt1 = AE\executeQueryEx($conn1, $query, $options);
    $numFields = sqlsrv_num_fields($stmt1);
    $row = $noRows;
    while ($row >= 1) {
        if ($row == $noRows) {
            if (!sqlsrv_fetch($stmt1, SQLSRV_SCROLL_LAST)) {
                fatalError("Failed to fetch row ".$row);
            }
        } else {
            if (!sqlsrv_fetch($stmt1, SQLSRV_SCROLL_PRIOR)) {
                fatalError("Failed to fetch row ".$row);
            }
        }
        trace("\nStreaming row $row:\n");
        for ($j = 0; $j < $numFields; $j++) {
            $col = $j + 1;
            if (!isUpdatable($col)) {
                continue;
            }
            if (isStreamable($col)) {
                verifyStream($stmt1, $startRow + $row - 1, $j);
            }
        }
        $row--;
    }
    sqlsrv_free_stmt($stmt1);

    dropTable($conn1, $tableName);

    sqlsrv_close($conn1);
}

function verifyStreamError($message)
{
    global $errState, $errMessage;
    if (AE\isColEncrypted()) {
        verifyError(sqlsrv_errors()[0], $errState, $errMessage);
    } else {
        fatalError($message);
    }
}

function verifyStream($stmt, $row, $colIndex)
{
    $col = $colIndex + 1;
    if (isStreamable($col)) {
        $type = getSqlType($col);
        if (isBinary($col)) {
            $stream = sqlsrv_get_field($stmt, $colIndex, SQLSRV_PHPTYPE_STREAM(SQLSRV_ENC_BINARY));
        } else {
            if (useUTF8Data()) {
                $stream = sqlsrv_get_field($stmt, $colIndex, SQLSRV_PHPTYPE_STREAM('UTF-8'));
            } else {
                $stream = sqlsrv_get_field($stmt, $colIndex, SQLSRV_PHPTYPE_STREAM(SQLSRV_ENC_CHAR));
            }
        }
        if ($stream === false) {
            verifyStreamError("Failed to read field $col: $type");
        } else {
            $value = '';
            if ($stream) {
                while (!feof($stream)) {
                    $value .= fread($stream, 8192);
                }
                fclose($stream);
                $data = AE\getInsertData($row, $col);
                if (!checkData($col, $value, $data)) {
                    trace("Data corruption on row $row column $col\n");
                    setUTF8Data(false);
                    die("Data corruption on row $row column $col\n");
                }
            }
            traceData($type, "".strlen($value)." bytes");
        }
    }
}

function checkData($col, $actual, $expected)
{
    if (is_null($expected)) {
        return empty($actual);
    }
    
    $success = true;

    if (isBinary($col)) {
        if (is_null($actual)) {
            $success = false;
        } else {
            $actual = bin2hex($actual);
            if (strncasecmp($actual, $expected, strlen($expected)) != 0) {
                $success = false;
            }
        }
    } else {
        $len = (empty($expected)) ? 0 : strlen($expected);
        if (strncasecmp($actual, $expected, $len) != 0) {
            if ($col != 19) {
                // skip ntext
                $pos = strpos($actual, $expected);
                if (($pos === false) || ($pos > 1)) {
                    $success = false;
                }
            }
        }
    }
    if (!$success) {
        trace("\nData error\nExpected:\n$expected\nActual:\n$actual\n");
    }

    return ($success);
}

// locale must be set before 1st connection
setUSAnsiLocale();
$testName = "Stream - Scrollable";

// error message expected with AE enabled
$errState = 'IMSSP';
$errMessage = 'Connection with Column Encryption enabled does not support fetching stream. Please fetch the data as a string.';

// test ansi only if windows or non-UTF8 locales are supported (ODBC 17 and above)
startTest($testName);
if (isLocaleSupported()) {
    try {
        setUTF8Data(false);
        streamScroll(20, 1);
    } catch (Exception $e) {
        echo $e->getMessage();
    }
}
endTest($testName);

// test utf8
startTest($testName);
try {
    setUTF8Data(true);
    resetLocaleToDefault();
    streamScroll(20, 1);
} catch (Exception $e) {
    echo $e->getMessage();
}
endTest($testName);

?>
--EXPECT--
Test "Stream - Scrollable" completed successfully.
Test "Stream - Scrollable" completed successfully.