X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Fplugin.php;h=42339137526a136db70c882bf73d7d953b1e813a;hb=13c331fa8152f11a811d2ff66210b3298bc21ada;hp=ee57f590435f8a2093d066247ade5b634e72f82f;hpb=9aadd3cb4216f2917858b5a4eacfc5e3dc17a9ac;p=quix0rs-gnu-social.git diff --git a/lib/plugin.php b/lib/plugin.php index ee57f59043..4233913752 100644 --- a/lib/plugin.php +++ b/lib/plugin.php @@ -79,6 +79,57 @@ class Plugin return true; } + /** + * Load related modules when needed + * + * Most non-trivial plugins will require extra modules 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 boolean 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 . '/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. @@ -88,7 +139,12 @@ class Plugin $class = get_class($this); if (substr($class, -6) == 'Plugin') { $name = substr($class, 0, -6); - $path = INSTALLDIR . "/plugins/$name/locale"; + $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) && is_dir($path)) { bindtextdomain($name, $path); bind_textdomain_codeset($name, 'UTF-8'); @@ -105,11 +161,26 @@ class Plugin { $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(&$versions) { - $cls = get_class($this); - $name = mb_substr($cls, 0, -6); + $name = $this->name(); $versions[] = array('name' => $name, // TRANS: Displayed as version information for a plugin if no version information was found. @@ -117,4 +188,56 @@ class Plugin return true; } + + function path($relative) + { + return self::staticPath($this->name(), $relative); + } + + static function staticPath($plugin, $relative) + { + $isHTTPS = GNUsocial::isHTTPS(); + + if ($isHTTPS) { + $server = common_config('plugins', 'sslserver'); + } else { + $server = common_config('plugins', 'server'); + } + + if (empty($server)) { + if ($isHTTPS) { + $server = common_config('site', 'sslserver'); + } + if (empty($server)) { + $server = common_config('site', 'server'); + } + } + + if ($isHTTPS) { + $path = common_config('plugins', 'sslpath'); + } else { + $path = common_config('plugins', 'path'); + } + + if (empty($path)) { + // 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/'; + } + } + + if ($path[strlen($path)-1] != '/') { + $path .= '/'; + } + + if ($path[0] != '/') { + $path = '/'.$path; + } + + $protocol = ($isHTTPS) ? 'https' : 'http'; + + return $protocol.'://'.$server.$path.$plugin.'/'.$relative; + } }