3 * StatusNet, the distributed open-source microblogging tool
5 * Superclass for plugins that do URL shortening
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 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 * Superclass for plugins that do URL shortening
39 * @author Craig Andrews <candrews@integralblue.com>
40 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
41 * @link http://status.net/
44 abstract class UrlShortenerPlugin extends Plugin
46 public $shortenerName;
47 public $freeService=false;
48 //------------Url Shortener plugin should implement some (or all) of these methods------------\\
53 * @return string shortened version of the url, or null if URL shortening failed
55 protected abstract function shorten($url);
57 //------------These methods may help you implement your plugin------------\\
58 protected function http_get($url)
60 $request = HTTPClient::start();
61 $response = $request->get($url);
62 return $response->getBody();
65 protected function http_post($url,$data)
67 $request = HTTPClient::start();
68 $response = $request->post($url, null, $data);
69 return $response->getBody();
72 //------------Below are the methods that connect StatusNet to the implementing Url Shortener plugin------------\\
74 function onInitializePlugin(){
75 if(!isset($this->shortenerName)){
76 throw new Exception("must specify a shortenerName");
80 function onGetUrlShorteners(&$shorteners)
82 $shorteners[$this->shortenerName]=array('freeService'=>$this->freeService);
85 function onStartShortenUrl($url,$shortenerName,&$shortenedUrl)
87 if($shortenerName == $this->shortenerName && strlen($url) >= common_config('site', 'shorturllength')){
88 $result = $this->shorten($url);
89 if(isset($result) && $result != null && $result !== false){
90 $shortenedUrl=$result;
91 common_log(LOG_INFO, __CLASS__ . ": $this->shortenerName shortened $url to $shortenedUrl");