BitlyUrlPlugin.php 7.04 KB
Newer Older
1 2 3 4
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
5
 * Plugin to use bit.ly URL shortening services.
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Plugin
 * @package   StatusNet
 * @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 29 30 31 32 33 34 35
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

36
class BitlyUrlPlugin extends UrlShortenerPlugin
37
{
38
    public $shortenerName = 'bit.ly';
Jean Baptiste Favre's avatar
Jean Baptiste Favre committed
39
    public $serviceUrl = 'http://api.bit.ly/v3/shorten?longUrl=%s';
40 41
    public $login; // To set a site-default when admins or users don't override it.
    public $apiKey;
42 43

    function onInitializePlugin(){
44 45
        parent::onInitializePlugin();
        if(!isset($this->serviceUrl)){
46 47
            // TRANS: Exception thrown when bit.ly URL shortening plugin was configured incorrectly.
            throw new Exception(_m('You must specify a serviceUrl for bit.ly URL shortening.'));
48
        }
49 50
    }

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
    /**
     * Add bit.ly to the list of available URL shorteners if it's configured,
     * otherwise leave it out.
     *
     * @param array $shorteners
     * @return boolean hook return value
     */
    function onGetUrlShorteners(&$shorteners)
    {
        if ($this->getLogin() && $this->getApiKey()) {
            return parent::onGetUrlShorteners($shorteners);
        }
        return true;
    }

66 67 68 69 70
    /**
     * Short a URL
     * @param url
     * @return string shortened version of the url, or null if URL shortening failed
     */
71
    protected function shorten($url) {
Jean Baptiste Favre's avatar
Jean Baptiste Favre committed
72
	common_log(LOG_INFO, "bit.ly call for $url");
73
        $response = $this->query($url);
Jean Baptiste Favre's avatar
Jean Baptiste Favre committed
74 75
	common_log(LOG_INFO, "bit.ly answer for $url is ".$response->getBody());
	return $this->decode($url, $response);
76 77
    }

78 79 80 81 82 83 84
    /**
     * Get the user's or site-wide default bit.ly login name.
     *
     * @return string
     */
    protected function getLogin()
    {
85 86 87 88 89
        $login = common_config('bitly', 'default_login');
        if (!$login) {
            $login = $this->login;
        }
        return $login;
90 91 92 93 94 95 96 97 98
    }

    /**
     * Get the user's or site-wide default bit.ly API key.
     *
     * @return string
     */
    protected function getApiKey()
    {
99 100 101 102 103
        $key = common_config('bitly', 'default_apikey');
        if (!$key) {
            $key = $this->apiKey;
        }
        return $key;
104 105
    }

106 107 108 109 110 111 112 113 114 115
    /**
     * Inject API key into query before sending out...
     *
     * @param string $url
     * @return HTTPResponse
     */
    protected function query($url)
    {
        // http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/shorten
        $params = http_build_query(array(
116 117
            'login' => $this->getLogin(),
            'apiKey' => $this->getApiKey()), '', '&');
118
        $serviceUrl = sprintf($this->serviceUrl, urlencode($url)) . '&' . $params;
119 120 121 122 123 124 125 126

        $request = HTTPClient::start();
        return $request->get($serviceUrl);
    }

    /**
     * JSON decode for API result
     */
Jean Baptiste Favre's avatar
Jean Baptiste Favre committed
127
    protected function decode($url, $response)
128
    {
Jean Baptiste Favre's avatar
Jean Baptiste Favre committed
129
        $msg = "bit.ly returned unknown response with unknown message for $url";
130 131 132 133
        if ($response->isOk()) {
            $body = $response->getBody();
            common_log(LOG_INFO, $body);
            $json = json_decode($body, true);
Jean Baptiste Favre's avatar
Jean Baptiste Favre committed
134 135 136 137
            if ($json['status_code'] == 200) {
                if (isset($json['data']['url'])) {
					common_log(LOG_INFO, "bit.ly returned ".$json['data']['url']." as short URL for $url");
                    return $json['data']['url'];
138
                }
Jean Baptiste Favre's avatar
Jean Baptiste Favre committed
139 140 141 142 143 144 145
				$msg = "bit.ly returned ".$json['status_code']." response, but didn't find expected URL $url in $body";
			}else{
				$msg = "bit.ly returned ".$json['status_code']." response with ".$json['status_txt']." for $url";
			}
		}
		common_log(LOG_ERR, $msg);
		return null;
146 147
    }

148 149 150 151
    function onPluginVersion(&$versions)
    {
        $versions[] = array('name' => sprintf('BitlyUrl (%s)', $this->shortenerName),
                            'version' => STATUSNET_VERSION,
152
                            'author' => 'Craig Andrews, Brion Vibber',
153 154
                            'homepage' => 'http://status.net/wiki/Plugin:BitlyUrl',
                            'rawdescription' =>
155
                            // TRANS: Plugin description. %1$s is the URL shortening service base URL (for example "bit.ly").
156 157 158 159 160
                            sprintf(_m('Uses <a href="http://%1$s/">%1$s</a> URL-shortener service.'),
                                    $this->shortenerName));

        return true;
    }
161 162 163 164 165 166 167 168 169

    /**
     * Hook for RouterInitialized event.
     *
     * @param Net_URL_Mapper $m path-to-action mapper
     * @return boolean hook return
     */
    function onRouterInitialized($m)
    {
Evan Prodromou's avatar
Evan Prodromou committed
170
        $m->connect('panel/bitly',
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
                    array('action' => 'bitlyadminpanel'));
        return true;
    }

    /**
     * If the plugin's installed, this should be accessible to admins.
     */
    function onAdminPanelCheck($name, &$isOK)
    {
        if ($name == 'bitly') {
            $isOK = true;
            return false;
        }

        return true;
    }

    /**
     * Add the bit.ly admin panel to the list...
     */
    function onEndAdminPanelNav($nav)
    {
        if (AdminPanelAction::canAdmin('bitly')) {
            $action_name = $nav->action->trimmed('action');

            $nav->out->menuItem(common_local_url('bitlyadminpanel'),
197
                                // TRANS: Menu item in administration menus for bit.ly URL shortening settings.
198
                                _m('bit.ly'),
199 200
                                // TRANS: Title for menu item in administration menus for bit.ly URL shortening settings.
                                _m('bit.ly URL shortening.'),
201 202 203 204 205 206 207
                                $action_name == 'bitlyadminpanel',
                                'nav_bitly_admin_panel');
        }

        return true;
    }

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
    /**
     * Internal hook point to check the default global credentials so
     * the admin form knows if we have a fallback or not.
     *
     * @param string $login
     * @param string $apiKey
     * @return boolean hook return value
     */
    function onBitlyDefaultCredentials(&$login, &$apiKey)
    {
        $login = $this->login;
        $apiKey = $this->apiKey;
        return false;
    }

223
}