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/
48 class MapstractionPlugin extends Plugin
50 /** provider name, one of:
51 'cloudmade', 'google', 'microsoft', 'openlayers', 'yahoo' */
52 public $provider = 'openlayers';
53 /** provider API key (or 'appid'), if required ('google' and 'yahoo' only) */
54 public $apikey = null;
59 * The way to register new actions from a plugin.
61 * @param Router $m reference to router
63 * @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
87 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
110 function onEndShowScripts($action)
112 $actionName = $action->trimmed('action');
113 // These are the ones that have maps on 'em
114 if (!in_array($actionName,
115 array('showstream', 'all', 'allmap', 'usermap'))) {
119 switch ($this->provider)
122 $action->script('http://tile.cloudmade.com/wml/0.2/web-maps-lite.js');
125 $action->script(sprintf('http://maps.google.com/maps?file=api&v=2&sensor=false&key=%s',
129 $action->script('http://dev.virtualearth.net/mapcontrol/mapcontrol.ashx?v=6');
132 // XXX: is this not nice...?
133 $action->script('http://openlayers.org/api/OpenLayers.js');
136 $action->script(sprintf('http://api.maps.yahoo.com/ajaxymap?v=3.8&appid=%s',
139 case 'geocommons': // don't support this yet
144 $action->script(sprintf('%s?(%s)',
145 common_path('plugins/Mapstraction/js/mxn.js'),
148 $action->script(common_path('plugins/Mapstraction/usermap.js'));
150 $action->elementStart('script', array('type' => 'text/javascript'));
151 $action->raw(sprintf('var _provider = "%s";', $this->provider));
152 $action->elementEnd('script');
154 switch ($actionName) {
157 $notice = empty($action->tag)
158 ? $action->user->getNotices(($action->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1)
159 : $action->user->getTaggedNotices($action->tag, ($action->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1, 0, 0, null);
163 $cur = common_current_user();
164 if (!empty($cur) && $cur->id == $action->user->id) {
165 $notice = $action->user->noticeInbox(($action->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
167 $notice = $action->user->noticesWithFriends(($action->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
172 $jsonArray = array();
174 while ($notice->fetch()) {
175 if (!empty($notice->lat) && !empty($notice->lon)) {
176 $jsonNotice = $this->noticeAsJson($notice);
177 $jsonArray[] = $jsonNotice;
181 $action->elementStart('script', array('type' => 'text/javascript'));
182 $action->raw('var _notices = ' . json_encode($jsonArray));
183 $action->elementEnd('script');
188 function onEndShowSections($action)
190 $actionName = $action->trimmed('action');
191 // These are the ones that have maps on 'em
192 if (!in_array($actionName,
193 array('showstream', 'all'))) {
197 $action->elementStart('div', array('id' => 'entity_map',
198 'class' => 'section'));
200 $action->element('h2', null, _('Map'));
202 $action->element('div', array('id' => 'map_canvas',
203 'class' => 'gray smallmap',
204 'style' => "width: 100%; height: 240px"));
206 $mapAct = ($actionName == 'showstream') ? 'usermap' : 'allmap';
207 $mapUrl = common_local_url($mapAct,
208 array('nickname' => $action->trimmed('nickname')));
210 $action->element('a', array('href' => $mapUrl),
213 $action->elementEnd('div');
216 function noticeAsJson($notice)
218 // FIXME: this code should be abstracted to a neutral third
219 // party, like Notice::asJson(). I'm not sure of the ethics
220 // of refactoring from within a plugin, so I'm just abusing
221 // the ApiAction method. Don't do this unless you're me!
223 require_once(INSTALLDIR.'/lib/api.php');
225 $act = new ApiAction('/dev/null');
227 $arr = $act->twitterStatusArray($notice, true);
228 $arr['url'] = $notice->bestUrl();
229 $arr['html'] = $notice->rendered;
230 $arr['source'] = $arr['source'];
232 if (!empty($notice->reply_to)) {
233 $reply_to = Notice::staticGet('id', $notice->reply_to);
234 if (!empty($reply_to)) {
235 $arr['in_reply_to_status_url'] = $reply_to->bestUrl();
240 $profile = $notice->getProfile();
241 $arr['user']['profile_url'] = $profile->profileurl;