]> git.openstreetmap.org Git - nominatim.git/blob - lib-php/DB.php
Merge pull request #2181 from lonvia/port-more-tool-functions-to-python
[nominatim.git] / lib-php / DB.php
1 <?php
2
3 namespace Nominatim;
4
5 require_once(CONST_LibDir.'/DatabaseError.php');
6
7 /**
8  * Uses PDO to access the database specified in the CONST_Database_DSN
9  * setting.
10  */
11 class DB
12 {
13     protected $connection;
14
15     public function __construct($sDSN = null)
16     {
17         $this->sDSN = $sDSN ?? getSetting('DATABASE_DSN');
18     }
19
20     public function connect($bNew = false, $bPersistent = true)
21     {
22         if (isset($this->connection) && !$bNew) {
23             return true;
24         }
25         $aConnOptions = array(
26                          \PDO::ATTR_ERRMODE            => \PDO::ERRMODE_EXCEPTION,
27                          \PDO::ATTR_DEFAULT_FETCH_MODE => \PDO::FETCH_ASSOC,
28                          \PDO::ATTR_PERSISTENT         => $bPersistent
29         );
30
31         // https://secure.php.net/manual/en/ref.pdo-pgsql.connection.php
32         try {
33             $conn = new \PDO($this->sDSN, null, null, $aConnOptions);
34         } catch (\PDOException $e) {
35             $sMsg = 'Failed to establish database connection:' . $e->getMessage();
36             throw new \Nominatim\DatabaseError($sMsg, 500, null, $e->getMessage());
37         }
38
39         $conn->exec("SET DateStyle TO 'sql,european'");
40         $conn->exec("SET client_encoding TO 'utf-8'");
41         $iMaxExecution = ini_get('max_execution_time');
42         if ($iMaxExecution > 0) $conn->setAttribute(\PDO::ATTR_TIMEOUT, $iMaxExecution); // seconds
43
44         $this->connection = $conn;
45         return true;
46     }
47
48     // returns the number of rows that were modified or deleted by the SQL
49     // statement. If no rows were affected returns 0.
50     public function exec($sSQL, $aInputVars = null, $sErrMessage = 'Database query failed')
51     {
52         $val = null;
53         try {
54             if (isset($aInputVars)) {
55                 $stmt = $this->connection->prepare($sSQL);
56                 $stmt->execute($aInputVars);
57             } else {
58                 $val = $this->connection->exec($sSQL);
59             }
60         } catch (\PDOException $e) {
61             throw new \Nominatim\DatabaseError($sErrMessage, 500, null, $e, $sSQL);
62         }
63         return $val;
64     }
65
66     /**
67      * Executes query. Returns first row as array.
68      * Returns false if no result found.
69      *
70      * @param string  $sSQL
71      *
72      * @return array[]
73      */
74     public function getRow($sSQL, $aInputVars = null, $sErrMessage = 'Database query failed')
75     {
76         try {
77             $stmt = $this->getQueryStatement($sSQL, $aInputVars, $sErrMessage);
78             $row = $stmt->fetch();
79         } catch (\PDOException $e) {
80             throw new \Nominatim\DatabaseError($sErrMessage, 500, null, $e, $sSQL);
81         }
82         return $row;
83     }
84
85     /**
86      * Executes query. Returns first value of first result.
87      * Returns false if no results found.
88      *
89      * @param string  $sSQL
90      *
91      * @return array[]
92      */
93     public function getOne($sSQL, $aInputVars = null, $sErrMessage = 'Database query failed')
94     {
95         try {
96             $stmt = $this->getQueryStatement($sSQL, $aInputVars, $sErrMessage);
97             $row = $stmt->fetch(\PDO::FETCH_NUM);
98             if ($row === false) return false;
99         } catch (\PDOException $e) {
100             throw new \Nominatim\DatabaseError($sErrMessage, 500, null, $e, $sSQL);
101         }
102         return $row[0];
103     }
104
105     /**
106      * Executes query. Returns array of results (arrays).
107      * Returns empty array if no results found.
108      *
109      * @param string  $sSQL
110      *
111      * @return array[]
112      */
113     public function getAll($sSQL, $aInputVars = null, $sErrMessage = 'Database query failed')
114     {
115         try {
116             $stmt = $this->getQueryStatement($sSQL, $aInputVars, $sErrMessage);
117             $rows = $stmt->fetchAll();
118         } catch (\PDOException $e) {
119             throw new \Nominatim\DatabaseError($sErrMessage, 500, null, $e, $sSQL);
120         }
121         return $rows;
122     }
123
124     /**
125      * Executes query. Returns array of the first value of each result.
126      * Returns empty array if no results found.
127      *
128      * @param string  $sSQL
129      *
130      * @return array[]
131      */
132     public function getCol($sSQL, $aInputVars = null, $sErrMessage = 'Database query failed')
133     {
134         $aVals = array();
135         try {
136             $stmt = $this->getQueryStatement($sSQL, $aInputVars, $sErrMessage);
137
138             while (($val = $stmt->fetchColumn(0)) !== false) { // returns first column or false
139                 $aVals[] = $val;
140             }
141         } catch (\PDOException $e) {
142             throw new \Nominatim\DatabaseError($sErrMessage, 500, null, $e, $sSQL);
143         }
144         return $aVals;
145     }
146
147     /**
148      * Executes query. Returns associate array mapping first value to second value of each result.
149      * Returns empty array if no results found.
150      *
151      * @param string  $sSQL
152      *
153      * @return array[]
154      */
155     public function getAssoc($sSQL, $aInputVars = null, $sErrMessage = 'Database query failed')
156     {
157         try {
158             $stmt = $this->getQueryStatement($sSQL, $aInputVars, $sErrMessage);
159
160             $aList = array();
161             while ($aRow = $stmt->fetch(\PDO::FETCH_NUM)) {
162                 $aList[$aRow[0]] = $aRow[1];
163             }
164         } catch (\PDOException $e) {
165             throw new \Nominatim\DatabaseError($sErrMessage, 500, null, $e, $sSQL);
166         }
167         return $aList;
168     }
169
170     /**
171      * Executes query. Returns a PDO statement to iterate over.
172      *
173      * @param string  $sSQL
174      *
175      * @return PDOStatement
176      */
177     public function getQueryStatement($sSQL, $aInputVars = null, $sErrMessage = 'Database query failed')
178     {
179         try {
180             if (isset($aInputVars)) {
181                 $stmt = $this->connection->prepare($sSQL);
182                 $stmt->execute($aInputVars);
183             } else {
184                 $stmt = $this->connection->query($sSQL);
185             }
186         } catch (\PDOException $e) {
187             throw new \Nominatim\DatabaseError($sErrMessage, 500, null, $e, $sSQL);
188         }
189         return $stmt;
190     }
191
192     /**
193      * St. John's Way => 'St. John\'s Way'
194      *
195      * @param string  $sVal  Text to be quoted.
196      *
197      * @return string
198      */
199     public function getDBQuoted($sVal)
200     {
201         return $this->connection->quote($sVal);
202     }
203
204     /**
205      * Like getDBQuoted, but takes an array.
206      *
207      * @param array  $aVals  List of text to be quoted.
208      *
209      * @return array[]
210      */
211     public function getDBQuotedList($aVals)
212     {
213         return array_map(function ($sVal) {
214             return $this->getDBQuoted($sVal);
215         }, $aVals);
216     }
217
218     /**
219      * [1,2,'b'] => 'ARRAY[1,2,'b']''
220      *
221      * @param array  $aVals  List of text to be quoted.
222      *
223      * @return string
224      */
225     public function getArraySQL($a)
226     {
227         return 'ARRAY['.join(',', $a).']';
228     }
229
230     /**
231      * Check if a table exists in the database. Returns true if it does.
232      *
233      * @param string  $sTableName
234      *
235      * @return boolean
236      */
237     public function tableExists($sTableName)
238     {
239         $sSQL = 'SELECT count(*) FROM pg_tables WHERE tablename = :tablename';
240         return ($this->getOne($sSQL, array(':tablename' => $sTableName)) == 1);
241     }
242
243     /**
244      * Deletes a table. Returns true if deleted or didn't exist.
245      *
246      * @param string  $sTableName
247      *
248      * @return boolean
249      */
250     public function deleteTable($sTableName)
251     {
252         return $this->exec('DROP TABLE IF EXISTS '.$sTableName.' CASCADE') == 0;
253     }
254
255     /**
256      * Tries to connect to the database but on failure doesn't throw an exception.
257      *
258      * @return boolean
259      */
260     public function checkConnection()
261     {
262         $bExists = true;
263         try {
264             $this->connect(true);
265         } catch (\Nominatim\DatabaseError $e) {
266             $bExists = false;
267         }
268         return $bExists;
269     }
270
271     /**
272      * e.g. 9.6, 10, 11.2
273      *
274      * @return float
275      */
276     public function getPostgresVersion()
277     {
278         $sVersionString = $this->getOne('SHOW server_version_num');
279         preg_match('#([0-9]?[0-9])([0-9][0-9])[0-9][0-9]#', $sVersionString, $aMatches);
280         return (float) ($aMatches[1].'.'.$aMatches[2]);
281     }
282
283     /**
284      * e.g. 2, 2.2
285      *
286      * @return float
287      */
288     public function getPostgisVersion()
289     {
290         $sVersionString = $this->getOne('select postgis_lib_version()');
291         preg_match('#^([0-9]+)[.]([0-9]+)[.]#', $sVersionString, $aMatches);
292         return (float) ($aMatches[1].'.'.$aMatches[2]);
293     }
294
295     /**
296      * Returns an associate array of postgresql database connection settings. Keys can
297      * be 'database', 'hostspec', 'port', 'username', 'password'.
298      * Returns empty array on failure, thus check if at least 'database' is set.
299      *
300      * @return array[]
301      */
302     public static function parseDSN($sDSN)
303     {
304         // https://secure.php.net/manual/en/ref.pdo-pgsql.connection.php
305         $aInfo = array();
306         if (preg_match('/^pgsql:(.+)$/', $sDSN, $aMatches)) {
307             foreach (explode(';', $aMatches[1]) as $sKeyVal) {
308                 list($sKey, $sVal) = explode('=', $sKeyVal, 2);
309                 if ($sKey == 'host') $sKey = 'hostspec';
310                 if ($sKey == 'dbname') $sKey = 'database';
311                 if ($sKey == 'user') $sKey = 'username';
312                 $aInfo[$sKey] = $sVal;
313             }
314         }
315         return $aInfo;
316     }
317
318     /**
319      * Takes an array of settings and return the DNS string. Key names can be
320      * 'database', 'hostspec', 'port', 'username', 'password' but aliases
321      * 'dbname', 'host' and 'user' are also supported.
322      *
323      * @return string
324      *
325      */
326     public static function generateDSN($aInfo)
327     {
328         $sDSN = sprintf(
329             'pgsql:host=%s;port=%s;dbname=%s;user=%s;password=%s;',
330             $aInfo['host'] ?? $aInfo['hostspec'] ?? '',
331             $aInfo['port'] ?? '',
332             $aInfo['dbname'] ?? $aInfo['database'] ?? '',
333             $aInfo['user'] ?? '',
334             $aInfo['password'] ?? ''
335         );
336         $sDSN = preg_replace('/\b\w+=;/', '', $sDSN);
337         $sDSN = preg_replace('/;\Z/', '', $sDSN);
338
339         return $sDSN;
340     }
341 }