plugin.php 5.17 KB
Newer Older
1 2
<?php
/**
3
 * StatusNet, the distributed open-source microblogging tool
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * Utility class for plugins
 *
 * 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
23
 * @package   StatusNet
24
 * @author    Evan Prodromou <evan@status.net>
25
 * @copyright 2008 StatusNet, Inc.
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/
28 29
 */

30
if (!defined('STATUSNET') && !defined('LACONICA')) {
31 32 33 34 35 36
    exit(1);
}

/**
 * Base class for plugins
 *
37
 * A base class for StatusNet plugins. Mostly a light wrapper around
38 39 40 41 42 43 44 45 46 47
 * the Event framework.
 *
 * Subclasses of Plugin will automatically handle an event if they define
 * a method called "onEventName". (Well, OK -- only if they call parent::__construct()
 * in their constructors.)
 *
 * They will also automatically handle the InitializePlugin and CleanupPlugin with the
 * initialize() and cleanup() methods, respectively.
 *
 * @category Plugin
48
 * @package  StatusNet
49
 * @author   Evan Prodromou <evan@status.net>
50
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
51
 * @link     http://status.net/
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
 *
 * @see      Event
 */

class Plugin
{
    function __construct()
    {
        Event::addHandler('InitializePlugin', array($this, 'initialize'));
        Event::addHandler('CleanupPlugin', array($this, 'cleanup'));

        foreach (get_class_methods($this) as $method) {
            if (mb_substr($method, 0, 2) == 'on') {
                Event::addHandler(mb_substr($method, 2), array($this, $method));
            }
        }
68 69

        $this->setupGettext();
70 71 72 73 74 75 76 77 78 79 80
    }

    function initialize()
    {
        return true;
    }

    function cleanup()
    {
        return true;
    }
81

82 83 84 85 86 87 88 89 90
    /**
     * Checks if this plugin has localization that needs to be set up.
     * Gettext localizations can be called via the _m() helper function.
     */
    protected function setupGettext()
    {
        $class = get_class($this);
        if (substr($class, -6) == 'Plugin') {
            $name = substr($class, 0, -6);
91 92 93 94 95 96
            $path = common_config('plugins', 'locale_path');
            if (!$path) {
                // @fixme this will fail for things installed in local/plugins
                // ... but then so will web links so far.
                $path = INSTALLDIR . "/plugins/$name/locale";
            }
97 98
            if (file_exists($path) && is_dir($path)) {
                bindtextdomain($name, $path);
99
                bind_textdomain_codeset($name, 'UTF-8');
100 101 102 103
            }
        }
    }

104 105 106 107 108 109 110 111 112
    protected function log($level, $msg)
    {
        common_log($level, get_class($this) . ': '.$msg);
    }

    protected function debug($msg)
    {
        $this->log(LOG_DEBUG, $msg);
    }
113 114 115 116 117 118
    
    function name()
    {
        $cls = get_class($this);
        return mb_substr($cls, 0, -6);
    }
119 120 121

    function onPluginVersion(&$versions)
    {
122
        $name = $this->name();
123 124

        $versions[] = array('name' => $name,
125
                            // TRANS: Displayed as version information for a plugin if no version information was found.
126 127 128 129
                            'version' => _('Unknown'));

        return true;
    }
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145

    function path($relative)
    {
        return self::staticPath($this->name(), $relative);
    }

    static function staticPath($plugin, $relative)
    {
        $isHTTPS = StatusNet::isHTTPS();

        if ($isHTTPS) {
            $server = common_config('plugins', 'sslserver');
        } else {
            $server = common_config('plugins', 'server');
        }

146
        if (empty($server)) {
147 148
            if ($isHTTPS) {
                $server = common_config('site', 'sslserver');
149
            }
150
            if (empty($server)) {
151 152 153 154
                $server = common_config('site', 'server');
            }
        }

155 156 157 158 159
        if ($isHTTPS) {
            $path = common_config('plugins', 'sslpath');
        } else {
            $path = common_config('plugins', 'path');
        }
160

161
        if (empty($path)) {
162 163 164 165 166 167
            // XXX: extra stat().
            if (@file_exists(INSTALLDIR.'/local/plugins/'.$plugin.'/'.$relative)) {
                $path = common_config('site', 'path') . '/local/plugins/';
            } else {
                $path = common_config('site', 'path') . '/plugins/';
            }
168 169
        }

170 171 172 173 174 175 176 177
        if ($path[strlen($path)-1] != '/') {
            $path .= '/';
        }

        if ($path[0] != '/') {
            $path = '/'.$path;
        }

178 179 180 181
        $protocol = ($isHTTPS) ? 'https' : 'http';

        return $protocol.'://'.$server.$path.$plugin.'/'.$relative;
    }
182
}