]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/UrlShortener/UrlShortenerPlugin.php
OStatus: fix regressions from merge
[quix0rs-gnu-social.git] / plugins / UrlShortener / UrlShortenerPlugin.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Superclass for plugins that do URL shortening
6  *
7  * PHP version 5
8  *
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.
13  *
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.
18  *
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/>.
21  *
22  * @category  Plugin
23  * @package   StatusNet
24  * @author    Craig Andrews <candrews@integralblue.com>
25  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
26  * @link      http://status.net/
27  */
28
29 if (!defined('STATUSNET') && !defined('LACONICA')) {
30     exit(1);
31 }
32
33 /**
34  * Superclass for plugins that do URL shortening
35  *
36  * @category Plugin
37  * @package  StatusNet
38  * @author   Craig Andrews <candrews@integralblue.com>
39  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
40  * @link     http://status.net/
41  */
42
43 abstract class UrlShortenerPlugin extends Plugin
44 {
45     public $shortenerName;
46     public $freeService=false;
47     //------------Url Shortener plugin should implement some (or all) of these methods------------\\
48
49     /**
50     * Short a URL
51     * @param url
52     * @return string shortened version of the url, or null if URL shortening failed
53     */
54     protected abstract function shorten($url);
55
56     //------------These methods may help you implement your plugin------------\\
57     protected function http_get($url)
58     {
59         $request = HTTPClient::start();
60         $response = $request->get($url);
61         return $response->getBody();
62     }
63
64     protected function http_post($url,$data)
65     {
66         $request = HTTPClient::start();
67         $response = $request->post($url, null, $data);
68         return $response->getBody();
69     }
70
71     //------------Below are the methods that connect StatusNet to the implementing Url Shortener plugin------------\\
72
73     function onInitializePlugin(){
74         if(!isset($this->shortenerName)){
75             throw new Exception("must specify a shortenerName");
76         }
77     }
78
79     function onGetUrlShorteners(&$shorteners)
80     {
81         $shorteners[$this->shortenerName]=array('freeService'=>$this->freeService);
82     }
83
84     function onStartShortenUrl($url,$shortenerName,&$shortenedUrl)
85     {
86         if($shortenerName == $this->shortenerName && strlen($url) >= common_config('site', 'shorturllength')){
87             $result = $this->shorten($url);
88             if(isset($result) && $result != null && $result !== false){
89                 $shortenedUrl=$result;
90                 common_log(LOG_INFO, __CLASS__ . ": $this->shortenerName shortened $url to $shortenedUrl");
91                 return false;
92             }
93         }
94     }
95 }