c86b4535ccd92254f3abda1e67de7375bb6ed51b
[Packages/TYPO3.CMS.git] / typo3 / sysext / backend / Classes / Console / Application.php
1 <?php
2 namespace TYPO3\CMS\Backend\Console;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16 use TYPO3\CMS\Core\Core\ApplicationInterface;
17 use TYPO3\CMS\Core\Core\Bootstrap;
18
19
20 /**
21 * Entry point for the TYPO3 Command Line for Backend calls
22 */
23 class Application implements ApplicationInterface {
24
25 /**
26 * @var Bootstrap
27 */
28 protected $bootstrap;
29
30 /**
31 *
32 * @var string
33 */
34 protected $entryPointPath = 'typo3/';
35
36 /**
37 * All available request handlers that can deal with a CLI Request
38 * @var array
39 */
40 protected $availableRequestHandlers = array(
41 \TYPO3\CMS\Backend\Console\CliRequestHandler::class
42 );
43
44 /**
45 * Constructor setting up legacy constants and register available Request Handlers
46 *
47 * @param \Composer\Autoload\ClassLoader|\Helhum\ClassAliasLoader\ClassAliasLoader $classLoader an instance of the class loader
48 */
49 public function __construct($classLoader) {
50 $this->checkEnvironmentOrDie();
51
52 $this->defineLegacyConstants();
53
54 $this->bootstrap = Bootstrap::getInstance()
55 ->initializeClassLoader($classLoader)
56 ->baseSetup($this->entryPointPath);
57
58 foreach ($this->availableRequestHandlers as $requestHandler) {
59 $this->bootstrap->registerRequestHandlerImplementation($requestHandler);
60 }
61
62 $this->bootstrap->configure();
63 }
64
65 /**
66 * Set up the application and shut it down afterwards
67 *
68 * @param callable $execute
69 * @return void
70 */
71 public function run(callable $execute = NULL) {
72 $this->bootstrap->handleRequest(new \Symfony\Component\Console\Input\ArgvInput());
73
74 if ($execute !== NULL) {
75 if ($execute instanceof \Closure) {
76 $execute->bindTo($this);
77 }
78 call_user_func($execute);
79 }
80
81 $this->bootstrap->shutdown();
82 }
83
84 /**
85 * Define constants and variables
86 */
87 protected function defineLegacyConstants() {
88 define('TYPO3_MODE', 'BE');
89 define('TYPO3_cliMode', TRUE);
90 }
91
92 /**
93 * Check the script is called from a cli environment.
94 *
95 * @return void
96 */
97 protected function checkEnvironmentOrDie() {
98 if (substr(php_sapi_name(), 0, 3) === 'cgi') {
99 $this->initializeCgiCompatibilityLayerOrDie();
100 } elseif (php_sapi_name() !== 'cli') {
101 die('Not called from a command line interface (e.g. a shell or scheduler).' . LF);
102 }
103 }
104
105 /**
106 * Set up cgi sapi as de facto cli, but check no HTTP
107 * environment variables are set.
108 *
109 * @return void
110 */
111 protected function initializeCgiCompatibilityLayerOrDie() {
112 // Sanity check: Ensure we're running in a shell or cronjob (and NOT via HTTP)
113 $checkEnvVars = array('HTTP_USER_AGENT', 'HTTP_HOST', 'SERVER_NAME', 'REMOTE_ADDR', 'REMOTE_PORT', 'SERVER_PROTOCOL');
114 foreach ($checkEnvVars as $var) {
115 if (array_key_exists($var, $_SERVER)) {
116 echo 'SECURITY CHECK FAILED! This script cannot be used within your browser!' . LF;
117 echo 'If you are sure that we run in a shell or cronjob, please unset' . LF;
118 echo 'environment variable ' . $var . ' (usually using \'unset ' . $var . '\')' . LF;
119 echo 'before starting this script.' . LF;
120 die;
121 }
122 }
123
124 // Mimic CLI API in CGI API (you must use the -C/-no-chdir and the -q/--no-header switches!)
125 ini_set('html_errors', 0);
126 ini_set('implicit_flush', 1);
127 ini_set('max_execution_time', 0);
128 define('STDIN', fopen('php://stdin', 'r'));
129 define('STDOUT', fopen('php://stdout', 'w'));
130 define('STDERR', fopen('php://stderr', 'w'));
131 }
132
133 }