vendor/se7enxweb/legacy-bridge/mvc/Kernel.php line 57

Open in your IDE?
  1. <?php
  3. /**
  4. * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  5. * @license For full copyright and license information view LICENSE file distributed with this source code.
  6. */
  7. namespace eZ\Publish\Core\MVC\Legacy;
  9. use Exception;
  10. use ezpKernel;
  11. use ezpKernelHandler;
  12. use ezxFormToken;
  13. use Psr\Log\LoggerInterface;
  14. use RuntimeException;
  16. /**
  17. * Class wrapping the legacy kernel.
  18. */
  19. class Kernel extends ezpKernel
  20. {
  21. /**
  22. * Legacy root directory.
  23. *
  24. * @var string
  25. */
  26. private $legacyRootDir;
  28. /**
  29. * Original webroot directory.
  30. *
  31. * @var string
  32. */
  33. private $webRootDir;
  35. private $runningCallback = false;
  37. /**
  38. * Directory where kernel was originally running from.
  39. *
  40. * @see self::runCallback()
  41. *
  42. * @var string
  43. */
  44. private $previousRunningDir;
  46. /**
  47. * @var \Psr\Log\LoggerInterface
  48. */
  49. private $logger;
  51. /**
  52. * @param \ezpKernelHandler $kernelHandler
  53. * @param string $legacyRootDir Must be a absolute dir
  54. * @param string $webRootDir Must be a absolute dir
  55. * @param \Psr\Log\LoggerInterface $logger
  56. */
  57. public function __construct(ezpKernelHandler $kernelHandler, $legacyRootDir, $webRootDir, LoggerInterface $logger = null)
  58. {
  59. $this->legacyRootDir = $legacyRootDir;
  60. $this->webRootDir = $webRootDir;
  61. $this->logger = $logger;
  63. $this->enterLegacyRootDir();
  64. parent::__construct($kernelHandler);
  65. $this->leaveLegacyRootDir();
  66. $this->setUseExceptions(true);
  67. }
  69. public static function resetInstance()
  70. {
  71. static::$instance = null;
  72. }
  74. /**
  75. * Changes the current working directory to the legacy root dir.
  76. * Calling this method is mandatory to use legacy kernel since a lot of resources in eZ Publish 4.x relatively defined.
  77. */
  78. public function enterLegacyRootDir()
  79. {
  80. $this->previousRunningDir = getcwd();
  81. if ($this->logger) {
  82. $this->logger->debug("Legacy kernel: Leaving '$this->previousRunningDir' for '$this->legacyRootDir'");
  83. }
  84. chdir($this->legacyRootDir);
  85. }
  87. /**
  88. * Leaves the legacy root dir and switches back to the dir where execution was happening before we entered LegacyRootDir.
  89. */
  90. public function leaveLegacyRootDir()
  91. {
  92. $previousDir = $this->previousRunningDir;
  93. if (!$previousDir) {
  94. if ($this->logger) {
  95. $this->logger->warning(
  96. "Trying to leave legacy root dir without a previously executing dir. Falling back to '$this->webRootDir'"
  97. );
  98. }
  99. $previousDir = $this->webRootDir;
  100. }
  102. $this->previousRunningDir = null;
  103. if ($this->logger) {
  104. $this->logger->debug("Legacy kernel: Leaving '$this->legacyRootDir' for '$previousDir'");
  105. }
  106. chdir($previousDir);
  107. }
  109. /**
  110. * Runs current request through legacy kernel.
  111. *
  112. * @return \ezpKernelResult
  113. */
  114. public function run()
  115. {
  116. $this->enterLegacyRootDir();
  117. $return = parent::run();
  118. $this->leaveLegacyRootDir();
  120. return $return;
  121. }
  123. /**
  124. * Runs a callback function in the legacy kernel environment.
  125. * This is useful to run eZ Publish 4.x code from a non-related context (like eZ Publish 5).
  126. * Will throw a \RuntimeException if trying to run a callback inside a callback.
  127. *
  128. * @param \Closure $callback
  129. * @param bool $postReinitialize Default is true.
  130. * If set to false, the kernel environment will not be reinitialized.
  131. * This can be useful to optimize several calls to the kernel within the same context.
  132. * @param bool|null $formTokenEnable Force ezxFormToken to be enabled or disabled, use system settings when null
  133. *
  134. * @throws \RuntimeException
  135. * @throws \Exception
  136. *
  137. * @return mixed The result of the callback
  138. */
  139. public function runCallback(\Closure $callback, $postReinitialize = true, $formTokenEnable = null)
  140. {
  141. if ($this->runningCallback) {
  142. throw new RuntimeException('Trying to run recursive callback in legacy kernel! Inception!');
  143. }
  145. $this->runningCallback = true;
  146. $this->enterLegacyRootDir();
  148. if ($formTokenEnable !== null && class_exists('ezxFormToken')) {
  149. $formTokenWasEnabled = ezxFormToken::isEnabled();
  150. ezxFormToken::setIsEnabled($formTokenEnable);
  151. }
  153. try {
  154. $return = parent::runCallback($callback, $postReinitialize);
  155. } catch (Exception $e) {
  156. $this->leaveLegacyRootDir();
  157. $this->runningCallback = false;
  158. throw $e;
  159. }
  161. if (isset($formTokenWasEnabled)) {
  162. ezxFormToken::setIsEnabled($formTokenWasEnabled);
  163. }
  165. $this->leaveLegacyRootDir();
  166. $this->runningCallback = false;
  168. return $return;
  169. }
  170. }