4 * Description: Use Geonames service to resolve nearest populated location for given latitude, longitude
6 * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
9 * Pre-requisite: Register a username at geonames.org
10 * and set in .htconfig.php
12 * $a->config['geonames']['username'] = 'your_username';
13 * Also visit http://geonames.org/manageaccount and enable access to the free web services
15 * When addon is installed, the system calls the addon
16 * name_install() function, located in 'addon/name/name.php',
17 * where 'name' is the name of the addon.
18 * If the addon is removed from the configuration list, the
19 * system will call the name_uninstall() function.
22 use Friendica\Core\Addon;
23 use Friendica\Core\Config;
24 use Friendica\Core\L10n;
25 use Friendica\Core\PConfig;
26 use Friendica\Util\Network;
28 function geonames_install() {
32 * Our addon will attach in three places.
33 * The first is just prior to storing a local post.
37 Addon::registerHook('post_local', 'addon/geonames/geonames.php', 'geonames_post_hook');
41 * Then we'll attach into the addon settings page, and also the
42 * settings post hook so that we can create and update
47 Addon::registerHook('addon_settings', 'addon/geonames/geonames.php', 'geonames_addon_admin');
48 Addon::registerHook('addon_settings_post', 'addon/geonames/geonames.php', 'geonames_addon_admin_post');
50 logger("installed geonames");
54 function geonames_uninstall() {
58 * uninstall unregisters any hooks created with register_hook
59 * during install. It may also delete configuration settings
60 * and any other cleanup.
64 Addon::unregisterHook('post_local', 'addon/geonames/geonames.php', 'geonames_post_hook');
65 Addon::unregisterHook('addon_settings', 'addon/geonames/geonames.php', 'geonames_addon_admin');
66 Addon::unregisterHook('addon_settings_post', 'addon/geonames/geonames.php', 'geonames_addon_admin_post');
69 logger("removed geonames");
74 function geonames_post_hook($a, &$item) {
78 * An item was posted on the local system.
79 * We are going to look for specific items:
80 * - A status post by a profile owner
81 * - The profile owner must have allowed our addon
85 logger('geonames invoked');
87 if(! local_user()) /* non-zero if this is a logged in user of this system */
90 if(local_user() != $item['uid']) /* Does this person own the post? */
93 if($item['parent']) /* If the item has a parent, this is a comment or something else, not a status post. */
96 /* Retrieve our personal config setting */
98 $geo_account = Config::get('geonames', 'username');
99 $active = PConfig::get(local_user(), 'geonames', 'enable');
101 if((! $geo_account) || (! $active))
104 if((! $item['coord']) || ($item['location']))
107 $coords = explode(' ',$item['coord']);
111 * OK, we're allowed to do our stuff.
115 $s = Network::fetchURL('http://api.geonames.org/findNearbyPlaceName?lat=' . $coords[0] . '&lng=' . $coords[1] . '&username=' . $geo_account);
120 $xml = Network::parseXmlString($s);
122 if($xml->geoname->name && $xml->geoname->countryName)
123 $item['location'] = $xml->geoname->name . ', ' . $xml->geoname->countryName;
126 // logger('geonames : ' . print_r($xml,true), LOGGER_DATA);
135 * Callback from the settings post function.
136 * $post contains the $_POST array.
137 * We will make sure we've got a valid user account
138 * and if so set our configuration setting for this person.
142 function geonames_addon_admin_post($a,$post) {
143 if(! local_user() || (! x($_POST,'geonames-submit')))
145 PConfig::set(local_user(),'geonames','enable',intval($_POST['geonames']));
147 info(L10n::t('Geonames settings updated.') . EOL);
153 * Called from the Addon Setting form.
154 * Add our own settings info to the page.
160 function geonames_addon_admin(&$a,&$s) {
165 $geo_account = Config::get('geonames', 'username');
170 /* Add our stylesheet to the page so we can make our settings look nice */
172 $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->get_baseurl() . '/addon/geonames/geonames.css' . '" media="all" />' . "\r\n";
174 /* Get the current state of our config variable */
176 $enabled = PConfig::get(local_user(),'geonames','enable');
178 $checked = (($enabled) ? ' checked="checked" ' : '');
180 /* Add some HTML to the existing form */
182 $s .= '<div class="settings-block">';
183 $s .= '<h3>' . L10n::t('Geonames Settings') . '</h3>';
184 $s .= '<div id="geonames-enable-wrapper">';
185 $s .= '<label id="geonames-enable-label" for="geonames-checkbox">' . L10n::t('Enable Geonames Addon') . '</label>';
186 $s .= '<input id="geonames-checkbox" type="checkbox" name="geonames" value="1" ' . $checked . '/>';
187 $s .= '</div><div class="clear"></div>';
189 /* provide a submit button */
191 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="geonames-submit" class="settings-submit" value="' . L10n::t('Save Settings') . '" /></div></div>';