src/LegacyModule.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica;
  23
  24 use Friendica\Core\L10n;
  25 use Friendica\Util\Profiler;
  26 use Psr\Log\LoggerInterface;
  27
  28 /**
  29  * This mock module enable class encapsulation of legacy global function modules.
  30  * After having provided the module file name, all the methods will behave like a normal Module class.
  31  *
  32  * @author Hypolite Petovan <mrpetovan@gmail.com>
  33  */
  34 class LegacyModule extends BaseModule
  35 {
  36         /**
  37          * The module name, which is the name of the file (without the .php suffix)
  38          * It's used to check for existence of the module functions.
  39          *
  40          * @var string
  41          */
  42         private $moduleName = '';
  43
  44         public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, array $server, string $file_path = '', array $parameters = [])
  45         {
  46                 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $server, $parameters);
  47
  48                 $this->setModuleFile($file_path);
  49
  50                 $this->runModuleFunction('init');
  51         }
  52
  53         /**
  54          * The only method that needs to be called, with the module/addon file name.
  55          *
  56          * @param string $file_path
  57          * @throws \Exception
  58          */
  59         private function setModuleFile($file_path)
  60         {
  61                 if (!is_readable($file_path)) {
  62                         throw new \Exception(DI::l10n()->t('Legacy module file not found: %s', $file_path));
  63                 }
  64
  65                 $this->moduleName = basename($file_path, '.php');
  66
  67                 require_once $file_path;
  68         }
  69
  70         public function content(array $request = []): string
  71         {
  72                 return $this->runModuleFunction('content');
  73         }
  74
  75         public function post(array $request = [], array $post = [])
  76         {
  77                 parent::post($post);
  78
  79                 $this->runModuleFunction('post');
  80         }
  81
  82         /**
  83          * Runs the module function designated by the provided suffix if it exists, the BaseModule method otherwise
  84          *
  85          * @param string $function_suffix
  86          * @return string
  87          * @throws \Exception
  88          */
  89         private function runModuleFunction(string $function_suffix)
  90         {
  91                 $function_name = $this->moduleName . '_' . $function_suffix;
  92
  93                 if (\function_exists($function_name)) {
  94                         $a = DI::app();
  95                         return $function_name($a);
  96                 }
  97
  98                 return '';
  99         }
 100 }