plugins/BitlyUrl/BitlyUrlPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to use bit.ly URL shortening services.
   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  Plugin
  23  * @package   StatusNet
  24  * @author    Craig Andrews <candrews@integralblue.com>
  25  * @author    Brion Vibber <brion@status.net>
  26  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  27  * @copyright 2010 StatusNet, Inc http://status.net/
  28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  29  * @link      http://status.net/
  30  */
  31
  32 if (!defined('STATUSNET')) {
  33     exit(1);
  34 }
  35
  36 class BitlyUrlPlugin extends UrlShortenerPlugin
  37 {
  38     public $shortenerName = 'bit.ly';
  39     public $serviceUrl = 'http://bit.ly/api?method=shorten&version=2.0.1&longUrl=%s';
  40     public $login; // To set a site-default when admins or users don't override it.
  41     public $apiKey;
  42
  43     function onInitializePlugin(){
  44         parent::onInitializePlugin();
  45         if(!isset($this->serviceUrl)){
  46             // TRANS: Exception thrown when bit.ly URL shortening plugin was configured incorrectly.
  47             throw new Exception(_m('You must specify a serviceUrl for bit.ly URL shortening.'));
  48         }
  49     }
  50
  51     /**
  52      * Add bit.ly to the list of available URL shorteners if it's configured,
  53      * otherwise leave it out.
  54      *
  55      * @param array $shorteners
  56      * @return boolean hook return value
  57      */
  58     function onGetUrlShorteners(&$shorteners)
  59     {
  60         if ($this->getLogin() && $this->getApiKey()) {
  61             return parent::onGetUrlShorteners($shorteners);
  62         }
  63         return true;
  64     }
  65
  66     /**
  67      * Short a URL
  68      * @param url
  69      * @return string shortened version of the url, or null if URL shortening failed
  70      */
  71     protected function shorten($url) {
  72         $response = $this->query($url);
  73         if ($this->isOk($url, $response)) {
  74             return $this->decode($url, $response->getBody());
  75         } else {
  76             return null;
  77         }
  78     }
  79
  80     /**
  81      * Get the user's or site-wide default bit.ly login name.
  82      *
  83      * @return string
  84      */
  85     protected function getLogin()
  86     {
  87         $login = common_config('bitly', 'default_login');
  88         if (!$login) {
  89             $login = $this->login;
  90         }
  91         return $login;
  92     }
  93
  94     /**
  95      * Get the user's or site-wide default bit.ly API key.
  96      *
  97      * @return string
  98      */
  99     protected function getApiKey()
 100     {
 101         $key = common_config('bitly', 'default_apikey');
 102         if (!$key) {
 103             $key = $this->apiKey;
 104         }
 105         return $key;
 106     }
 107
 108     /**
 109      * Inject API key into query before sending out...
 110      *
 111      * @param string $url
 112      * @return HTTPResponse
 113      */
 114     protected function query($url)
 115     {
 116         // http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/shorten
 117         $params = http_build_query(array(
 118             'login' => $this->getLogin(),
 119             'apiKey' => $this->getApiKey()), '', '&');
 120         $serviceUrl = sprintf($this->serviceUrl, urlencode($url)) . '&' . $params;
 121
 122         $request = HTTPClient::start();
 123         return $request->get($serviceUrl);
 124     }
 125
 126     /**
 127      * JSON decode for API result
 128      */
 129     protected function decode($url, $body)
 130     {
 131         $json = json_decode($body, true);
 132         return $json['results'][$url]['shortUrl'];
 133     }
 134
 135     /**
 136      * JSON decode for API result
 137      */
 138     protected function isOk($url, $response)
 139     {
 140         $code = 'unknown';
 141         $msg = '';
 142         if ($response->isOk()) {
 143             $body = $response->getBody();
 144             common_log(LOG_INFO, $body);
 145             $json = json_decode($body, true);
 146             if ($json['statusCode'] == 'OK') {
 147                 if (!isset($json['results'][$url])) {
 148                     common_log(LOG_ERR, "bit.ly returned OK response, but didn't find expected URL $url in $body");
 149                     return false;
 150                 }
 151                 $data = $json['results'][$url];
 152                 if (isset($data['shortUrl'])) {
 153                     return true;
 154                 } else if (isset($data['statusCode']) && $data['statusCode'] == 'ERROR') {
 155                     $code = $data['errorCode'];
 156                     $msg = $data['errorMessage'];
 157                 }
 158             } else if ($json['statusCode'] == 'ERROR') {
 159                 $code = $json['errorCode'];
 160                 $msg = $json['errorMessage'];
 161             }
 162             common_log(LOG_ERR, "bit.ly returned error $code $msg for $url");
 163         }
 164         return false;
 165     }
 166
 167     function onPluginVersion(&$versions)
 168     {
 169         $versions[] = array('name' => sprintf('BitlyUrl (%s)', $this->shortenerName),
 170                             'version' => STATUSNET_VERSION,
 171                             'author' => 'Craig Andrews, Brion Vibber',
 172                             'homepage' => 'http://status.net/wiki/Plugin:BitlyUrl',
 173                             'rawdescription' =>
 174                             // TRANS: Plugin description. %1$s is the URL shortening service base URL (for example "bit.ly").
 175                             sprintf(_m('Uses <a href="http://%1$s/">%1$s</a> URL-shortener service.'),
 176                                     $this->shortenerName));
 177
 178         return true;
 179     }
 180
 181     /**
 182      * Hook for RouterInitialized event.
 183      *
 184      * @param Net_URL_Mapper $m path-to-action mapper
 185      * @return boolean hook return
 186      */
 187     function onRouterInitialized($m)
 188     {
 189         $m->connect('panel/bitly',
 190                     array('action' => 'bitlyadminpanel'));
 191         return true;
 192     }
 193
 194     /**
 195      * If the plugin's installed, this should be accessible to admins.
 196      */
 197     function onAdminPanelCheck($name, &$isOK)
 198     {
 199         if ($name == 'bitly') {
 200             $isOK = true;
 201             return false;
 202         }
 203
 204         return true;
 205     }
 206
 207     /**
 208      * Add the bit.ly admin panel to the list...
 209      */
 210     function onEndAdminPanelNav($nav)
 211     {
 212         if (AdminPanelAction::canAdmin('bitly')) {
 213             $action_name = $nav->action->trimmed('action');
 214
 215             $nav->out->menuItem(common_local_url('bitlyadminpanel'),
 216                                 // TRANS: Menu item in administration menus for bit.ly URL shortening settings.
 217                                 _m('bit.ly'),
 218                                 // TRANS: Title for menu item in administration menus for bit.ly URL shortening settings.
 219                                 _m('bit.ly URL shortening.'),
 220                                 $action_name == 'bitlyadminpanel',
 221                                 'nav_bitly_admin_panel');
 222         }
 223
 224         return true;
 225     }
 226
 227     /**
 228      * Automatically load the actions and libraries used by the plugin
 229      *
 230      * @param Class $cls the class
 231      *
 232      * @return boolean hook return
 233      *
 234      */
 235     function onAutoload($cls)
 236     {
 237         $base = dirname(__FILE__);
 238         $lower = strtolower($cls);
 239         switch ($lower) {
 240         case 'bitlyadminpanelaction':
 241             require_once "$base/$lower.php";
 242             return false;
 243         default:
 244             return true;
 245         }
 246     }
 247
 248     /**
 249      * Internal hook point to check the default global credentials so
 250      * the admin form knows if we have a fallback or not.
 251      *
 252      * @param string $login
 253      * @param string $apiKey
 254      * @return boolean hook return value
 255      */
 256     function onBitlyDefaultCredentials(&$login, &$apiKey)
 257     {
 258         $login = $this->login;
 259         $apiKey = $this->apiKey;
 260         return false;
 261     }
 262
 263 }