exit(1);
}
-require_once INSTALLDIR.'/plugins/UrlShortener/UrlShortenerPlugin.php';
-
class BitlyUrlPlugin extends UrlShortenerPlugin
{
public $shortenerName = 'bit.ly';
- public $serviceUrl = 'http://bit.ly/api?method=shorten&version=2.0.1&longUrl=%s';
- public $login;
+ public $serviceUrl = 'http://api.bit.ly/v3/shorten?longUrl=%s';
+ public $login; // To set a site-default when admins or users don't override it.
public $apiKey;
function onInitializePlugin(){
parent::onInitializePlugin();
if(!isset($this->serviceUrl)){
- throw new Exception(_m("You must specify a serviceUrl for bit.ly shortening."));
- }
- if(!isset($this->login)){
- throw new Exception(_m("You must specify a login name for bit.ly shortening."));
+ // 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.'));
}
- if(!isset($this->login)){
- throw new Exception(_m("You must specify an API key for bit.ly shortening."));
+ }
+
+ /**
+ * 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;
}
/**
* @return string shortened version of the url, or null if URL shortening failed
*/
protected function shorten($url) {
+ common_log(LOG_INFO, "bit.ly call for $url");
$response = $this->query($url);
- if ($this->isOk($url, $response)) {
- return $this->decode($url, $response->getBody());
- } else {
- return null;
+ common_log(LOG_INFO, "bit.ly answer for $url is ".$response->getBody());
+ return $this->decode($url, $response);
+ }
+
+ /**
+ * Get the user's or site-wide default bit.ly login name.
+ *
+ * @return string
+ */
+ protected function getLogin()
+ {
+ $login = common_config('bitly', 'default_login');
+ if (!$login) {
+ $login = $this->login;
}
+ return $login;
+ }
+
+ /**
+ * Get the user's or site-wide default bit.ly API key.
+ *
+ * @return string
+ */
+ protected function getApiKey()
+ {
+ $key = common_config('bitly', 'default_apikey');
+ if (!$key) {
+ $key = $this->apiKey;
+ }
+ return $key;
}
/**
{
// http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/shorten
$params = http_build_query(array(
- 'login' => $this->login,
- 'apiKey' => $this->apiKey), '', '&');
- $serviceUrl = sprintf($this->serviceUrl, $url) . '&' . $params;
+ 'login' => $this->getLogin(),
+ 'apiKey' => $this->getApiKey()), '', '&');
+ $serviceUrl = sprintf($this->serviceUrl, urlencode($url)) . '&' . $params;
$request = HTTPClient::start();
return $request->get($serviceUrl);
/**
* JSON decode for API result
*/
- protected function decode($url, $body)
+ protected function decode($url, $response)
{
- $json = json_decode($body, true);
- return $json['results'][$url]['shortUrl'];
- }
-
- /**
- * JSON decode for API result
- */
- protected function isOk($url, $response)
- {
- $code = 'unknown';
- $msg = '';
+ $msg = "bit.ly returned unknown response with unknown message for $url";
if ($response->isOk()) {
$body = $response->getBody();
common_log(LOG_INFO, $body);
$json = json_decode($body, true);
- if ($json['statusCode'] == 'OK') {
- $data = $json['results'][$url];
- if (isset($data['shortUrl'])) {
- return true;
- } else if (isset($data['statusCode']) && $data['statusCode'] == 'ERROR') {
- $code = $data['errorCode'];
- $msg = $data['errorMessage'];
+ 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'];
}
- } else if ($json['statusCode'] == 'ERROR') {
- $code = $json['errorCode'];
- $msg = $json['errorMessage'];
- }
- common_log(LOG_ERR, "bit.ly returned error $code $msg for $url");
- }
- return false;
+ $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;
}
- function onPluginVersion(&$versions)
+ function onPluginVersion(array &$versions)
{
$versions[] = array('name' => sprintf('BitlyUrl (%s)', $this->shortenerName),
- 'version' => STATUSNET_VERSION,
+ 'version' => GNUSOCIAL_VERSION,
'author' => 'Craig Andrews, Brion Vibber',
'homepage' => 'http://status.net/wiki/Plugin:BitlyUrl',
'rawdescription' =>
+ // TRANS: Plugin description. %1$s is the URL shortening service base URL (for example "bit.ly").
sprintf(_m('Uses <a href="http://%1$s/">%1$s</a> URL-shortener service.'),
$this->shortenerName));
return true;
}
+
+ /**
+ * Hook for RouterInitialized event.
+ *
+ * @param URLMapper $m path-to-action mapper
+ * @return boolean hook return
+ */
+ public function onRouterInitialized(URLMapper $m)
+ {
+ $m->connect('panel/bitly',
+ 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(Menu $nav)
+ {
+ if (AdminPanelAction::canAdmin('bitly')) {
+ $action_name = $nav->action->trimmed('action');
+
+ $nav->out->menuItem(common_local_url('bitlyadminpanel'),
+ // TRANS: Menu item in administration menus for bit.ly URL shortening settings.
+ _m('bit.ly'),
+ // TRANS: Title for menu item in administration menus for bit.ly URL shortening settings.
+ _m('bit.ly URL shortening.'),
+ $action_name == 'bitlyadminpanel',
+ 'nav_bitly_admin_panel');
+ }
+
+ return true;
+ }
+
+ /**
+ * 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;
+ }
+
}
projects / quix0rs-gnu-social.git / blobdiff