3 * StatusNet, the distributed open-source microblogging tool
5 * Plugin to use bit.ly URL shortening services.
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.
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.
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/>.
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/
32 if (!defined('STATUSNET')) {
36 require_once INSTALLDIR.'/plugins/UrlShortener/UrlShortenerPlugin.php';
38 class BitlyUrlPlugin extends UrlShortenerPlugin
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.
45 function onInitializePlugin(){
46 parent::onInitializePlugin();
47 if(!isset($this->serviceUrl)){
48 throw new Exception(_m("You must specify a serviceUrl for bit.ly shortening."));
53 * Add bit.ly to the list of available URL shorteners if it's configured,
54 * otherwise leave it out.
56 * @param array $shorteners
57 * @return boolean hook return value
59 function onGetUrlShorteners(&$shorteners)
61 if ($this->getLogin() && $this->getApiKey()) {
62 return parent::onGetUrlShorteners($shorteners);
70 * @return string shortened version of the url, or null if URL shortening failed
72 protected function shorten($url) {
73 common_log(LOG_INFO, "bit.ly call for $url");
74 $response = $this->query($url);
75 common_log(LOG_INFO, "bit.ly answer for $url is ".$response->getBody());
76 return $this->decode($url, $response);
80 * Get the user's or site-wide default bit.ly login name.
84 protected function getLogin()
86 $login = common_config('bitly', 'default_login');
88 $login = $this->login;
94 * Get the user's or site-wide default bit.ly API key.
98 protected function getApiKey()
100 $key = common_config('bitly', 'default_apikey');
102 $key = $this->apiKey;
108 * Inject API key into query before sending out...
111 * @return HTTPResponse
113 protected function query($url)
115 // http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/shorten
116 $params = http_build_query(array(
117 'login' => $this->getLogin(),
118 'apiKey' => $this->getApiKey()), '', '&');
119 $serviceUrl = sprintf($this->serviceUrl, urlencode($url)) . '&' . $params;
121 $request = HTTPClient::start();
122 return $request->get($serviceUrl);
126 * JSON decode for API result
128 protected function decode($url, $response)
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'];
140 $msg = "bit.ly returned ".$json['status_code']." response, but didn't find expected URL $url in $body";
142 $msg = "bit.ly returned ".$json['status_code']." response with ".$json['status_txt']." for $url";
145 common_log(LOG_ERR, $msg);
149 function onPluginVersion(&$versions)
151 $versions[] = array('name' => sprintf('BitlyUrl (%s)', $this->shortenerName),
152 'version' => STATUSNET_VERSION,
153 'author' => 'Craig Andrews, Brion Vibber',
154 'homepage' => 'http://status.net/wiki/Plugin:BitlyUrl',
156 sprintf(_m('Uses <a href="http://%1$s/">%1$s</a> URL-shortener service.'),
157 $this->shortenerName));
163 * Hook for RouterInitialized event.
165 * @param Net_URL_Mapper $m path-to-action mapper
166 * @return boolean hook return
168 function onRouterInitialized($m)
170 $m->connect('admin/bitly',
171 array('action' => 'bitlyadminpanel'));
176 * If the plugin's installed, this should be accessible to admins.
178 function onAdminPanelCheck($name, &$isOK)
180 if ($name == 'bitly') {
189 * Add the bit.ly admin panel to the list...
191 function onEndAdminPanelNav($nav)
193 if (AdminPanelAction::canAdmin('bitly')) {
194 $action_name = $nav->action->trimmed('action');
196 $nav->out->menuItem(common_local_url('bitlyadminpanel'),
198 _m('bit.ly URL shortening'),
199 $action_name == 'bitlyadminpanel',
200 'nav_bitly_admin_panel');
207 * Automatically load the actions and libraries used by the plugin
209 * @param Class $cls the class
211 * @return boolean hook return
214 function onAutoload($cls)
216 $base = dirname(__FILE__);
217 $lower = strtolower($cls);
219 case 'bitlyadminpanelaction':
220 require_once "$base/$lower.php";
228 * Internal hook point to check the default global credentials so
229 * the admin form knows if we have a fallback or not.
231 * @param string $login
232 * @param string $apiKey
233 * @return boolean hook return value
235 function onBitlyDefaultCredentials(&$login, &$apiKey)
237 $login = $this->login;
238 $apiKey = $this->apiKey;