Redid how URL shorteners work. This way is much more like how Evan wants events to work (and more like how the rest of SN works).

6 files changed, 168 insertions, 107 deletions

diff --git a/plugins/BitlyUrl/BitlyUrlPlugin.php b/plugins/BitlyUrl/BitlyUrlPlugin.php
index 478ef99d2..65d0f70e6 100644
--- a/plugins/BitlyUrl/BitlyUrlPlugin.php
+++ b/plugins/BitlyUrl/BitlyUrlPlugin.php
@@ -31,31 +31,24 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-class BitlyUrlPlugin extends Plugin
+require_once INSTALLDIR.'/plugins/UrlShortener/UrlShortenerPlugin.php';
+
+class BitlyUrlPlugin extends UrlShortenerPlugin
 {
-    function __construct()
-    {
-        parent::__construct();
-    }
+    public $serviceUrl;
 
     function onInitializePlugin(){
-        $this->registerUrlShortener(
-            'bit.ly',
-            array(),
-            array('BitlyUrl',array('http://bit.ly/api?method=shorten&long_url='))
-        );
+        parent::onInitializePlugin();
+        if(!isset($this->serviceUrl)){
+            throw new Exception("must specify a serviceUrl");
+        }
     }
-}
 
-class BitlyUrl extends ShortUrlApi
-{
-    protected function shorten_imp($url) {
+    protected function shorten($url) {
         $response = $this->http_get($url);
-        if(!$response){
-            return $url;
-        }else{
-            return current(json_decode($response)->results)->hashUrl;
-        }
+        if(!$response) return;
+        return current(json_decode($response)->results)->hashUrl;
     }
 }
 
+
diff --git a/plugins/LilUrl/LilUrlPlugin.php b/plugins/LilUrl/LilUrlPlugin.php
index 852253b02..e906751e8 100644
--- a/plugins/LilUrl/LilUrlPlugin.php
+++ b/plugins/LilUrl/LilUrlPlugin.php
@@ -31,37 +31,31 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-require_once(INSTALLDIR.'/lib/Shorturl_api.php');
+require_once INSTALLDIR.'/plugins/UrlShortener/UrlShortenerPlugin.php';
 
-class LilUrlPlugin extends Plugin
+class LilUrlPlugin extends UrlShortenerPlugin
 {
-    function __construct()
-    {
-        parent::__construct();
-    }
+    public $serviceUrl;
 
     function onInitializePlugin(){
-        $this->registerUrlShortener(
-            'ur1.ca',
-            array('freeService'=>true),
-            array('LilUrl',array('http://ur1.ca/'))
-        );
+        parent::onInitializePlugin();
+        if(!isset($this->serviceUrl)){
+            throw new Exception("must specify a serviceUrl");
+        }
     }
-}
 
-class LilUrl extends ShortUrlApi
-{
-    protected function shorten_imp($url) {
-        $data['longurl'] = $url;
-        $response = $this->http_post($data);
-        if (!$response) return $url;
-        $y = @simplexml_load_string($response);
-        if (!isset($y->body)) return $url;
+    protected function shorten($url) {
+        $data = array('longurl' => $url);
+        
+        $responseBody = $this->http_post($this->serviceUrl,$data);
+        
+        if (!$responseBody) return;
+        $y = @simplexml_load_string($responseBody);
+        if (!isset($y->body)) return;
         $x = $y->body->p[0]->a->attributes();
         if (isset($x['href'])) {
-            common_log(LOG_INFO, __CLASS__ . ": shortened $url to $x[href]");
             return $x['href'];
         }
-        return $url;
     }
 }
+
diff --git a/plugins/PtitUrl/PtitUrlPlugin.php b/plugins/PtitUrl/PtitUrlPlugin.php
index f00d3e2f2..ef453e96d 100644
--- a/plugins/PtitUrl/PtitUrlPlugin.php
+++ b/plugins/PtitUrl/PtitUrlPlugin.php
@@ -30,33 +30,28 @@
 if (!defined('STATUSNET')) {
     exit(1);
 }
+require_once INSTALLDIR.'/plugins/UrlShortener/UrlShortenerPlugin.php';
 
-class PtitUrlPlugin extends Plugin
+class PtitUrlPlugin extends UrlShortenerPlugin
 {
-    function __construct()
-    {
-        parent::__construct();
-    }
+    public $serviceUrl;
 
     function onInitializePlugin(){
-        $this->registerUrlShortener(
-            'ptiturl.com',
-            array(),
-            array('PtitUrl',array('http://ptiturl.com/?creer=oui&action=Reduire&url='))
-        );
+        parent::onInitializePlugin();
+        if(!isset($this->serviceUrl)){
+            throw new Exception("must specify a serviceUrl");
+        }
     }
-}
 
-class PtitUrl extends ShortUrlApi
-{
-    protected function shorten_imp($url) {
-        $response = $this->http_get($url);
-        if (!$response) return $url;
+    protected function shorten($url)
+    {
+        $response = $this->http_get(sprintf($this->serviceUrl,urlencode($url)));
+        if (!$response) return;
         $response = $this->tidy($response);
         $y = @simplexml_load_string($response);
-        if (!isset($y->body)) return $url;
+        if (!isset($y->body)) return;
         $xml = $y->body->center->table->tr->td->pre->a->attributes();
         if (isset($xml['href'])) return $xml['href'];
-        return $url;
     }
 }
+
diff --git a/plugins/SimpleUrl/SimpleUrlPlugin.php b/plugins/SimpleUrl/SimpleUrlPlugin.php
index d59d63e47..45b745b07 100644
--- a/plugins/SimpleUrl/SimpleUrlPlugin.php
+++ b/plugins/SimpleUrl/SimpleUrlPlugin.php
@@ -31,40 +31,21 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-class SimpleUrlPlugin extends Plugin
+require_once INSTALLDIR.'/plugins/UrlShortener/UrlShortenerPlugin.php';
+
+class SimpleUrlPlugin extends UrlShortenerPlugin
 {
-    function __construct()
-    {
-        parent::__construct();
-    }
+    public $serviceUrl;
 
     function onInitializePlugin(){
-        $this->registerUrlShortener(
-            'is.gd',
-            array(),
-            array('SimpleUrl',array('http://is.gd/api.php?longurl='))
-        );
-        $this->registerUrlShortener(
-            'snipr.com',
-            array(),
-            array('SimpleUrl',array('http://snipr.com/site/snip?r=simple&link='))
-        );
-        $this->registerUrlShortener(
-            'metamark.net',
-            array(),
-            array('SimpleUrl',array('http://metamark.net/api/rest/simple?long_url='))
-        );
-        $this->registerUrlShortener(
-            'tinyurl.com',
-            array(),
-            array('SimpleUrl',array('http://tinyurl.com/api-create.php?url='))
-        );
+        parent::onInitializePlugin();
+        if(!isset($this->serviceUrl)){
+            throw new Exception("must specify a serviceUrl");
+        }
     }
-}
 
-class SimpleUrl extends ShortUrlApi
-{
-    protected function shorten_imp($url) {
-        return $this->http_get($url);
+    protected function shorten($url) {
+        return $this->http_get(sprintf($this->serviceUrl,urlencode($url)));
     }
 }
+
diff --git a/plugins/TightUrl/TightUrlPlugin.php b/plugins/TightUrl/TightUrlPlugin.php
index 48efb355f..56414c8c8 100644
--- a/plugins/TightUrl/TightUrlPlugin.php
+++ b/plugins/TightUrl/TightUrlPlugin.php
@@ -31,32 +31,27 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-class TightUrlPlugin extends Plugin
+require_once INSTALLDIR.'/plugins/UrlShortener/UrlShortenerPlugin.php';
+
+class TightUrlPlugin extends UrlShortenerPlugin
 {
-    function __construct()
-    {
-        parent::__construct();
-    }
+    public $serviceUrl;
 
     function onInitializePlugin(){
-        $this->registerUrlShortener(
-            '2tu.us',
-            array('freeService'=>true),
-            array('TightUrl',array('http://2tu.us/?save=y&url='))
-        );
+        parent::onInitializePlugin();
+        if(!isset($this->serviceUrl)){
+            throw new Exception("must specify a serviceUrl");
+        }
     }
-}
 
-class TightUrl extends ShortUrlApi
-{
-    protected function shorten_imp($url) {
-        $response = $this->http_get($url);
-        if (!$response) return $url;
+    protected function shorten($url)
+    {
+        $response = $this->http_get(sprintf($this->serviceUrl,urlencode($url)));
+        if (!$response) return;
         $response = $this->tidy($response);
         $y = @simplexml_load_string($response);
-        if (!isset($y->body)) return $url;
+        if (!isset($y->body)) return;
         $xml = $y->body->p[0]->code[0]->a->attributes();
         if (isset($xml['href'])) return $xml['href'];
-        return $url;
     }
 }
diff --git a/plugins/UrlShortener/UrlShortenerPlugin.php b/plugins/UrlShortener/UrlShortenerPlugin.php
new file mode 100644
index 000000000..37206aa89
--- /dev/null
+++ b/plugins/UrlShortener/UrlShortenerPlugin.php
@@ -0,0 +1,103 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Superclass for plugins that do URL shortening
+ *
+ * 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>
+ * @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') && !defined('LACONICA')) {
+    exit(1);
+}
+
+/**
+ * Superclass for plugins that do URL shortening
+ *
+ * @category Plugin
+ * @package  StatusNet
+ * @author   Craig Andrews <candrews@integralblue.com>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ */
+
+abstract class UrlShortenerPlugin extends Plugin
+{
+    public $shortenerName;
+    public $freeService=false;
+    //------------Url Shortener plugin should implement some (or all) of these methods------------\\
+
+    /**
+    * Short a URL
+    * @param url
+    * @return string shortened version of the url, or null if URL shortening failed
+    */
+    protected abstract function shorten($url);
+
+    //------------These methods may help you implement your plugin------------\\
+    protected function http_get($url)
+    {
+        $request = HTTPClient::start();
+        $response = $request->get($url);
+        return $response->getBody();
+    }
+
+    protected function http_post($url,$data)
+    {
+        $request = HTTPClient::start();
+        $response = $request->post($url, null, $data);
+        return $response->getBody();
+    }
+
+    protected function tidy($response) {
+        $response = str_replace('&nbsp;', ' ', $response);
+        $config = array('output-xhtml' => true);
+        $tidy = new tidy;
+        $tidy->parseString($response, $config, 'utf8');
+        $tidy->cleanRepair();
+        return (string)$tidy;
+    }
+    //------------Below are the methods that connect StatusNet to the implementing Url Shortener plugin------------\\
+
+    function onInitializePlugin(){
+        if(!isset($this->shortenerName)){
+            throw new Exception("must specify a shortenerName");
+        }
+    }
+
+    function onGetUrlShorteners(&$shorteners)
+    {
+        $shorteners[$this->shortenerName]=array('freeService'=>$this->freeService);
+    }
+
+    function onStartShortenUrl($url,$shortenerName,&$shortenedUrl)
+    {
+        if($shortenerName == $this->shortenerName && strlen($url) >= common_config('site', 'shorturllength')){
+            $result = $this->shorten($url);
+            if(isset($result) && $result != null && $result !== false){
+                $shortenedUrl=$result;
+                common_log(LOG_INFO, __CLASS__ . ": $this->shortenerName shortened $url to $shortenedUrl");
+                return false;
+            }
+        }
+    }
+}