]> git.openstreetmap.org Git - nominatim.git/blob - lib/lib.php
add wrapper calls for all nominatim tool functions
[nominatim.git] / lib / lib.php
1 <?php
2
3 require('Symfony/Component/Dotenv/autoload.php');
4
5 function loadSettings($sProjectDir)
6 {
7     @define('CONST_InstallDir', $sProjectDir);
8     // Temporary hack to set the direcory via environment instead of
9     // the installed scripts. Neither setting is part of the official
10     // set of settings.
11     defined('CONST_DataDir') or define('CONST_DataDir', $_SERVER['NOMINATIM_DATADIR']);
12     defined('CONST_BinDir') or define('CONST_BinDir', $_SERVER['NOMINATIM_BINDIR']);
13
14     $dotenv = new \Symfony\Component\Dotenv\Dotenv();
15     $dotenv->load(CONST_DataDir.'/settings/env.defaults');
16
17     if (file_exists($sProjectDir.'/.env')) {
18         $dotenv->load($sProjectDir.'/.env');
19     }
20 }
21
22 function getSetting($sConfName, $sDefault = null)
23 {
24     $sValue = $_SERVER['NOMINATIM_'.$sConfName];
25
26     if ($sDefault !== null && !$sValue) {
27         return $sDefault;
28     }
29
30     return $sValue;
31 }
32
33 function getSettingBool($sConfName)
34 {
35     $sVal = strtolower(getSetting($sConfName));
36
37     return strcmp($sVal, 'yes') == 0
38            || strcmp($sVal, 'true') == 0
39            || strcmp($sVal, '1') == 0;
40 }
41
42 function getSettingConfig($sConfName, $sSystemConfig)
43 {
44     $sValue = $_SERVER['NOMINATIM_'.$sConfName];
45
46     if (!$sValue) {
47         return CONST_DataDir.'/settings/'.$sSystemConfig;
48     }
49
50     return $sValue;
51 }
52
53 function fail($sError, $sUserError = false)
54 {
55     if (!$sUserError) $sUserError = $sError;
56     error_log('ERROR: '.$sError);
57     var_dump($sUserError)."\n";
58     exit(-1);
59 }
60
61
62 function getProcessorCount()
63 {
64     $sCPU = file_get_contents('/proc/cpuinfo');
65     preg_match_all('#processor\s+: [0-9]+#', $sCPU, $aMatches);
66     return count($aMatches[0]);
67 }
68
69
70 function getTotalMemoryMB()
71 {
72     $sCPU = file_get_contents('/proc/meminfo');
73     preg_match('#MemTotal: +([0-9]+) kB#', $sCPU, $aMatches);
74     return (int)($aMatches[1]/1024);
75 }
76
77
78 function getCacheMemoryMB()
79 {
80     $sCPU = file_get_contents('/proc/meminfo');
81     preg_match('#Cached: +([0-9]+) kB#', $sCPU, $aMatches);
82     return (int)($aMatches[1]/1024);
83 }
84
85 function getDatabaseDate(&$oDB)
86 {
87     // Find the newest node in the DB
88     $iLastOSMID = $oDB->getOne("select max(osm_id) from place where osm_type = 'N'");
89     // Lookup the timestamp that node was created
90     $sLastNodeURL = 'https://www.openstreetmap.org/api/0.6/node/'.$iLastOSMID.'/1';
91     $sLastNodeXML = file_get_contents($sLastNodeURL);
92
93     if ($sLastNodeXML === false) {
94         return false;
95     }
96
97     preg_match('#timestamp="(([0-9]{4})-([0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})Z)"#', $sLastNodeXML, $aLastNodeDate);
98
99     return $aLastNodeDate[1];
100 }
101
102
103 function byImportance($a, $b)
104 {
105     if ($a['importance'] != $b['importance'])
106         return ($a['importance'] > $b['importance']?-1:1);
107
108     return $a['foundorder'] <=> $b['foundorder'];
109 }
110
111
112 function javascript_renderData($xVal, $iOptions = 0)
113 {
114     $sCallback = isset($_GET['json_callback']) ? $_GET['json_callback'] : '';
115     if ($sCallback && !preg_match('/^[$_\p{L}][$_\p{L}\p{Nd}.[\]]*$/u', $sCallback)) {
116         // Unset, we call javascript_renderData again during exception handling
117         unset($_GET['json_callback']);
118         throw new Exception('Invalid json_callback value', 400);
119     }
120
121     $iOptions |= JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES;
122     if (isset($_GET['pretty']) && in_array(strtolower($_GET['pretty']), array('1', 'true'))) {
123         $iOptions |= JSON_PRETTY_PRINT;
124     }
125
126     $jsonout = json_encode($xVal, $iOptions);
127
128     if ($sCallback) {
129         header('Content-Type: application/javascript; charset=UTF-8');
130         echo $_GET['json_callback'].'('.$jsonout.')';
131     } else {
132         header('Content-Type: application/json; charset=UTF-8');
133         echo $jsonout;
134     }
135 }
136
137 function addQuotes($s)
138 {
139     return "'".$s."'";
140 }
141
142 function fwriteConstDef($rFile, $sConstName, $value)
143 {
144     $sEscapedValue;
145
146     if (is_bool($value)) {
147         $sEscapedValue = $value ? 'true' : 'false';
148     } elseif (is_numeric($value)) {
149         $sEscapedValue = strval($value);
150     } elseif (!$value) {
151         $sEscapedValue = 'false';
152     } else {
153         $sEscapedValue = addQuotes(str_replace("'", "\\'", (string)$value));
154     }
155
156     fwrite($rFile, "@define('CONST_$sConstName', $sEscapedValue);\n");
157 }
158
159
160 function parseLatLon($sQuery)
161 {
162     $sFound    = null;
163     $fQueryLat = null;
164     $fQueryLon = null;
165
166     if (preg_match('/\\s*([NS])[\s]+([0-9]+[0-9.]*)[°\s]+([0-9.]+)?[′\']*[,\s]+([EW])[\s]+([0-9]+)[°\s]+([0-9]+[0-9.]*)[′\']*\\s*/', $sQuery, $aData)) {
167         /*               1          2                    3                     4          5             6
168          * degrees decimal minutes
169          * N 40 26.767, W 79 58.933
170          * N 40°26.767′, W 79°58.933′
171          */
172         $sFound    = $aData[0];
173         $fQueryLat = ($aData[1]=='N'?1:-1) * ($aData[2] + $aData[3]/60);
174         $fQueryLon = ($aData[4]=='E'?1:-1) * ($aData[5] + $aData[6]/60);
175     } elseif (preg_match('/\\s*([0-9]+)[°\s]+([0-9]+[0-9.]*)?[′\']*[\s]+([NS])[,\s]+([0-9]+)[°\s]+([0-9]+[0-9.]*)?[′\'\s]+([EW])\\s*/', $sQuery, $aData)) {
176         /*                     1             2                          3           4             5                       6
177          * degrees decimal minutes
178          * 40 26.767 N, 79 58.933 W
179          * 40° 26.767′ N 79° 58.933′ W
180          */
181         $sFound    = $aData[0];
182         $fQueryLat = ($aData[3]=='N'?1:-1) * ($aData[1] + $aData[2]/60);
183         $fQueryLon = ($aData[6]=='E'?1:-1) * ($aData[4] + $aData[5]/60);
184     } elseif (preg_match('/\\s*([NS])[\s]+([0-9]+)[°\s]+([0-9]+)[′\'\s]+([0-9]+)[″"]*[,\s]+([EW])[\s]+([0-9]+)[°\s]+([0-9]+)[′\'\s]+([0-9]+)[″"]*\\s*/', $sQuery, $aData)) {
185         /*                     1          2             3               4                  5          6             7               8
186          * degrees decimal seconds
187          * N 40 26 46 W 79 58 56
188          * N 40° 26′ 46″, W 79° 58′ 56″
189          */
190         $sFound    = $aData[0];
191         $fQueryLat = ($aData[1]=='N'?1:-1) * ($aData[2] + $aData[3]/60 + $aData[4]/3600);
192         $fQueryLon = ($aData[5]=='E'?1:-1) * ($aData[6] + $aData[7]/60 + $aData[8]/3600);
193     } elseif (preg_match('/\\s*([0-9]+)[°\s]+([0-9]+)[′\'\s]+([0-9]+[0-9.]*)[″"\s]+([NS])[,\s]+([0-9]+)[°\s]+([0-9]+)[′\'\s]+([0-9]+[0-9.]*)[″"\s]+([EW])\\s*/', $sQuery, $aData)) {
194         /*                     1             2               3                     4           5             6               7                     8
195          * degrees decimal seconds
196          * 40 26 46 N 79 58 56 W
197          * 40° 26′ 46″ N, 79° 58′ 56″ W
198          * 40° 26′ 46.78″ N, 79° 58′ 56.89″ W
199          */
200         $sFound    = $aData[0];
201         $fQueryLat = ($aData[4]=='N'?1:-1) * ($aData[1] + $aData[2]/60 + $aData[3]/3600);
202         $fQueryLon = ($aData[8]=='E'?1:-1) * ($aData[5] + $aData[6]/60 + $aData[7]/3600);
203     } elseif (preg_match('/\\s*([NS])[\s]+([0-9]+[0-9]*\\.[0-9]+)[°]*[,\s]+([EW])[\s]+([0-9]+[0-9]*\\.[0-9]+)[°]*\\s*/', $sQuery, $aData)) {
204         /*                     1          2                                3          4
205          * degrees decimal
206          * N 40.446° W 79.982°
207          */
208         $sFound    = $aData[0];
209         $fQueryLat = ($aData[1]=='N'?1:-1) * ($aData[2]);
210         $fQueryLon = ($aData[3]=='E'?1:-1) * ($aData[4]);
211     } elseif (preg_match('/\\s*([0-9]+[0-9]*\\.[0-9]+)[°\s]+([NS])[,\s]+([0-9]+[0-9]*\\.[0-9]+)[°\s]+([EW])\\s*/', $sQuery, $aData)) {
212         /*                     1                            2           3                            4
213          * degrees decimal
214          * 40.446° N 79.982° W
215          */
216         $sFound    = $aData[0];
217         $fQueryLat = ($aData[2]=='N'?1:-1) * ($aData[1]);
218         $fQueryLon = ($aData[4]=='E'?1:-1) * ($aData[3]);
219     } elseif (preg_match('/(\\s*\\[|^\\s*|\\s*)(-?[0-9]+[0-9]*\\.[0-9]+)[,\s]+(-?[0-9]+[0-9]*\\.[0-9]+)(\\]\\s*|\\s*$|\\s*)/', $sQuery, $aData)) {
220         /*                 1                   2                              3                        4
221          * degrees decimal
222          * 12.34, 56.78
223          * 12.34 56.78
224          * [12.456,-78.90]
225          */
226         $sFound    = $aData[0];
227         $fQueryLat = $aData[2];
228         $fQueryLon = $aData[3];
229     } else {
230         return false;
231     }
232
233     return array($sFound, $fQueryLat, $fQueryLon);
234 }
235
236 function createPointsAroundCenter($fLon, $fLat, $fRadius)
237 {
238     $iSteps = max(8, min(100, ($fRadius * 40000)^2));
239     $fStepSize = (2*pi())/$iSteps;
240     $aPolyPoints = array();
241     for ($f = 0; $f < 2*pi(); $f += $fStepSize) {
242         $aPolyPoints[] = array('', $fLon+($fRadius*sin($f)), $fLat+($fRadius*cos($f)) );
243     }
244     return $aPolyPoints;
245 }
246
247 function closestHouseNumber($aRow)
248 {
249     $fHouse = $aRow['startnumber']
250                 + ($aRow['endnumber'] - $aRow['startnumber']) * $aRow['fraction'];
251
252     switch ($aRow['interpolationtype']) {
253         case 'odd':
254             $iHn = (int)($fHouse/2) * 2 + 1;
255             break;
256         case 'even':
257             $iHn = (int)(round($fHouse/2)) * 2;
258             break;
259         default:
260             $iHn = (int)(round($fHouse));
261             break;
262     }
263
264     return max(min($aRow['endnumber'], $iHn), $aRow['startnumber']);
265 }
266
267 function getSearchRankLabel($iRank)
268 {
269     if (!isset($iRank)) return 'unknown';
270     if ($iRank < 2) return 'continent';
271     if ($iRank < 4) return 'sea';
272     if ($iRank < 8) return 'country';
273     if ($iRank < 12) return 'state';
274     if ($iRank < 16) return 'county';
275     if ($iRank == 16) return 'city';
276     if ($iRank == 17) return 'town / island';
277     if ($iRank == 18) return 'village / hamlet';
278     if ($iRank == 20) return 'suburb';
279     if ($iRank == 21) return 'postcode area';
280     if ($iRank == 22) return 'croft / farm / locality / islet';
281     if ($iRank == 23) return 'postcode area';
282     if ($iRank == 25) return 'postcode point';
283     if ($iRank == 26) return 'street / major landmark';
284     if ($iRank == 27) return 'minory street / path';
285     if ($iRank == 28) return 'house / building';
286     return 'other: ' . $iRank;
287 }