PageRenderTime 70ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 1ms

/lib/Cake/Model/Datasource/DboSource.php

https://bitbucket.org/Aapje/quoted-for-the-win
PHP | 3280 lines | 2145 code | 278 blank | 857 comment | 575 complexity | 5e1358e6e15f10220814ad8c5d3b5560 MD5 | raw file
  1. <?php
  2. /**
  3. * Dbo Source
  4. *
  5. * PHP 5
  6. *
  7. * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  8. * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  9. *
  10. * Licensed under The MIT License
  11. * Redistributions of files must retain the above copyright notice.
  12. *
  13. * @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  14. * @link http://cakephp.org CakePHP(tm) Project
  15. * @package Cake.Model.Datasource
  16. * @since CakePHP(tm) v 0.10.0.1076
  17. * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  18. */
  19. App::uses('DataSource', 'Model/Datasource');
  20. App::uses('String', 'Utility');
  21. App::uses('View', 'View');
  22. /**
  23. * DboSource
  24. *
  25. * Creates DBO-descendant objects from a given db connection configuration
  26. *
  27. * @package Cake.Model.Datasource
  28. */
  29. class DboSource extends DataSource {
  30. /**
  31. * Description string for this Database Data Source.
  32. *
  33. * @var string
  34. */
  35. public $description = "Database Data Source";
  36. /**
  37. * index definition, standard cake, primary, index, unique
  38. *
  39. * @var array
  40. */
  41. public $index = array('PRI' => 'primary', 'MUL' => 'index', 'UNI' => 'unique');
  42. /**
  43. * Database keyword used to assign aliases to identifiers.
  44. *
  45. * @var string
  46. */
  47. public $alias = 'AS ';
  48. /**
  49. * Caches result from query parsing operations. Cached results for both DboSource::name() and
  50. * DboSource::conditions() will be stored here. Method caching uses `md5()`. If you have
  51. * problems with collisions, set DboSource::$cacheMethods to false.
  52. *
  53. * @var array
  54. */
  55. public static $methodCache = array();
  56. /**
  57. * Whether or not to cache the results of DboSource::name() and DboSource::conditions()
  58. * into the memory cache. Set to false to disable the use of the memory cache.
  59. *
  60. * @var boolean.
  61. */
  62. public $cacheMethods = true;
  63. /**
  64. * Flag to support nested transactions. If it is set to false, you will be able to use
  65. * the transaction methods (begin/commit/rollback), but just the global transaction will
  66. * be executed.
  67. *
  68. * @var boolean
  69. */
  70. public $useNestedTransactions = false;
  71. /**
  72. * Print full query debug info?
  73. *
  74. * @var boolean
  75. */
  76. public $fullDebug = false;
  77. /**
  78. * String to hold how many rows were affected by the last SQL operation.
  79. *
  80. * @var string
  81. */
  82. public $affected = null;
  83. /**
  84. * Number of rows in current resultset
  85. *
  86. * @var integer
  87. */
  88. public $numRows = null;
  89. /**
  90. * Time the last query took
  91. *
  92. * @var integer
  93. */
  94. public $took = null;
  95. /**
  96. * Result
  97. *
  98. * @var array
  99. */
  100. protected $_result = null;
  101. /**
  102. * Queries count.
  103. *
  104. * @var integer
  105. */
  106. protected $_queriesCnt = 0;
  107. /**
  108. * Total duration of all queries.
  109. *
  110. * @var integer
  111. */
  112. protected $_queriesTime = null;
  113. /**
  114. * Log of queries executed by this DataSource
  115. *
  116. * @var array
  117. */
  118. protected $_queriesLog = array();
  119. /**
  120. * Maximum number of items in query log
  121. *
  122. * This is to prevent query log taking over too much memory.
  123. *
  124. * @var integer Maximum number of queries in the queries log.
  125. */
  126. protected $_queriesLogMax = 200;
  127. /**
  128. * Caches serialized results of executed queries
  129. *
  130. * @var array Cache of results from executed sql queries.
  131. */
  132. protected $_queryCache = array();
  133. /**
  134. * A reference to the physical connection of this DataSource
  135. *
  136. * @var array
  137. */
  138. protected $_connection = null;
  139. /**
  140. * The DataSource configuration key name
  141. *
  142. * @var string
  143. */
  144. public $configKeyName = null;
  145. /**
  146. * The starting character that this DataSource uses for quoted identifiers.
  147. *
  148. * @var string
  149. */
  150. public $startQuote = null;
  151. /**
  152. * The ending character that this DataSource uses for quoted identifiers.
  153. *
  154. * @var string
  155. */
  156. public $endQuote = null;
  157. /**
  158. * The set of valid SQL operations usable in a WHERE statement
  159. *
  160. * @var array
  161. */
  162. protected $_sqlOps = array('like', 'ilike', 'or', 'not', 'in', 'between', 'regexp', 'similar to');
  163. /**
  164. * Indicates the level of nested transactions
  165. *
  166. * @var integer
  167. */
  168. protected $_transactionNesting = 0;
  169. /**
  170. * Default fields that are used by the DBO
  171. *
  172. * @var array
  173. */
  174. protected $_queryDefaults = array(
  175. 'conditions' => array(),
  176. 'fields' => null,
  177. 'table' => null,
  178. 'alias' => null,
  179. 'order' => null,
  180. 'limit' => null,
  181. 'joins' => array(),
  182. 'group' => null,
  183. 'offset' => null
  184. );
  185. /**
  186. * Separator string for virtualField composition
  187. *
  188. * @var string
  189. */
  190. public $virtualFieldSeparator = '__';
  191. /**
  192. * List of table engine specific parameters used on table creating
  193. *
  194. * @var array
  195. */
  196. public $tableParameters = array();
  197. /**
  198. * List of engine specific additional field parameters used on table creating
  199. *
  200. * @var array
  201. */
  202. public $fieldParameters = array();
  203. /**
  204. * Indicates whether there was a change on the cached results on the methods of this class
  205. * This will be used for storing in a more persistent cache
  206. *
  207. * @var boolean
  208. */
  209. protected $_methodCacheChange = false;
  210. /**
  211. * Constructor
  212. *
  213. * @param array $config Array of configuration information for the Datasource.
  214. * @param boolean $autoConnect Whether or not the datasource should automatically connect.
  215. * @throws MissingConnectionException when a connection cannot be made.
  216. */
  217. public function __construct($config = null, $autoConnect = true) {
  218. if (!isset($config['prefix'])) {
  219. $config['prefix'] = '';
  220. }
  221. parent::__construct($config);
  222. $this->fullDebug = Configure::read('debug') > 1;
  223. if (!$this->enabled()) {
  224. throw new MissingConnectionException(array(
  225. 'class' => get_class($this),
  226. 'message' => __d('cake_dev', 'Selected driver is not enabled'),
  227. 'enabled' => false
  228. ));
  229. }
  230. if ($autoConnect) {
  231. $this->connect();
  232. }
  233. }
  234. /**
  235. * Reconnects to database server with optional new settings
  236. *
  237. * @param array $config An array defining the new configuration settings
  238. * @return boolean True on success, false on failure
  239. */
  240. public function reconnect($config = array()) {
  241. $this->disconnect();
  242. $this->setConfig($config);
  243. $this->_sources = null;
  244. return $this->connect();
  245. }
  246. /**
  247. * Disconnects from database.
  248. *
  249. * @return boolean True if the database could be disconnected, else false
  250. */
  251. public function disconnect() {
  252. if ($this->_result instanceof PDOStatement) {
  253. $this->_result->closeCursor();
  254. }
  255. unset($this->_connection);
  256. $this->connected = false;
  257. return true;
  258. }
  259. /**
  260. * Get the underlying connection object.
  261. *
  262. * @return PDO
  263. */
  264. public function getConnection() {
  265. return $this->_connection;
  266. }
  267. /**
  268. * Gets the version string of the database server
  269. *
  270. * @return string The database version
  271. */
  272. public function getVersion() {
  273. return $this->_connection->getAttribute(PDO::ATTR_SERVER_VERSION);
  274. }
  275. /**
  276. * Returns a quoted and escaped string of $data for use in an SQL statement.
  277. *
  278. * @param string $data String to be prepared for use in an SQL statement
  279. * @param string $column The column into which this data will be inserted
  280. * @return string Quoted and escaped data
  281. */
  282. public function value($data, $column = null) {
  283. if (is_array($data) && !empty($data)) {
  284. return array_map(
  285. array(&$this, 'value'),
  286. $data, array_fill(0, count($data), $column)
  287. );
  288. } elseif (is_object($data) && isset($data->type, $data->value)) {
  289. if ($data->type == 'identifier') {
  290. return $this->name($data->value);
  291. } elseif ($data->type == 'expression') {
  292. return $data->value;
  293. }
  294. } elseif (in_array($data, array('{$__cakeID__$}', '{$__cakeForeignKey__$}'), true)) {
  295. return $data;
  296. }
  297. if ($data === null || (is_array($data) && empty($data))) {
  298. return 'NULL';
  299. }
  300. if (empty($column)) {
  301. $column = $this->introspectType($data);
  302. }
  303. switch ($column) {
  304. case 'binary':
  305. return $this->_connection->quote($data, PDO::PARAM_LOB);
  306. case 'boolean':
  307. return $this->_connection->quote($this->boolean($data, true), PDO::PARAM_BOOL);
  308. case 'string':
  309. case 'text':
  310. return $this->_connection->quote($data, PDO::PARAM_STR);
  311. default:
  312. if ($data === '') {
  313. return 'NULL';
  314. }
  315. if (is_float($data)) {
  316. return str_replace(',', '.', strval($data));
  317. }
  318. if ((is_int($data) || $data === '0') || (
  319. is_numeric($data) && strpos($data, ',') === false &&
  320. $data[0] != '0' && strpos($data, 'e') === false)
  321. ) {
  322. return $data;
  323. }
  324. return $this->_connection->quote($data);
  325. }
  326. }
  327. /**
  328. * Returns an object to represent a database identifier in a query. Expression objects
  329. * are not sanitized or escaped.
  330. *
  331. * @param string $identifier A SQL expression to be used as an identifier
  332. * @return stdClass An object representing a database identifier to be used in a query
  333. */
  334. public function identifier($identifier) {
  335. $obj = new stdClass();
  336. $obj->type = 'identifier';
  337. $obj->value = $identifier;
  338. return $obj;
  339. }
  340. /**
  341. * Returns an object to represent a database expression in a query. Expression objects
  342. * are not sanitized or escaped.
  343. *
  344. * @param string $expression An arbitrary SQL expression to be inserted into a query.
  345. * @return stdClass An object representing a database expression to be used in a query
  346. */
  347. public function expression($expression) {
  348. $obj = new stdClass();
  349. $obj->type = 'expression';
  350. $obj->value = $expression;
  351. return $obj;
  352. }
  353. /**
  354. * Executes given SQL statement.
  355. *
  356. * @param string $sql SQL statement
  357. * @param array $params Additional options for the query.
  358. * @return boolean
  359. */
  360. public function rawQuery($sql, $params = array()) {
  361. $this->took = $this->numRows = false;
  362. return $this->execute($sql, $params);
  363. }
  364. /**
  365. * Queries the database with given SQL statement, and obtains some metadata about the result
  366. * (rows affected, timing, any errors, number of rows in resultset). The query is also logged.
  367. * If Configure::read('debug') is set, the log is shown all the time, else it is only shown on errors.
  368. *
  369. * ### Options
  370. *
  371. * - log - Whether or not the query should be logged to the memory log.
  372. *
  373. * @param string $sql SQL statement
  374. * @param array $options
  375. * @param array $params values to be bound to the query
  376. * @return mixed Resource or object representing the result set, or false on failure
  377. */
  378. public function execute($sql, $options = array(), $params = array()) {
  379. $options += array('log' => $this->fullDebug);
  380. $t = microtime(true);
  381. $this->_result = $this->_execute($sql, $params);
  382. if ($options['log']) {
  383. $this->took = round((microtime(true) - $t) * 1000, 0);
  384. $this->numRows = $this->affected = $this->lastAffected();
  385. $this->logQuery($sql, $params);
  386. }
  387. return $this->_result;
  388. }
  389. /**
  390. * Executes given SQL statement.
  391. *
  392. * @param string $sql SQL statement
  393. * @param array $params list of params to be bound to query
  394. * @param array $prepareOptions Options to be used in the prepare statement
  395. * @return mixed PDOStatement if query executes with no problem, true as the result of a successful, false on error
  396. * query returning no rows, such as a CREATE statement, false otherwise
  397. * @throws PDOException
  398. */
  399. protected function _execute($sql, $params = array(), $prepareOptions = array()) {
  400. $sql = trim($sql);
  401. if (preg_match('/^(?:CREATE|ALTER|DROP)\s+(?:TABLE|INDEX)/i', $sql)) {
  402. $statements = array_filter(explode(';', $sql));
  403. if (count($statements) > 1) {
  404. $result = array_map(array($this, '_execute'), $statements);
  405. return array_search(false, $result) === false;
  406. }
  407. }
  408. try {
  409. $query = $this->_connection->prepare($sql, $prepareOptions);
  410. $query->setFetchMode(PDO::FETCH_LAZY);
  411. if (!$query->execute($params)) {
  412. $this->_results = $query;
  413. $query->closeCursor();
  414. return false;
  415. }
  416. if (!$query->columnCount()) {
  417. $query->closeCursor();
  418. if (!$query->rowCount()) {
  419. return true;
  420. }
  421. }
  422. return $query;
  423. } catch (PDOException $e) {
  424. if (isset($query->queryString)) {
  425. $e->queryString = $query->queryString;
  426. } else {
  427. $e->queryString = $sql;
  428. }
  429. throw $e;
  430. }
  431. }
  432. /**
  433. * Returns a formatted error message from previous database operation.
  434. *
  435. * @param PDOStatement $query the query to extract the error from if any
  436. * @return string Error message with error number
  437. */
  438. public function lastError(PDOStatement $query = null) {
  439. if ($query) {
  440. $error = $query->errorInfo();
  441. } else {
  442. $error = $this->_connection->errorInfo();
  443. }
  444. if (empty($error[2])) {
  445. return null;
  446. }
  447. return $error[1] . ': ' . $error[2];
  448. }
  449. /**
  450. * Returns number of affected rows in previous database operation. If no previous operation exists,
  451. * this returns false.
  452. *
  453. * @param mixed $source
  454. * @return integer Number of affected rows
  455. */
  456. public function lastAffected($source = null) {
  457. if ($this->hasResult()) {
  458. return $this->_result->rowCount();
  459. }
  460. return 0;
  461. }
  462. /**
  463. * Returns number of rows in previous resultset. If no previous resultset exists,
  464. * this returns false.
  465. *
  466. * @param mixed $source Not used
  467. * @return integer Number of rows in resultset
  468. */
  469. public function lastNumRows($source = null) {
  470. return $this->lastAffected();
  471. }
  472. /**
  473. * DataSource Query abstraction
  474. *
  475. * @return resource Result resource identifier.
  476. */
  477. public function query() {
  478. $args = func_get_args();
  479. $fields = null;
  480. $order = null;
  481. $limit = null;
  482. $page = null;
  483. $recursive = null;
  484. if (count($args) === 1) {
  485. return $this->fetchAll($args[0]);
  486. } elseif (count($args) > 1 && (strpos($args[0], 'findBy') === 0 || strpos($args[0], 'findAllBy') === 0)) {
  487. $params = $args[1];
  488. if (substr($args[0], 0, 6) === 'findBy') {
  489. $all = false;
  490. $field = Inflector::underscore(substr($args[0], 6));
  491. } else {
  492. $all = true;
  493. $field = Inflector::underscore(substr($args[0], 9));
  494. }
  495. $or = (strpos($field, '_or_') !== false);
  496. if ($or) {
  497. $field = explode('_or_', $field);
  498. } else {
  499. $field = explode('_and_', $field);
  500. }
  501. $off = count($field) - 1;
  502. if (isset($params[1 + $off])) {
  503. $fields = $params[1 + $off];
  504. }
  505. if (isset($params[2 + $off])) {
  506. $order = $params[2 + $off];
  507. }
  508. if (!array_key_exists(0, $params)) {
  509. return false;
  510. }
  511. $c = 0;
  512. $conditions = array();
  513. foreach ($field as $f) {
  514. $conditions[$args[2]->alias . '.' . $f] = $params[$c++];
  515. }
  516. if ($or) {
  517. $conditions = array('OR' => $conditions);
  518. }
  519. if ($all) {
  520. if (isset($params[3 + $off])) {
  521. $limit = $params[3 + $off];
  522. }
  523. if (isset($params[4 + $off])) {
  524. $page = $params[4 + $off];
  525. }
  526. if (isset($params[5 + $off])) {
  527. $recursive = $params[5 + $off];
  528. }
  529. return $args[2]->find('all', compact('conditions', 'fields', 'order', 'limit', 'page', 'recursive'));
  530. } else {
  531. if (isset($params[3 + $off])) {
  532. $recursive = $params[3 + $off];
  533. }
  534. return $args[2]->find('first', compact('conditions', 'fields', 'order', 'recursive'));
  535. }
  536. } else {
  537. if (isset($args[1]) && $args[1] === true) {
  538. return $this->fetchAll($args[0], true);
  539. } elseif (isset($args[1]) && !is_array($args[1]) ) {
  540. return $this->fetchAll($args[0], false);
  541. } elseif (isset($args[1]) && is_array($args[1])) {
  542. if (isset($args[2])) {
  543. $cache = $args[2];
  544. } else {
  545. $cache = true;
  546. }
  547. return $this->fetchAll($args[0], $args[1], array('cache' => $cache));
  548. }
  549. }
  550. }
  551. /**
  552. * Returns a row from current resultset as an array
  553. *
  554. * @param string $sql Some SQL to be executed.
  555. * @return array The fetched row as an array
  556. */
  557. public function fetchRow($sql = null) {
  558. if (is_string($sql) && strlen($sql) > 5 && !$this->execute($sql)) {
  559. return null;
  560. }
  561. if ($this->hasResult()) {
  562. $this->resultSet($this->_result);
  563. $resultRow = $this->fetchResult();
  564. if (isset($resultRow[0])) {
  565. $this->fetchVirtualField($resultRow);
  566. }
  567. return $resultRow;
  568. } else {
  569. return null;
  570. }
  571. }
  572. /**
  573. * Returns an array of all result rows for a given SQL query.
  574. * Returns false if no rows matched.
  575. *
  576. *
  577. * ### Options
  578. *
  579. * - `cache` - Returns the cached version of the query, if exists and stores the result in cache.
  580. * This is a non-persistent cache, and only lasts for a single request. This option
  581. * defaults to true. If you are directly calling this method, you can disable caching
  582. * by setting $options to `false`
  583. *
  584. * @param string $sql SQL statement
  585. * @param array $params parameters to be bound as values for the SQL statement
  586. * @param array $options additional options for the query.
  587. * @return array Array of resultset rows, or false if no rows matched
  588. */
  589. public function fetchAll($sql, $params = array(), $options = array()) {
  590. if (is_string($options)) {
  591. $options = array('modelName' => $options);
  592. }
  593. if (is_bool($params)) {
  594. $options['cache'] = $params;
  595. $params = array();
  596. }
  597. $options += array('cache' => true);
  598. $cache = $options['cache'];
  599. if ($cache && ($cached = $this->getQueryCache($sql, $params)) !== false) {
  600. return $cached;
  601. }
  602. if ($result = $this->execute($sql, array(), $params)) {
  603. $out = array();
  604. if ($this->hasResult()) {
  605. $first = $this->fetchRow();
  606. if ($first != null) {
  607. $out[] = $first;
  608. }
  609. while ($item = $this->fetchResult()) {
  610. if (isset($item[0])) {
  611. $this->fetchVirtualField($item);
  612. }
  613. $out[] = $item;
  614. }
  615. }
  616. if (!is_bool($result) && $cache) {
  617. $this->_writeQueryCache($sql, $out, $params);
  618. }
  619. if (empty($out) && is_bool($this->_result)) {
  620. return $this->_result;
  621. }
  622. return $out;
  623. }
  624. return false;
  625. }
  626. /**
  627. * Fetches the next row from the current result set
  628. *
  629. * @return boolean
  630. */
  631. public function fetchResult() {
  632. return false;
  633. }
  634. /**
  635. * Modifies $result array to place virtual fields in model entry where they belongs to
  636. *
  637. * @param array $result Reference to the fetched row
  638. * @return void
  639. */
  640. public function fetchVirtualField(&$result) {
  641. if (isset($result[0]) && is_array($result[0])) {
  642. foreach ($result[0] as $field => $value) {
  643. if (strpos($field, $this->virtualFieldSeparator) === false) {
  644. continue;
  645. }
  646. list($alias, $virtual) = explode($this->virtualFieldSeparator, $field);
  647. if (!ClassRegistry::isKeySet($alias)) {
  648. return;
  649. }
  650. $model = ClassRegistry::getObject($alias);
  651. if ($model->isVirtualField($virtual)) {
  652. $result[$alias][$virtual] = $value;
  653. unset($result[0][$field]);
  654. }
  655. }
  656. if (empty($result[0])) {
  657. unset($result[0]);
  658. }
  659. }
  660. }
  661. /**
  662. * Returns a single field of the first of query results for a given SQL query, or false if empty.
  663. *
  664. * @param string $name Name of the field
  665. * @param string $sql SQL query
  666. * @return mixed Value of field read.
  667. */
  668. public function field($name, $sql) {
  669. $data = $this->fetchRow($sql);
  670. if (empty($data[$name])) {
  671. return false;
  672. }
  673. return $data[$name];
  674. }
  675. /**
  676. * Empties the method caches.
  677. * These caches are used by DboSource::name() and DboSource::conditions()
  678. *
  679. * @return void
  680. */
  681. public function flushMethodCache() {
  682. $this->_methodCacheChange = true;
  683. self::$methodCache = array();
  684. }
  685. /**
  686. * Cache a value into the methodCaches. Will respect the value of DboSource::$cacheMethods.
  687. * Will retrieve a value from the cache if $value is null.
  688. *
  689. * If caching is disabled and a write is attempted, the $value will be returned.
  690. * A read will either return the value or null.
  691. *
  692. * @param string $method Name of the method being cached.
  693. * @param string $key The key name for the cache operation.
  694. * @param mixed $value The value to cache into memory.
  695. * @return mixed Either null on failure, or the value if its set.
  696. */
  697. public function cacheMethod($method, $key, $value = null) {
  698. if ($this->cacheMethods === false) {
  699. return $value;
  700. }
  701. if (empty(self::$methodCache)) {
  702. self::$methodCache = Cache::read('method_cache', '_cake_core_');
  703. }
  704. if ($value === null) {
  705. return (isset(self::$methodCache[$method][$key])) ? self::$methodCache[$method][$key] : null;
  706. }
  707. $this->_methodCacheChange = true;
  708. return self::$methodCache[$method][$key] = $value;
  709. }
  710. /**
  711. * Returns a quoted name of $data for use in an SQL statement.
  712. * Strips fields out of SQL functions before quoting.
  713. *
  714. * Results of this method are stored in a memory cache. This improves performance, but
  715. * because the method uses a hashing algorithm it can have collisions.
  716. * Setting DboSource::$cacheMethods to false will disable the memory cache.
  717. *
  718. * @param mixed $data Either a string with a column to quote. An array of columns to quote or an
  719. * object from DboSource::expression() or DboSource::identifier()
  720. * @return string SQL field
  721. */
  722. public function name($data) {
  723. if (is_object($data) && isset($data->type)) {
  724. return $data->value;
  725. }
  726. if ($data === '*') {
  727. return '*';
  728. }
  729. if (is_array($data)) {
  730. foreach ($data as $i => $dataItem) {
  731. $data[$i] = $this->name($dataItem);
  732. }
  733. return $data;
  734. }
  735. $cacheKey = md5($this->startQuote . $data . $this->endQuote);
  736. if ($return = $this->cacheMethod(__FUNCTION__, $cacheKey)) {
  737. return $return;
  738. }
  739. $data = trim($data);
  740. if (preg_match('/^[\w-]+(?:\.[^ \*]*)*$/', $data)) { // string, string.string
  741. if (strpos($data, '.') === false) { // string
  742. return $this->cacheMethod(__FUNCTION__, $cacheKey, $this->startQuote . $data . $this->endQuote);
  743. }
  744. $items = explode('.', $data);
  745. return $this->cacheMethod(__FUNCTION__, $cacheKey,
  746. $this->startQuote . implode($this->endQuote . '.' . $this->startQuote, $items) . $this->endQuote
  747. );
  748. }
  749. if (preg_match('/^[\w-]+\.\*$/', $data)) { // string.*
  750. return $this->cacheMethod(__FUNCTION__, $cacheKey,
  751. $this->startQuote . str_replace('.*', $this->endQuote . '.*', $data)
  752. );
  753. }
  754. if (preg_match('/^([\w-]+)\((.*)\)$/', $data, $matches)) { // Functions
  755. return $this->cacheMethod(__FUNCTION__, $cacheKey,
  756. $matches[1] . '(' . $this->name($matches[2]) . ')'
  757. );
  758. }
  759. if (
  760. preg_match('/^([\w-]+(\.[\w-]+|\(.*\))*)\s+' . preg_quote($this->alias) . '\s*([\w-]+)$/i', $data, $matches
  761. )) {
  762. return $this->cacheMethod(
  763. __FUNCTION__, $cacheKey,
  764. preg_replace(
  765. '/\s{2,}/', ' ', $this->name($matches[1]) . ' ' . $this->alias . ' ' . $this->name($matches[3])
  766. )
  767. );
  768. }
  769. if (preg_match('/^[\w-_\s]*[\w-_]+/', $data)) {
  770. return $this->cacheMethod(__FUNCTION__, $cacheKey, $this->startQuote . $data . $this->endQuote);
  771. }
  772. return $this->cacheMethod(__FUNCTION__, $cacheKey, $data);
  773. }
  774. /**
  775. * Checks if the source is connected to the database.
  776. *
  777. * @return boolean True if the database is connected, else false
  778. */
  779. public function isConnected() {
  780. return $this->connected;
  781. }
  782. /**
  783. * Checks if the result is valid
  784. *
  785. * @return boolean True if the result is valid else false
  786. */
  787. public function hasResult() {
  788. return is_a($this->_result, 'PDOStatement');
  789. }
  790. /**
  791. * Get the query log as an array.
  792. *
  793. * @param boolean $sorted Get the queries sorted by time taken, defaults to false.
  794. * @param boolean $clear If True the existing log will cleared.
  795. * @return array Array of queries run as an array
  796. */
  797. public function getLog($sorted = false, $clear = true) {
  798. if ($sorted) {
  799. $log = sortByKey($this->_queriesLog, 'took', 'desc', SORT_NUMERIC);
  800. } else {
  801. $log = $this->_queriesLog;
  802. }
  803. if ($clear) {
  804. $this->_queriesLog = array();
  805. }
  806. return array('log' => $log, 'count' => $this->_queriesCnt, 'time' => $this->_queriesTime);
  807. }
  808. /**
  809. * Outputs the contents of the queries log. If in a non-CLI environment the sql_log element
  810. * will be rendered and output. If in a CLI environment, a plain text log is generated.
  811. *
  812. * @param boolean $sorted Get the queries sorted by time taken, defaults to false.
  813. * @return void
  814. */
  815. public function showLog($sorted = false) {
  816. $log = $this->getLog($sorted, false);
  817. if (empty($log['log'])) {
  818. return;
  819. }
  820. if (PHP_SAPI != 'cli') {
  821. $controller = null;
  822. $View = new View($controller, false);
  823. $View->set('logs', array($this->configKeyName => $log));
  824. echo $View->element('sql_dump', array('_forced_from_dbo_' => true));
  825. } else {
  826. foreach ($log['log'] as $k => $i) {
  827. print (($k + 1) . ". {$i['query']}\n");
  828. }
  829. }
  830. }
  831. /**
  832. * Log given SQL query.
  833. *
  834. * @param string $sql SQL statement
  835. * @param array $params Values binded to the query (prepared statements)
  836. * @return void
  837. */
  838. public function logQuery($sql, $params = array()) {
  839. $this->_queriesCnt++;
  840. $this->_queriesTime += $this->took;
  841. $this->_queriesLog[] = array(
  842. 'query' => $sql,
  843. 'params' => $params,
  844. 'affected' => $this->affected,
  845. 'numRows' => $this->numRows,
  846. 'took' => $this->took
  847. );
  848. if (count($this->_queriesLog) > $this->_queriesLogMax) {
  849. array_shift($this->_queriesLog);
  850. }
  851. }
  852. /**
  853. * Gets full table name including prefix
  854. *
  855. * @param Model|string $model Either a Model object or a string table name.
  856. * @param boolean $quote Whether you want the table name quoted.
  857. * @param boolean $schema Whether you want the schema name included.
  858. * @return string Full quoted table name
  859. */
  860. public function fullTableName($model, $quote = true, $schema = true) {
  861. if (is_object($model)) {
  862. $schemaName = $model->schemaName;
  863. $table = $model->tablePrefix . $model->table;
  864. } elseif (!empty($this->config['prefix']) && strpos($model, $this->config['prefix']) !== 0) {
  865. $table = $this->config['prefix'] . strval($model);
  866. } else {
  867. $table = strval($model);
  868. }
  869. if ($schema && !isset($schemaName)) {
  870. $schemaName = $this->getSchemaName();
  871. }
  872. if ($quote) {
  873. if ($schema && !empty($schemaName)) {
  874. if (false == strstr($table, '.')) {
  875. return $this->name($schemaName) . '.' . $this->name($table);
  876. }
  877. }
  878. return $this->name($table);
  879. }
  880. if ($schema && !empty($schemaName)) {
  881. if (false == strstr($table, '.')) {
  882. return $schemaName . '.' . $table;
  883. }
  884. }
  885. return $table;
  886. }
  887. /**
  888. * The "C" in CRUD
  889. *
  890. * Creates new records in the database.
  891. *
  892. * @param Model $model Model object that the record is for.
  893. * @param array $fields An array of field names to insert. If null, $model->data will be
  894. * used to generate field names.
  895. * @param array $values An array of values with keys matching the fields. If null, $model->data will
  896. * be used to generate values.
  897. * @return boolean Success
  898. */
  899. public function create(Model $model, $fields = null, $values = null) {
  900. $id = null;
  901. if ($fields == null) {
  902. unset($fields, $values);
  903. $fields = array_keys($model->data);
  904. $values = array_values($model->data);
  905. }
  906. $count = count($fields);
  907. for ($i = 0; $i < $count; $i++) {
  908. $valueInsert[] = $this->value($values[$i], $model->getColumnType($fields[$i]));
  909. $fieldInsert[] = $this->name($fields[$i]);
  910. if ($fields[$i] == $model->primaryKey) {
  911. $id = $values[$i];
  912. }
  913. }
  914. $query = array(
  915. 'table' => $this->fullTableName($model),
  916. 'fields' => implode(', ', $fieldInsert),
  917. 'values' => implode(', ', $valueInsert)
  918. );
  919. if ($this->execute($this->renderStatement('create', $query))) {
  920. if (empty($id)) {
  921. $id = $this->lastInsertId($this->fullTableName($model, false, false), $model->primaryKey);
  922. }
  923. $model->setInsertID($id);
  924. $model->id = $id;
  925. return true;
  926. }
  927. $model->onError();
  928. return false;
  929. }
  930. /**
  931. * The "R" in CRUD
  932. *
  933. * Reads record(s) from the database.
  934. *
  935. * @param Model $model A Model object that the query is for.
  936. * @param array $queryData An array of queryData information containing keys similar to Model::find()
  937. * @param integer $recursive Number of levels of association
  938. * @return mixed boolean false on error/failure. An array of results on success.
  939. */
  940. public function read(Model $model, $queryData = array(), $recursive = null) {
  941. $queryData = $this->_scrubQueryData($queryData);
  942. $null = null;
  943. $array = array('callbacks' => $queryData['callbacks']);
  944. $linkedModels = array();
  945. $bypass = false;
  946. if ($recursive === null && isset($queryData['recursive'])) {
  947. $recursive = $queryData['recursive'];
  948. }
  949. if (!is_null($recursive)) {
  950. $_recursive = $model->recursive;
  951. $model->recursive = $recursive;
  952. }
  953. if (!empty($queryData['fields'])) {
  954. $bypass = true;
  955. $queryData['fields'] = $this->fields($model, null, $queryData['fields']);
  956. } else {
  957. $queryData['fields'] = $this->fields($model);
  958. }
  959. $_associations = $model->associations();
  960. if ($model->recursive == -1) {
  961. $_associations = array();
  962. } elseif ($model->recursive == 0) {
  963. unset($_associations[2], $_associations[3]);
  964. }
  965. foreach ($_associations as $type) {
  966. foreach ($model->{$type} as $assoc => $assocData) {
  967. $linkModel = $model->{$assoc};
  968. $external = isset($assocData['external']);
  969. $linkModel->getDataSource();
  970. if ($model->useDbConfig === $linkModel->useDbConfig) {
  971. if ($bypass) {
  972. $assocData['fields'] = false;
  973. }
  974. if (true === $this->generateAssociationQuery($model, $linkModel, $type, $assoc, $assocData, $queryData, $external, $null)) {
  975. $linkedModels[$type . '/' . $assoc] = true;
  976. }
  977. }
  978. }
  979. }
  980. $query = trim($this->generateAssociationQuery($model, null, null, null, null, $queryData, false, $null));
  981. $resultSet = $this->fetchAll($query, $model->cacheQueries);
  982. if ($resultSet === false) {
  983. $model->onError();
  984. return false;
  985. }
  986. $filtered = array();
  987. if ($queryData['callbacks'] === true || $queryData['callbacks'] === 'after') {
  988. $filtered = $this->_filterResults($resultSet, $model);
  989. }
  990. if ($model->recursive > -1) {
  991. $joined = array();
  992. if (isset($queryData['joins'][0]['alias'])) {
  993. $joined[$model->alias] = (array)Hash::extract($queryData['joins'], '{n}.alias');
  994. }
  995. foreach ($_associations as $type) {
  996. foreach ($model->{$type} as $assoc => $assocData) {
  997. $linkModel = $model->{$assoc};
  998. if (!isset($linkedModels[$type . '/' . $assoc])) {
  999. if ($model->useDbConfig === $linkModel->useDbConfig) {
  1000. $db = $this;
  1001. } else {
  1002. $db = ConnectionManager::getDataSource($linkModel->useDbConfig);
  1003. }
  1004. } elseif ($model->recursive > 1 && ($type === 'belongsTo' || $type === 'hasOne')) {
  1005. $db = $this;
  1006. }
  1007. if (isset($db) && method_exists($db, 'queryAssociation')) {
  1008. $stack = array($assoc);
  1009. $stack['_joined'] = $joined;
  1010. $db->queryAssociation($model, $linkModel, $type, $assoc, $assocData, $array, true, $resultSet, $model->recursive - 1, $stack);
  1011. unset($db);
  1012. if ($type === 'hasMany') {
  1013. $filtered[] = $assoc;
  1014. }
  1015. }
  1016. }
  1017. }
  1018. if ($queryData['callbacks'] === true || $queryData['callbacks'] === 'after') {
  1019. $this->_filterResults($resultSet, $model, $filtered);
  1020. }
  1021. }
  1022. if (!is_null($recursive)) {
  1023. $model->recursive = $_recursive;
  1024. }
  1025. return $resultSet;
  1026. }
  1027. /**
  1028. * Passes association results thru afterFind filters of corresponding model
  1029. *
  1030. * @param array $results Reference of resultset to be filtered
  1031. * @param Model $model Instance of model to operate against
  1032. * @param array $filtered List of classes already filtered, to be skipped
  1033. * @return array Array of results that have been filtered through $model->afterFind
  1034. */
  1035. protected function _filterResults(&$results, Model $model, $filtered = array()) {
  1036. $current = reset($results);
  1037. if (!is_array($current)) {
  1038. return array();
  1039. }
  1040. $keys = array_diff(array_keys($current), $filtered, array($model->alias));
  1041. $filtering = array();
  1042. foreach ($keys as $className) {
  1043. if (!isset($model->{$className}) || !is_object($model->{$className})) {
  1044. continue;
  1045. }
  1046. $linkedModel = $model->{$className};
  1047. $filtering[] = $className;
  1048. foreach ($results as &$result) {
  1049. $data = $linkedModel->afterFind(array(array($className => $result[$className])), false);
  1050. if (isset($data[0][$className])) {
  1051. $result[$className] = $data[0][$className];
  1052. }
  1053. }
  1054. }
  1055. return $filtering;
  1056. }
  1057. /**
  1058. * Queries associations. Used to fetch results on recursive models.
  1059. *
  1060. * @param Model $model Primary Model object
  1061. * @param Model $linkModel Linked model that
  1062. * @param string $type Association type, one of the model association types ie. hasMany
  1063. * @param string $association
  1064. * @param array $assocData
  1065. * @param array $queryData
  1066. * @param boolean $external Whether or not the association query is on an external datasource.
  1067. * @param array $resultSet Existing results
  1068. * @param integer $recursive Number of levels of association
  1069. * @param array $stack
  1070. * @return mixed
  1071. * @throws CakeException when results cannot be created.
  1072. */
  1073. public function queryAssociation(Model $model, &$linkModel, $type, $association, $assocData, &$queryData, $external, &$resultSet, $recursive, $stack) {
  1074. if (isset($stack['_joined'])) {
  1075. $joined = $stack['_joined'];
  1076. unset($stack['_joined']);
  1077. }
  1078. if ($query = $this->generateAssociationQuery($model, $linkModel, $type, $association, $assocData, $queryData, $external, $resultSet)) {
  1079. if (!is_array($resultSet)) {
  1080. throw new CakeException(__d('cake_dev', 'Error in Model %s', get_class($model)));
  1081. }
  1082. if ($type === 'hasMany' && empty($assocData['limit']) && !empty($assocData['foreignKey'])) {
  1083. $ins = $fetch = array();
  1084. foreach ($resultSet as &$result) {
  1085. if ($in = $this->insertQueryData('{$__cakeID__$}', $result, $association, $assocData, $model, $linkModel, $stack)) {
  1086. $ins[] = $in;
  1087. }
  1088. }
  1089. if (!empty($ins)) {
  1090. $ins = array_unique($ins);
  1091. $fetch = $this->fetchAssociated($model, $query, $ins);
  1092. }
  1093. if (!empty($fetch) && is_array($fetch)) {
  1094. if ($recursive > 0) {
  1095. foreach ($linkModel->associations() as $type1) {
  1096. foreach ($linkModel->{$type1} as $assoc1 => $assocData1) {
  1097. $deepModel = $linkModel->{$assoc1};
  1098. $tmpStack = $stack;
  1099. $tmpStack[] = $assoc1;
  1100. if ($linkModel->useDbConfig === $deepModel->useDbConfig) {
  1101. $db = $this;
  1102. } else {
  1103. $db = ConnectionManager::getDataSource($deepModel->useDbConfig);
  1104. }
  1105. $db->queryAssociation($linkModel, $deepModel, $type1, $assoc1, $assocData1, $queryData, true, $fetch, $recursive - 1, $tmpStack);
  1106. }
  1107. }
  1108. }
  1109. }
  1110. if ($queryData['callbacks'] === true || $queryData['callbacks'] === 'after') {
  1111. $this->_filterResults($fetch, $model);
  1112. }
  1113. return $this->_mergeHasMany($resultSet, $fetch, $association, $model, $linkModel);
  1114. } elseif ($type === 'hasAndBelongsToMany') {
  1115. $ins = $fetch = array();
  1116. foreach ($resultSet as &$result) {
  1117. if ($in = $this->insertQueryData('{$__cakeID__$}', $result, $association, $assocData, $model, $linkModel, $stack)) {
  1118. $ins[] = $in;
  1119. }
  1120. }
  1121. if (!empty($ins)) {
  1122. $ins = array_unique($ins);
  1123. if (count($ins) > 1) {
  1124. $query = str_replace('{$__cakeID__$}', '(' . implode(', ', $ins) . ')', $query);
  1125. $query = str_replace('= (', 'IN (', $query);
  1126. } else {
  1127. $query = str_replace('{$__cakeID__$}', $ins[0], $query);
  1128. }
  1129. $query = str_replace(' WHERE 1 = 1', '', $query);
  1130. }
  1131. $foreignKey = $model->hasAndBelongsToMany[$association]['foreignKey'];
  1132. $joinKeys = array($foreignKey, $model->hasAndBelongsToMany[$association]['associationForeignKey']);
  1133. list($with, $habtmFields) = $model->joinModel($model->hasAndBelongsToMany[$association]['with'], $joinKeys);
  1134. $habtmFieldsCount = count($habtmFields);
  1135. $q = $this->insertQueryData($query, null, $association, $assocData, $model, $linkModel, $stack);
  1136. if ($q !== false) {
  1137. $fetch = $this->fetchAll($q, $model->cacheQueries);
  1138. } else {
  1139. $fetch = null;
  1140. }
  1141. }
  1142. $modelAlias = $model->alias;
  1143. $modelPK = $model->primaryKey;
  1144. foreach ($resultSet as &$row) {
  1145. if ($type !== 'hasAndBelongsToMany') {
  1146. $q = $this->insertQueryData($query, $row, $association, $assocData, $model, $linkModel, $stack);
  1147. $fetch = null;
  1148. if ($q !== false) {
  1149. $joinedData = array();
  1150. if (($type === 'belongsTo' || $type === 'hasOne') && isset($row[$linkModel->alias], $joined[$model->alias]) && in_array($linkModel->alias, $joined[$model->alias])) {
  1151. $joinedData = Hash::filter($row[$linkModel->alias]);
  1152. if (!empty($joinedData)) {
  1153. $fetch[0] = array($linkModel->alias => $row[$linkModel->alias]);
  1154. }
  1155. } else {
  1156. $fetch = $this->fetchAll($q, $model->cacheQueries);
  1157. }
  1158. }
  1159. }
  1160. $selfJoin = $linkModel->name === $model->name;
  1161. if (!empty($fetch) && is_array($fetch)) {
  1162. if ($recursive > 0) {
  1163. foreach ($linkModel->associations() as $type1) {
  1164. foreach ($linkModel->{$type1} as $assoc1 => $assocData1) {
  1165. $deepModel = $linkModel->{$assoc1};
  1166. if ($type1 === 'belongsTo' || ($deepModel->alias === $modelAlias && $type === 'belongsTo') || ($deepModel->alias !== $modelAlias)) {
  1167. $tmpStack = $stack;
  1168. $tmpStack[] = $assoc1;
  1169. if ($linkModel->useDbConfig == $deepModel->useDbConfig) {
  1170. $db = $this;
  1171. } else {
  1172. $db = ConnectionManager::getDataSource($deepModel->useDbConfig);
  1173. }
  1174. $db->queryAssociation($linkModel, $deepModel, $type1, $assoc1, $assocData1, $queryData, true, $fetch, $recursive - 1, $tmpStack);
  1175. }
  1176. }
  1177. }
  1178. }
  1179. if ($type === 'hasAndBelongsToMany') {
  1180. $merge = array();
  1181. foreach ($fetch as $data) {
  1182. if (isset($data[$with]) && $data[$with][$foreignKey] === $row[$modelAlias][$modelPK]) {
  1183. if ($habtmFieldsCount <= 2) {
  1184. unset($data[$with]);
  1185. }
  1186. $merge[] = $data;
  1187. }
  1188. }
  1189. if (empty($merge) && !isset($row[$association])) {
  1190. $row[$association] = $merge;
  1191. } else {
  1192. $this->_mergeAssociation($row, $merge, $association, $type);
  1193. }
  1194. } else {
  1195. $this->_mergeAssociation($row, $fetch, $association, $type, $selfJoin);
  1196. }
  1197. if (isset($row[$association])) {
  1198. $row[$association] = $linkModel->afterFind($row[$association], false);
  1199. }
  1200. } else {
  1201. $tempArray[0][$association] = false;
  1202. $this->_mergeAssociation($row, $tempArray, $association, $type, $selfJoin);
  1203. }
  1204. }
  1205. }
  1206. }
  1207. /**
  1208. * A more efficient way to fetch associations. Woohoo!
  1209. *
  1210. * @param Model $model Primary model object
  1211. * @param string $query Association query
  1212. * @param array $ids Array of IDs of associated records
  1213. * @return array Association results
  1214. */
  1215. public function fetchAssociated(Model $model, $query, $ids) {
  1216. $query = str_replace('{$__cakeID__$}', implode(', ', $ids), $query);
  1217. if (count($ids) > 1) {
  1218. $query = str_replace('= (', 'IN (', $query);
  1219. }
  1220. return $this->fetchAll($query, $model->cacheQueries);
  1221. }
  1222. /**
  1223. * mergeHasMany - Merge the results of hasMany relations.
  1224. *
  1225. *
  1226. * @param array $resultSet Data to merge into
  1227. * @param array $merge Data to merge
  1228. * @param string $association Name of Model being Merged
  1229. * @param Model $model Model being merged onto
  1230. * @param Model $linkModel Model being merged
  1231. * @return void
  1232. */
  1233. protected function _mergeHasMany(&$resultSet, $merge, $association, $model, $linkModel) {
  1234. $modelAlias = $model->alias;
  1235. $modelPK = $model->primaryKey;
  1236. $modelFK = $model->hasMany[$association]['foreignKey'];
  1237. foreach ($resultSet as &$result) {
  1238. if (!isset($result[$modelAlias])) {
  1239. continue;
  1240. }
  1241. $merged = array();
  1242. foreach ($merge as $data) {
  1243. if ($result[$modelAlias][$modelPK] === $data[$association][$modelFK]) {
  1244. if (count($data) > 1) {
  1245. $data = array_merge($data[$association], $data);
  1246. unset($data[$association]);
  1247. foreach ($data as $key => $name) {
  1248. if (is_numeric($key)) {
  1249. $data[$association][] = $name;
  1250. unset($data[$key]);
  1251. }
  1252. }
  1253. $merged[] = $data;
  1254. } else {
  1255. $merged[] = $data[$association];
  1256. }
  1257. }
  1258. }
  1259. $result = Hash::mergeDiff($result, array($association => $merged));
  1260. }
  1261. }
  1262. /**
  1263. * Merge association of merge into data
  1264. *
  1265. * @param array $data
  1266. * @param array $merge
  1267. * @param string $association
  1268. * @param string $type
  1269. * @param boolean $selfJoin
  1270. * @return void
  1271. */
  1272. protected function _mergeAssociation(&$data, &$merge, $association, $type, $selfJoin = false) {
  1273. if (isset($merge[0]) && !isset($merge[0][$association])) {
  1274. $association = Inflector::pluralize($association);
  1275. }
  1276. if ($type === 'belongsTo' || $type === 'hasOne') {
  1277. if (isset($merge[$association])) {
  1278. $data[$association] = $merge[$association][0];
  1279. } else {
  1280. if (count($merge[0][$association]) > 1) {
  1281. foreach ($merge[0] as $assoc => $data2) {
  1282. if ($assoc !== $association) {
  1283. $merge[0][$association][$assoc] = $data2;
  1284. }
  1285. }
  1286. }
  1287. if (!isset($data[$association])) {
  1288. if ($merge[0][$association] != null) {
  1289. $data[$association] = $merge[0][$association];
  1290. } else {
  1291. $data[$association] = array();
  1292. }
  1293. } else {
  1294. if (is_array($merge[0][$association])) {
  1295. foreach ($data[$association] as $k => $v) {
  1296. if (!is_array($v)) {
  1297. $dataAssocTmp[$k] = $v;
  1298. }
  1299. }
  1300. foreach ($merge[0][$association] as $k => $v) {
  1301. if (!is_array($v)) {
  1302. $mergeAssocTmp[$k] = $v;
  1303. }
  1304. }
  1305. $dataKeys = array_keys($data);
  1306. $mergeKeys = array_keys($merge[0]);
  1307. if ($mergeKeys[0] === $dataKeys[0] || $mergeKeys === $dataKeys) {
  1308. $data[$association][$association] = $merge[0][$association];
  1309. } else {
  1310. $diff = Hash::diff($dataAssocTmp, $mergeAssocTmp);
  1311. $data[$association] = array_merge($merge[0][$association], $diff);
  1312. }
  1313. } elseif ($selfJoin && array_key_exists($association, $merge[0])) {
  1314. $data[$association] = array_merge($data[$association], array($association => array()));
  1315. }
  1316. }
  1317. }
  1318. } else {
  1319. if (isset($merge[0][$association]) && $merge[0][$association] === false) {
  1320. if (!isset($data[$association])) {
  1321. $data[$association] = array();
  1322. }
  1323. } else {
  1324. foreach ($merge as $row) {
  1325. $insert = array();
  1326. if (count($row) === 1) {
  1327. $insert = $row[$association];
  1328. } elseif (isset($row[$association])) {
  1329. $insert = array_merge($row[$association], $row);
  1330. unset($insert[$association]);
  1331. }
  1332. if (empty($data[$association]) || (isset($data[$association]) && !in_array($insert, $data[$association], true))) {
  1333. $data[$association][] = $insert;
  1334. }
  1335. }
  1336. }
  1337. }
  1338. }
  1339. /**
  1340. * Generates an array representing a query or part of a query from a single model or two associated models
  1341. *
  1342. * @param Model $model
  1343. * @param Model $linkModel
  1344. * @param string $type
  1345. * @param string $association
  1346. * @param array $assocData
  1347. * @param array $queryData
  1348. * @param boolean $external
  1349. * @param array $resultSet
  1350. * @return mixed
  1351. */
  1352. public function generateAssociationQuery(Model $model, $linkModel, $type, $association, $assocData, &$queryData, $external, &$resultSet) {
  1353. $queryData = $this->_scrubQueryData($queryData);
  1354. $assocData = $this->_scrubQueryData($assocData);
  1355. $modelAlias = $model->alias;
  1356. if (empty($queryData['fields'])) {
  1357. $queryData['fields'] = $this->fields($model, $modelAlias);
  1358. } elseif (!empty($model->hasMany) && $model->recursive > -1) {
  1359. $assocFields = $this->fields($model, $modelAlias, array("{$modelAlias}.{$model->primaryKey}"));
  1360. $passedFields = $queryData['fields'];
  1361. if (count($passedFields) === 1) {
  1362. if (strpos($passedFields[0], $assocFields[0]) === false && !preg_match('/^[a-z]+\(/i', $passedFields[0])) {
  1363. $queryData['fields'] = array_merge($passedFields, $assocFields);
  1364. } else {
  1365. $queryData['fields'] = $passedFields;
  1366. }
  1367. } else {
  1368. $queryData['fields'] = array_merge($passedFields, $assocFields);
  1369. }
  1370. unset($assocFields, $passedFields);
  1371. }
  1372. if ($linkModel === null) {
  1373. return $this->buildStatement(
  1374. array(
  1375. 'fields' => array_unique($queryData['fields']),
  1376. 'table' => $this->fullTableName($model),
  1377. 'alias' => $modelAlias,
  1378. 'limit' => $queryData['limit'],
  1379. 'offset' => $queryData['offset'],
  1380. 'joins' => $queryData['joins'],
  1381. 'conditions' => $queryData['conditions'],
  1382. 'order' => $queryData['order'],
  1383. 'group' => $queryData['group']
  1384. ),
  1385. $model
  1386. );
  1387. }
  1388. if ($external && !empty($assocData['finderQuery'])) {
  1389. return $assocData['finderQuery'];
  1390. }
  1391. $self = $model->name === $linkModel->name;
  1392. $fields = array();
  1393. if ($external || (in_array($type, array('hasOne', 'belongsTo')) && $assocData['fields'] !== false)) {
  1394. $fields = $this->fields($linkModel, $association, $assocData['fields']);
  1395. }
  1396. if (empty($assocData['offset']) && !empty($assocData['page'])) {
  1397. $assocData['offset'] = ($assocData['page'] - 1) * $assocData['limit'];
  1398. }
  1399. $assocData['limit'] = $this->limit($assocData['limit'], $assocData['offset']);
  1400. switch ($type) {
  1401. case 'hasOne':
  1402. case 'belongsTo':
  1403. $conditions = $this->_mergeConditions(
  1404. $assocData['conditions'],
  1405. $this->getConstraint($type, $model, $linkModel, $association, array_merge($assocData, compact('external', 'self')))
  1406. );
  1407. if (!$self && $external) {
  1408. foreach ($conditions as $key => $condition) {
  1409. if (is_numeric($key) && strpos($condition, $modelAlias . '.') !== false) {
  1410. unset($conditions[$key]);
  1411. }
  1412. }
  1413. }
  1414. if ($external) {
  1415. $query = array_merge($assocData, array(
  1416. 'conditions' => $conditions,
  1417. 'table' => $this->fullTableName($linkModel),
  1418. 'fields' => $fields,
  1419. 'alias' => $association,
  1420. 'group' => null
  1421. ));
  1422. $query += array('order' => $assocData['order'], 'limit' => $assocData['limit']);
  1423. } else {
  1424. $join = array(
  1425. 'table' => $linkModel,
  1426. 'alias' => $association,
  1427. 'type' => isset($assocData['type']) ? $assocData['type'] : 'LEFT',
  1428. 'conditions' => trim($this->conditions($conditions, true, false, $model))
  1429. );
  1430. $queryData['fields'] = array_merge($queryData['fields'], $fields);
  1431. if (!empty($assocData['order'])) {
  1432. $queryData['order'][] = $assocData['order'];
  1433. }
  1434. if (!in_array($join, $queryData['joins'])) {
  1435. $queryData['joins'][] = $join;
  1436. }
  1437. return true;
  1438. }
  1439. break;
  1440. case 'hasMany':
  1441. $assocData['fields'] = $this->fields($linkModel, $association, $assocData['fields']);
  1442. if (!empty($assocData['foreignKey'])) {
  1443. $assocData['fields'] = array_merge($assocData['fields'], $this->fields($linkModel, $association, array("{$association}.{$assocData['foreignKey']}")));
  1444. }
  1445. $query = array(
  1446. 'conditions' => $this->_mergeConditions($this->getConstraint('hasMany', $model, $linkModel, $association, $assocData), $assocData['conditions']),
  1447. 'fields' => array_unique($assocData['fields']),
  1448. 'table' => $this->fullTableName($linkModel),
  1449. 'alias' => $association,
  1450. 'order' => $assocData['order'],
  1451. 'limit' => $assocData['limit'],
  1452. 'group' => null
  1453. );
  1454. break;
  1455. case 'hasAndBelongsToMany':
  1456. $joinFields = array();
  1457. $joinAssoc = null;
  1458. if (isset($assocData['with']) && !empty($assocData['with'])) {
  1459. $joinKeys = array($assocData['foreignKey'], $assocData['associationForeignKey']);
  1460. list($with, $joinFields) = $model->joinModel($assocData['with'], $joinKeys);
  1461. $joinTbl = $model->{$with};
  1462. $joinAlias = $joinTbl;
  1463. if (is_array($joinFields) && !empty($joinFields)) {
  1464. $joinAssoc = $joinAlias = $model->{$with}->alias;
  1465. $joinFields = $this->fields($model->{$with}, $joinAlias, $joinFields);
  1466. } else {
  1467. $joinFields = array();
  1468. }
  1469. } else {
  1470. $joinTbl = $assocData['joinTable'];
  1471. $joinAlias = $this->fullTableName($assocData['joinTable']);
  1472. }
  1473. $query = array(
  1474. 'conditions' => $assocData['conditions'],
  1475. 'limit' => $assocData['limit'],
  1476. 'table' => $this->fullTableName($linkModel),
  1477. 'alias' => $association,
  1478. 'fields' => array_merge($this->fields($linkModel, $association, $assocData['fields']), $joinFields),
  1479. 'order' => $assocData['order'],
  1480. 'group' => null,
  1481. 'joins' => array(array(
  1482. 'table' => $joinTbl,
  1483. 'alias' => $joinAssoc,
  1484. 'conditions' => $this->getConstraint('hasAndBelongsToMany', $model, $linkModel, $joinAlias, $assocData, $association)
  1485. ))
  1486. );
  1487. break;
  1488. }
  1489. if (isset($query)) {
  1490. return $this->buildStatement($query, $model);
  1491. }
  1492. return null;
  1493. }
  1494. /**
  1495. * Returns a conditions array for the constraint between two models
  1496. *
  1497. * @param string $type Association type
  1498. * @param Model $model Model object
  1499. * @param string $linkModel
  1500. * @param string $alias
  1501. * @param array $assoc
  1502. * @param string $alias2
  1503. * @return array Conditions array defining the constraint between $model and $association
  1504. */
  1505. public function getConstraint($type, $model, $linkModel, $alias, $assoc, $alias2 = null) {
  1506. $assoc += array('external' => false, 'self' => false);
  1507. if (empty($assoc['foreignKey'])) {
  1508. return array();
  1509. }
  1510. switch (true) {
  1511. case ($assoc['external'] && $type === 'hasOne'):
  1512. return array("{$alias}.{$assoc['foreignKey']}" => '{$__cakeID__$}');
  1513. case ($assoc['external'] && $type === 'belongsTo'):
  1514. return array("{$alias}.{$linkModel->primaryKey}" => '{$__cakeForeignKey__$}');
  1515. case (!$assoc['external'] && $type === 'hasOne'):
  1516. return array("{$alias}.{$assoc['foreignKey']}" => $this->identifier("{$model->alias}.{$model->primaryKey}"));
  1517. case (!$assoc['external'] && $type === 'belongsTo'):
  1518. return array("{$model->alias}.{$assoc['foreignKey']}" => $this->identifier("{$alias}.{$linkModel->primaryKey}"));
  1519. case ($type === 'hasMany'):
  1520. return array("{$alias}.{$assoc['foreignKey']}" => array('{$__cakeID__$}'));
  1521. case ($type === 'hasAndBelongsToMany'):
  1522. return array(
  1523. array("{$alias}.{$assoc['foreignKey']}" => '{$__cakeID__$}'),
  1524. array("{$alias}.{$assoc['associationForeignKey']}" => $this->identifier("{$alias2}.{$linkModel->primaryKey}"))
  1525. );
  1526. }
  1527. return array();
  1528. }
  1529. /**
  1530. * Builds and generates a JOIN statement from an array. Handles final clean-up before conversion.
  1531. *
  1532. * @param array $join An array defining a JOIN statement in a query
  1533. * @return string An SQL JOIN statement to be used in a query
  1534. * @see DboSource::renderJoinStatement()
  1535. * @see DboSource::buildStatement()
  1536. */
  1537. public function buildJoinStatement($join) {
  1538. $data = array_merge(array(
  1539. 'type' => null,
  1540. 'alias' => null,
  1541. 'table' => 'join_table',
  1542. 'conditions' => array()
  1543. ), $join);
  1544. if (!empty($data['alias'])) {
  1545. $data['alias'] = $this->alias . $this->name($data['alias']);
  1546. }
  1547. if (!empty($data['conditions'])) {
  1548. $data['conditions'] = trim($this->conditions($data['conditions'], true, false));
  1549. }
  1550. if (!empty($data['table'])) {
  1551. $schema = !(is_string($data['table']) && strpos($data['table'], '(') === 0);
  1552. $data['table'] = $this->fullTableName($data['table'], true, $schema);
  1553. }
  1554. return $this->renderJoinStatement($data);
  1555. }
  1556. /**
  1557. * Builds and generates an SQL statement from an array. Handles final clean-up before conversion.
  1558. *
  1559. * @param array $query An array defining an SQL query
  1560. * @param Model $model The model object which initiated the query
  1561. * @return string An executable SQL statement
  1562. * @see DboSource::renderStatement()
  1563. */
  1564. public function buildStatement($query, $model) {
  1565. $query = array_merge($this->_queryDefaults, $query);
  1566. if (!empty($query['joins'])) {
  1567. $count = count($query['joins']);
  1568. for ($i = 0; $i < $count; $i++) {
  1569. if (is_array($query['joins'][$i])) {
  1570. $query['joins'][$i] = $this->buildJoinStatement($query['joins'][$i]);
  1571. }
  1572. }
  1573. }
  1574. return $this->renderStatement('select', array(
  1575. 'conditions' => $this->conditions($query['conditions'], true, true, $model),
  1576. 'fields' => implode(', ', $query['fields']),
  1577. 'table' => $query['table'],
  1578. 'alias' => $this->alias . $this->name($query['alias']),
  1579. 'order' => $this->order($query['order'], 'ASC', $model),
  1580. 'limit' => $this->limit($query['limit'], $query['offset']),
  1581. 'joins' => implode(' ', $query['joins']),
  1582. 'group' => $this->group($query['group'], $model)
  1583. ));
  1584. }
  1585. /**
  1586. * Renders a final SQL JOIN statement
  1587. *
  1588. * @param array $data
  1589. * @return string
  1590. */
  1591. public function renderJoinStatement($data) {
  1592. extract($data);
  1593. return trim("{$type} JOIN {$table} {$alias} ON ({$conditions})");
  1594. }
  1595. /**
  1596. * Renders a final SQL statement by putting together the component parts in the correct order
  1597. *
  1598. * @param string $type type of query being run. e.g select, create, update, delete, schema, alter.
  1599. * @param array $data Array of data to insert into the query.
  1600. * @return string Rendered SQL expression to be run.
  1601. */
  1602. public function renderStatement($type, $data) {
  1603. extract($data);
  1604. $aliases = null;
  1605. switch (strtolower($type)) {
  1606. case 'select':
  1607. return "SELECT {$fields} FROM {$table} {$alias} {$joins} {$conditions} {$group} {$order} {$limit}";
  1608. case 'create':
  1609. return "INSERT INTO {$table} ({$fields}) VALUES ({$values})";
  1610. case 'update':
  1611. if (!empty($alias)) {
  1612. $aliases = "{$this->alias}{$alias} {$joins} ";
  1613. }
  1614. return "UPDATE {$table} {$aliases}SET {$fields} {$conditions}";
  1615. case 'delete':
  1616. if (!empty($alias)) {
  1617. $aliases = "{$this->alias}{$alias} {$joins} ";
  1618. }
  1619. return "DELETE {$alias} FROM {$table} {$aliases}{$conditions}";
  1620. case 'schema':
  1621. foreach (array('columns', 'indexes', 'tableParameters') as $var) {
  1622. if (is_array(${$var})) {
  1623. ${$var} = "\t" . join(",\n\t", array_filter(${$var}));
  1624. } else {
  1625. ${$var} = '';
  1626. }
  1627. }
  1628. if (trim($indexes) !== '') {
  1629. $columns .= ',';
  1630. }
  1631. return "CREATE TABLE {$table} (\n{$columns}{$indexes}) {$tableParameters};";
  1632. case 'alter':
  1633. return;
  1634. }
  1635. }
  1636. /**
  1637. * Merges a mixed set of string/array conditions
  1638. *
  1639. * @param mixed $query
  1640. * @param mixed $assoc
  1641. * @return array
  1642. */
  1643. protected function _mergeConditions($query, $assoc) {
  1644. if (empty($assoc)) {
  1645. return $query;
  1646. }
  1647. if (is_array($query)) {
  1648. return array_merge((array)$assoc, $query);
  1649. }
  1650. if (!empty($query)) {
  1651. $query = array($query);
  1652. if (is_array($assoc)) {
  1653. $query = array_merge($query, $assoc);
  1654. } else {
  1655. $query[] = $assoc;
  1656. }
  1657. return $query;
  1658. }
  1659. return $assoc;
  1660. }
  1661. /**
  1662. * Generates and executes an SQL UPDATE statement for given model, fields, and values.
  1663. * For databases that do not support aliases in UPDATE queries.
  1664. *
  1665. * @param Model $model
  1666. * @param array $fields
  1667. * @param array $values
  1668. * @param mixed $conditions
  1669. * @return boolean Success
  1670. */
  1671. public function update(Model $model, $fields = array(), $values = null, $conditions = null) {
  1672. if ($values == null) {
  1673. $combined = $fields;
  1674. } else {
  1675. $combined = array_combine($fields, $values);
  1676. }
  1677. $fields = implode(', ', $this->_prepareUpdateFields($model, $combined, empty($conditions)));
  1678. $alias = $joins = null;
  1679. $table = $this->fullTableName($model);
  1680. $conditions = $this->_matchRecords($model, $conditions);
  1681. if ($conditions === false) {
  1682. return false;
  1683. }
  1684. $query = compact('table', 'alias', 'joins', 'fields', 'conditions');
  1685. if (!$this->execute($this->renderStatement('update', $query))) {
  1686. $model->onError();
  1687. return false;
  1688. }
  1689. return true;
  1690. }
  1691. /**
  1692. * Quotes and prepares fields and values for an SQL UPDATE statement
  1693. *
  1694. * @param Model $model
  1695. * @param array $fields
  1696. * @param boolean $quoteValues If values should be quoted, or treated as SQL snippets
  1697. * @param boolean $alias Include the model alias in the field name
  1698. * @return array Fields and values, quoted and prepared
  1699. */
  1700. protected function _prepareUpdateFields(Model $model, $fields, $quoteValues = true, $alias = false) {
  1701. $quotedAlias = $this->startQuote . $model->alias . $this->endQuote;
  1702. $updates = array();
  1703. foreach ($fields as $field => $value) {
  1704. if ($alias && strpos($field, '.') === false) {
  1705. $quoted = $model->escapeField($field);
  1706. } elseif (!$alias && strpos($field, '.') !== false) {
  1707. $quoted = $this->name(str_replace($quotedAlias . '.', '', str_replace(
  1708. $model->alias . '.', '', $field
  1709. )));
  1710. } else {
  1711. $quoted = $this->name($field);
  1712. }
  1713. if ($value === null) {
  1714. $updates[] = $quoted . ' = NULL';
  1715. continue;
  1716. }
  1717. $update = $quoted . ' = ';
  1718. if ($quoteValues) {
  1719. $update .= $this->value($value, $model->getColumnType($field));
  1720. } elseif ($model->getColumnType($field) == 'boolean' && (is_int($value) || is_bool($value))) {
  1721. $update .= $this->boolean($value, true);
  1722. } elseif (!$alias) {
  1723. $update .= str_replace($quotedAlias . '.', '', str_replace(
  1724. $model->alias . '.', '', $value
  1725. ));
  1726. } else {
  1727. $update .= $value;
  1728. }
  1729. $updates[] = $update;
  1730. }
  1731. return $updates;
  1732. }
  1733. /**
  1734. * Generates and executes an SQL DELETE statement.
  1735. * For databases that do not support aliases in UPDATE queries.
  1736. *
  1737. * @param Model $model
  1738. * @param mixed $conditions
  1739. * @return boolean Success
  1740. */
  1741. public function delete(Model $model, $conditions = null) {
  1742. $alias = $joins = null;
  1743. $table = $this->fullTableName($model);
  1744. $conditions = $this->_matchRecords($model, $conditions);
  1745. if ($conditions === false) {
  1746. return false;
  1747. }
  1748. if ($this->execute($this->renderStatement('delete', compact('alias', 'table', 'joins', 'conditions'))) === false) {
  1749. $model->onError();
  1750. return false;
  1751. }
  1752. return true;
  1753. }
  1754. /**
  1755. * Gets a list of record IDs for the given conditions. Used for multi-record updates and deletes
  1756. * in databases that do not support aliases in UPDATE/DELETE queries.
  1757. *
  1758. * @param Model $model
  1759. * @param mixed $conditions
  1760. * @return array List of record IDs
  1761. */
  1762. protected function _matchRecords(Model $model, $conditions = null) {
  1763. if ($conditions === true) {
  1764. $conditions = $this->conditions(true);
  1765. } elseif ($conditions === null) {
  1766. $conditions = $this->conditions($this->defaultConditions($model, $conditions, false), true, true, $model);
  1767. } else {
  1768. $noJoin = true;
  1769. foreach ($conditions as $field => $value) {
  1770. $originalField = $field;
  1771. if (strpos($field, '.') !== false) {
  1772. list($alias, $field) = explode('.', $field);
  1773. $field = ltrim($field, $this->startQuote);
  1774. $field = rtrim($field, $this->endQuote);
  1775. }
  1776. if (!$model->hasField($field)) {
  1777. $noJoin = false;
  1778. break;
  1779. }
  1780. if ($field !== $originalField) {
  1781. $conditions[$field] = $value;
  1782. unset($conditions[$originalField]);
  1783. }
  1784. }
  1785. if ($noJoin === true) {
  1786. return $this->conditions($conditions);
  1787. }
  1788. $idList = $model->find('all', array(
  1789. 'fields' => "{$model->alias}.{$model->primaryKey}",
  1790. 'conditions' => $conditions
  1791. ));
  1792. if (empty($idList)) {
  1793. return false;
  1794. }
  1795. $conditions = $this->conditions(array(
  1796. $model->primaryKey => Hash::extract($idList, "{n}.{$model->alias}.{$model->primaryKey}")
  1797. ));
  1798. }
  1799. return $conditions;
  1800. }
  1801. /**
  1802. * Returns an array of SQL JOIN fragments from a model's associations
  1803. *
  1804. * @param Model $model
  1805. * @return array
  1806. */
  1807. protected function _getJoins(Model $model) {
  1808. $join = array();
  1809. $joins = array_merge($model->getAssociated('hasOne'), $model->getAssociated('belongsTo'));
  1810. foreach ($joins as $assoc) {
  1811. if (isset($model->{$assoc}) && $model->useDbConfig == $model->{$assoc}->useDbConfig && $model->{$assoc}->getDataSource()) {
  1812. $assocData = $model->getAssociated($assoc);
  1813. $join[] = $this->buildJoinStatement(array(
  1814. 'table' => $model->{$assoc},
  1815. 'alias' => $assoc,
  1816. 'type' => isset($assocData['type']) ? $assocData['type'] : 'LEFT',
  1817. 'conditions' => trim($this->conditions(
  1818. $this->_mergeConditions($assocData['conditions'], $this->getConstraint($assocData['association'], $model, $model->{$assoc}, $assoc, $assocData)),
  1819. true, false, $model
  1820. ))
  1821. ));
  1822. }
  1823. }
  1824. return $join;
  1825. }
  1826. /**
  1827. * Returns an SQL calculation, i.e. COUNT() or MAX()
  1828. *
  1829. * @param Model $model
  1830. * @param string $func Lowercase name of SQL function, i.e. 'count' or 'max'
  1831. * @param array $params Function parameters (any values must be quoted manually)
  1832. * @return string An SQL calculation function
  1833. */
  1834. public function calculate(Model $model, $func, $params = array()) {
  1835. $params = (array)$params;
  1836. switch (strtolower($func)) {
  1837. case 'count':
  1838. if (!isset($params[0])) {
  1839. $params[0] = '*';
  1840. }
  1841. if (!isset($params[1])) {
  1842. $params[1] = 'count';
  1843. }
  1844. if (is_object($model) && $model->isVirtualField($params[0])) {
  1845. $arg = $this->_quoteFields($model->getVirtualField($params[0]));
  1846. } else {
  1847. $arg = $this->name($params[0]);
  1848. }
  1849. return 'COUNT(' . $arg . ') AS ' . $this->name($params[1]);
  1850. case 'max':
  1851. case 'min':
  1852. if (!isset($params[1])) {
  1853. $params[1] = $params[0];
  1854. }
  1855. if (is_object($model) && $model->isVirtualField($params[0])) {
  1856. $arg = $this->_quoteFields($model->getVirtualField($params[0]));
  1857. } else {
  1858. $arg = $this->name($params[0]);
  1859. }
  1860. return strtoupper($func) . '(' . $arg . ') AS ' . $this->name($params[1]);
  1861. }
  1862. }
  1863. /**
  1864. * Deletes all the records in a table and resets the count of the auto-incrementing
  1865. * primary key, where applicable.
  1866. *
  1867. * @param Model|string $table A string or model class representing the table to be truncated
  1868. * @return boolean SQL TRUNCATE TABLE statement, false if not applicable.
  1869. */
  1870. public function truncate($table) {
  1871. return $this->execute('TRUNCATE TABLE ' . $this->fullTableName($table));
  1872. }
  1873. /**
  1874. * Check if the server support nested transactions
  1875. *
  1876. * @return boolean
  1877. */
  1878. public function nestedTransactionSupported() {
  1879. return false;
  1880. }
  1881. /**
  1882. * Begin a transaction
  1883. *
  1884. * @return boolean True on success, false on fail
  1885. * (i.e. if the database/model does not support transactions,
  1886. * or a transaction has not started).
  1887. */
  1888. public function begin() {
  1889. if ($this->_transactionStarted) {
  1890. if ($this->nestedTransactionSupported()) {
  1891. return $this->_beginNested();
  1892. }
  1893. $this->_transactionNesting++;
  1894. return $this->_transactionStarted;
  1895. }
  1896. $this->_transactionNesting = 0;
  1897. if ($this->fullDebug) {
  1898. $this->logQuery('BEGIN');
  1899. }
  1900. return $this->_transactionStarted = $this->_connection->beginTransaction();
  1901. }
  1902. /**
  1903. * Begin a nested transaction
  1904. *
  1905. * @return boolean
  1906. */
  1907. protected function _beginNested() {
  1908. $query = 'SAVEPOINT LEVEL' . ++$this->_transactionNesting;
  1909. if ($this->fullDebug) {
  1910. $this->logQuery($query);
  1911. }
  1912. $this->_connection->exec($query);
  1913. return true;
  1914. }
  1915. /**
  1916. * Commit a transaction
  1917. *
  1918. * @return boolean True on success, false on fail
  1919. * (i.e. if the database/model does not support transactions,
  1920. * or a transaction has not started).
  1921. */
  1922. public function commit() {
  1923. if (!$this->_transactionStarted) {
  1924. return false;
  1925. }
  1926. if ($this->_transactionNesting === 0) {
  1927. if ($this->fullDebug) {
  1928. $this->logQuery('COMMIT');
  1929. }
  1930. $this->_transactionStarted = false;
  1931. return $this->_connection->commit();
  1932. }
  1933. if ($this->nestedTransactionSupported()) {
  1934. return $this->_commitNested();
  1935. }
  1936. $this->_transactionNesting--;
  1937. return true;
  1938. }
  1939. /**
  1940. * Commit a nested transaction
  1941. *
  1942. * @return boolean
  1943. */
  1944. protected function _commitNested() {
  1945. $query = 'RELEASE SAVEPOINT LEVEL' . $this->_transactionNesting--;
  1946. if ($this->fullDebug) {
  1947. $this->logQuery($query);
  1948. }
  1949. $this->_connection->exec($query);
  1950. return true;
  1951. }
  1952. /**
  1953. * Rollback a transaction
  1954. *
  1955. * @return boolean True on success, false on fail
  1956. * (i.e. if the database/model does not support transactions,
  1957. * or a transaction has not started).
  1958. */
  1959. public function rollback() {
  1960. if (!$this->_transactionStarted) {
  1961. return false;
  1962. }
  1963. if ($this->_transactionNesting === 0) {
  1964. if ($this->fullDebug) {
  1965. $this->logQuery('ROLLBACK');
  1966. }
  1967. $this->_transactionStarted = false;
  1968. return $this->_connection->rollBack();
  1969. }
  1970. if ($this->nestedTransactionSupported()) {
  1971. return $this->_rollbackNested();
  1972. }
  1973. $this->_transactionNesting--;
  1974. return true;
  1975. }
  1976. /**
  1977. * Rollback a nested transaction
  1978. *
  1979. * @return boolean
  1980. */
  1981. protected function _rollbackNested() {
  1982. $query = 'ROLLBACK TO SAVEPOINT LEVEL' . $this->_transactionNesting--;
  1983. if ($this->fullDebug) {
  1984. $this->logQuery($query);
  1985. }
  1986. $this->_connection->exec($query);
  1987. return true;
  1988. }
  1989. /**
  1990. * Returns the ID generated from the previous INSERT operation.
  1991. *
  1992. * @param mixed $source
  1993. * @return mixed
  1994. */
  1995. public function lastInsertId($source = null) {
  1996. return $this->_connection->lastInsertId();
  1997. }
  1998. /**
  1999. * Creates a default set of conditions from the model if $conditions is null/empty.
  2000. * If conditions are supplied then they will be returned. If a model doesn't exist and no conditions
  2001. * were provided either null or false will be returned based on what was input.
  2002. *
  2003. * @param Model $model
  2004. * @param string|array|boolean $conditions Array of conditions, conditions string, null or false. If an array of conditions,
  2005. * or string conditions those conditions will be returned. With other values the model's existence will be checked.
  2006. * If the model doesn't exist a null or false will be returned depending on the input value.
  2007. * @param boolean $useAlias Use model aliases rather than table names when generating conditions
  2008. * @return mixed Either null, false, $conditions or an array of default conditions to use.
  2009. * @see DboSource::update()
  2010. * @see DboSource::conditions()
  2011. */
  2012. public function defaultConditions(Model $model, $conditions, $useAlias = true) {
  2013. if (!empty($conditions)) {
  2014. return $conditions;
  2015. }
  2016. $exists = $model->exists();
  2017. if (!$exists && $conditions !== null) {
  2018. return false;
  2019. } elseif (!$exists) {
  2020. return null;
  2021. }
  2022. $alias = $model->alias;
  2023. if (!$useAlias) {
  2024. $alias = $this->fullTableName($model, false);
  2025. }
  2026. return array("{$alias}.{$model->primaryKey}" => $model->getID());
  2027. }
  2028. /**
  2029. * Returns a key formatted like a string Model.fieldname(i.e. Post.title, or Country.name)
  2030. *
  2031. * @param Model $model
  2032. * @param string $key
  2033. * @param string $assoc
  2034. * @return string
  2035. */
  2036. public function resolveKey(Model $model, $key, $assoc = null) {
  2037. if (strpos('.', $key) !== false) {
  2038. return $this->name($model->alias) . '.' . $this->name($key);
  2039. }
  2040. return $key;
  2041. }
  2042. /**
  2043. * Private helper method to remove query metadata in given data array.
  2044. *
  2045. * @param array $data
  2046. * @return array
  2047. */
  2048. protected function _scrubQueryData($data) {
  2049. static $base = null;
  2050. if ($base === null) {
  2051. $base = array_fill_keys(array('conditions', 'fields', 'joins', 'order', 'limit', 'offset', 'group'), array());
  2052. $base['callbacks'] = null;
  2053. }
  2054. return (array)$data + $base;
  2055. }
  2056. /**
  2057. * Converts model virtual fields into sql expressions to be fetched later
  2058. *
  2059. * @param Model $model
  2060. * @param string $alias Alias table name
  2061. * @param array $fields virtual fields to be used on query
  2062. * @return array
  2063. */
  2064. protected function _constructVirtualFields(Model $model, $alias, $fields) {
  2065. $virtual = array();
  2066. foreach ($fields as $field) {
  2067. $virtualField = $this->name($alias . $this->virtualFieldSeparator . $field);
  2068. $expression = $this->_quoteFields($model->getVirtualField($field));
  2069. $virtual[] = '(' . $expression . ") {$this->alias} {$virtualField}";
  2070. }
  2071. return $virtual;
  2072. }
  2073. /**
  2074. * Generates the fields list of an SQL query.
  2075. *
  2076. * @param Model $model
  2077. * @param string $alias Alias table name
  2078. * @param mixed $fields
  2079. * @param boolean $quote If false, returns fields array unquoted
  2080. * @return array
  2081. */
  2082. public function fields(Model $model, $alias = null, $fields = array(), $quote = true) {
  2083. if (empty($alias)) {
  2084. $alias = $model->alias;
  2085. }
  2086. $virtualFields = $model->getVirtualField();
  2087. $cacheKey = array(
  2088. $alias,
  2089. get_class($model),
  2090. $model->alias,
  2091. $virtualFields,
  2092. $fields,
  2093. $quote,
  2094. ConnectionManager::getSourceName($this)
  2095. );
  2096. $cacheKey = md5(serialize($cacheKey));
  2097. if ($return = $this->cacheMethod(__FUNCTION__, $cacheKey)) {
  2098. return $return;
  2099. }
  2100. $allFields = empty($fields);
  2101. if ($allFields) {
  2102. $fields = array_keys($model->schema());
  2103. } elseif (!is_array($fields)) {
  2104. $fields = String::tokenize($fields);
  2105. }
  2106. $fields = array_values(array_filter($fields));
  2107. $allFields = $allFields || in_array('*', $fields) || in_array($model->alias . '.*', $fields);
  2108. $virtual = array();
  2109. if (!empty($virtualFields)) {
  2110. $virtualKeys = array_keys($virtualFields);
  2111. foreach ($virtualKeys as $field) {
  2112. $virtualKeys[] = $model->alias . '.' . $field;
  2113. }
  2114. $virtual = ($allFields) ? $virtualKeys : array_intersect($virtualKeys, $fields);
  2115. foreach ($virtual as $i => $field) {
  2116. if (strpos($field, '.') !== false) {
  2117. $virtual[$i] = str_replace($model->alias . '.', '', $field);
  2118. }
  2119. $fields = array_diff($fields, array($field));
  2120. }
  2121. $fields = array_values($fields);
  2122. }
  2123. if (!$quote) {
  2124. if (!empty($virtual)) {
  2125. $fields = array_merge($fields, $this->_constructVirtualFields($model, $alias, $virtual));
  2126. }
  2127. return $fields;
  2128. }
  2129. $count = count($fields);
  2130. if ($count >= 1 && !in_array($fields[0], array('*', 'COUNT(*)'))) {
  2131. for ($i = 0; $i < $count; $i++) {
  2132. if (is_string($fields[$i]) && in_array($fields[$i], $virtual)) {
  2133. unset($fields[$i]);
  2134. continue;
  2135. }
  2136. if (is_object($fields[$i]) && isset($fields[$i]->type) && $fields[$i]->type === 'expression') {
  2137. $fields[$i] = $fields[$i]->value;
  2138. } elseif (preg_match('/^\(.*\)\s' . $this->alias . '.*/i', $fields[$i])) {
  2139. continue;
  2140. } elseif (!preg_match('/^.+\\(.*\\)/', $fields[$i])) {
  2141. $prepend = '';
  2142. if (strpos($fields[$i], 'DISTINCT') !== false) {
  2143. $prepend = 'DISTINCT ';
  2144. $fields[$i] = trim(str_replace('DISTINCT', '', $fields[$i]));
  2145. }
  2146. $dot = strpos($fields[$i], '.');
  2147. if ($dot === false) {
  2148. $prefix = !(
  2149. strpos($fields[$i], ' ') !== false ||
  2150. strpos($fields[$i], '(') !== false
  2151. );
  2152. $fields[$i] = $this->name(($prefix ? $alias . '.' : '') . $fields[$i]);
  2153. } else {
  2154. if (strpos($fields[$i], ',') === false) {
  2155. $build = explode('.', $fields[$i]);
  2156. if (!Hash::numeric($build)) {
  2157. $fields[$i] = $this->name(implode('.', $build));
  2158. }
  2159. }
  2160. }
  2161. $fields[$i] = $prepend . $fields[$i];
  2162. } elseif (preg_match('/\(([\.\w]+)\)/', $fields[$i], $field)) {
  2163. if (isset($field[1])) {
  2164. if (strpos($field[1], '.') === false) {
  2165. $field[1] = $this->name($alias . '.' . $field[1]);
  2166. } else {
  2167. $field[0] = explode('.', $field[1]);
  2168. if (!Hash::numeric($field[0])) {
  2169. $field[0] = implode('.', array_map(array(&$this, 'name'), $field[0]));
  2170. $fields[$i] = preg_replace('/\(' . $field[1] . '\)/', '(' . $field[0] . ')', $fields[$i], 1);
  2171. }
  2172. }
  2173. }
  2174. }
  2175. }
  2176. }
  2177. if (!empty($virtual)) {
  2178. $fields = array_merge($fields, $this->_constructVirtualFields($model, $alias, $virtual));
  2179. }
  2180. return $this->cacheMethod(__FUNCTION__, $cacheKey, array_unique($fields));
  2181. }
  2182. /**
  2183. * Creates a WHERE clause by parsing given conditions data. If an array or string
  2184. * conditions are provided those conditions will be parsed and quoted. If a boolean
  2185. * is given it will be integer cast as condition. Null will return 1 = 1.
  2186. *
  2187. * Results of this method are stored in a memory cache. This improves performance, but
  2188. * because the method uses a hashing algorithm it can have collisions.
  2189. * Setting DboSource::$cacheMethods to false will disable the memory cache.
  2190. *
  2191. * @param mixed $conditions Array or string of conditions, or any value.
  2192. * @param boolean $quoteValues If true, values should be quoted
  2193. * @param boolean $where If true, "WHERE " will be prepended to the return value
  2194. * @param Model $model A reference to the Model instance making the query
  2195. * @return string SQL fragment
  2196. */
  2197. public function conditions($conditions, $quoteValues = true, $where = true, $model = null) {
  2198. $clause = $out = '';
  2199. if ($where) {
  2200. $clause = ' WHERE ';
  2201. }
  2202. if (is_array($conditions) && !empty($conditions)) {
  2203. $out = $this->conditionKeysToString($conditions, $quoteValues, $model);
  2204. if (empty($out)) {
  2205. return $clause . ' 1 = 1';
  2206. }
  2207. return $clause . implode(' AND ', $out);
  2208. }
  2209. if (is_bool($conditions)) {
  2210. return $clause . (int)$conditions . ' = 1';
  2211. }
  2212. if (empty($conditions) || trim($conditions) === '') {
  2213. return $clause . '1 = 1';
  2214. }
  2215. $clauses = '/^WHERE\\x20|^GROUP\\x20BY\\x20|^HAVING\\x20|^ORDER\\x20BY\\x20/i';
  2216. if (preg_match($clauses, $conditions)) {
  2217. $clause = '';
  2218. }
  2219. $conditions = $this->_quoteFields($conditions);
  2220. return $clause . $conditions;
  2221. }
  2222. /**
  2223. * Creates a WHERE clause by parsing given conditions array. Used by DboSource::conditions().
  2224. *
  2225. * @param array $conditions Array or string of conditions
  2226. * @param boolean $quoteValues If true, values should be quoted
  2227. * @param Model $model A reference to the Model instance making the query
  2228. * @return string SQL fragment
  2229. */
  2230. public function conditionKeysToString($conditions, $quoteValues = true, $model = null) {
  2231. $out = array();
  2232. $data = $columnType = null;
  2233. $bool = array('and', 'or', 'not', 'and not', 'or not', 'xor', '||', '&&');
  2234. foreach ($conditions as $key => $value) {
  2235. $join = ' AND ';
  2236. $not = null;
  2237. if (is_array($value)) {
  2238. $valueInsert = (
  2239. !empty($value) &&
  2240. (substr_count($key, '?') === count($value) || substr_count($key, ':') === count($value))
  2241. );
  2242. }
  2243. if (is_numeric($key) && empty($value)) {
  2244. continue;
  2245. } elseif (is_numeric($key) && is_string($value)) {
  2246. $out[] = $not . $this->_quoteFields($value);
  2247. } elseif ((is_numeric($key) && is_array($value)) || in_array(strtolower(trim($key)), $bool)) {
  2248. if (in_array(strtolower(trim($key)), $bool)) {
  2249. $join = ' ' . strtoupper($key) . ' ';
  2250. } else {
  2251. $key = $join;
  2252. }
  2253. $value = $this->conditionKeysToString($value, $quoteValues, $model);
  2254. if (strpos($join, 'NOT') !== false) {
  2255. if (strtoupper(trim($key)) === 'NOT') {
  2256. $key = 'AND ' . trim($key);
  2257. }
  2258. $not = 'NOT ';
  2259. }
  2260. if (empty($value[1])) {
  2261. if ($not) {
  2262. $out[] = $not . '(' . $value[0] . ')';
  2263. } else {
  2264. $out[] = $value[0];
  2265. }
  2266. } else {
  2267. $out[] = '(' . $not . '(' . implode(') ' . strtoupper($key) . ' (', $value) . '))';
  2268. }
  2269. } else {
  2270. if (is_object($value) && isset($value->type)) {
  2271. if ($value->type === 'identifier') {
  2272. $data .= $this->name($key) . ' = ' . $this->name($value->value);
  2273. } elseif ($value->type === 'expression') {
  2274. if (is_numeric($key)) {
  2275. $data .= $value->value;
  2276. } else {
  2277. $data .= $this->name($key) . ' = ' . $value->value;
  2278. }
  2279. }
  2280. } elseif (is_array($value) && !empty($value) && !$valueInsert) {
  2281. $keys = array_keys($value);
  2282. if ($keys === array_values($keys)) {
  2283. $count = count($value);
  2284. if ($count === 1 && !preg_match("/\s+NOT$/", $key)) {
  2285. $data = $this->_quoteFields($key) . ' = (';
  2286. } else {
  2287. $data = $this->_quoteFields($key) . ' IN (';
  2288. }
  2289. if ($quoteValues) {
  2290. if (is_object($model)) {
  2291. $columnType = $model->getColumnType($key);
  2292. }
  2293. $data .= implode(', ', $this->value($value, $columnType));
  2294. }
  2295. $data .= ')';
  2296. } else {
  2297. $ret = $this->conditionKeysToString($value, $quoteValues, $model);
  2298. if (count($ret) > 1) {
  2299. $data = '(' . implode(') AND (', $ret) . ')';
  2300. } elseif (isset($ret[0])) {
  2301. $data = $ret[0];
  2302. }
  2303. }
  2304. } elseif (is_numeric($key) && !empty($value)) {
  2305. $data = $this->_quoteFields($value);
  2306. } else {
  2307. $data = $this->_parseKey($model, trim($key), $value);
  2308. }
  2309. if ($data != null) {
  2310. $out[] = $data;
  2311. $data = null;
  2312. }
  2313. }
  2314. }
  2315. return $out;
  2316. }
  2317. /**
  2318. * Extracts a Model.field identifier and an SQL condition operator from a string, formats
  2319. * and inserts values, and composes them into an SQL snippet.
  2320. *
  2321. * @param Model $model Model object initiating the query
  2322. * @param string $key An SQL key snippet containing a field and optional SQL operator
  2323. * @param mixed $value The value(s) to be inserted in the string
  2324. * @return string
  2325. */
  2326. protected function _parseKey($model, $key, $value) {
  2327. $operatorMatch = '/^(((' . implode(')|(', $this->_sqlOps);
  2328. $operatorMatch .= ')\\x20?)|<[>=]?(?![^>]+>)\\x20?|[>=!]{1,3}(?!<)\\x20?)/is';
  2329. $bound = (strpos($key, '?') !== false || (is_array($value) && strpos($key, ':') !== false));
  2330. if (strpos($key, ' ') === false) {
  2331. $operator = '=';
  2332. } else {
  2333. list($key, $operator) = explode(' ', trim($key), 2);
  2334. if (!preg_match($operatorMatch, trim($operator)) && strpos($operator, ' ') !== false) {
  2335. $key = $key . ' ' . $operator;
  2336. $split = strrpos($key, ' ');
  2337. $operator = substr($key, $split);
  2338. $key = substr($key, 0, $split);
  2339. }
  2340. }
  2341. $virtual = false;
  2342. if (is_object($model) && $model->isVirtualField($key)) {
  2343. $key = $this->_quoteFields($model->getVirtualField($key));
  2344. $virtual = true;
  2345. }
  2346. $type = is_object($model) ? $model->getColumnType($key) : null;
  2347. $null = $value === null || (is_array($value) && empty($value));
  2348. if (strtolower($operator) === 'not') {
  2349. $data = $this->conditionKeysToString(
  2350. array($operator => array($key => $value)), true, $model
  2351. );
  2352. return $data[0];
  2353. }
  2354. $value = $this->value($value, $type);
  2355. if (!$virtual && $key !== '?') {
  2356. $isKey = (strpos($key, '(') !== false || strpos($key, ')') !== false);
  2357. $key = $isKey ? $this->_quoteFields($key) : $this->name($key);
  2358. }
  2359. if ($bound) {
  2360. return String::insert($key . ' ' . trim($operator), $value);
  2361. }
  2362. if (!preg_match($operatorMatch, trim($operator))) {
  2363. $operator .= ' =';
  2364. }
  2365. $operator = trim($operator);
  2366. if (is_array($value)) {
  2367. $value = implode(', ', $value);
  2368. switch ($operator) {
  2369. case '=':
  2370. $operator = 'IN';
  2371. break;
  2372. case '!=':
  2373. case '<>':
  2374. $operator = 'NOT IN';
  2375. break;
  2376. }
  2377. $value = "({$value})";
  2378. } elseif ($null || $value === 'NULL') {
  2379. switch ($operator) {
  2380. case '=':
  2381. $operator = 'IS';
  2382. break;
  2383. case '!=':
  2384. case '<>':
  2385. $operator = 'IS NOT';
  2386. break;
  2387. }
  2388. }
  2389. if ($virtual) {
  2390. return "({$key}) {$operator} {$value}";
  2391. }
  2392. return "{$key} {$operator} {$value}";
  2393. }
  2394. /**
  2395. * Quotes Model.fields
  2396. *
  2397. * @param string $conditions
  2398. * @return string or false if no match
  2399. */
  2400. protected function _quoteFields($conditions) {
  2401. $start = $end = null;
  2402. $original = $conditions;
  2403. if (!empty($this->startQuote)) {
  2404. $start = preg_quote($this->startQuote);
  2405. }
  2406. if (!empty($this->endQuote)) {
  2407. $end = preg_quote($this->endQuote);
  2408. }
  2409. $conditions = str_replace(array($start, $end), '', $conditions);
  2410. $conditions = preg_replace_callback(
  2411. '/(?:[\'\"][^\'\"\\\]*(?:\\\.[^\'\"\\\]*)*[\'\"])|([a-z0-9_][a-z0-9\\-_]*\\.[a-z0-9_][a-z0-9_\\-]*)/i',
  2412. array(&$this, '_quoteMatchedField'),
  2413. $conditions
  2414. );
  2415. if ($conditions !== null) {
  2416. return $conditions;
  2417. }
  2418. return $original;
  2419. }
  2420. /**
  2421. * Auxiliary function to quote matches `Model.fields` from a preg_replace_callback call
  2422. *
  2423. * @param string $match matched string
  2424. * @return string quoted string
  2425. */
  2426. protected function _quoteMatchedField($match) {
  2427. if (is_numeric($match[0])) {
  2428. return $match[0];
  2429. }
  2430. return $this->name($match[0]);
  2431. }
  2432. /**
  2433. * Returns a limit statement in the correct format for the particular database.
  2434. *
  2435. * @param integer $limit Limit of results returned
  2436. * @param integer $offset Offset from which to start results
  2437. * @return string SQL limit/offset statement
  2438. */
  2439. public function limit($limit, $offset = null) {
  2440. if ($limit) {
  2441. $rt = '';
  2442. if (!strpos(strtolower($limit), 'limit')) {
  2443. $rt = ' LIMIT';
  2444. }
  2445. if ($offset) {
  2446. $rt .= ' ' . $offset . ',';
  2447. }
  2448. $rt .= ' ' . $limit;
  2449. return $rt;
  2450. }
  2451. return null;
  2452. }
  2453. /**
  2454. * Returns an ORDER BY clause as a string.
  2455. *
  2456. * @param array|string $keys Field reference, as a key (i.e. Post.title)
  2457. * @param string $direction Direction (ASC or DESC)
  2458. * @param Model $model model reference (used to look for virtual field)
  2459. * @return string ORDER BY clause
  2460. */
  2461. public function order($keys, $direction = 'ASC', $model = null) {
  2462. if (!is_array($keys)) {
  2463. $keys = array($keys);
  2464. }
  2465. $keys = array_filter($keys);
  2466. $result = array();
  2467. while (!empty($keys)) {
  2468. list($key, $dir) = each($keys);
  2469. array_shift($keys);
  2470. if (is_numeric($key)) {
  2471. $key = $dir;
  2472. $dir = $direction;
  2473. }
  2474. if (is_string($key) && strpos($key, ',') !== false && !preg_match('/\(.+\,.+\)/', $key)) {
  2475. $key = array_map('trim', explode(',', $key));
  2476. }
  2477. if (is_array($key)) {
  2478. //Flatten the array
  2479. $key = array_reverse($key, true);
  2480. foreach ($key as $k => $v) {
  2481. if (is_numeric($k)) {
  2482. array_unshift($keys, $v);
  2483. } else {
  2484. $keys = array($k => $v) + $keys;
  2485. }
  2486. }
  2487. continue;
  2488. } elseif (is_object($key) && isset($key->type) && $key->type === 'expression') {
  2489. $result[] = $key->value;
  2490. continue;
  2491. }
  2492. if (preg_match('/\\x20(ASC|DESC).*/i', $key, $_dir)) {
  2493. $dir = $_dir[0];
  2494. $key = preg_replace('/\\x20(ASC|DESC).*/i', '', $key);
  2495. }
  2496. $key = trim($key);
  2497. if (is_object($model) && $model->isVirtualField($key)) {
  2498. $key = '(' . $this->_quoteFields($model->getVirtualField($key)) . ')';
  2499. }
  2500. list($alias, $field) = pluginSplit($key);
  2501. if (is_object($model) && $alias !== $model->alias && is_object($model->{$alias}) && $model->{$alias}->isVirtualField($key)) {
  2502. $key = '(' . $this->_quoteFields($model->{$alias}->getVirtualField($key)) . ')';
  2503. }
  2504. if (strpos($key, '.')) {
  2505. $key = preg_replace_callback('/([a-zA-Z0-9_-]{1,})\\.([a-zA-Z0-9_-]{1,})/', array(&$this, '_quoteMatchedField'), $key);
  2506. }
  2507. if (!preg_match('/\s/', $key) && strpos($key, '.') === false) {
  2508. $key = $this->name($key);
  2509. }
  2510. $key .= ' ' . trim($dir);
  2511. $result[] = $key;
  2512. }
  2513. if (!empty($result)) {
  2514. return ' ORDER BY ' . implode(', ', $result);
  2515. }
  2516. return '';
  2517. }
  2518. /**
  2519. * Create a GROUP BY SQL clause
  2520. *
  2521. * @param string $group Group By Condition
  2522. * @param Model $model
  2523. * @return string string condition or null
  2524. */
  2525. public function group($group, $model = null) {
  2526. if ($group) {
  2527. if (!is_array($group)) {
  2528. $group = array($group);
  2529. }
  2530. foreach ($group as $index => $key) {
  2531. if (is_object($model) && $model->isVirtualField($key)) {
  2532. $group[$index] = '(' . $model->getVirtualField($key) . ')';
  2533. }
  2534. }
  2535. $group = implode(', ', $group);
  2536. return ' GROUP BY ' . $this->_quoteFields($group);
  2537. }
  2538. return null;
  2539. }
  2540. /**
  2541. * Disconnects database, kills the connection and says the connection is closed.
  2542. *
  2543. * @return void
  2544. */
  2545. public function close() {
  2546. $this->disconnect();
  2547. }
  2548. /**
  2549. * Checks if the specified table contains any record matching specified SQL
  2550. *
  2551. * @param Model $Model Model to search
  2552. * @param string $sql SQL WHERE clause (condition only, not the "WHERE" part)
  2553. * @return boolean True if the table has a matching record, else false
  2554. */
  2555. public function hasAny(Model $Model, $sql) {
  2556. $sql = $this->conditions($sql);
  2557. $table = $this->fullTableName($Model);
  2558. $alias = $this->alias . $this->name($Model->alias);
  2559. $where = $sql ? "{$sql}" : ' WHERE 1 = 1';
  2560. $id = $Model->escapeField();
  2561. $out = $this->fetchRow("SELECT COUNT({$id}) {$this->alias}count FROM {$table} {$alias}{$where}");
  2562. if (is_array($out)) {
  2563. return $out[0]['count'];
  2564. }
  2565. return false;
  2566. }
  2567. /**
  2568. * Gets the length of a database-native column description, or null if no length
  2569. *
  2570. * @param string $real Real database-layer column type (i.e. "varchar(255)")
  2571. * @return mixed An integer or string representing the length of the column, or null for unknown length.
  2572. */
  2573. public function length($real) {
  2574. if (!preg_match_all('/([\w\s]+)(?:\((\d+)(?:,(\d+))?\))?(\sunsigned)?(\szerofill)?/', $real, $result)) {
  2575. $col = str_replace(array(')', 'unsigned'), '', $real);
  2576. $limit = null;
  2577. if (strpos($col, '(') !== false) {
  2578. list($col, $limit) = explode('(', $col);
  2579. }
  2580. if ($limit !== null) {
  2581. return intval($limit);
  2582. }
  2583. return null;
  2584. }
  2585. $types = array(
  2586. 'int' => 1, 'tinyint' => 1, 'smallint' => 1, 'mediumint' => 1, 'integer' => 1, 'bigint' => 1
  2587. );
  2588. list($real, $type, $length, $offset, $sign, $zerofill) = $result;
  2589. $typeArr = $type;
  2590. $type = $type[0];
  2591. $length = $length[0];
  2592. $offset = $offset[0];
  2593. $isFloat = in_array($type, array('dec', 'decimal', 'float', 'numeric', 'double'));
  2594. if ($isFloat && $offset) {
  2595. return $length . ',' . $offset;
  2596. }
  2597. if (($real[0] == $type) && (count($real) === 1)) {
  2598. return null;
  2599. }
  2600. if (isset($types[$type])) {
  2601. $length += $types[$type];
  2602. if (!empty($sign)) {
  2603. $length--;
  2604. }
  2605. } elseif (in_array($type, array('enum', 'set'))) {
  2606. $length = 0;
  2607. foreach ($typeArr as $key => $enumValue) {
  2608. if ($key === 0) {
  2609. continue;
  2610. }
  2611. $tmpLength = strlen($enumValue);
  2612. if ($tmpLength > $length) {
  2613. $length = $tmpLength;
  2614. }
  2615. }
  2616. }
  2617. return intval($length);
  2618. }
  2619. /**
  2620. * Translates between PHP boolean values and Database (faked) boolean values
  2621. *
  2622. * @param mixed $data Value to be translated
  2623. * @param boolean $quote
  2624. * @return string|boolean Converted boolean value
  2625. */
  2626. public function boolean($data, $quote = false) {
  2627. if ($quote) {
  2628. return !empty($data) ? '1' : '0';
  2629. }
  2630. return !empty($data);
  2631. }
  2632. /**
  2633. * Inserts multiple values into a table
  2634. *
  2635. * @param string $table The table being inserted into.
  2636. * @param array $fields The array of field/column names being inserted.
  2637. * @param array $values The array of values to insert. The values should
  2638. * be an array of rows. Each row should have values keyed by the column name.
  2639. * Each row must have the values in the same order as $fields.
  2640. * @return boolean
  2641. */
  2642. public function insertMulti($table, $fields, $values) {
  2643. $table = $this->fullTableName($table);
  2644. $holder = implode(',', array_fill(0, count($fields), '?'));
  2645. $fields = implode(', ', array_map(array(&$this, 'name'), $fields));
  2646. $pdoMap = array(
  2647. 'integer' => PDO::PARAM_INT,
  2648. 'float' => PDO::PARAM_STR,
  2649. 'boolean' => PDO::PARAM_BOOL,
  2650. 'string' => PDO::PARAM_STR,
  2651. 'text' => PDO::PARAM_STR
  2652. );
  2653. $columnMap = array();
  2654. $sql = "INSERT INTO {$table} ({$fields}) VALUES ({$holder})";
  2655. $statement = $this->_connection->prepare($sql);
  2656. $this->begin();
  2657. foreach ($values[key($values)] as $key => $val) {
  2658. $type = $this->introspectType($val);
  2659. $columnMap[$key] = $pdoMap[$type];
  2660. }
  2661. foreach ($values as $value) {
  2662. $i = 1;
  2663. foreach ($value as $col => $val) {
  2664. $statement->bindValue($i, $val, $columnMap[$col]);
  2665. $i += 1;
  2666. }
  2667. $statement->execute();
  2668. $statement->closeCursor();
  2669. }
  2670. return $this->commit();
  2671. }
  2672. /**
  2673. * Returns an array of the indexes in given datasource name.
  2674. *
  2675. * @param string $model Name of model to inspect
  2676. * @return array Fields in table. Keys are column and unique
  2677. */
  2678. public function index($model) {
  2679. return false;
  2680. }
  2681. /**
  2682. * Generate a database-native schema for the given Schema object
  2683. *
  2684. * @param Model $schema An instance of a subclass of CakeSchema
  2685. * @param string $tableName Optional. If specified only the table name given will be generated.
  2686. * Otherwise, all tables defined in the schema are generated.
  2687. * @return string
  2688. */
  2689. public function createSchema($schema, $tableName = null) {
  2690. if (!is_a($schema, 'CakeSchema')) {
  2691. trigger_error(__d('cake_dev', 'Invalid schema object'), E_USER_WARNING);
  2692. return null;
  2693. }
  2694. $out = '';
  2695. foreach ($schema->tables as $curTable => $columns) {
  2696. if (!$tableName || $tableName == $curTable) {
  2697. $cols = $colList = $indexes = $tableParameters = array();
  2698. $primary = null;
  2699. $table = $this->fullTableName($curTable);
  2700. $primaryCount = 0;
  2701. foreach ($columns as $col) {
  2702. if (isset($col['key']) && $col['key'] === 'primary') {
  2703. $primaryCount++;
  2704. }
  2705. }
  2706. foreach ($columns as $name => $col) {
  2707. if (is_string($col)) {
  2708. $col = array('type' => $col);
  2709. }
  2710. $isPrimary = isset($col['key']) && $col['key'] === 'primary';
  2711. // Multi-column primary keys are not supported.
  2712. if ($isPrimary && $primaryCount > 1) {
  2713. unset($col['key']);
  2714. $isPrimary = false;
  2715. }
  2716. if ($isPrimary) {
  2717. $primary = $name;
  2718. }
  2719. if ($name !== 'indexes' && $name !== 'tableParameters') {
  2720. $col['name'] = $name;
  2721. if (!isset($col['type'])) {
  2722. $col['type'] = 'string';
  2723. }
  2724. $cols[] = $this->buildColumn($col);
  2725. } elseif ($name === 'indexes') {
  2726. $indexes = array_merge($indexes, $this->buildIndex($col, $table));
  2727. } elseif ($name === 'tableParameters') {
  2728. $tableParameters = array_merge($tableParameters, $this->buildTableParameters($col, $table));
  2729. }
  2730. }
  2731. if (!isset($columns['indexes']['PRIMARY']) && !empty($primary)) {
  2732. $col = array('PRIMARY' => array('column' => $primary, 'unique' => 1));
  2733. $indexes = array_merge($indexes, $this->buildIndex($col, $table));
  2734. }
  2735. $columns = $cols;
  2736. $out .= $this->renderStatement('schema', compact('table', 'columns', 'indexes', 'tableParameters')) . "\n\n";
  2737. }
  2738. }
  2739. return $out;
  2740. }
  2741. /**
  2742. * Generate a alter syntax from CakeSchema::compare()
  2743. *
  2744. * @param mixed $compare
  2745. * @param string $table
  2746. * @return boolean
  2747. */
  2748. public function alterSchema($compare, $table = null) {
  2749. return false;
  2750. }
  2751. /**
  2752. * Generate a "drop table" statement for the given Schema object
  2753. *
  2754. * @param CakeSchema $schema An instance of a subclass of CakeSchema
  2755. * @param string $table Optional. If specified only the table name given will be generated.
  2756. * Otherwise, all tables defined in the schema are generated.
  2757. * @return string
  2758. */
  2759. public function dropSchema(CakeSchema $schema, $table = null) {
  2760. $out = '';
  2761. foreach ($schema->tables as $curTable => $columns) {
  2762. if (!$table || $table == $curTable) {
  2763. $out .= 'DROP TABLE ' . $this->fullTableName($curTable) . ";\n";
  2764. }
  2765. }
  2766. return $out;
  2767. }
  2768. /**
  2769. * Generate a database-native column schema string
  2770. *
  2771. * @param array $column An array structured like the following: array('name' => 'value', 'type' => 'value'[, options]),
  2772. * where options can be 'default', 'length', or 'key'.
  2773. * @return string
  2774. */
  2775. public function buildColumn($column) {
  2776. $name = $type = null;
  2777. extract(array_merge(array('null' => true), $column));
  2778. if (empty($name) || empty($type)) {
  2779. trigger_error(__d('cake_dev', 'Column name or type not defined in schema'), E_USER_WARNING);
  2780. return null;
  2781. }
  2782. if (!isset($this->columns[$type])) {
  2783. trigger_error(__d('cake_dev', 'Column type %s does not exist', $type), E_USER_WARNING);
  2784. return null;
  2785. }
  2786. $real = $this->columns[$type];
  2787. $out = $this->name($name) . ' ' . $real['name'];
  2788. if (isset($column['length'])) {
  2789. $length = $column['length'];
  2790. } elseif (isset($column['limit'])) {
  2791. $length = $column['limit'];
  2792. } elseif (isset($real['length'])) {
  2793. $length = $real['length'];
  2794. } elseif (isset($real['limit'])) {
  2795. $length = $real['limit'];
  2796. }
  2797. if (isset($length)) {
  2798. $out .= '(' . $length . ')';
  2799. }
  2800. if (($column['type'] === 'integer' || $column['type'] === 'float') && isset($column['default']) && $column['default'] === '') {
  2801. $column['default'] = null;
  2802. }
  2803. $out = $this->_buildFieldParameters($out, $column, 'beforeDefault');
  2804. if (isset($column['key']) && $column['key'] === 'primary' && $type === 'integer') {
  2805. $out .= ' ' . $this->columns['primary_key']['name'];
  2806. } elseif (isset($column['key']) && $column['key'] === 'primary') {
  2807. $out .= ' NOT NULL';
  2808. } elseif (isset($column['default']) && isset($column['null']) && $column['null'] === false) {
  2809. $out .= ' DEFAULT ' . $this->value($column['default'], $type) . ' NOT NULL';
  2810. } elseif (isset($column['default'])) {
  2811. $out .= ' DEFAULT ' . $this->value($column['default'], $type);
  2812. } elseif ($type !== 'timestamp' && !empty($column['null'])) {
  2813. $out .= ' DEFAULT NULL';
  2814. } elseif ($type === 'timestamp' && !empty($column['null'])) {
  2815. $out .= ' NULL';
  2816. } elseif (isset($column['null']) && $column['null'] === false) {
  2817. $out .= ' NOT NULL';
  2818. }
  2819. if ($type === 'timestamp' && isset($column['default']) && strtolower($column['default']) === 'current_timestamp') {
  2820. $out = str_replace(array("'CURRENT_TIMESTAMP'", "'current_timestamp'"), 'CURRENT_TIMESTAMP', $out);
  2821. }
  2822. return $this->_buildFieldParameters($out, $column, 'afterDefault');
  2823. }
  2824. /**
  2825. * Build the field parameters, in a position
  2826. *
  2827. * @param string $columnString The partially built column string
  2828. * @param array $columnData The array of column data.
  2829. * @param string $position The position type to use. 'beforeDefault' or 'afterDefault' are common
  2830. * @return string a built column with the field parameters added.
  2831. */
  2832. protected function _buildFieldParameters($columnString, $columnData, $position) {
  2833. foreach ($this->fieldParameters as $paramName => $value) {
  2834. if (isset($columnData[$paramName]) && $value['position'] == $position) {
  2835. if (isset($value['options']) && !in_array($columnData[$paramName], $value['options'])) {
  2836. continue;
  2837. }
  2838. $val = $columnData[$paramName];
  2839. if ($value['quote']) {
  2840. $val = $this->value($val);
  2841. }
  2842. $columnString .= ' ' . $value['value'] . $value['join'] . $val;
  2843. }
  2844. }
  2845. return $columnString;
  2846. }
  2847. /**
  2848. * Format indexes for create table
  2849. *
  2850. * @param array $indexes
  2851. * @param string $table
  2852. * @return array
  2853. */
  2854. public function buildIndex($indexes, $table = null) {
  2855. $join = array();
  2856. foreach ($indexes as $name => $value) {
  2857. $out = '';
  2858. if ($name === 'PRIMARY') {
  2859. $out .= 'PRIMARY ';
  2860. $name = null;
  2861. } else {
  2862. if (!empty($value['unique'])) {
  2863. $out .= 'UNIQUE ';
  2864. }
  2865. $name = $this->startQuote . $name . $this->endQuote;
  2866. }
  2867. if (is_array($value['column'])) {
  2868. $out .= 'KEY ' . $name . ' (' . implode(', ', array_map(array(&$this, 'name'), $value['column'])) . ')';
  2869. } else {
  2870. $out .= 'KEY ' . $name . ' (' . $this->name($value['column']) . ')';
  2871. }
  2872. $join[] = $out;
  2873. }
  2874. return $join;
  2875. }
  2876. /**
  2877. * Read additional table parameters
  2878. *
  2879. * @param string $name
  2880. * @return array
  2881. */
  2882. public function readTableParameters($name) {
  2883. $parameters = array();
  2884. if (method_exists($this, 'listDetailedSources')) {
  2885. $currentTableDetails = $this->listDetailedSources($name);
  2886. foreach ($this->tableParameters as $paramName => $parameter) {
  2887. if (!empty($parameter['column']) && !empty($currentTableDetails[$parameter['column']])) {
  2888. $parameters[$paramName] = $currentTableDetails[$parameter['column']];
  2889. }
  2890. }
  2891. }
  2892. return $parameters;
  2893. }
  2894. /**
  2895. * Format parameters for create table
  2896. *
  2897. * @param array $parameters
  2898. * @param string $table
  2899. * @return array
  2900. */
  2901. public function buildTableParameters($parameters, $table = null) {
  2902. $result = array();
  2903. foreach ($parameters as $name => $value) {
  2904. if (isset($this->tableParameters[$name])) {
  2905. if ($this->tableParameters[$name]['quote']) {
  2906. $value = $this->value($value);
  2907. }
  2908. $result[] = $this->tableParameters[$name]['value'] . $this->tableParameters[$name]['join'] . $value;
  2909. }
  2910. }
  2911. return $result;
  2912. }
  2913. /**
  2914. * Guesses the data type of an array
  2915. *
  2916. * @param string $value
  2917. * @return void
  2918. */
  2919. public function introspectType($value) {
  2920. if (!is_array($value)) {
  2921. if (is_bool($value)) {
  2922. return 'boolean';
  2923. }
  2924. if (is_float($value) && floatval($value) === $value) {
  2925. return 'float';
  2926. }
  2927. if (is_int($value) && intval($value) === $value) {
  2928. return 'integer';
  2929. }
  2930. if (is_string($value) && strlen($value) > 255) {
  2931. return 'text';
  2932. }
  2933. return 'string';
  2934. }
  2935. $isAllFloat = $isAllInt = true;
  2936. $containsFloat = $containsInt = $containsString = false;
  2937. foreach ($value as $valElement) {
  2938. $valElement = trim($valElement);
  2939. if (!is_float($valElement) && !preg_match('/^[\d]+\.[\d]+$/', $valElement)) {
  2940. $isAllFloat = false;
  2941. } else {
  2942. $containsFloat = true;
  2943. continue;
  2944. }
  2945. if (!is_int($valElement) && !preg_match('/^[\d]+$/', $valElement)) {
  2946. $isAllInt = false;
  2947. } else {
  2948. $containsInt = true;
  2949. continue;
  2950. }
  2951. $containsString = true;
  2952. }
  2953. if ($isAllFloat) {
  2954. return 'float';
  2955. }
  2956. if ($isAllInt) {
  2957. return 'integer';
  2958. }
  2959. if ($containsInt && !$containsString) {
  2960. return 'integer';
  2961. }
  2962. return 'string';
  2963. }
  2964. /**
  2965. * Writes a new key for the in memory sql query cache
  2966. *
  2967. * @param string $sql SQL query
  2968. * @param mixed $data result of $sql query
  2969. * @param array $params query params bound as values
  2970. * @return void
  2971. */
  2972. protected function _writeQueryCache($sql, $data, $params = array()) {
  2973. if (preg_match('/^\s*select/i', $sql)) {
  2974. $this->_queryCache[$sql][serialize($params)] = $data;
  2975. }
  2976. }
  2977. /**
  2978. * Returns the result for a sql query if it is already cached
  2979. *
  2980. * @param string $sql SQL query
  2981. * @param array $params query params bound as values
  2982. * @return mixed results for query if it is cached, false otherwise
  2983. */
  2984. public function getQueryCache($sql, $params = array()) {
  2985. if (isset($this->_queryCache[$sql]) && preg_match('/^\s*select/i', $sql)) {
  2986. $serialized = serialize($params);
  2987. if (isset($this->_queryCache[$sql][$serialized])) {
  2988. return $this->_queryCache[$sql][$serialized];
  2989. }
  2990. }
  2991. return false;
  2992. }
  2993. /**
  2994. * Used for storing in cache the results of the in-memory methodCache
  2995. *
  2996. */
  2997. public function __destruct() {
  2998. if ($this->_methodCacheChange) {
  2999. Cache::write('method_cache', self::$methodCache, '_cake_core_');
  3000. }
  3001. }
  3002. }