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 = STATUSNET_VERSION;
51 /** provider name, one of:
52 'cloudmade', 'google', 'microsoft', 'openlayers', 'yahoo' */
53 public $provider = 'openlayers';
54 /** provider API key (or 'appid'), if required ('google' and '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(sprintf('http://maps.google.com/maps?file=api&v=2&sensor=false&key=%s',
102 urlencode($this->apikey)));
105 $action->script((StatusNet::isHTTPS()?'https':'http') + '://dev.virtualearth.net/mapcontrol/mapcontrol.ashx?v=6');
108 // Use our included stripped & minified OpenLayers.
109 $action->script($this->path('OpenLayers/OpenLayers.js'));
112 $action->script(sprintf('http://api.maps.yahoo.com/ajaxymap?v=3.8&appid=%s',
113 urlencode($this->apikey)));
115 case 'geocommons': // don't support this yet
120 if ($this->provider == 'openlayers') {
121 // We have an optimized path for our default case.
123 // Note that OpenLayers.js needs to be separate, or it won't
124 // be able to find its UI images and styles.
125 $action->script($this->path('usermap-mxn-openlayers.min.js'));
127 $action->script(sprintf('%s?(%s)',
128 $this->path('js/mxn.js'),
131 $action->script($this->path('usermap.js'));
134 $action->inlineScript(sprintf('var _provider = "%s";', $this->provider));
136 // usermap and allmap handle this themselves
138 if (in_array($actionName,
139 array('showstream', 'all'))) {
140 $action->inlineScript('$(document).ready(function() { '.
141 ' var user = null; '.
142 (($actionName == 'showstream') ? ' user = scrapeUser(); ' : '') .
143 ' var notices = scrapeNotices(user); ' .
144 ' var canvas = $("#map_canvas")[0]; ' .
145 ' if (typeof(canvas) != "undefined") { showMapstraction(canvas, notices); } '.
152 function onEndShowSections($action)
154 $actionName = $action->trimmed('action');
155 // These are the ones that have maps on 'em
156 if (!in_array($actionName,
157 array('showstream', 'all'))) {
161 $action->elementStart('div', array('id' => 'entity_map',
162 'class' => 'section'));
164 // TRANS: Header for Map widget that displays a map with geodata for notices.
165 $action->element('h2', null, _m('Map'));
167 $action->element('div', array('id' => 'map_canvas',
168 'class' => 'gray smallmap',
169 'style' => "width: 100%; height: 240px"));
171 $mapAct = ($actionName == 'showstream') ? 'usermap' : 'allmap';
172 $mapUrl = common_local_url($mapAct,
173 array('nickname' => $action->trimmed('nickname')));
175 $action->element('a', array('href' => $mapUrl),
176 // TRANS: Clickable item to allow opening the map in full size.
179 $action->elementEnd('div');
182 function onPluginVersion(&$versions)
184 $versions[] = array('name' => 'Mapstraction',
185 'version' => self::VERSION,
186 'author' => 'Evan Prodromou',
187 'homepage' => 'http://status.net/wiki/Plugin:Mapstraction',
189 // TRANS: Plugin description.
190 _m('Show maps of users\' and friends\' notices '.
191 'with <a href="http://www.mapstraction.com/">Mapstraction</a>.'));