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             include_once INSTALLDIR.'/plugins/Mapstraction/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  94             return false;
  95         default:
  96             return true;
  97         }
  98     }
  99
 100     /**
 101      * Hook for adding extra JavaScript
 102      *
 103      * This makes sure our scripts get loaded for map-related pages
 104      *
 105      * @param Action $action Action object for the page
 106      *
 107      * @return boolean event handler return
 108      */
 109
 110     function onEndShowScripts($action)
 111     {
 112         // These are the ones that have maps on 'em
 113         if (!in_array($action->trimmed('action'),
 114                       array('showstream', 'all', 'allmap', 'usermap'))) {
 115             return true;
 116         }
 117
 118         switch ($this->provider)
 119         {
 120         case 'cloudmade':
 121             $action->script('http://tile.cloudmade.com/wml/0.2/web-maps-lite.js');
 122             break;
 123         case 'google':
 124             $action->script(sprintf('http://maps.google.com/maps?file=api&amp;v=2&amp;sensor=false&amp;key=%s',
 125                                     $this->apikey));
 126             break;
 127         case 'microsoft':
 128             $action->script('http://dev.virtualearth.net/mapcontrol/mapcontrol.ashx?v=6');
 129             break;
 130         case 'openlayers':
 131             // XXX: is this not nice...?
 132             $action->script('http://openlayers.org/api/OpenLayers.js');
 133             break;
 134         case 'yahoo':
 135             $action->script(sprintf('http://api.maps.yahoo.com/ajaxymap?v=3.8&appid=%s',
 136                                     $this->apikey));
 137             break;
 138         case 'geocommons': // don't support this yet
 139         default:
 140             return true;
 141         }
 142
 143         $action->script(sprintf('%s?(%s)',
 144                                 common_path('plugins/Mapstraction/js/mxn.js'),
 145                                 $this->provider));
 146
 147         return true;
 148     }
 149 }