PageRenderTime 69ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 1ms

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

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