gnu-social/plugins/Mapstraction/MapstractionPlugin.php

181 lines
6.4 KiB
PHP
Raw Permalink Normal View History

2009-11-18 04:23:13 +00:00
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Plugin to provide map visualization of location data
*
* 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 provide map visualization of location data
*
* This plugin uses the Mapstraction JavaScript library to
*
* @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 MapstractionPlugin extends Plugin
{
const PLUGIN_VERSION = '2.0.0';
2010-01-08 08:38:20 +00:00
2009-11-18 04:23:13 +00:00
/** provider name, one of:
'cloudmade', 'microsoft', 'openlayers', 'yahoo' */
2009-11-18 04:23:13 +00:00
public $provider = 'openlayers';
/** provider API key (or 'appid'), if required ('yahoo' only) */
2009-11-18 04:23:13 +00:00
public $apikey = null;
/**
* Hook for new URLs
*
* The way to register new actions from a plugin.
*
* @param Router $m reference to router
2009-11-18 04:23:13 +00:00
*
* @return boolean event handler return
*/
function onRouterInitialized($m)
2009-11-18 04:23:13 +00:00
{
$m->connect(':nickname/all/map',
['action' => 'allmap'],
['nickname' => Nickname::DISPLAY_FMT]);
2009-11-18 04:23:13 +00:00
$m->connect(':nickname/map',
['action' => 'usermap'],
['nickname' => Nickname::DISPLAY_FMT]);
2009-11-18 04:23:13 +00:00
return true;
}
/**
* Hook for adding extra JavaScript
*
* This makes sure our scripts get loaded for map-related pages
*
* @param Action $action Action object for the page
*
* @return boolean event handler return
*/
function onEndShowScripts($action)
{
2009-11-19 17:34:56 +00:00
$actionName = $action->trimmed('action');
2009-11-18 04:23:13 +00:00
if (!in_array($actionName,
array('showstream', 'all', 'usermap', 'allmap'))) {
return true;
}
2009-11-18 04:23:13 +00:00
switch ($this->provider)
{
case 'cloudmade':
$action->script('http://tile.cloudmade.com/wml/0.2/web-maps-lite.js');
break;
case 'microsoft':
$action->script((GNUsocial::isHTTPS()?'https':'http') + '://dev.virtualearth.net/mapcontrol/mapcontrol.ashx?v=6');
2009-11-18 04:23:13 +00:00
break;
case 'openlayers':
// Use our included stripped & minified OpenLayers.
$action->script($this->path('OpenLayers/OpenLayers.js'));
2009-11-18 04:23:13 +00:00
break;
case 'yahoo':
$action->script(sprintf('http://api.maps.yahoo.com/ajaxymap?v=3.8&appid=%s',
urlencode($this->apikey)));
2009-11-18 04:23:13 +00:00
break;
case 'geocommons': // don't support this yet
default:
return true;
}
$action->script(sprintf('%s?(%s)',
$this->path('js/mxn.js'),
$this->provider));
$action->script($this->path('usermap.js'));
2009-11-19 17:34:56 +00:00
$action->inlineScript(sprintf('var _provider = "%s";', $this->provider));
// usermap and allmap handle this themselves
if (in_array($actionName,
array('showstream', 'all'))) {
$action->inlineScript('$(document).ready(function() { '.
' var user = null; '.
(($actionName == 'showstream') ? ' user = scrapeUser(); ' : '') .
' var notices = scrapeNotices(user); ' .
' var canvas = $("#map_canvas")[0]; ' .
' if (typeof(canvas) != "undefined") { showMapstraction(canvas, notices); } '.
'});');
}
2009-11-18 04:23:13 +00:00
return true;
}
2009-11-19 17:34:56 +00:00
function onEndShowSections(Action $action)
2009-11-19 17:34:56 +00:00
{
$actionName = $action->trimmed('action');
// These are the ones that have maps on 'em
if (!in_array($actionName,
array('showstream', 'all'))) {
return true;
}
$action->elementStart('div', array('id' => 'entity_map',
'class' => 'section'));
// TRANS: Header for Map widget that displays a map with geodata for notices.
$action->element('h2', null, _m('Map'));
2009-11-19 17:34:56 +00:00
$action->element('div', array('id' => 'map_canvas',
'class' => 'gray smallmap',
'style' => "width: 100%; height: 240px"));
$mapAct = ($actionName == 'showstream') ? 'usermap' : 'allmap';
$mapUrl = common_local_url($mapAct,
array('nickname' => $action->trimmed('nickname')));
$action->element('a', array('href' => $mapUrl),
// TRANS: Clickable item to allow opening the map in full size.
_m('Full size'));
2009-11-19 17:34:56 +00:00
$action->elementEnd('div');
}
2010-01-08 08:38:20 +00:00
public function onPluginVersion(array &$versions): bool
2010-01-08 08:38:20 +00:00
{
$versions[] = array('name' => 'Mapstraction',
'version' => self::PLUGIN_VERSION,
2010-01-08 08:38:20 +00:00
'author' => 'Evan Prodromou',
'homepage' => GNUSOCIAL_ENGINE_REPO_URL . 'tree/master/plugins/Mapstraction',
2010-01-08 08:38:20 +00:00
'rawdescription' =>
// TRANS: Plugin description.
2010-01-08 08:38:20 +00:00
_m('Show maps of users\' and friends\' notices '.
'with <a href="http://www.mapstraction.com/">Mapstraction</a>.'));
2010-01-08 08:38:20 +00:00
return true;
}
2009-11-18 04:23:13 +00:00
}