3 * StatusNet, the distributed open-source microblogging tool
5 * Plugin to provide map visualization of location data
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @copyright 2009 StatusNet Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
35 * Plugin to provide map visualization of location data
37 * This plugin uses the Mapstraction JavaScript library to
41 * @author Evan Prodromou <evan@status.net>
42 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43 * @link http://status.net/
47 class MapstractionPlugin extends Plugin
49 const VERSION = GNUSOCIAL_VERSION;
51 /** provider name, one of:
52 'cloudmade', 'microsoft', 'openlayers', 'yahoo' */
53 public $provider = 'openlayers';
54 /** provider API key (or 'appid'), if required ('yahoo' only) */
55 public $apikey = null;
60 * The way to register new actions from a plugin.
62 * @param Router $m reference to router
64 * @return boolean event handler return
66 function onRouterInitialized($m)
68 $m->connect(':nickname/all/map',
69 array('action' => 'allmap'),
70 array('nickname' => Nickname::DISPLAY_FMT));
71 $m->connect(':nickname/map',
72 array('action' => 'usermap'),
73 array('nickname' => Nickname::DISPLAY_FMT));
78 * Hook for adding extra JavaScript
80 * This makes sure our scripts get loaded for map-related pages
82 * @param Action $action Action object for the page
84 * @return boolean event handler return
86 function onEndShowScripts($action)
88 $actionName = $action->trimmed('action');
90 if (!in_array($actionName,
91 array('showstream', 'all', 'usermap', 'allmap'))) {
95 switch ($this->provider)
98 $action->script('http://tile.cloudmade.com/wml/0.2/web-maps-lite.js');
101 $action->script((GNUsocial::isHTTPS()?'https':'http') + '://dev.virtualearth.net/mapcontrol/mapcontrol.ashx?v=6');
104 // Use our included stripped & minified OpenLayers.
105 $action->script($this->path('OpenLayers/OpenLayers.js'));
108 $action->script(sprintf('http://api.maps.yahoo.com/ajaxymap?v=3.8&appid=%s',
109 urlencode($this->apikey)));
111 case 'geocommons': // don't support this yet
115 $action->script(sprintf('%s?(%s)',
116 $this->path('js/mxn.js'),
118 $action->script($this->path('usermap.js'));
120 $action->inlineScript(sprintf('var _provider = "%s";', $this->provider));
122 // usermap and allmap handle this themselves
124 if (in_array($actionName,
125 array('showstream', 'all'))) {
126 $action->inlineScript('$(document).ready(function() { '.
127 ' var user = null; '.
128 (($actionName == 'showstream') ? ' user = scrapeUser(); ' : '') .
129 ' var notices = scrapeNotices(user); ' .
130 ' var canvas = $("#map_canvas")[0]; ' .
131 ' if (typeof(canvas) != "undefined") { showMapstraction(canvas, notices); } '.
138 function onEndShowSections(Action $action)
140 $actionName = $action->trimmed('action');
141 // These are the ones that have maps on 'em
142 if (!in_array($actionName,
143 array('showstream', 'all'))) {
147 $action->elementStart('div', array('id' => 'entity_map',
148 'class' => 'section'));
150 // TRANS: Header for Map widget that displays a map with geodata for notices.
151 $action->element('h2', null, _m('Map'));
153 $action->element('div', array('id' => 'map_canvas',
154 'class' => 'gray smallmap',
155 'style' => "width: 100%; height: 240px"));
157 $mapAct = ($actionName == 'showstream') ? 'usermap' : 'allmap';
158 $mapUrl = common_local_url($mapAct,
159 array('nickname' => $action->trimmed('nickname')));
161 $action->element('a', array('href' => $mapUrl),
162 // TRANS: Clickable item to allow opening the map in full size.
165 $action->elementEnd('div');
168 function onPluginVersion(array &$versions)
170 $versions[] = array('name' => 'Mapstraction',
171 'version' => self::VERSION,
172 'author' => 'Evan Prodromou',
173 'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/Mapstraction',
175 // TRANS: Plugin description.
176 _m('Show maps of users\' and friends\' notices '.
177 'with <a href="http://www.mapstraction.com/">Mapstraction</a>.'));