urlshortenerplugin.php 4.28 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
<?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/>.
 *
22 23 24 25 26
 * @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/
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
 */

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;
46 47 48 49
    public $freeService = false;

    // Url Shortener plugins should implement some (or all)
    // of these methods
50 51

    /**
52 53 54 55 56 57 58
     * Make an URL shorter.
     *
     * @param string $url URL to shorten
     *
     * @return string shortened version of the url, or null on failure
     */

59 60
    protected abstract function shorten($url);

61 62 63 64 65 66 67 68 69 70
    /**
     * Utility to get the data at an URL
     *
     * @param string $url URL to fetch
     *
     * @return string response body
     *
     * @todo rename to code-standard camelCase httpGet()
     */

71 72
    protected function http_get($url)
    {
73
        $request  = HTTPClient::start();
74 75 76 77
        $response = $request->get($url);
        return $response->getBody();
    }

78 79 80 81 82 83 84 85 86 87 88 89
    /**
     * Utility to post a request and get a response URL
     *
     * @param string $url  URL to fetch
     * @param array  $data post parameters
     *
     * @return string response body
     *
     * @todo rename to code-standard httpPost()
     */

    protected function http_post($url, $data)
90
    {
91
        $request  = HTTPClient::start();
92 93 94 95
        $response = $request->post($url, null, $data);
        return $response->getBody();
    }

96
    // Hook handlers
97

98 99 100 101 102 103 104 105 106
    /**
     * Called when all plugins have been initialized
     *
     * @return boolean hook value
     */

    function onInitializePlugin()
    {
        if (!isset($this->shortenerName)) {
107 108
            throw new Exception("must specify a shortenerName");
        }
109
        return true;
110 111
    }

112 113 114 115 116 117 118 119 120 121 122
    /**
     * Called when a showing the URL shortener drop-down box
     *
     * Properties of the shortening service currently only
     * include whether it's a free service.
     *
     * @param array &$shorteners array mapping shortener name to properties
     *
     * @return boolean hook value
     */

123 124
    function onGetUrlShorteners(&$shorteners)
    {
125 126 127
        $shorteners[$this->shortenerName] =
          array('freeService' => $this->freeService);
        return true;
128 129
    }

130 131 132 133 134 135 136 137 138 139 140 141
    /**
     * Called to shorten an URL
     *
     * @param string $url           URL to shorten
     * @param string $shortenerName Shortening service. Don't handle if it's
     *                              not you!
     * @param string &$shortenedUrl URL after shortening; out param.
     *
     * @return boolean hook value
     */

    function onStartShortenUrl($url, $shortenerName, &$shortenedUrl)
142
    {
143
        if ($shortenerName == $this->shortenerName) {
144
            $result = $this->shorten($url);
145 146 147 148 149
            if (isset($result) && $result != null && $result !== false) {
                $shortenedUrl = $result;
                common_log(LOG_INFO,
                           __CLASS__ . ": $this->shortenerName ".
                           "shortened $url to $shortenedUrl");
150 151 152
                return false;
            }
        }
153
        return true;
154 155
    }
}