friendica-addons/geonames/geonames.php

205 lines
5.4 KiB
PHP
Raw Normal View History

2012-02-05 23:14:57 -05:00
<?php
/**
* Name: Geonames
* Description: Use Geonames service to resolve nearest populated location for given latitude, longitude
* Version: 1.0
* Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
2018-06-27 23:12:27 -04:00
*
*
2012-02-05 23:14:57 -05:00
* Pre-requisite: Register a username at geonames.org
* and set in config/addon.config.php
2018-06-27 23:12:27 -04:00
*
* [geonames]
* username = your_username
2012-02-05 23:14:57 -05:00
*
* Also visit http://geonames.org/manageaccount and enable access to the free web services
*
* When addon is installed, the system calls the addon
2012-02-05 23:14:57 -05:00
* name_install() function, located in 'addon/name/name.php',
* where 'name' is the name of the addon.
2018-06-27 23:12:27 -04:00
* If the addon is removed from the configuration list, the
2012-02-05 23:14:57 -05:00
* system will call the name_uninstall() function.
*
*/
2019-02-03 16:22:03 -05:00
use Friendica\Core\Config;
use Friendica\Core\Hook;
2018-01-22 14:03:11 -05:00
use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\PConfig;
use Friendica\Util\Network;
use Friendica\Util\XML;
2012-02-05 23:14:57 -05:00
function geonames_install() {
Hook::register('load_config', 'addon/geonames/geonames.php', 'geonames_load_config');
2018-06-27 23:12:27 -04:00
2012-02-05 23:14:57 -05:00
/**
2018-06-27 23:12:27 -04:00
*
* Our addon will attach in three places.
2012-02-05 23:14:57 -05:00
* The first is just prior to storing a local post.
*
*/
Hook::register('post_local', 'addon/geonames/geonames.php', 'geonames_post_hook');
2012-02-05 23:14:57 -05:00
/**
*
2018-06-27 23:12:27 -04:00
* Then we'll attach into the addon settings page, and also the
2012-02-05 23:14:57 -05:00
* settings post hook so that we can create and update
* user preferences.
*
*/
Hook::register('addon_settings', 'addon/geonames/geonames.php', 'geonames_addon_admin');
Hook::register('addon_settings_post', 'addon/geonames/geonames.php', 'geonames_addon_admin_post');
2012-02-05 23:14:57 -05:00
Logger::log("installed geonames");
2012-02-05 23:14:57 -05:00
}
function geonames_uninstall() {
/**
*
* uninstall unregisters any hooks created with register_hook
* during install. It may also delete configuration settings
* and any other cleanup.
*
*/
Hook::unregister('load_config', 'addon/geonames/geonames.php', 'geonames_load_config');
Hook::unregister('post_local', 'addon/geonames/geonames.php', 'geonames_post_hook');
Hook::unregister('addon_settings', 'addon/geonames/geonames.php', 'geonames_addon_admin');
Hook::unregister('addon_settings_post', 'addon/geonames/geonames.php', 'geonames_addon_admin_post');
2012-02-05 23:14:57 -05:00
Logger::log("removed geonames");
2012-02-05 23:14:57 -05:00
}
2019-02-10 14:10:59 -05:00
function geonames_load_config(\Friendica\App $a, Config\Cache\ConfigCacheLoader $loader)
2018-06-27 23:12:27 -04:00
{
2019-02-10 14:10:59 -05:00
$a->getConfigCache()->load($loader->loadAddonConfig('geonames'));
2018-06-27 23:12:27 -04:00
}
2012-02-05 23:14:57 -05:00
function geonames_post_hook($a, &$item) {
/**
*
* An item was posted on the local system.
* We are going to look for specific items:
* - A status post by a profile owner
* - The profile owner must have allowed our addon
2012-02-05 23:14:57 -05:00
*
*/
Logger::log('geonames invoked');
2012-02-05 23:14:57 -05:00
if(! local_user()) /* non-zero if this is a logged in user of this system */
return;
if(local_user() != $item['uid']) /* Does this person own the post? */
return;
if($item['parent']) /* If the item has a parent, this is a comment or something else, not a status post. */
return;
/* Retrieve our personal config setting */
$geo_account = Config::get('geonames', 'username');
$active = PConfig::get(local_user(), 'geonames', 'enable');
2012-02-05 23:14:57 -05:00
if((! $geo_account) || (! $active))
return;
if((! $item['coord']) || ($item['location']))
return;
$coords = explode(' ',$item['coord']);
/**
*
* OK, we're allowed to do our stuff.
*
*/
$s = Network::fetchUrl('http://api.geonames.org/findNearbyPlaceName?lat=' . $coords[0] . '&lng=' . $coords[1] . '&username=' . $geo_account);
2012-02-05 23:14:57 -05:00
if(! $s)
return;
$xml = XML::parseString($s);
2012-02-05 23:14:57 -05:00
if($xml->geoname->name && $xml->geoname->countryName)
$item['location'] = $xml->geoname->name . ', ' . $xml->geoname->countryName;
2018-10-30 09:48:09 -04:00
// Logger::log('geonames : ' . print_r($xml,true), Logger::DATA);
2012-02-05 23:14:57 -05:00
return;
}
/**
*
* Callback from the settings post function.
* $post contains the $_POST array.
* We will make sure we've got a valid user account
* and if so set our configuration setting for this person.
*
*/
function geonames_addon_admin_post($a,$post) {
if(! local_user() || empty($_POST['geonames-submit']))
2012-02-05 23:14:57 -05:00
return;
PConfig::set(local_user(),'geonames','enable',intval($_POST['geonames']));
2012-02-05 23:14:57 -05:00
2018-01-22 14:03:11 -05:00
info(L10n::t('Geonames settings updated.') . EOL);
2012-02-05 23:14:57 -05:00
}
/**
*
2018-06-27 23:12:27 -04:00
* Called from the Addon Setting form.
2012-02-05 23:14:57 -05:00
* Add our own settings info to the page.
*
*/
function geonames_addon_admin(&$a,&$s) {
2012-02-05 23:14:57 -05:00
if(! local_user())
return;
$geo_account = Config::get('geonames', 'username');
2012-02-05 23:14:57 -05:00
if(! $geo_account)
return;
/* Add our stylesheet to the page so we can make our settings look nice */
$a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->getBaseURL() . '/addon/geonames/geonames.css' . '" media="all" />' . "\r\n";
2012-02-05 23:14:57 -05:00
/* Get the current state of our config variable */
$enabled = PConfig::get(local_user(),'geonames','enable');
2012-02-05 23:14:57 -05:00
$checked = (($enabled) ? ' checked="checked" ' : '');
/* Add some HTML to the existing form */
$s .= '<div class="settings-block">';
2018-01-22 14:03:11 -05:00
$s .= '<h3>' . L10n::t('Geonames Settings') . '</h3>';
2012-02-05 23:14:57 -05:00
$s .= '<div id="geonames-enable-wrapper">';
2018-01-22 14:03:11 -05:00
$s .= '<label id="geonames-enable-label" for="geonames-checkbox">' . L10n::t('Enable Geonames Addon') . '</label>';
2012-02-05 23:14:57 -05:00
$s .= '<input id="geonames-checkbox" type="checkbox" name="geonames" value="1" ' . $checked . '/>';
$s .= '</div><div class="clear"></div>';
/* provide a submit button */
2018-01-22 14:03:11 -05:00
$s .= '<div class="settings-submit-wrapper" ><input type="submit" name="geonames-submit" class="settings-submit" value="' . L10n::t('Save Settings') . '" /></div></div>';
2012-02-05 23:14:57 -05:00
}