plugins/Mapstraction/MapstractionPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to provide map visualization of location data
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  Action
  23  * @package   StatusNet
  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/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Plugin to provide map visualization of location data
  36  *
  37  * This plugin uses the Mapstraction JavaScript library to
  38  *
  39  * @category Plugin
  40  * @package  StatusNet
  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/
  44  *
  45  * @seeAlso  Location
  46  */
  47 class MapstractionPlugin extends Plugin
  48 {
  49     const VERSION = GNUSOCIAL_VERSION;
  50
  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;
  56
  57     /**
  58      * Hook for new URLs
  59      *
  60      * The way to register new actions from a plugin.
  61      *
  62      * @param Router $m reference to router
  63      *
  64      * @return boolean event handler return
  65      */
  66     function onRouterInitialized($m)
  67     {
  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));
  74         return true;
  75     }
  76
  77     /**
  78      * Hook for adding extra JavaScript
  79      *
  80      * This makes sure our scripts get loaded for map-related pages
  81      *
  82      * @param Action $action Action object for the page
  83      *
  84      * @return boolean event handler return
  85      */
  86     function onEndShowScripts($action)
  87     {
  88         $actionName = $action->trimmed('action');
  89
  90         if (!in_array($actionName,
  91                       array('showstream', 'all', 'usermap', 'allmap'))) {
  92             return true;
  93         }
  94
  95         switch ($this->provider)
  96         {
  97         case 'cloudmade':
  98             $action->script('http://tile.cloudmade.com/wml/0.2/web-maps-lite.js');
  99             break;
 100         case 'google':
 101             $action->script(sprintf('http://maps.google.com/maps?file=api&v=2&sensor=false&key=%s',
 102                                     urlencode($this->apikey)));
 103             break;
 104         case 'microsoft':
 105             $action->script((StatusNet::isHTTPS()?'https':'http') + '://dev.virtualearth.net/mapcontrol/mapcontrol.ashx?v=6');
 106             break;
 107         case 'openlayers':
 108             // Use our included stripped & minified OpenLayers.
 109             $action->script($this->path('OpenLayers/OpenLayers.js'));
 110             break;
 111         case 'yahoo':
 112             $action->script(sprintf('http://api.maps.yahoo.com/ajaxymap?v=3.8&appid=%s',
 113                                     urlencode($this->apikey)));
 114             break;
 115         case 'geocommons': // don't support this yet
 116         default:
 117             return true;
 118         }
 119         $action->script(sprintf('%s?(%s)',
 120                                 $this->path('js/mxn.js'),
 121                                 $this->provider));
 122         $action->script($this->path('usermap.js'));
 123
 124         $action->inlineScript(sprintf('var _provider = "%s";', $this->provider));
 125
 126         // usermap and allmap handle this themselves
 127
 128         if (in_array($actionName,
 129                      array('showstream', 'all'))) {
 130             $action->inlineScript('$(document).ready(function() { '.
 131                                   ' var user = null; '.
 132                                   (($actionName == 'showstream') ? ' user = scrapeUser(); ' : '') .
 133                                   ' var notices = scrapeNotices(user); ' .
 134                                   ' var canvas = $("#map_canvas")[0]; ' .
 135                                   ' if (typeof(canvas) != "undefined") { showMapstraction(canvas, notices); } '.
 136                                   '});');
 137         }
 138
 139         return true;
 140     }
 141
 142     function onEndShowSections($action)
 143     {
 144         $actionName = $action->trimmed('action');
 145         // These are the ones that have maps on 'em
 146         if (!in_array($actionName,
 147                       array('showstream', 'all'))) {
 148             return true;
 149         }
 150
 151         $action->elementStart('div', array('id' => 'entity_map',
 152                                          'class' => 'section'));
 153
 154         // TRANS: Header for Map widget that displays a map with geodata for notices.
 155         $action->element('h2', null, _m('Map'));
 156
 157         $action->element('div', array('id' => 'map_canvas',
 158                                     'class' => 'gray smallmap',
 159                                     'style' => "width: 100%; height: 240px"));
 160
 161         $mapAct = ($actionName == 'showstream') ? 'usermap' : 'allmap';
 162         $mapUrl =  common_local_url($mapAct,
 163                                     array('nickname' => $action->trimmed('nickname')));
 164
 165         $action->element('a', array('href' => $mapUrl),
 166                          // TRANS: Clickable item to allow opening the map in full size.
 167                          _m('Full size'));
 168
 169         $action->elementEnd('div');
 170     }
 171
 172     function onPluginVersion(&$versions)
 173     {
 174         $versions[] = array('name' => 'Mapstraction',
 175                             'version' => self::VERSION,
 176                             'author' => 'Evan Prodromou',
 177                             'homepage' => 'http://status.net/wiki/Plugin:Mapstraction',
 178                             'rawdescription' =>
 179                             // TRANS: Plugin description.
 180                             _m('Show maps of users\' and friends\' notices '.
 181                                'with <a href="http://www.mapstraction.com/">Mapstraction</a>.'));
 182         return true;
 183     }
 184 }