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_FMT.']{1,64}'));
71 $m->connect(':nickname/map',
72 array('action' => 'usermap'),
73 array('nickname' => '['.NICKNAME_FMT.']{1,64}'));
78 * Hook for autoloading classes
80 * This makes sure our classes get autoloaded from our directory
82 * @param string $cls name of class being used
84 * @return boolean event handler return
86 function onAutoload($cls)
93 include_once INSTALLDIR.'/plugins/Mapstraction/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
101 * Hook for adding extra JavaScript
103 * This makes sure our scripts get loaded for map-related pages
105 * @param Action $action Action object for the page
107 * @return boolean event handler return
109 function onEndShowScripts($action)
111 $actionName = $action->trimmed('action');
113 if (!in_array($actionName,
114 array('showstream', 'all', 'usermap', 'allmap'))) {
118 switch ($this->provider)
121 $action->script('http://tile.cloudmade.com/wml/0.2/web-maps-lite.js');
124 $action->script(sprintf('http://maps.google.com/maps?file=api&v=2&sensor=false&key=%s',
125 urlencode($this->apikey)));
128 $action->script('http://dev.virtualearth.net/mapcontrol/mapcontrol.ashx?v=6');
131 // XXX: is this not nice...?
132 $action->script('http://openlayers.org/api/OpenLayers.js');
135 $action->script(sprintf('http://api.maps.yahoo.com/ajaxymap?v=3.8&appid=%s',
136 urlencode($this->apikey)));
138 case 'geocommons': // don't support this yet
143 $action->script(sprintf('%s?(%s)',
144 common_path('plugins/Mapstraction/js/mxn.js'),
147 $action->script(common_path('plugins/Mapstraction/usermap.js'));
149 $action->inlineScript(sprintf('var _provider = "%s";', $this->provider));
151 // usermap and allmap handle this themselves
153 if (in_array($actionName,
154 array('showstream', 'all'))) {
155 $action->inlineScript('$(document).ready(function() { '.
156 ' var user = null; '.
157 (($actionName == 'showstream') ? ' user = scrapeUser(); ' : '') .
158 ' var notices = scrapeNotices(user); ' .
159 ' showMapstraction($("#map_canvas"), notices); '.
166 function onEndShowSections($action)
168 $actionName = $action->trimmed('action');
169 // These are the ones that have maps on 'em
170 if (!in_array($actionName,
171 array('showstream', 'all'))) {
175 $action->elementStart('div', array('id' => 'entity_map',
176 'class' => 'section'));
178 $action->element('h2', null, _m('Map'));
180 $action->element('div', array('id' => 'map_canvas',
181 'class' => 'gray smallmap',
182 'style' => "width: 100%; height: 240px"));
184 $mapAct = ($actionName == 'showstream') ? 'usermap' : 'allmap';
185 $mapUrl = common_local_url($mapAct,
186 array('nickname' => $action->trimmed('nickname')));
188 $action->element('a', array('href' => $mapUrl),
189 // TRANS: Clickable item to allow opening the map in full size.
192 $action->elementEnd('div');
195 function onPluginVersion(&$versions)
197 $versions[] = array('name' => 'Mapstraction',
198 'version' => self::VERSION,
199 'author' => 'Evan Prodromou',
200 'homepage' => 'http://status.net/wiki/Plugin:Mapstraction',
202 _m('Show maps of users\' and friends\' notices '.
203 'with <a href="http://www.mapstraction.com/">Mapstraction</a>.'));