c18f26145c
For reference (raised by rozzin in IRC): * http://foldoc.org/module * http://foldoc.org/library * http://foldoc.org/plugin As noted by XRevan86, modules are not necessarily non-essential. As we will keep the modules directory in GS root [therefore, near to plugins/], it is evidenced the difference between both. This is a simple yet fundamental structural change. It doesn't change functionality but makes clearer the way we understand GNU social's internals.
237 lines
7.6 KiB
PHP
237 lines
7.6 KiB
PHP
<?php
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
//
|
|
// GNU social 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.
|
|
//
|
|
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
defined('GNUSOCIAL') || die();
|
|
|
|
/**
|
|
* Base class for plugins
|
|
*
|
|
* A base class for StatusNet plugins. Mostly a light wrapper around
|
|
* 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
|
|
* @package GNU social
|
|
* @author Evan Prodromou <evan@status.net>
|
|
* @copyright 2010-2019 Free Software Foundation, Inc http://www.fsf.org
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*
|
|
* @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));
|
|
}
|
|
}
|
|
|
|
$this->setupGettext();
|
|
}
|
|
|
|
function initialize()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
function cleanup()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Load related components when needed
|
|
*
|
|
* Most non-trivial plugins will require extra components to do their work. Typically
|
|
* these include data classes, action classes, widget classes, or external libraries.
|
|
*
|
|
* This method receives a class name and loads the PHP file related to that class. By
|
|
* tradition, action classes typically have files named for the action, all lower-case.
|
|
* Data classes are in files with the data class name, initial letter capitalized.
|
|
*
|
|
* Note that this method will be called for *all* overloaded classes, not just ones
|
|
* in this plugin! So, make sure to return true by default to let other plugins, and
|
|
* the core code, get a chance.
|
|
*
|
|
* @param string $cls Name of the class to be loaded
|
|
*
|
|
* @return bool hook value; true means continue processing, false means stop.
|
|
*/
|
|
public function onAutoload($cls) {
|
|
$cls = basename($cls);
|
|
$basedir = INSTALLDIR . '/local/plugins/' . mb_substr(get_called_class(), 0, -6);
|
|
if (!file_exists($basedir)) {
|
|
$basedir = INSTALLDIR . '/modules/' . mb_substr(get_called_class(), 0, -6);
|
|
}
|
|
if (!file_exists($basedir)) {
|
|
$basedir = INSTALLDIR . '/plugins/' . mb_substr(get_called_class(), 0, -6);
|
|
}
|
|
|
|
$file = null;
|
|
|
|
if (preg_match('/^(\w+)(Action|Form)$/', $cls, $type)) {
|
|
$type = array_map('strtolower', $type);
|
|
$file = "{$basedir}/{$type[2]}s/{$type[1]}.php";
|
|
}
|
|
if (!file_exists($file)) {
|
|
$file = "{$basedir}/classes/{$cls}.php";
|
|
|
|
// library files can be put into subdirs ('_'->'/' conversion)
|
|
// such as LRDDMethod_WebFinger -> lib/lrddmethod/webfinger.php
|
|
if (!file_exists($file)) {
|
|
$type = strtolower($cls);
|
|
$type = str_replace('_', '/', $type);
|
|
$file = "{$basedir}/lib/{$type}.php";
|
|
}
|
|
}
|
|
|
|
if (!is_null($file) && file_exists($file)) {
|
|
require_once($file);
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
$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";
|
|
if (!file_exists($path)) {
|
|
$path = INSTALLDIR . "/modules/{$name}/locale";
|
|
}
|
|
if (!file_exists($path)) {
|
|
$path = INSTALLDIR . "/local/plugins/{$name}/locale";
|
|
}
|
|
}
|
|
if (file_exists($path) && is_dir($path)) {
|
|
bindtextdomain($name, $path);
|
|
bind_textdomain_codeset($name, 'UTF-8');
|
|
}
|
|
}
|
|
}
|
|
|
|
protected function log($level, $msg)
|
|
{
|
|
common_log($level, get_class($this) . ': '.$msg);
|
|
}
|
|
|
|
protected function debug($msg)
|
|
{
|
|
$this->log(LOG_DEBUG, $msg);
|
|
}
|
|
|
|
public function name()
|
|
{
|
|
$cls = get_class($this);
|
|
return mb_substr($cls, 0, -6);
|
|
}
|
|
|
|
public function version()
|
|
{
|
|
return GNUSOCIAL_VERSION;
|
|
}
|
|
|
|
protected function userAgent() {
|
|
return HTTPClient::userAgent()
|
|
. ' (' . get_class($this) . ' v' . $this->version() . ')';
|
|
}
|
|
|
|
function onPluginVersion(array &$versions)
|
|
{
|
|
$name = $this->name();
|
|
|
|
$versions[] = array('name' => $name,
|
|
// TRANS: Displayed as version information for a plugin if no version information was found.
|
|
'version' => _('Unknown'));
|
|
|
|
return true;
|
|
}
|
|
|
|
function path($relative)
|
|
{
|
|
return self::staticPath($this->name(), $relative);
|
|
}
|
|
|
|
static function staticPath($plugin, $relative)
|
|
{
|
|
if (GNUsocial::useHTTPS()) {
|
|
$server = common_config('plugins', 'sslserver');
|
|
} else {
|
|
$server = common_config('plugins', 'server');
|
|
}
|
|
|
|
if (empty($server)) {
|
|
if (GNUsocial::useHTTPS()) {
|
|
$server = common_config('site', 'sslserver');
|
|
}
|
|
if (empty($server)) {
|
|
$server = common_config('site', 'server');
|
|
}
|
|
}
|
|
|
|
if (GNUsocial::useHTTPS()) {
|
|
$path = common_config('plugins', 'sslpath');
|
|
} else {
|
|
$path = common_config('plugins', 'path');
|
|
}
|
|
|
|
if (empty($path)) {
|
|
// XXX: extra stat().
|
|
if (@file_exists(PUBLICDIR . '/local/plugins/' . $plugin . '/' . $relative)) {
|
|
$path = common_config('site', 'path') . '/local/plugins/';
|
|
} elseif (@file_exists(PUBLICDIR . '/modules/' . $plugin . '/' . $relative)) {
|
|
$path = common_config('site', 'path') . '/modules/';
|
|
} else {
|
|
$path = common_config('site', 'path') . '/plugins/';
|
|
}
|
|
}
|
|
|
|
if ($path[strlen($path)-1] != '/') {
|
|
$path .= '/';
|
|
}
|
|
|
|
if ($path[0] != '/') {
|
|
$path = '/'.$path;
|
|
}
|
|
|
|
$protocol = GNUsocial::useHTTPS() ? 'https' : 'http';
|
|
|
|
return $protocol.'://'.$server.$path.$plugin.'/'.$relative;
|
|
}
|
|
}
|