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
  48 class MapstractionPlugin extends Plugin
  49 {
  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;
  55
  56     /**
  57      * Hook for new URLs
  58      *
  59      * The way to register new actions from a plugin.
  60      *
  61      * @param Router $m reference to router
  62      *
  63      * @return boolean event handler return
  64      */
  65
  66     function onRouterInitialized($m)
  67     {
  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}'));
  74         return true;
  75     }
  76
  77     /**
  78      * Hook for autoloading classes
  79      *
  80      * This makes sure our classes get autoloaded from our directory
  81      *
  82      * @param string $cls name of class being used
  83      *
  84      * @return boolean event handler return
  85      */
  86
  87     function onAutoload($cls)
  88     {
  89         switch ($cls)
  90         {
  91         case 'AllmapAction':
  92         case 'UsermapAction':
  93         case 'MapAction':
  94             include_once INSTALLDIR.'/plugins/Mapstraction/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  95             return false;
  96         default:
  97             return true;
  98         }
  99     }
 100
 101     /**
 102      * Hook for adding extra JavaScript
 103      *
 104      * This makes sure our scripts get loaded for map-related pages
 105      *
 106      * @param Action $action Action object for the page
 107      *
 108      * @return boolean event handler return
 109      */
 110
 111     function onEndShowScripts($action)
 112     {
 113         $actionName = $action->trimmed('action');
 114
 115         if (!in_array($actionName,
 116                       array('showstream', 'all', 'usermap', 'allmap'))) {
 117             return true;
 118         }
 119
 120         switch ($this->provider)
 121         {
 122         case 'cloudmade':
 123             $action->script('http://tile.cloudmade.com/wml/0.2/web-maps-lite.js');
 124             break;
 125         case 'google':
 126             $action->script(sprintf('http://maps.google.com/maps?file=api&amp;v=2&amp;sensor=false&amp;key=%s',
 127                                     $this->apikey));
 128             break;
 129         case 'microsoft':
 130             $action->script('http://dev.virtualearth.net/mapcontrol/mapcontrol.ashx?v=6');
 131             break;
 132         case 'openlayers':
 133             // XXX: is this not nice...?
 134             $action->script('http://openlayers.org/api/OpenLayers.js');
 135             break;
 136         case 'yahoo':
 137             $action->script(sprintf('http://api.maps.yahoo.com/ajaxymap?v=3.8&appid=%s',
 138                                     $this->apikey));
 139             break;
 140         case 'geocommons': // don't support this yet
 141         default:
 142             return true;
 143         }
 144
 145         $action->script(sprintf('%s?(%s)',
 146                                 common_path('plugins/Mapstraction/js/mxn.js'),
 147                                 $this->provider));
 148
 149         $action->script(common_path('plugins/Mapstraction/usermap.js'));
 150
 151         $action->inlineScript(sprintf('var _provider = "%s";', $this->provider));
 152
 153         // usermap and allmap handle this themselves
 154
 155         if (in_array($actionName,
 156                      array('showstream', 'all'))) {
 157             $action->inlineScript('$(document).ready(function() { '.
 158                                   ' var user = null; '.
 159                                   (($actionName == 'showstream') ? ' user = scrapeUser(); ' : '') .
 160                                   ' var notices = scrapeNotices(user); ' .
 161                                   ' showMapstraction($("#map_canvas"), notices); '.
 162                                   '});');
 163         }
 164
 165         return true;
 166     }
 167
 168     function onEndShowSections($action)
 169     {
 170         $actionName = $action->trimmed('action');
 171         // These are the ones that have maps on 'em
 172         if (!in_array($actionName,
 173                       array('showstream', 'all'))) {
 174             return true;
 175         }
 176
 177         $action->elementStart('div', array('id' => 'entity_map',
 178                                          'class' => 'section'));
 179
 180         $action->element('h2', null, _('Map'));
 181
 182         $action->element('div', array('id' => 'map_canvas',
 183                                     'class' => 'gray smallmap',
 184                                     'style' => "width: 100%; height: 240px"));
 185
 186         $mapAct = ($actionName == 'showstream') ? 'usermap' : 'allmap';
 187         $mapUrl =  common_local_url($mapAct,
 188                                     array('nickname' => $action->trimmed('nickname')));
 189
 190         $action->element('a', array('href' => $mapUrl),
 191                          _("Full size"));
 192
 193         $action->elementEnd('div');
 194     }
 195 }