summaryrefslogtreecommitdiff
path: root/plugins/GeonamesPlugin.php
blob: 934e998c714a5fb504c554cc090dc5b720404395 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Plugin to convert string locations to Geonames IDs and vice versa
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Action
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2009 StatusNet Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

/**
 * Plugin to convert string locations to Geonames IDs and vice versa
 *
 * This handles most of the events that Location class emits. It uses
 * the geonames.org Web service to convert names like 'Montreal, Quebec, Canada'
 * into IDs and lat/lon pairs.
 *
 * @category Plugin
 * @package  StatusNet
 * @author   Evan Prodromou <evan@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 *
 * @seeAlso  Location
 */

class GeonamesPlugin extends Plugin
{
    const NAMESPACE = 1;

    /**
     * convert a name into a Location object
     *
     * @param string   $name      Name to convert
     * @param string   $language  ISO code for anguage the name is in
     * @param Location &$location Location object (may be null)
     *
     * @return boolean whether to continue (results in $location)
     */

    function onLocationFromName($name, $language, &$location)
    {
        $client = HTTPClient::start();

        // XXX: break down a name by commas, narrow by each

        $str = http_build_query(array('maxRows' => 1,
                                      'q' => $name,
                                      'lang' => $language,
                                      'type' => 'json'));

        $result = $client->get('http://ws.geonames.org/search?'.$str);

        if ($result->code == "200") {
            $rj = json_decode($result->body);
            if (count($rj['geonames']) > 0) {
                $n = $rj['geonames'][0];

                $location = new Location();

                $location->lat              = $n['lat'];
                $location->lon              = $n['lng'];
                $location->names[$language] = $n['name'];
                $location->location_id      = $n['geonameId'];
                $location->location_ns      = self::NAMESPACE;

                // handled, don't continue processing!
                return false;
            }
        }

        // Continue processing; we don't have the answer
        return true;
    }

    /**
     * convert an id into a Location object
     *
     * @param string   $id        Name to convert
     * @param string   $ns        Name to convert
     * @param string   $language  ISO code for language for results
     * @param Location &$location Location object (may be null)
     *
     * @return boolean whether to continue (results in $location)
     */

    function onLocationFromId($id, $ns, $language, &$location)
    {
        if ($ns != self::NAMESPACE) {
            // It's not one of our IDs... keep processing
            return true;
        }

        $client = HTTPClient::start();

        $str = http_build_query(array('geonameId' => $id,
                                      'lang' => $language));

        $result = $client->get('http://ws.geonames.org/hierarchyJSON?'.$str);

        if ($result->code == "200") {

            $rj = json_decode($result->body);

            if (count($rj['geonames']) > 0) {

                $parts = array();

                foreach ($rj['geonames'] as $level) {
                    if (in_array($level['fcode'], array('PCLI', 'ADM1', 'PPL'))) {
                        $parts[] = $level['name'];
                    }
                }

                $last = $rj['geonames'][count($rj['geonames'])-1];

                if (!in_array($level['fcode'], array('PCLI', 'ADM1', 'PPL'))) {
                    $parts[] = $last['name'];
                }

                $location = new Location();

                $location->location_id      = $last['geonameId'];
                $location->location_ns      = self::NAMESPACE;
                $location->lat              = $last['lat'];
                $location->lon              = $last['lng'];
                $location->names[$language] = implode(', ', array_reverse($parts));
            }
        }

        // We're responsible for this NAMESPACE; nobody else
        // can resolve it

        return false;
    }

    /**
     * convert a lat/lon pair into a Location object
     *
     * Given a lat/lon, we try to find a Location that's around
     * it or nearby. We prefer populated places (cities, towns, villages).
     *
     * @param string   $lat       Latitude
     * @param string   $lon       Longitude
     * @param string   $language  ISO code for language for results
     * @param Location &$location Location object (may be null)
     *
     * @return boolean whether to continue (results in $location)
     */

    function onLocationFromLatLon($lat, $lon, $language, &$location)
    {
        $client = HTTPClient::start();

        $str = http_build_query(array('lat' => $lat,
                                      'lng' => $lon,
                                      'lang' => $language));

        $result =
          $client->get('http://ws.geonames.org/findNearbyPlaceNameJSON?'.$str);

        if ($result->code == "200") {

            $rj = json_decode($result->body);

            if (count($rj['geonames']) > 0) {

                $n = $rj['geonames'][0];

                $parts = array();

                $location = new Location();

                $parts[] = $n['name'];

                if (!empty($n['adminName1'])) {
                    $parts[] = $n['adminName1'];
                }

                if (!empty($n['countryName'])) {
                    $parts[] = $n['countryName'];
                }

                $location->location_id = $n['geonameId'];
                $location->location_ns = self::NAMESPACE;
                $location->lat         = $lat;
                $location->lon         = $lon;

                $location->names[$language] = implode(', ', $parts);

                // Success! We handled it, so no further processing

                return false;
            }
        }

        // For some reason we don't know, so pass.

        return true;
    }

    /**
     * Human-readable name for a location
     *
     * Given a location, we try to retrieve a human-readable name
     * in the target language.
     *
     * @param Location $location Location to get the name for
     * @param string   $language ISO code for language to find name in
     * @param string   &$name    Place to put the name
     *
     * @return boolean whether to continue
     */

    function onLocationNameLanguage($location, $language, &$name)
    {
        if ($location->location_ns != self::NAMESPACE) {
            // It's not one of our IDs... keep processing
            return true;
        }

        $client = HTTPClient::start();

        $str = http_build_query(array('geonameId' => $id,
                                      'lang' => $language));

        $result = $client->get('http://ws.geonames.org/hierarchyJSON?'.$str);

        if ($result->code == "200") {

            $rj = json_decode($result->body);

            if (count($rj['geonames']) > 0) {

                $parts = array();

                foreach ($rj['geonames'] as $level) {
                    if (in_array($level['fcode'], array('PCLI', 'ADM1', 'PPL'))) {
                        $parts[] = $level['name'];
                    }
                }

                $last = $rj['geonames'][count($rj['geonames'])-1];

                if (!in_array($level['fcode'], array('PCLI', 'ADM1', 'PPL'))) {
                    $parts[] = $last['name'];
                }

                if (count($parts)) {
                    $name = implode(', ', array_reverse($parts));
                    return false;
                }
            }
        }

        return true;
    }
}