234 lines
8.3 KiB
PHP
234 lines
8.3 KiB
PHP
<?php
|
|
/*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* This software consists of voluntary contributions made by many individuals
|
|
* and is licensed under the MIT license. For more information, see
|
|
* <http://www.doctrine-project.org>.
|
|
*/
|
|
|
|
namespace Doctrine\DBAL;
|
|
|
|
use Doctrine\DBAL\Connection;
|
|
|
|
/**
|
|
* Utility class that parses sql statements with regard to types and parameters.
|
|
*
|
|
* @link www.doctrine-project.org
|
|
* @since 2.0
|
|
* @author Benjamin Eberlei <kontakt@beberlei.de>
|
|
*/
|
|
class SQLParserUtils
|
|
{
|
|
const POSITIONAL_TOKEN = '\?';
|
|
const NAMED_TOKEN = '(?<!:):[a-zA-Z_][a-zA-Z0-9_]*';
|
|
|
|
// Quote characters within string literals can be preceded by a backslash.
|
|
const ESCAPED_SINGLE_QUOTED_TEXT = "'(?:[^'\\\\]|\\\\'|\\\\\\\\)*'";
|
|
const ESCAPED_DOUBLE_QUOTED_TEXT = '"(?:[^"\\\\]|\\\\"|\\\\\\\\)*"';
|
|
|
|
/**
|
|
* Gets an array of the placeholders in an sql statements as keys and their positions in the query string.
|
|
*
|
|
* Returns an integer => integer pair (indexed from zero) for a positional statement
|
|
* and a string => int[] pair for a named statement.
|
|
*
|
|
* @param string $statement
|
|
* @param boolean $isPositional
|
|
*
|
|
* @return array
|
|
*/
|
|
static public function getPlaceholderPositions($statement, $isPositional = true)
|
|
{
|
|
$match = ($isPositional) ? '?' : ':';
|
|
if (strpos($statement, $match) === false) {
|
|
return array();
|
|
}
|
|
|
|
$token = ($isPositional) ? self::POSITIONAL_TOKEN : self::NAMED_TOKEN;
|
|
$paramMap = array();
|
|
|
|
foreach (self::getUnquotedStatementFragments($statement) as $fragment) {
|
|
preg_match_all("/$token/", $fragment[0], $matches, PREG_OFFSET_CAPTURE);
|
|
foreach ($matches[0] as $placeholder) {
|
|
if ($isPositional) {
|
|
$paramMap[] = $placeholder[1] + $fragment[1];
|
|
} else {
|
|
$pos = $placeholder[1] + $fragment[1];
|
|
$paramMap[$pos] = substr($placeholder[0], 1, strlen($placeholder[0]));
|
|
}
|
|
}
|
|
}
|
|
|
|
return $paramMap;
|
|
}
|
|
|
|
/**
|
|
* For a positional query this method can rewrite the sql statement with regard to array parameters.
|
|
*
|
|
* @param string $query The SQL query to execute.
|
|
* @param array $params The parameters to bind to the query.
|
|
* @param array $types The types the previous parameters are in.
|
|
*
|
|
* @return array
|
|
*
|
|
* @throws SQLParserUtilsException
|
|
*/
|
|
static public function expandListParameters($query, $params, $types)
|
|
{
|
|
$isPositional = is_int(key($params));
|
|
$arrayPositions = array();
|
|
$bindIndex = -1;
|
|
|
|
foreach ($types as $name => $type) {
|
|
++$bindIndex;
|
|
|
|
if ($type !== Connection::PARAM_INT_ARRAY && $type !== Connection::PARAM_STR_ARRAY) {
|
|
continue;
|
|
}
|
|
|
|
if ($isPositional) {
|
|
$name = $bindIndex;
|
|
}
|
|
|
|
$arrayPositions[$name] = false;
|
|
}
|
|
|
|
if (( ! $arrayPositions && $isPositional)) {
|
|
return array($query, $params, $types);
|
|
}
|
|
|
|
$paramPos = self::getPlaceholderPositions($query, $isPositional);
|
|
|
|
if ($isPositional) {
|
|
$paramOffset = 0;
|
|
$queryOffset = 0;
|
|
|
|
foreach ($paramPos as $needle => $needlePos) {
|
|
if ( ! isset($arrayPositions[$needle])) {
|
|
continue;
|
|
}
|
|
|
|
$needle += $paramOffset;
|
|
$needlePos += $queryOffset;
|
|
$count = count($params[$needle]);
|
|
|
|
$params = array_merge(
|
|
array_slice($params, 0, $needle),
|
|
$params[$needle],
|
|
array_slice($params, $needle + 1)
|
|
);
|
|
|
|
$types = array_merge(
|
|
array_slice($types, 0, $needle),
|
|
$count ?
|
|
array_fill(0, $count, $types[$needle] - Connection::ARRAY_PARAM_OFFSET) : // array needles are at PDO::PARAM_* + 100
|
|
array(),
|
|
array_slice($types, $needle + 1)
|
|
);
|
|
|
|
$expandStr = $count ? implode(", ", array_fill(0, $count, "?")) : 'NULL';
|
|
$query = substr($query, 0, $needlePos) . $expandStr . substr($query, $needlePos + 1);
|
|
|
|
$paramOffset += ($count - 1); // Grows larger by number of parameters minus the replaced needle.
|
|
$queryOffset += (strlen($expandStr) - 1);
|
|
}
|
|
|
|
return array($query, $params, $types);
|
|
}
|
|
|
|
$queryOffset = 0;
|
|
$typesOrd = array();
|
|
$paramsOrd = array();
|
|
|
|
foreach ($paramPos as $pos => $paramName) {
|
|
$paramLen = strlen($paramName) + 1;
|
|
$value = static::extractParam($paramName, $params, true);
|
|
|
|
if ( ! isset($arrayPositions[$paramName]) && ! isset($arrayPositions[':' . $paramName])) {
|
|
$pos += $queryOffset;
|
|
$queryOffset -= ($paramLen - 1);
|
|
$paramsOrd[] = $value;
|
|
$typesOrd[] = static::extractParam($paramName, $types, false, \PDO::PARAM_STR);
|
|
$query = substr($query, 0, $pos) . '?' . substr($query, ($pos + $paramLen));
|
|
|
|
continue;
|
|
}
|
|
|
|
$count = count($value);
|
|
$expandStr = $count > 0 ? implode(', ', array_fill(0, $count, '?')) : 'NULL';
|
|
|
|
foreach ($value as $val) {
|
|
$paramsOrd[] = $val;
|
|
$typesOrd[] = static::extractParam($paramName, $types, false) - Connection::ARRAY_PARAM_OFFSET;
|
|
}
|
|
|
|
$pos += $queryOffset;
|
|
$queryOffset += (strlen($expandStr) - $paramLen);
|
|
$query = substr($query, 0, $pos) . $expandStr . substr($query, ($pos + $paramLen));
|
|
}
|
|
|
|
return array($query, $paramsOrd, $typesOrd);
|
|
}
|
|
|
|
/**
|
|
* Slice the SQL statement around pairs of quotes and
|
|
* return string fragments of SQL outside of quoted literals.
|
|
* Each fragment is captured as a 2-element array:
|
|
*
|
|
* 0 => matched fragment string,
|
|
* 1 => offset of fragment in $statement
|
|
*
|
|
* @param string $statement
|
|
* @return array
|
|
*/
|
|
static private function getUnquotedStatementFragments($statement)
|
|
{
|
|
$literal = self::ESCAPED_SINGLE_QUOTED_TEXT . '|' . self::ESCAPED_DOUBLE_QUOTED_TEXT;
|
|
preg_match_all("/([^'\"]+)(?:$literal)?/s", $statement, $fragments, PREG_OFFSET_CAPTURE);
|
|
|
|
return $fragments[1];
|
|
}
|
|
|
|
/**
|
|
* @param string $paramName The name of the parameter (without a colon in front)
|
|
* @param array $paramsOrTypes A hash of parameters or types
|
|
* @param bool $isParam
|
|
* @param mixed $defaultValue An optional default value. If omitted, an exception is thrown
|
|
*
|
|
* @throws SQLParserUtilsException
|
|
* @return mixed
|
|
*/
|
|
static private function extractParam($paramName, $paramsOrTypes, $isParam, $defaultValue = null)
|
|
{
|
|
if (array_key_exists($paramName, $paramsOrTypes)) {
|
|
return $paramsOrTypes[$paramName];
|
|
}
|
|
|
|
// Hash keys can be prefixed with a colon for compatibility
|
|
if (array_key_exists(':' . $paramName, $paramsOrTypes)) {
|
|
return $paramsOrTypes[':' . $paramName];
|
|
}
|
|
|
|
if (null !== $defaultValue) {
|
|
return $defaultValue;
|
|
}
|
|
|
|
if ($isParam) {
|
|
throw SQLParserUtilsException::missingParam($paramName);
|
|
}
|
|
|
|
throw SQLParserUtilsException::missingType($paramName);
|
|
}
|
|
}
|