plugins/GeoURLPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to add ICBM metadata to HTML pages and report data to GeoURL.org
   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 add ICBM metadata to HTML pages and report data to GeoURL.org
  36  *
  37  * Adds metadata to notice and profile pages that geourl.org and others
  38  * understand. Also, pings geourl.org when a new notice is saved or
  39  * a profile is changed.
  40  *
  41  * @category Plugin
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  *
  47  * @seeAlso  Location
  48  */
  49
  50 class GeoURLPlugin extends Plugin
  51 {
  52     public $ping = 'http://geourl.org/ping/';
  53
  54     /**
  55      * Add extra <meta> headers for certain pages that geourl.org understands
  56      *
  57      * @param Action $action page being shown
  58      *
  59      * @return boolean event handler flag
  60      */
  61
  62     function onEndShowHeadElements($action)
  63     {
  64         $name = $action->trimmed('action');
  65
  66         $location = null;
  67
  68         if ($name == 'showstream') {
  69             $profile = $action->profile;
  70             if (!empty($profile) && !empty($profile->lat) && !empty($profile->lon)) {
  71                 $location = $profile->lat . ', ' . $profile->lon;
  72             }
  73         } else if ($name == 'shownotice') {
  74             $notice = $action->profile;
  75             if (!empty($notice) && !empty($notice->lat) && !empty($notice->lon)) {
  76                 $location = $notice->lat . ', ' . $notice->lon;
  77             }
  78         }
  79
  80         if (!empty($location)) {
  81             $action->element('meta', array('name' => 'ICBM',
  82                                            'content' => $location));
  83             $action->element('meta', array('name' => 'DC.title',
  84                                            'content' => $action->title()));
  85         }
  86
  87         return true;
  88     }
  89
  90     /**
  91      * Report local notices to GeoURL.org when they're created
  92      *
  93      * @param Notice &$notice queued notice
  94      *
  95      * @return boolean event handler flag
  96      */
  97
  98     function onHandleQueuedNotice(&$notice)
  99     {
 100         if ($notice->is_local == 1) {
 101
 102             $request = HTTPClient::start();
 103
 104             $url = common_local_url('shownotice',
 105                                     array('notice' => $notice->id));
 106
 107             try {
 108                 $request->post($this->ping,
 109                                null,
 110                                array('p' => $url));
 111             } catch (HTTP_Request2_Exception $e) {
 112                 common_log(LOG_WARNING,
 113                            "GeoURL.org ping failed for '$url' ($this->ping)");
 114             }
 115         }
 116
 117         return true;
 118     }
 119
 120     function onPluginVersion(&$versions)
 121     {
 122         $versions[] = array('name' => 'GeoURL',
 123                             'version' => STATUSNET_VERSION,
 124                             'author' => 'Evan Prodromou',
 125                             'homepage' => 'http://status.net/wiki/Plugin:GeoURL',
 126                             'rawdescription' =>
 127                             _m('Ping <a href="http://geourl.org/">GeoURL</a> when '.
 128                                'new geolocation-enhanced notices are posted.'));
 129         return true;
 130     }
 131 }