3 * StatusNet, the distributed open-source microblogging tool
5 * Utility class for plugins
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 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/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 * Base class for plugins
37 * A base class for StatusNet plugins. Mostly a light wrapper around
38 * the Event framework.
40 * Subclasses of Plugin will automatically handle an event if they define
41 * a method called "onEventName". (Well, OK -- only if they call parent::__construct()
42 * in their constructors.)
44 * They will also automatically handle the InitializePlugin and CleanupPlugin with the
45 * initialize() and cleanup() methods, respectively.
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/
58 function __construct()
60 Event::addHandler('InitializePlugin', array($this, 'initialize'));
61 Event::addHandler('CleanupPlugin', array($this, 'cleanup'));
63 foreach (get_class_methods($this) as $method) {
64 if (mb_substr($method, 0, 2) == 'on') {
65 Event::addHandler(mb_substr($method, 2), array($this, $method));
69 $this->setupGettext();
83 * Load related modules when needed
85 * Most non-trivial plugins will require extra modules to do their work. Typically
86 * these include data classes, action classes, widget classes, or external libraries.
88 * This method receives a class name and loads the PHP file related to that class. By
89 * tradition, action classes typically have files named for the action, all lower-case.
90 * Data classes are in files with the data class name, initial letter capitalized.
92 * Note that this method will be called for *all* overloaded classes, not just ones
93 * in this plugin! So, make sure to return true by default to let other plugins, and
94 * the core code, get a chance.
96 * @param string $cls Name of the class to be loaded
98 * @return boolean hook value; true means continue processing, false means stop.
100 public function onAutoload($cls) {
101 $cls = basename($cls);
102 $basedir = INSTALLDIR . '/local/plugins/' . mb_substr(get_called_class(), 0, -6);
103 if (!file_exists($basedir)) {
104 $basedir = INSTALLDIR . '/plugins/' . mb_substr(get_called_class(), 0, -6);
109 if (preg_match('/^(\w+)(Action|Form)$/', $cls, $type)) {
110 $type = array_map('strtolower', $type);
111 $file = "$basedir/{$type[2]}s/{$type[1]}.php";
113 if (!file_exists($file)) {
114 $file = "$basedir/classes/{$cls}.php";
116 // library files can be put into subdirs ('_'->'/' conversion)
117 // such as LRDDMethod_WebFinger -> lib/lrddmethod/webfinger.php
118 if (!file_exists($file)) {
119 $type = strtolower($cls);
120 $type = str_replace('_', '/', $type);
121 $file = "$basedir/lib/{$type}.php";
125 if (!is_null($file) && file_exists($file)) {
134 * Checks if this plugin has localization that needs to be set up.
135 * Gettext localizations can be called via the _m() helper function.
137 protected function setupGettext()
139 $class = get_class($this);
140 if (substr($class, -6) == 'Plugin') {
141 $name = substr($class, 0, -6);
142 $path = common_config('plugins', 'locale_path');
144 // @fixme this will fail for things installed in local/plugins
145 // ... but then so will web links so far.
146 $path = INSTALLDIR . "/plugins/$name/locale";
147 if (!file_exists($path)) {
148 $path = INSTALLDIR . "/local/plugins/$name/locale";
151 if (file_exists($path) && is_dir($path)) {
152 bindtextdomain($name, $path);
153 bind_textdomain_codeset($name, 'UTF-8');
158 protected function log($level, $msg)
160 common_log($level, get_class($this) . ': '.$msg);
163 protected function debug($msg)
165 $this->log(LOG_DEBUG, $msg);
168 public function name()
170 $cls = get_class($this);
171 return mb_substr($cls, 0, -6);
174 public function version()
176 return GNUSOCIAL_VERSION;
179 protected function userAgent() {
180 return HTTPClient::userAgent()
181 . ' (' . get_class($this) . ' v' . $this->version() . ')';
184 function onPluginVersion(array &$versions)
186 $name = $this->name();
188 $versions[] = array('name' => $name,
189 // TRANS: Displayed as version information for a plugin if no version information was found.
190 'version' => _('Unknown'));
195 function path($relative)
197 return self::staticPath($this->name(), $relative);
200 static function staticPath($plugin, $relative)
202 if (GNUsocial::useHTTPS()) {
203 $server = common_config('plugins', 'sslserver');
205 $server = common_config('plugins', 'server');
208 if (empty($server)) {
209 if (GNUsocial::useHTTPS()) {
210 $server = common_config('site', 'sslserver');
212 if (empty($server)) {
213 $server = common_config('site', 'server');
217 if (GNUsocial::useHTTPS()) {
218 $path = common_config('plugins', 'sslpath');
220 $path = common_config('plugins', 'path');
224 // XXX: extra stat().
225 if (@file_exists(INSTALLDIR.'/local/plugins/'.$plugin.'/'.$relative)) {
226 $path = common_config('site', 'path') . '/local/plugins/';
228 $path = common_config('site', 'path') . '/plugins/';
232 if ($path[strlen($path)-1] != '/') {
236 if ($path[0] != '/') {
240 $protocol = GNUsocial::useHTTPS() ? 'https' : 'http';
242 return $protocol.'://'.$server.$path.$plugin.'/'.$relative;