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