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     const PLUGIN_VERSION = '2.0.0';
  39
  40     public $shortenerName = 'bit.ly';
  41     public $serviceUrl = 'http://api.bit.ly/v3/shorten?longUrl=%s';
  42     public $login; // To set a site-default when admins or users don't override it.
  43     public $apiKey;
  44
  45     function onInitializePlugin(){
  46         parent::onInitializePlugin();
  47         if(!isset($this->serviceUrl)){
  48             // TRANS: Exception thrown when bit.ly URL shortening plugin was configured incorrectly.
  49             throw new Exception(_m('You must specify a serviceUrl for bit.ly URL shortening.'));
  50         }
  51     }
  52
  53     /**
  54      * Add bit.ly to the list of available URL shorteners if it's configured,
  55      * otherwise leave it out.
  56      *
  57      * @param array $shorteners
  58      * @return boolean hook return value
  59      */
  60     function onGetUrlShorteners(&$shorteners)
  61     {
  62         if ($this->getLogin() && $this->getApiKey()) {
  63             return parent::onGetUrlShorteners($shorteners);
  64         }
  65         return true;
  66     }
  67
  68     /**
  69      * Short a URL
  70      * @param url
  71      * @return string shortened version of the url, or null if URL shortening failed
  72      */
  73     protected function shorten($url) {
  74         common_log(LOG_INFO, "bit.ly call for $url");
  75         $response = $this->query($url);
  76         common_log(LOG_INFO, "bit.ly answer for $url is ".$response->getBody());
  77         return $this->decode($url, $response);
  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         $params = http_build_query(array(
 117             'login' => $this->getLogin(),
 118             'apiKey' => $this->getApiKey()), '', '&');
 119         $serviceUrl = sprintf($this->serviceUrl, urlencode($url)) . '&' . $params;
 120
 121         $request = HTTPClient::start();
 122         return $request->get($serviceUrl);
 123     }
 124
 125     /**
 126      * JSON decode for API result
 127      */
 128     protected function decode($url, $response)
 129     {
 130         $msg = "bit.ly returned unknown response with unknown message for $url";
 131         if ($response->isOk()) {
 132             $body = $response->getBody();
 133             common_log(LOG_INFO, $body);
 134             $json = json_decode($body, true);
 135             if ($json['status_code'] == 200) {
 136                 if (isset($json['data']['url'])) {
 137                                         common_log(LOG_INFO, "bit.ly returned ".$json['data']['url']." as short URL for $url");
 138                     return $json['data']['url'];
 139                 }
 140                                 $msg = "bit.ly returned ".$json['status_code']." response, but didn't find expected URL $url in $body";
 141                         }else{
 142                                 $msg = "bit.ly returned ".$json['status_code']." response with ".$json['status_txt']." for $url";
 143                         }
 144                 }
 145                 common_log(LOG_ERR, $msg);
 146                 return null;
 147     }
 148
 149     function onPluginVersion(array &$versions)
 150     {
 151         $versions[] = array('name' => sprintf('BitlyUrl (%s)', $this->shortenerName),
 152                             'version' => self::PLUGIN_VERSION,
 153                             'author' => 'Craig Andrews, Brion Vibber',
 154                             'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/BitlyUrl',
 155                             'rawdescription' =>
 156                             // TRANS: Plugin description. %1$s is the URL shortening service base URL (for example "bit.ly").
 157                             sprintf(_m('Uses <a href="http://%1$s/">%1$s</a> URL-shortener service.'),
 158                                     $this->shortenerName));
 159
 160         return true;
 161     }
 162
 163     /**
 164      * Hook for RouterInitialized event.
 165      *
 166      * @param URLMapper $m path-to-action mapper
 167      * @return boolean hook return
 168      */
 169     public function onRouterInitialized(URLMapper $m)
 170     {
 171         $m->connect('panel/bitly',
 172                     ['action' => 'bitlyadminpanel']);
 173         return true;
 174     }
 175
 176     /**
 177      * If the plugin's installed, this should be accessible to admins.
 178      */
 179     function onAdminPanelCheck($name, &$isOK)
 180     {
 181         if ($name == 'bitly') {
 182             $isOK = true;
 183             return false;
 184         }
 185
 186         return true;
 187     }
 188
 189     /**
 190      * Add the bit.ly admin panel to the list...
 191      */
 192     function onEndAdminPanelNav($nav)
 193     {
 194         if (AdminPanelAction::canAdmin('bitly')) {
 195             $action_name = $nav->action->trimmed('action');
 196
 197             $nav->out->menuItem(common_local_url('bitlyadminpanel'),
 198                                 // TRANS: Menu item in administration menus for bit.ly URL shortening settings.
 199                                 _m('bit.ly'),
 200                                 // TRANS: Title for menu item in administration menus for bit.ly URL shortening settings.
 201                                 _m('bit.ly URL shortening.'),
 202                                 $action_name == 'bitlyadminpanel',
 203                                 'nav_bitly_admin_panel');
 204         }
 205
 206         return true;
 207     }
 208
 209     /**
 210      * Internal hook point to check the default global credentials so
 211      * the admin form knows if we have a fallback or not.
 212      *
 213      * @param string $login
 214      * @param string $apiKey
 215      * @return boolean hook return value
 216      */
 217     function onBitlyDefaultCredentials(&$login, &$apiKey)
 218     {
 219         $login = $this->login;
 220         $apiKey = $this->apiKey;
 221         return false;
 222     }
 223
 224 }