interface/modules/zend_modules/library/Zend/Db/Adapter/Platform/Postgresql.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Db\Adapter\Platform;
  11
  12 use Zend\Db\Adapter\Driver\DriverInterface;
  13 use Zend\Db\Adapter\Driver\Pdo;
  14 use Zend\Db\Adapter\Driver\Pgsql;
  15 use Zend\Db\Adapter\Exception;
  16
  17 class Postgresql implements PlatformInterface
  18 {
  19     /** @var resource|\PDO */
  20     protected $resource = null;
  21
  22     public function __construct($driver = null)
  23     {
  24         if ($driver) {
  25             $this->setDriver($driver);
  26         }
  27     }
  28
  29     /**
  30      * @param \Zend\Db\Adapter\Driver\Pgsql\Pgsql|\Zend\Db\Adapter\Driver\Pdo\Pdo|resource|\PDO $driver
  31      * @throws \Zend\Db\Adapter\Exception\InvalidArgumentException
  32      * @return $this
  33      */
  34     public function setDriver($driver)
  35     {
  36         if ($driver instanceof Pgsql\Pgsql
  37             || ($driver instanceof Pdo\Pdo && $driver->getDatabasePlatformName() == 'Postgresql')
  38             || (is_resource($driver) && (in_array(get_resource_type($driver), array('pgsql link', 'pgsql link persistent'))))
  39             || ($driver instanceof \PDO && $driver->getAttribute(\PDO::ATTR_DRIVER_NAME) == 'pgsql')
  40         ) {
  41             $this->resource = $driver;
  42             return $this;
  43         }
  44
  45         throw new Exception\InvalidArgumentException('$driver must be a Pgsql or Postgresql PDO Zend\Db\Adapter\Driver, pgsql link resource or Postgresql PDO instance');
  46     }
  47
  48     /**
  49      * Get name
  50      *
  51      * @return string
  52      */
  53     public function getName()
  54     {
  55         return 'PostgreSQL';
  56     }
  57
  58     /**
  59      * Get quote indentifier symbol
  60      *
  61      * @return string
  62      */
  63     public function getQuoteIdentifierSymbol()
  64     {
  65         return '"';
  66     }
  67
  68     /**
  69      * Quote identifier
  70      *
  71      * @param  string $identifier
  72      * @return string
  73      */
  74     public function quoteIdentifier($identifier)
  75     {
  76         return '"' . str_replace('"', '\\' . '"', $identifier) . '"';
  77     }
  78
  79     /**
  80      * Quote identifier chain
  81      *
  82      * @param string|string[] $identifierChain
  83      * @return string
  84      */
  85     public function quoteIdentifierChain($identifierChain)
  86     {
  87         $identifierChain = str_replace('"', '\\"', $identifierChain);
  88         if (is_array($identifierChain)) {
  89             $identifierChain = implode('"."', $identifierChain);
  90         }
  91         return '"' . $identifierChain . '"';
  92     }
  93
  94     /**
  95      * Get quote value symbol
  96      *
  97      * @return string
  98      */
  99     public function getQuoteValueSymbol()
 100     {
 101         return '\'';
 102     }
 103
 104     /**
 105      * Quote value
 106      *
 107      * @param  string $value
 108      * @return string
 109      */
 110     public function quoteValue($value)
 111     {
 112         if ($this->resource instanceof DriverInterface) {
 113             $this->resource = $this->resource->getConnection()->getResource();
 114         }
 115         if (is_resource($this->resource)) {
 116             return '\'' . pg_escape_string($this->resource, $value) . '\'';
 117         }
 118         if ($this->resource instanceof \PDO) {
 119             return $this->resource->quote($value);
 120         }
 121         trigger_error(
 122             'Attempting to quote a value in ' . __CLASS__ . ' without extension/driver support '
 123                 . 'can introduce security vulnerabilities in a production environment.'
 124         );
 125         return '\'' . addcslashes($value, "\x00\n\r\\'\"\x1a") . '\'';
 126     }
 127
 128     /**
 129      * Quote Trusted Value
 130      *
 131      * The ability to quote values without notices
 132      *
 133      * @param $value
 134      * @return mixed
 135      */
 136     public function quoteTrustedValue($value)
 137     {
 138         if ($this->resource instanceof DriverInterface) {
 139             $this->resource = $this->resource->getConnection()->getResource();
 140         }
 141         if (is_resource($this->resource)) {
 142             return '\'' . pg_escape_string($this->resource, $value) . '\'';
 143         }
 144         if ($this->resource instanceof \PDO) {
 145             return $this->resource->quote($value);
 146         }
 147         return '\'' . addcslashes($value, "\x00\n\r\\'\"\x1a") . '\'';
 148     }
 149
 150     /**
 151      * Quote value list
 152      *
 153      * @param string|string[] $valueList
 154      * @return string
 155      */
 156     public function quoteValueList($valueList)
 157     {
 158         if (!is_array($valueList)) {
 159             return $this->quoteValue($valueList);
 160         }
 161
 162         $value = reset($valueList);
 163         do {
 164             $valueList[key($valueList)] = $this->quoteValue($value);
 165         } while ($value = next($valueList));
 166         return implode(', ', $valueList);
 167     }
 168
 169     /**
 170      * Get identifier separator
 171      *
 172      * @return string
 173      */
 174     public function getIdentifierSeparator()
 175     {
 176         return '.';
 177     }
 178
 179     /**
 180      * Quote identifier in fragment
 181      *
 182      * @param  string $identifier
 183      * @param  array $safeWords
 184      * @return string
 185      */
 186     public function quoteIdentifierInFragment($identifier, array $safeWords = array())
 187     {
 188         $parts = preg_split('#([\.\s\W])#', $identifier, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
 189         if ($safeWords) {
 190             $safeWords = array_flip($safeWords);
 191             $safeWords = array_change_key_case($safeWords, CASE_LOWER);
 192         }
 193         foreach ($parts as $i => $part) {
 194             if ($safeWords && isset($safeWords[strtolower($part)])) {
 195                 continue;
 196             }
 197             switch ($part) {
 198                 case ' ':
 199                 case '.':
 200                 case '*':
 201                 case 'AS':
 202                 case 'As':
 203                 case 'aS':
 204                 case 'as':
 205                     break;
 206                 default:
 207                     $parts[$i] = '"' . str_replace('"', '\\' . '"', $part) . '"';
 208             }
 209         }
 210         return implode('', $parts);
 211     }
 212
 213 }