1: <?php
  2: 
  3: /**
  4:  * This file is part of the Nette Framework (https://nette.org)
  5:  * Copyright (c) 2004 David Grudl (http://davidgrudl.com)
  6:  */
  7: 
  8: namespace Nette\Database\Drivers;
  9: 
 10: use Nette;
 11: 
 12: 
 13: /**
 14:  * Supplemental SQLite3 database driver.
 15:  *
 16:  * @author     David Grudl
 17:  */
 18: class SqliteDriver extends Nette\Object implements Nette\Database\ISupplementalDriver
 19: {
 20:     /** @var Nette\Database\Connection */
 21:     private $connection;
 22: 
 23:     /** @var string  Datetime format */
 24:     private $fmtDateTime;
 25: 
 26: 
 27:     public function __construct(Nette\Database\Connection $connection, array $options)
 28:     {
 29:         $this->connection = $connection;
 30:         $this->fmtDateTime = isset($options['formatDateTime']) ? $options['formatDateTime'] : 'U';
 31:     }
 32: 
 33: 
 34:     /********************* SQL ****************d*g**/
 35: 
 36: 
 37:     /**
 38:      * Delimites identifier for use in a SQL statement.
 39:      */
 40:     public function delimite($name)
 41:     {
 42:         return '[' . strtr($name, '[]', '  ') . ']';
 43:     }
 44: 
 45: 
 46:     /**
 47:      * Formats boolean for use in a SQL statement.
 48:      */
 49:     public function formatBool($value)
 50:     {
 51:         return $value ? '1' : '0';
 52:     }
 53: 
 54: 
 55:     /**
 56:      * Formats date-time for use in a SQL statement.
 57:      */
 58:     public function formatDateTime(\DateTime $value)
 59:     {
 60:         return $value->format($this->fmtDateTime);
 61:     }
 62: 
 63: 
 64:     /**
 65:      * Encodes string for use in a LIKE statement.
 66:      */
 67:     public function formatLike($value, $pos)
 68:     {
 69:         $value = addcslashes(substr($this->connection->quote($value), 1, -1), '%_\\');
 70:         return ($pos <= 0 ? "'%" : "'") . $value . ($pos >= 0 ? "%'" : "'") . " ESCAPE '\\'";
 71:     }
 72: 
 73: 
 74:     /**
 75:      * Injects LIMIT/OFFSET to the SQL query.
 76:      */
 77:     public function applyLimit(& $sql, $limit, $offset)
 78:     {
 79:         if ($limit >= 0 || $offset > 0) {
 80:             $sql .= ' LIMIT ' . $limit . ($offset > 0 ? ' OFFSET ' . (int) $offset : '');
 81:         }
 82:     }
 83: 
 84: 
 85:     /**
 86:      * Normalizes result row.
 87:      */
 88:     public function normalizeRow($row, $statement)
 89:     {
 90:         foreach ($row as $key => $value) {
 91:             unset($row[$key]);
 92:             if ($key[0] === '[' || $key[0] === '"') {
 93:                 $key = substr($key, 1, -1);
 94:             }
 95:             $row[$key] = $value;
 96:         }
 97:         return $row;
 98:     }
 99: 
100: 
101:     /********************* reflection ****************d*g**/
102: 
103: 
104:     /**
105:      * Returns list of tables.
106:      */
107:     public function getTables()
108:     {
109:         $tables = array();
110:         foreach ($this->connection->query("
111:             SELECT name, type = 'view' as view FROM sqlite_master WHERE type IN ('table', 'view') AND name NOT LIKE 'sqlite_%'
112:             UNION ALL
113:             SELECT name, type = 'view' as view FROM sqlite_temp_master WHERE type IN ('table', 'view') AND name NOT LIKE 'sqlite_%'
114:             ORDER BY name
115:         ") as $row) {
116:             $tables[] = array(
117:                 'name' => $row->name,
118:                 'view' => (bool) $row->view,
119:             );
120:         }
121: 
122:         return $tables;
123:     }
124: 
125: 
126:     /**
127:      * Returns metadata for all columns in a table.
128:      */
129:     public function getColumns($table)
130:     {
131:         $meta = $this->connection->query("
132:             SELECT sql FROM sqlite_master WHERE type = 'table' AND name = {$this->connection->quote($table)}
133:             UNION ALL
134:             SELECT sql FROM sqlite_temp_master WHERE type = 'table' AND name = {$this->connection->quote($table)}
135:         ")->fetch();
136: 
137:         $columns = array();
138:         foreach ($this->connection->query("PRAGMA table_info({$this->delimite($table)})") as $row) {
139:             $column = $row['name'];
140:             $pattern = "/(\"$column\"|\[$column\]|$column)\\s+[^,]+\\s+PRIMARY\\s+KEY\\s+AUTOINCREMENT/Ui";
141:             $type = explode('(', $row['type']);
142:             $columns[] = array(
143:                 'name' => $column,
144:                 'table' => $table,
145:                 'nativetype' => strtoupper($type[0]),
146:                 'size' => isset($type[1]) ? (int) $type[1] : NULL,
147:                 'unsigned' => FALSE,
148:                 'nullable' => $row['notnull'] == '0',
149:                 'default' => $row['dflt_value'],
150:                 'autoincrement' => (bool) preg_match($pattern, $meta['sql']),
151:                 'primary' => $row['pk'] > 0,
152:                 'vendor' => (array) $row,
153:             );
154:         }
155:         return $columns;
156:     }
157: 
158: 
159:     /**
160:      * Returns metadata for all indexes in a table.
161:      */
162:     public function getIndexes($table)
163:     {
164:         $indexes = array();
165:         foreach ($this->connection->query("PRAGMA index_list({$this->delimite($table)})") as $row) {
166:             $indexes[$row['name']]['name'] = $row['name'];
167:             $indexes[$row['name']]['unique'] = (bool) $row['unique'];
168:             $indexes[$row['name']]['primary'] = FALSE;
169:         }
170: 
171:         foreach ($indexes as $index => $values) {
172:             $res = $this->connection->query("PRAGMA index_info({$this->delimite($index)})");
173:             while ($row = $res->fetch(TRUE)) {
174:                 $indexes[$index]['columns'][$row['seqno']] = $row['name'];
175:             }
176:         }
177: 
178:         $columns = $this->getColumns($table);
179:         foreach ($indexes as $index => $values) {
180:             $column = $indexes[$index]['columns'][0];
181:             foreach ($columns as $info) {
182:                 if ($column == $info['name']) {
183:                     $indexes[$index]['primary'] = (bool) $info['primary'];
184:                     break;
185:                 }
186:             }
187:         }
188:         if (!$indexes) { // @see http://www.sqlite.org/lang_createtable.html#rowid
189:             foreach ($columns as $column) {
190:                 if ($column['vendor']['pk']) {
191:                     $indexes[] = array(
192:                         'name' => 'ROWID',
193:                         'unique' => TRUE,
194:                         'primary' => TRUE,
195:                         'columns' => array($column['name']),
196:                     );
197:                     break;
198:                 }
199:             }
200:         }
201: 
202:         return array_values($indexes);
203:     }
204: 
205: 
206:     /**
207:      * Returns metadata for all foreign keys in a table.
208:      */
209:     public function getForeignKeys($table)
210:     {
211:         $keys = array();
212:         foreach ($this->connection->query("PRAGMA foreign_key_list({$this->delimite($table)})") as $row) {
213:             $keys[$row['id']]['name'] = $row['id']; // foreign key name
214:             $keys[$row['id']]['local'] = $row['from']; // local columns
215:             $keys[$row['id']]['table'] = $row['table']; // referenced table
216:             $keys[$row['id']]['foreign'] = $row['to']; // referenced columns
217:             $keys[$row['id']]['onDelete'] = $row['on_delete'];
218:             $keys[$row['id']]['onUpdate'] = $row['on_update'];
219: 
220:             if ($keys[$row['id']]['foreign'][0] == NULL) {
221:                 $keys[$row['id']]['foreign'] = NULL;
222:             }
223:         }
224:         return array_values($keys);
225:     }
226: 
227: 
228:     /**
229:      * @return bool
230:      */
231:     public function isSupported($item)
232:     {
233:         return FALSE;
234:     }
235: 
236: }
237: