From 5326cc0c2edab855271aafb44133e4843903cfe0 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sat, 20 Oct 2018 22:34:26 -0400 Subject: [PATCH 1/3] Add Friendica\LegacyModule class --- src/LegacyModule.php | 73 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 src/LegacyModule.php diff --git a/src/LegacyModule.php b/src/LegacyModule.php new file mode 100644 index 0000000000..4b0371edb5 --- /dev/null +++ b/src/LegacyModule.php @@ -0,0 +1,73 @@ + + */ +class LegacyModule extends BaseModule +{ + /** + * The module name, which is the name of the file (without the .php suffix) + * It's used to check for existence of the module functions. + * + * @var string + */ + private static $moduleName = ''; + + /** + * The only method that needs to be called, with the module/addon file name. + * + * @param string $file_path + */ + public static function setModuleFile($file_path) + { + if (!file_exists($file_path)) { + throw new Exception(Core\L10n::t('Legacy module file not found: %s', $file_path)); + } + + self::$moduleName = basename($file_path, '.php'); + + require_once $file_path; + } + + public static function init() + { + self::runModuleFunction('init'); + } + + public static function content() + { + return self::runModuleFunction('content'); + } + + public static function post() + { + self::runModuleFunction('post'); + } + + public static function afterpost() + { + self::runModuleFunction('afterpost'); + } + + /** + * Runs the module function designated by the provided suffix if it exists, the BaseModule method otherwise + * + * @param string $function_suffix + * @return string + */ + private static function runModuleFunction($function_suffix) + { + $function_name = static::$moduleName . '_' . $function_suffix; + + if (\function_exists($function_name)) { + return $function_name(self::getApp()); + } else { + return parent::{$function_suffix}(); + } + } +} From b27ff9d2b72647b34eae5fc01d98f0ea64122445 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sat, 20 Oct 2018 22:34:55 -0400 Subject: [PATCH 2/3] Remove direct module function calls in index.php --- index.php | 37 ++++++++++--------------------------- 1 file changed, 10 insertions(+), 27 deletions(-) diff --git a/index.php b/index.php index 884b067325..c834688ffb 100644 --- a/index.php +++ b/index.php @@ -260,6 +260,8 @@ if (strlen($a->module)) { } else { include_once "addon/{$a->module}/{$a->module}.php"; if (function_exists($a->module . '_module')) { + Friendica\LegacyModule::setModuleFile("addon/{$a->module}/{$a->module}.php"); + $a->module_class = 'Friendica\\LegacyModule'; $a->module_loaded = true; } } @@ -273,10 +275,11 @@ if (strlen($a->module)) { /** * If not, next look for a 'standard' program module in the 'mod' directory + * We emulate a Module class through the LegacyModule class */ - if (! $a->module_loaded && file_exists("mod/{$a->module}.php")) { - include_once "mod/{$a->module}.php"; + Friendica\LegacyModule::setModuleFile("mod/{$a->module}.php"); + $a->module_class = 'Friendica\\LegacyModule'; $a->module_loaded = true; } @@ -336,16 +339,11 @@ if ($a->module_loaded) { Addon::callHooks($a->module . '_mod_init', $placeholder); - if ($a->module_class) { - call_user_func([$a->module_class, 'init']); - } else if (function_exists($a->module . '_init')) { - $func = $a->module . '_init'; - $func($a); - } + call_user_func([$a->module_class, 'init']); // "rawContent" is especially meant for technical endpoints. // This endpoint doesn't need any theme initialization or other comparable stuff. - if (!$a->error && $a->module_class) { + if (!$a->error) { call_user_func([$a->module_class, 'rawContent']); } @@ -356,34 +354,19 @@ if ($a->module_loaded) { if (! $a->error && $_SERVER['REQUEST_METHOD'] === 'POST') { Addon::callHooks($a->module . '_mod_post', $_POST); - if ($a->module_class) { - call_user_func([$a->module_class, 'post']); - } else if (function_exists($a->module . '_post')) { - $func = $a->module . '_post'; - $func($a); - } + call_user_func([$a->module_class, 'post']); } if (! $a->error) { Addon::callHooks($a->module . '_mod_afterpost', $placeholder); - if ($a->module_class) { - call_user_func([$a->module_class, 'afterpost']); - } else if (function_exists($a->module . '_afterpost')) { - $func = $a->module . '_afterpost'; - $func($a); - } + call_user_func([$a->module_class, 'afterpost']); } if (! $a->error) { $arr = ['content' => $a->page['content']]; Addon::callHooks($a->module . '_mod_content', $arr); $a->page['content'] = $arr['content']; - if ($a->module_class) { - $arr = ['content' => call_user_func([$a->module_class, 'content'])]; - } else if (function_exists($a->module . '_content')) { - $func = $a->module . '_content'; - $arr = ['content' => $func($a)]; - } + $arr = ['content' => call_user_func([$a->module_class, 'content'])]; Addon::callHooks($a->module . '_mod_aftercontent', $arr); $a->page['content'] .= $arr['content']; } From 1a37224910d241fa3d6e239dcec24f7d95f41ab7 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sat, 20 Oct 2018 22:42:04 -0400 Subject: [PATCH 3/3] Change file_exists to is_readable in LegacyModule --- src/LegacyModule.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/LegacyModule.php b/src/LegacyModule.php index 4b0371edb5..737101b5c2 100644 --- a/src/LegacyModule.php +++ b/src/LegacyModule.php @@ -25,7 +25,7 @@ class LegacyModule extends BaseModule */ public static function setModuleFile($file_path) { - if (!file_exists($file_path)) { + if (!is_readable($file_path)) { throw new Exception(Core\L10n::t('Legacy module file not found: %s', $file_path)); }